Documentation ¶
Index ¶
- func SetComplexType(v interface{}) error
- type Abuse_Lockdown_Resource
- type Account
- type Account_AbuseEmail
- type Account_Address
- type Account_Address_Type
- type Account_Affiliation
- type Account_Agreement
- type Account_Agreement_Status
- type Account_Agreement_Type
- type Account_Attachment_Employee
- type Account_Attachment_Employee_Role
- type Account_Attribute
- type Account_Attribute_Type
- type Account_Authentication_Attribute
- type Account_Authentication_Attribute_Type
- type Account_Authentication_OpenIdConnect_Option
- type Account_Authentication_OpenIdConnect_RegistrationInformation
- type Account_Authentication_Saml
- type Account_Brand_Migration_Request
- type Account_Business_Partner
- type Account_Classification_Group_Type
- type Account_Contact
- type Account_Contact_Type
- type Account_External_Setup
- type Account_Historical_Report
- type Account_Internal_Ibm
- type Account_Internal_Ibm_CostRecovery_Validator
- type Account_Link
- type Account_Link_Bluemix
- type Account_Link_OpenStack
- type Account_Link_OpenStack_DomainCreationDetails
- type Account_Link_OpenStack_LinkRequest
- type Account_Link_OpenStack_ProjectCreationDetails
- type Account_Link_OpenStack_ProjectDetails
- type Account_Link_Vendor
- type Account_Lockdown_Request
- type Account_MasterServiceAgreement
- type Account_Media
- type Account_Media_Data_Transfer_Request
- type Account_Media_Data_Transfer_Request_Status
- type Account_Media_Type
- type Account_Network_Vlan_Span
- type Account_Note
- type Account_Note_History
- type Account_Partner_Referral_Prospect
- type Account_Password
- type Account_Password_Type
- type Account_ProofOfConcept
- type Account_ProofOfConcept_Approver
- type Account_ProofOfConcept_Approver_Role
- type Account_ProofOfConcept_Approver_Type
- type Account_ProofOfConcept_Campaign_Code
- type Account_ProofOfConcept_Funding_Type
- type Account_Regional_Registry_Detail
- type Account_Regional_Registry_Detail_Property
- type Account_Regional_Registry_Detail_Property_Type
- type Account_Regional_Registry_Detail_Type
- type Account_Regional_Registry_Detail_Version4_Person_Default
- type Account_Reports_Request
- type Account_Rwhois_Handle
- type Account_Shipment
- type Account_Shipment_Item
- type Account_Shipment_Item_Type
- type Account_Shipment_Resource_Type
- type Account_Shipment_Status
- type Account_Shipment_Tracking_Data
- type Account_Shipment_Type
- type Account_Status
- type Account_Status_Change_Reason
- type Auxiliary_Network_Status
- type Auxiliary_Notification_Emergency
- type Auxiliary_Notification_Emergency_Signature
- type Auxiliary_Notification_Emergency_Status
- type Auxiliary_Shipping_Courier
- type Auxiliary_Shipping_Courier_Type
- type BMS_Container_Country
- type Billing_Chargeback_Type
- type Billing_Currency
- type Billing_Currency_Country
- type Billing_Currency_ExchangeRate
- type Billing_Info
- type Billing_Info_Ach
- type Billing_Info_Cycle
- type Billing_Invoice
- type Billing_Invoice_Item
- type Billing_Invoice_Item_Hardware
- type Billing_Invoice_Item_Tax_Info
- type Billing_Invoice_Next
- type Billing_Invoice_Receivable_Payment
- type Billing_Invoice_Tax_Info
- type Billing_Invoice_Tax_Status
- type Billing_Invoice_Tax_Type
- type Billing_Item
- type Billing_Item_Account_Media_Data_Transfer_Request
- type Billing_Item_Association_History
- type Billing_Item_Cancellation_Reason
- type Billing_Item_Cancellation_Reason_Category
- type Billing_Item_Cancellation_Request
- type Billing_Item_Cancellation_Request_Item
- type Billing_Item_Cancellation_Request_Status
- type Billing_Item_Chronicle
- type Billing_Item_Ctc_Account
- type Billing_Item_Gateway_Appliance_Cluster
- type Billing_Item_Gateway_License
- type Billing_Item_Hardware
- type Billing_Item_Hardware_Colocation
- type Billing_Item_Hardware_Component
- type Billing_Item_Hardware_Security_Module
- type Billing_Item_Hardware_Server
- type Billing_Item_Network_Application_Delivery_Controller
- type Billing_Item_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress
- type Billing_Item_Network_Bandwidth
- type Billing_Item_Network_Firewall
- type Billing_Item_Network_Firewall_Module_Context
- type Billing_Item_Network_Interconnect
- type Billing_Item_Network_Interconnect_Routing
- type Billing_Item_Network_LoadBalancer
- type Billing_Item_Network_LoadBalancer_VirtualIpAddress
- type Billing_Item_Network_Message_Delivery
- type Billing_Item_Network_PerformanceStorage_Iscsi
- type Billing_Item_Network_PerformanceStorage_Nfs
- type Billing_Item_Network_Storage
- type Billing_Item_Network_Storage_Hub
- type Billing_Item_Network_Storage_Hub_Bandwidth
- type Billing_Item_Network_Subnet
- type Billing_Item_Network_Subnet_IpAddress_Global
- type Billing_Item_Network_Tunnel
- type Billing_Item_Network_Vlan
- type Billing_Item_NewCustomerSetup
- type Billing_Item_Private_Cloud
- type Billing_Item_Software_Component
- type Billing_Item_Software_Component_Analytics_Urchin
- type Billing_Item_Software_Component_ControlPanel
- type Billing_Item_Software_Component_ControlPanel_Parallels_Plesk_Billing
- type Billing_Item_Software_Component_OperatingSystem_Addon
- type Billing_Item_Software_Component_OperatingSystem_Addon_Citrix_Essentials
- type Billing_Item_Software_Component_Virtual_OperatingSystem
- type Billing_Item_Software_Component_Virtual_OperatingSystem_Microsoft
- type Billing_Item_Software_Component_Virtual_OperatingSystem_Redhat
- type Billing_Item_Software_License
- type Billing_Item_Support
- type Billing_Item_User_Customer_External_Binding
- type Billing_Item_Virtual_DedicatedHost
- type Billing_Item_Virtual_Dedicated_Rack
- type Billing_Item_Virtual_Disk_Image
- type Billing_Item_Virtual_Guest
- type Billing_Item_Virtual_Host_Usage
- type Billing_Item_Virtual_ReservedCapacity
- type Billing_Item_Workspace
- type Billing_Order
- type Billing_Order_Cart
- type Billing_Order_Item
- type Billing_Order_Item_Category_Answer
- type Billing_Order_Quote
- type Billing_Order_Type
- type Billing_Payment_Card_ChangeRequest
- type Billing_Payment_Card_ManualPayment
- type Billing_Payment_Card_PayerAuthentication_Setup
- type Billing_Payment_Card_PayerAuthentication_Setup_Information
- type Billing_Payment_Card_Transaction
- type Billing_Payment_PayPal_Transaction
- type Billing_Payment_Processor
- type Billing_Payment_Processor_Method
- type Billing_Payment_Processor_Type
- type Billing_Payment_Transaction
- type Billing_Payment_Type
- type Brand
- type Brand_Attribute
- type Brand_Business_Partner
- type Brand_Contact
- type Brand_Contact_Type
- type Brand_Payment_Processor
- type Brand_Restriction_Location_CustomerCountry
- type Business_Partner_Channel
- type Business_Partner_Segment
- type Catalyst_Affiliate
- type Catalyst_Company_Type
- type Catalyst_Enrollment
- type Catalyst_Enrollment_Request
- type Catalyst_Enrollment_Request_Container_AnswerOption
- type Compliance_Report_Type
- type Configuration_Storage_Filesystem_Type
- type Configuration_Storage_Group
- type Configuration_Storage_Group_Array_Type
- type Configuration_Storage_Group_Order
- type Configuration_Storage_Group_Template_Group
- type Configuration_Template
- type Configuration_Template_Attribute
- type Configuration_Template_Section
- type Configuration_Template_Section_Attribute
- type Configuration_Template_Section_Definition
- type Configuration_Template_Section_Definition_Attribute
- type Configuration_Template_Section_Definition_Attribute_Type
- type Configuration_Template_Section_Definition_Group
- type Configuration_Template_Section_Definition_Type
- type Configuration_Template_Section_Definition_Value
- type Configuration_Template_Section_Profile
- type Configuration_Template_Section_Reference
- type Configuration_Template_Section_Type
- type Configuration_Template_Type
- type Container_Account_Authentication_OpenIdConnect_UsernameLookupContainer
- type Container_Account_Discount_Program
- type Container_Account_Discount_Program_Collection
- type Container_Account_External_Setup_ProvisioningHoldLifted
- type Container_Account_External_Setup_ProvisioningHoldLifted_Attributes
- type Container_Account_Historical_Summary
- type Container_Account_Historical_Summary_Detail
- type Container_Account_Historical_Summary_Detail_Uptime
- type Container_Account_Historical_Summary_Uptime
- type Container_Account_Internal_Ibm_CostRecovery
- type Container_Account_Internal_Ibm_Request
- type Container_Account_Payment_Method_CreditCard
- type Container_Account_PersonalInformation
- type Container_Account_ProofOfConcept_Contact_Customer
- type Container_Account_ProofOfConcept_Contact_Ibmer_Requester
- type Container_Account_ProofOfConcept_Contact_Ibmer_Technical
- type Container_Account_ProofOfConcept_Request_AccountFunded
- type Container_Account_ProofOfConcept_Request_CostRecovery
- type Container_Account_ProofOfConcept_Request_GlobalFunded
- type Container_Account_ProofOfConcept_Request_Opportunity
- type Container_Account_ProofOfConcept_Review
- type Container_Account_ProofOfConcept_Review_Event
- type Container_Account_ProofOfConcept_Review_History
- type Container_Account_ProofOfConcept_Review_Summary
- type Container_Account_Update_Response
- type Container_Authentication_Request_Common
- type Container_Authentication_Request_Contract
- type Container_Authentication_Request_Native
- type Container_Authentication_Request_Native_External
- type Container_Authentication_Request_Native_External_Totp
- type Container_Authentication_Request_Native_External_Verisign
- type Container_Authentication_Request_OpenIdConnect
- type Container_Authentication_Request_OpenIdConnect_External
- type Container_Authentication_Request_OpenIdConnect_External_Totp
- type Container_Authentication_Request_OpenIdConnect_External_Verisign
- type Container_Authentication_Response_2FactorAuthenticationNeeded
- type Container_Authentication_Response_Account
- type Container_Authentication_Response_AccountIdMissing
- type Container_Authentication_Response_Common
- type Container_Authentication_Response_IpAddressRestrictionCheckNeeded
- type Container_Authentication_Response_LoginFailed
- type Container_Authentication_Response_Success
- type Container_Auxiliary_Network_Status_Reading
- type Container_Bandwidth_GraphInputs
- type Container_Bandwidth_GraphOutputs
- type Container_Bandwidth_Projection
- type Container_Bandwidth_Usage
- type Container_Billing_Currency_Country
- type Container_Billing_Currency_Format
- type Container_Billing_Info_Ach
- type Container_Billing_Invoice_Email
- type Container_Billing_Order_Status
- type Container_Catalyst_ManualEnrollmentRequest
- type Container_Collection_Locale_CountryCode
- type Container_Collection_Locale_StateCode
- type Container_Collection_Locale_VatCountryCodeAndFormat
- type Container_Disk_Image_Capture_Template
- type Container_Disk_Image_Capture_Template_Volume
- type Container_Disk_Image_Capture_Template_Volume_Partition
- type Container_Exception
- type Container_Graph
- type Container_Graph_Option
- type Container_Graph_Plot
- type Container_Graph_Plot_Coordinate
- type Container_Hardware_CaptureEnabled
- type Container_Hardware_Configuration
- type Container_Hardware_Configuration_Option
- type Container_Hardware_DiskImageMap
- type Container_Hardware_MassUpdate
- type Container_Hardware_Pool_Details
- type Container_Hardware_Pool_Details_Router
- type Container_Hardware_Server_Configuration
- type Container_Hardware_Server_Details
- type Container_Hardware_Server_Request
- type Container_Image_StorageGroupDetails
- type Container_Image_StorageGroupDetails_Drives
- type Container_KnowledgeLayer_QuestionAnswer
- type Container_Message
- type Container_Metric_Data_Type
- type Container_Metric_Tracking_Object_Details
- type Container_Metric_Tracking_Object_Summary
- type Container_Metric_Tracking_Object_Virtual_Host_Details
- type Container_Metric_Tracking_Object_Virtual_Host_Summary
- type Container_Monitoring_Alarm_History
- type Container_Network_Authentication_Data
- type Container_Network_Bandwidth_Data_Summary
- type Container_Network_Bandwidth_Version1_Usage
- type Container_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader
- type Container_Network_CdnMarketplace_Configuration_Behavior_TokenAuth
- type Container_Network_CdnMarketplace_Configuration_Cache_Purge
- type Container_Network_CdnMarketplace_Configuration_Cache_PurgeGroup
- type Container_Network_CdnMarketplace_Configuration_Cache_PurgeGroupHistory
- type Container_Network_CdnMarketplace_Configuration_Input
- type Container_Network_CdnMarketplace_Configuration_Mapping
- type Container_Network_CdnMarketplace_Configuration_Mapping_Path
- type Container_Network_CdnMarketplace_Configuration_Performance_DynamicContentAcceleration
- type Container_Network_CdnMarketplace_Metrics
- type Container_Network_CdnMarketplace_Vendor
- type Container_Network_Directory_Listing
- type Container_Network_LoadBalancer_StatusEntry
- type Container_Network_Message_Delivery_Email
- type Container_Network_Message_Delivery_Email_Sendgrid_Account
- type Container_Network_Message_Delivery_Email_Sendgrid_Account_Offering
- type Container_Network_Message_Delivery_Email_Sendgrid_Account_Overview
- type Container_Network_Message_Delivery_Email_Sendgrid_Account_Profile
- type Container_Network_Message_Delivery_Email_Sendgrid_Catalog_Item
- type Container_Network_Message_Delivery_Email_Sendgrid_Catalog_Item_Entitlements
- type Container_Network_Message_Delivery_Email_Sendgrid_Catalog_Item_Offering
- type Container_Network_Message_Delivery_Email_Sendgrid_Customer_Profile
- type Container_Network_Message_Delivery_Email_Sendgrid_List_Entry
- type Container_Network_Message_Delivery_Email_Sendgrid_Statistics
- type Container_Network_Message_Delivery_Email_Sendgrid_Statistics_Graph
- type Container_Network_Message_Delivery_Email_Sendgrid_Statistics_Options
- type Container_Network_Port_Statistic
- type Container_Network_SecurityGroup_Limit
- type Container_Network_Service_Resource_ObjectStorage_ConnectionInformation
- type Container_Network_Storage_Backup_Evault_WebCc_Authentication_Details
- type Container_Network_Storage_DataCenterLimits_VolumeCountLimitContainer
- type Container_Network_Storage_DuplicateConversionStatusInformation
- type Container_Network_Storage_Evault_Vault_Task
- type Container_Network_Storage_Evault_WebCc_AgentStatus
- type Container_Network_Storage_Evault_WebCc_BackupResults
- type Container_Network_Storage_Evault_WebCc_JobDetails
- type Container_Network_Storage_Host
- type Container_Network_Storage_HostsGatewayInformation
- type Container_Network_Storage_Hub_ObjectStorage_Bucket
- type Container_Network_Storage_Hub_ObjectStorage_ContentDeliveryUrl
- type Container_Network_Storage_Hub_ObjectStorage_Endpoint
- type Container_Network_Storage_Hub_ObjectStorage_File
- type Container_Network_Storage_Hub_ObjectStorage_Folder
- type Container_Network_Storage_Hub_ObjectStorage_Node
- type Container_Network_Storage_Hub_ObjectStorage_Policy
- type Container_Network_Storage_Hub_ObjectStorage_Provision
- type Container_Network_Storage_MassDataMigration_Request_Address
- type Container_Network_Storage_NetworkConnectionInformation
- type Container_Network_Storage_VolumeDuplicateParameters
- type Container_Network_Subnet_IpAddress
- type Container_Network_Subnet_Registration_SubnetReference
- type Container_Network_Subnet_Registration_TransactionDetails
- type Container_Policy_Acceptance
- type Container_Product_Item_Category
- type Container_Product_Item_Category_Question_Answer
- type Container_Product_Item_Category_ZeroFee_Count
- type Container_Product_Item_Discount_Program
- type Container_Product_Order
- type Container_Product_Order_Account_Media_Data_Transfer_Request
- type Container_Product_Order_Attribute_Address
- type Container_Product_Order_Attribute_Contact
- type Container_Product_Order_Attribute_Organization
- type Container_Product_Order_Billing_Information
- type Container_Product_Order_Gateway_Appliance_Cluster
- type Container_Product_Order_Gateway_Appliance_Upgrade
- type Container_Product_Order_Hardware_Security_Module
- type Container_Product_Order_Hardware_Server
- type Container_Product_Order_Hardware_Server_Colocation
- type Container_Product_Order_Hardware_Server_Gateway_Appliance
- type Container_Product_Order_Hardware_Server_Upgrade
- type Container_Product_Order_Hardware_Server_Upgrade_MigrateToReserved
- type Container_Product_Order_Hardware_Server_Vpc
- type Container_Product_Order_Monitoring_Package
- type Container_Product_Order_MultiConfiguration
- type Container_Product_Order_MultiConfiguration_Tornado
- type Container_Product_Order_Network
- type Container_Product_Order_Network_Application_Delivery_Controller
- type Container_Product_Order_Network_Interconnect
- type Container_Product_Order_Network_Interconnect_Upgrade
- type Container_Product_Order_Network_LoadBalancer
- type Container_Product_Order_Network_LoadBalancer_AsAService
- type Container_Product_Order_Network_Message_Delivery
- type Container_Product_Order_Network_Message_Delivery_Upgrade
- type Container_Product_Order_Network_PerformanceStorage
- type Container_Product_Order_Network_PerformanceStorage_Iscsi
- type Container_Product_Order_Network_PerformanceStorage_Nfs
- type Container_Product_Order_Network_Protection_Firewall
- type Container_Product_Order_Network_Protection_Firewall_Dedicated
- type Container_Product_Order_Network_Protection_Firewall_Dedicated_Upgrade
- type Container_Product_Order_Network_Storage_AsAService
- type Container_Product_Order_Network_Storage_AsAService_Upgrade
- type Container_Product_Order_Network_Storage_Backup_Evault_Plugin
- type Container_Product_Order_Network_Storage_Backup_Evault_Vault
- type Container_Product_Order_Network_Storage_Enterprise
- type Container_Product_Order_Network_Storage_Enterprise_SnapshotSpace
- type Container_Product_Order_Network_Storage_Enterprise_SnapshotSpace_Upgrade
- type Container_Product_Order_Network_Storage_Hub
- type Container_Product_Order_Network_Storage_Hub_Datacenter
- type Container_Product_Order_Network_Storage_Iscsi
- type Container_Product_Order_Network_Storage_MassDataMigration_Request
- type Container_Product_Order_Network_Storage_Modification
- type Container_Product_Order_Network_Storage_Nas
- type Container_Product_Order_Network_Storage_Object
- type Container_Product_Order_Network_Storage_ObjectStorage_LocationGroup
- type Container_Product_Order_Network_Subnet
- type Container_Product_Order_Network_Tunnel_Ipsec
- type Container_Product_Order_Network_Vlan
- type Container_Product_Order_Network_Vlans
- type Container_Product_Order_NewCustomerSetup
- type Container_Product_Order_Private_Cloud
- type Container_Product_Order_Property
- type Container_Product_Order_Receipt
- type Container_Product_Order_Security_Certificate
- type Container_Product_Order_Service
- type Container_Product_Order_Service_External
- type Container_Product_Order_Software_Component_Virtual
- type Container_Product_Order_Software_License
- type Container_Product_Order_SshKeys
- type Container_Product_Order_Storage_Group
- type Container_Product_Order_Storage_Group_Partition
- type Container_Product_Order_Support
- type Container_Product_Order_User_Customer_External_Binding
- type Container_Product_Order_Virtual_DedicatedHost
- type Container_Product_Order_Virtual_Disk_Image
- type Container_Product_Order_Virtual_Guest
- type Container_Product_Order_Virtual_Guest_Upgrade
- type Container_Product_Order_Virtual_Guest_Vpc
- type Container_Product_Order_Virtual_Guest_Vpc_NetworkInterface
- type Container_Product_Order_Virtual_Guest_Vpc_StorageVolume
- type Container_Product_Order_Virtual_Guest_Vpc_Upgrade
- type Container_Product_Order_Virtual_ReservedCapacity
- type Container_Product_Order_Vpc_IpAllocation
- type Container_Product_Order_Vpc_Subnet
- type Container_Product_Promotion
- type Container_Product_Promotion_RequirementGroup
- type Container_Provisioning_Maintenance_Window
- type Container_Referral_Partner_Commission
- type Container_Referral_Partner_Payment_Option
- type Container_Referral_Partner_Prospect
- type Container_RemoteManagement_Graphs_SensorSpeed
- type Container_RemoteManagement_Graphs_SensorTemperature
- type Container_RemoteManagement_PmInfo
- type Container_RemoteManagement_SensorReading
- type Container_RemoteManagement_SensorReadingsWithGraphs
- type Container_Resource_Metadata_ServiceResource
- type Container_Search_ObjectType
- type Container_Search_ObjectType_Property
- type Container_Search_Result
- type Container_Software_Component_HostIps_Policy
- type Container_Tax_Cache
- type Container_Tax_Cache_Item
- type Container_Tax_Rates
- type Container_Ticket_GraphInputs
- type Container_Ticket_GraphOutputs
- type Container_Ticket_Priority
- type Container_Ticket_Survey_Preference
- type Container_User_Authentication_Token
- type Container_User_Customer_External_Binding
- type Container_User_Customer_External_Binding_Totp
- type Container_User_Customer_External_Binding_Vendor
- type Container_User_Customer_External_Binding_Verisign
- type Container_User_Customer_OpenIdConnect_LoginAccountInfo
- type Container_User_Customer_OpenIdConnect_MigrationState
- type Container_User_Customer_PasswordSet
- type Container_User_Customer_Portal_MobileToken
- type Container_User_Customer_Portal_Token
- type Container_User_Customer_Profile_Event_HyperWarp_ProfileChange
- type Container_User_Customer_Profile_Event_HyperWarp_ProfileChange_Context
- type Container_User_Customer_Profile_Event_HyperWarp_ProfileChange_EventProperties
- type Container_User_Employee_External_Binding_Verisign
- type Container_Utility_File_Attachment
- type Container_Utility_File_Entity
- type Container_Utility_Message
- type Container_Utility_Microsoft_Windows_UpdateServices_Status
- type Container_Utility_Microsoft_Windows_UpdateServices_UpdateItem
- type Container_Utility_Network_Firewall_Rule_Attribute
- type Container_Utility_Network_Subnet_Mask_Generic_Detail
- type Container_Virtual_ConsoleData
- type Container_Virtual_DedicatedHost_AllocationStatus
- type Container_Virtual_DedicatedHost_Pci_Device_AllocationStatus
- type Container_Virtual_Guest_Block_Device_Template_Configuration
- type Container_Virtual_Guest_Block_Device_Template_Group_RiasAccount
- type Container_Virtual_Guest_Configuration
- type Container_Virtual_Guest_Configuration_Option
- type Container_Virtual_Guest_PendingMaintenanceAction
- type Device_Status
- type Dns_Domain
- type Dns_Domain_Forward
- type Dns_Domain_ResourceRecord
- type Dns_Domain_ResourceRecord_AType
- type Dns_Domain_ResourceRecord_AaaaType
- type Dns_Domain_ResourceRecord_CnameType
- type Dns_Domain_ResourceRecord_MxType
- type Dns_Domain_ResourceRecord_NsType
- type Dns_Domain_ResourceRecord_PtrType
- type Dns_Domain_ResourceRecord_SoaType
- type Dns_Domain_ResourceRecord_SpfType
- type Dns_Domain_ResourceRecord_SrvType
- type Dns_Domain_ResourceRecord_TxtType
- type Dns_Domain_Reverse
- type Dns_Domain_Reverse_Version4
- type Dns_Domain_Reverse_Version6
- type Dns_Message
- type Dns_Secondary
- type Dns_Status
- type Email_Subscription
- type Email_Subscription_Group
- type Email_Subscription_Suppression_User
- type Entity
- type Event_Log
- type Exception_Brand_Creation
- type Exception_Hardware_Component_Locator_ComponentLocatorException
- type Exception_Hardware_Component_Locator_InvalidGenericComponentArgument
- type FlexibleCredit_Affiliate
- type FlexibleCredit_Company_Type
- type FlexibleCredit_Enrollment
- type FlexibleCredit_Program
- type Float64
- type Hardware
- type Hardware_Attribute
- type Hardware_Attribute_Type
- type Hardware_Attribute_UserData
- type Hardware_Benchmark_Certification
- type Hardware_Blade
- type Hardware_Chassis
- type Hardware_Component
- type Hardware_Component_Attribute
- type Hardware_Component_Attribute_Type
- type Hardware_Component_DriveController
- type Hardware_Component_Firmware
- type Hardware_Component_Firmware_Attribute
- type Hardware_Component_Firmware_Attribute_Type
- type Hardware_Component_Firmware_QualificationTypes
- type Hardware_Component_HardDrive
- type Hardware_Component_Locator
- type Hardware_Component_Locator_Result
- type Hardware_Component_Model
- type Hardware_Component_Model_Architecture_Type
- type Hardware_Component_Model_Attribute
- type Hardware_Component_Model_Attribute_Type
- type Hardware_Component_Model_Generic
- type Hardware_Component_Model_Generic_Attribute
- type Hardware_Component_Model_Generic_MarketingFeature
- type Hardware_Component_Motherboard
- type Hardware_Component_Motherboard_Reboot_Time
- type Hardware_Component_NetworkCard
- type Hardware_Component_PSID_Xref
- type Hardware_Component_Partition
- type Hardware_Component_Partition_OperatingSystem
- type Hardware_Component_Partition_Template
- type Hardware_Component_Partition_Template_Partition
- type Hardware_Component_Processor
- type Hardware_Component_Ram
- type Hardware_Component_RemoteManagement
- type Hardware_Component_RemoteManagement_Command
- type Hardware_Component_RemoteManagement_Command_Request
- type Hardware_Component_RemoteManagement_User
- type Hardware_Component_Revision
- type Hardware_Component_SecurityDevice
- type Hardware_Component_SecurityDevice_Infineon
- type Hardware_Component_Type
- type Hardware_Firewall
- type Hardware_Function
- type Hardware_Group
- type Hardware_LoadBalancer
- type Hardware_Note
- type Hardware_Note_Type
- type Hardware_Power_Component
- type Hardware_Resource_Configuration
- type Hardware_Resource_Configuration_Property
- type Hardware_Resource_Configuration_Property_Type
- type Hardware_Resource_Configuration_Type
- type Hardware_Router
- type Hardware_Router_Backend
- type Hardware_Router_Frontend
- type Hardware_SecurityModule
- type Hardware_SecurityModule750
- type Hardware_Server
- type Hardware_Server_Partition
- type Hardware_Server_Partition_Network_Attribute
- type Hardware_State
- type Hardware_Status
- type Hardware_Switch
- type Layout_Container
- type Layout_Container_Type
- type Layout_Item
- type Layout_Item_Type
- type Layout_Preference
- type Layout_Preference_Type
- type Layout_Profile
- type Layout_Profile_Containers
- type Layout_Profile_Customer
- type Layout_Profile_Preference
- type Legal_RegulatedWorkload
- type Legal_RegulatedWorkload_Type
- type Locale
- type Locale_Country
- type Locale_StateProvince
- type Locale_Timezone
- type Location
- type Location_Datacenter
- type Location_Group
- type Location_Group_Location_CrossReference
- type Location_Group_Pricing
- type Location_Group_Regional
- type Location_Group_Type
- type Location_Inventory_Room
- type Location_Network_Operations_Center
- type Location_Office
- type Location_Rack
- type Location_Region
- type Location_Region_Location
- type Location_Reservation
- type Location_Reservation_Rack
- type Location_Reservation_Rack_Member
- type Location_Root
- type Location_Server_Room
- type Location_Slot
- type Location_Status
- type Location_Storage_Room
- type Marketplace_EmailDistribution
- type Marketplace_Partner
- type Marketplace_Partner_Attachment
- type Marketplace_Partner_Attachment_Type
- type Marketplace_Partner_File
- type Marketplace_Partner_File_Attributes
- type McAfee_Epolicy_Orchestrator_Version36_Agent_Details
- type McAfee_Epolicy_Orchestrator_Version36_Agent_Parent_Details
- type McAfee_Epolicy_Orchestrator_Version36_Antivirus_Event
- type McAfee_Epolicy_Orchestrator_Version36_Antivirus_Event_AccessProtection
- type McAfee_Epolicy_Orchestrator_Version36_Antivirus_Event_Filter_Description
- type McAfee_Epolicy_Orchestrator_Version36_Hips_Version6_BlockedApplicationEvent
- type McAfee_Epolicy_Orchestrator_Version36_Hips_Version6_Event_Signature
- type McAfee_Epolicy_Orchestrator_Version36_Hips_Version6_IPSEvent
- type McAfee_Epolicy_Orchestrator_Version36_Hips_Version7_BlockedApplicationEvent
- type McAfee_Epolicy_Orchestrator_Version36_Hips_Version7_Event_Signature
- type McAfee_Epolicy_Orchestrator_Version36_Hips_Version7_IPSEvent
- type McAfee_Epolicy_Orchestrator_Version36_Policy_Object
- type McAfee_Epolicy_Orchestrator_Version36_Product_Properties
- type McAfee_Epolicy_Orchestrator_Version45_Agent_Details
- type McAfee_Epolicy_Orchestrator_Version45_Agent_Parent_Details
- type McAfee_Epolicy_Orchestrator_Version45_Event
- type McAfee_Epolicy_Orchestrator_Version45_Event_Filter_Description
- type McAfee_Epolicy_Orchestrator_Version45_Event_Version7
- type McAfee_Epolicy_Orchestrator_Version45_Event_Version8
- type McAfee_Epolicy_Orchestrator_Version45_Hips_Event_Signature_Version7
- type McAfee_Epolicy_Orchestrator_Version45_Hips_Event_Signature_Version8
- type McAfee_Epolicy_Orchestrator_Version45_Policy_Object
- type McAfee_Epolicy_Orchestrator_Version45_Product_Properties
- type McAfee_Epolicy_Orchestrator_Version51_Agent_Details
- type McAfee_Epolicy_Orchestrator_Version51_Policy_Object
- type McAfee_Epolicy_Orchestrator_Version51_Product_Properties
- type Metric_Tracking_Object
- type Metric_Tracking_Object_Abstract
- type Metric_Tracking_Object_Bandwidth_Summary
- type Metric_Tracking_Object_Data
- type Metric_Tracking_Object_HardwareServer
- type Metric_Tracking_Object_Type
- type Metric_Tracking_Object_VirtualDedicatedRack
- type Metric_Tracking_Object_Virtual_Storage_Repository
- type Monitoring_Robot
- type Monitoring_Robot_Status
- type Network
- type Network_Application_Delivery_Controller
- type Network_Application_Delivery_Controller_Configuration_History
- type Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute
- type Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type
- type Network_Application_Delivery_Controller_LoadBalancer_Health_Check
- type Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type
- type Network_Application_Delivery_Controller_LoadBalancer_Routing_Method
- type Network_Application_Delivery_Controller_LoadBalancer_Routing_Type
- type Network_Application_Delivery_Controller_LoadBalancer_Service
- type Network_Application_Delivery_Controller_LoadBalancer_Service_Group
- type Network_Application_Delivery_Controller_LoadBalancer_Service_Group_CrossReference
- type Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress
- type Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress_SecureTransportCipher
- type Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress_SecureTransportProtocol
- type Network_Application_Delivery_Controller_LoadBalancer_VirtualServer
- type Network_Application_Delivery_Controller_Type
- type Network_Bandwidth_Usage
- type Network_Bandwidth_Version1_Allocation
- type Network_Bandwidth_Version1_Allotment
- type Network_Bandwidth_Version1_Allotment_Detail
- type Network_Bandwidth_Version1_Allotment_Type
- type Network_Bandwidth_Version1_Usage_Detail
- type Network_Bandwidth_Version1_Usage_Detail_Type
- type Network_CdnMarketplace_Account
- type Network_CdnMarketplace_Configuration_Behavior_Geoblocking
- type Network_CdnMarketplace_Configuration_Behavior_Geoblocking_Type
- type Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection
- type Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader
- type Network_CdnMarketplace_Configuration_Behavior_TokenAuth
- type Network_CdnMarketplace_Configuration_Cache_Purge
- type Network_CdnMarketplace_Configuration_Cache_PurgeGroup
- type Network_CdnMarketplace_Configuration_Cache_PurgeHistory
- type Network_CdnMarketplace_Configuration_Cache_TimeToLive
- type Network_CdnMarketplace_Configuration_Mapping
- type Network_CdnMarketplace_Configuration_Mapping_Path
- type Network_CdnMarketplace_Metrics
- type Network_CdnMarketplace_Utils_Response
- type Network_CdnMarketplace_Vendor
- type Network_Component
- type Network_Component_Duplex_Mode
- type Network_Component_Firewall
- type Network_Component_Firewall_Rule
- type Network_Component_Firewall_Subnets
- type Network_Component_Group
- type Network_Component_IpAddress
- type Network_Component_Network_Vlan_Trunk
- type Network_Component_RemoteManagement
- type Network_Component_Uplink_Hardware
- type Network_Customer_Subnet
- type Network_Customer_Subnet_IpAddress
- type Network_DirectLink_Location
- type Network_DirectLink_Provider
- type Network_DirectLink_ServiceType
- type Network_Firewall_AccessControlList
- type Network_Firewall_Interface
- type Network_Firewall_Module_Context_Interface
- type Network_Firewall_Template
- type Network_Firewall_Template_Rule
- type Network_Firewall_Update_Request
- type Network_Firewall_Update_Request_Customer
- type Network_Firewall_Update_Request_Employee
- type Network_Firewall_Update_Request_Rule
- type Network_Firewall_Update_Request_Rule_Version6
- type Network_Gateway
- type Network_Gateway_Licenses
- type Network_Gateway_Member
- type Network_Gateway_Member_Attribute
- type Network_Gateway_Member_Licenses
- type Network_Gateway_Member_Passwords
- type Network_Gateway_Precheck
- type Network_Gateway_Status
- type Network_Gateway_VersionUpgrade
- type Network_Gateway_Vlan
- type Network_Interconnect_Tenant
- type Network_LBaaS_HealthMonitor
- type Network_LBaaS_L7HealthMonitor
- type Network_LBaaS_L7Member
- type Network_LBaaS_L7Policy
- type Network_LBaaS_L7Pool
- type Network_LBaaS_L7PoolMembersHealth
- type Network_LBaaS_L7Rule
- type Network_LBaaS_L7SessionAffinity
- type Network_LBaaS_Listener
- type Network_LBaaS_LoadBalancer
- type Network_LBaaS_LoadBalancerAppliance
- type Network_LBaaS_LoadBalancerHealthMonitorConfiguration
- type Network_LBaaS_LoadBalancerMonitoringMetricDataPoint
- type Network_LBaaS_LoadBalancerProtocolConfiguration
- type Network_LBaaS_LoadBalancerServerInstanceInfo
- type Network_LBaaS_LoadBalancerStatistics
- type Network_LBaaS_Member
- type Network_LBaaS_MemberHealth
- type Network_LBaaS_PolicyRule
- type Network_LBaaS_Pool
- type Network_LBaaS_PoolMembersHealth
- type Network_LBaaS_SSLCipher
- type Network_LBaaS_SessionAffinity
- type Network_LoadBalancer_Service
- type Network_LoadBalancer_VirtualIpAddress
- type Network_Logging_Syslog
- type Network_Message_Delivery
- type Network_Message_Delivery_Attribute
- type Network_Message_Delivery_Email_Sendgrid
- type Network_Message_Delivery_Type
- type Network_Message_Delivery_Vendor
- type Network_Monitor
- type Network_Monitor_Version1_Incident
- type Network_Monitor_Version1_Query_Host
- type Network_Monitor_Version1_Query_Host_Stratum
- type Network_Monitor_Version1_Query_ResponseType
- type Network_Monitor_Version1_Query_Result
- type Network_Monitor_Version1_Query_Type
- type Network_Pod
- type Network_Protection_Address
- type Network_Regional_Internet_Registry
- type Network_SecurityGroup
- type Network_SecurityGroup_OrderBinding
- type Network_SecurityGroup_Request
- type Network_SecurityGroup_RequestRules
- type Network_SecurityGroup_Rule
- type Network_Security_Scanner_Request
- type Network_Security_Scanner_Request_Status
- type Network_Service_Resource
- type Network_Service_Resource_Attribute
- type Network_Service_Resource_Attribute_Type
- type Network_Service_Resource_CosStor
- type Network_Service_Resource_Hub
- type Network_Service_Resource_Hub_Swift
- type Network_Service_Resource_Type
- type Network_Service_Vpn_Overrides
- type Network_Storage
- type Network_Storage_Allowed_Host
- type Network_Storage_Allowed_Host_Hardware
- type Network_Storage_Allowed_Host_IpAddress
- type Network_Storage_Allowed_Host_Subnet
- type Network_Storage_Allowed_Host_VirtualGuest
- type Network_Storage_Backup
- type Network_Storage_Backup_Evault
- type Network_Storage_Backup_Evault_Version6
- type Network_Storage_Credential
- type Network_Storage_Credential_Type
- type Network_Storage_Daily_Usage
- type Network_Storage_DedicatedCluster
- type Network_Storage_Event
- type Network_Storage_Event_Type
- type Network_Storage_Group
- type Network_Storage_Group_Iscsi
- type Network_Storage_Group_Nfs
- type Network_Storage_Group_Type
- type Network_Storage_History
- type Network_Storage_Hub
- type Network_Storage_Hub_Cleversafe_Account
- type Network_Storage_Hub_Swift
- type Network_Storage_Hub_Swift_Container
- type Network_Storage_Hub_Swift_Metrics
- type Network_Storage_Hub_Swift_Share
- type Network_Storage_Hub_Swift_Version1
- type Network_Storage_Iscsi
- type Network_Storage_Iscsi_OS_Type
- type Network_Storage_MassDataMigration_CrossRegion_Country_Xref
- type Network_Storage_MassDataMigration_Request
- type Network_Storage_MassDataMigration_Request_DeviceConfiguration
- type Network_Storage_MassDataMigration_Request_KeyContact
- type Network_Storage_MassDataMigration_Request_Status
- type Network_Storage_Nas
- type Network_Storage_Partnership
- type Network_Storage_Partnership_Type
- type Network_Storage_Property
- type Network_Storage_Property_Type
- type Network_Storage_Replicant
- type Network_Storage_Schedule
- type Network_Storage_Schedule_Property
- type Network_Storage_Schedule_Property_Type
- type Network_Storage_Schedule_Type
- type Network_Storage_Snapshot
- type Network_Storage_Type
- type Network_Subnet
- type Network_Subnet_IpAddress
- type Network_Subnet_IpAddress_Global
- type Network_Subnet_IpAddress_UsageDetail
- type Network_Subnet_IpAddress_Version6
- type Network_Subnet_Registration
- type Network_Subnet_Registration_Apnic
- type Network_Subnet_Registration_Arin
- type Network_Subnet_Registration_Details
- type Network_Subnet_Registration_Event
- type Network_Subnet_Registration_Event_Type
- type Network_Subnet_Registration_Ripe
- type Network_Subnet_Registration_Status
- type Network_Subnet_Rwhois_Data
- type Network_Subnet_Swip_Transaction
- type Network_Tunnel_Module_Context
- type Network_Tunnel_Module_Context_Address_Translation
- type Network_Vlan
- type Network_Vlan_Firewall
- type Network_Vlan_Firewall_Rule
- type Network_Vlan_Type
- type Notification
- type Notification_Delivery_Method
- type Notification_Mobile
- type Notification_Occurrence_Account
- type Notification_Occurrence_Event
- type Notification_Occurrence_Event_Attachment
- type Notification_Occurrence_Event_Type
- type Notification_Occurrence_Resource
- type Notification_Occurrence_Resource_Hardware
- type Notification_Occurrence_Resource_Network_Application_Delivery_Controller
- type Notification_Occurrence_Resource_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress
- type Notification_Occurrence_Resource_Network_Storage_Iscsi_NetApp
- type Notification_Occurrence_Resource_Network_Storage_Lockbox
- type Notification_Occurrence_Resource_Network_Storage_Nas
- type Notification_Occurrence_Resource_Network_Storage_NetApp_Volume
- type Notification_Occurrence_Resource_Network_Storage_NetApp_Volume_Replicant_Iscsi
- type Notification_Occurrence_Resource_Network_Storage_NetApp_Volume_Replicant_Nas
- type Notification_Occurrence_Resource_Virtual
- type Notification_Occurrence_Status_Code
- type Notification_Occurrence_Update
- type Notification_Occurrence_User
- type Notification_Preference
- type Notification_Subscriber
- type Notification_Subscriber_Customer
- type Notification_Subscriber_Delivery_Method
- type Notification_User_Subscriber
- type Notification_User_Subscriber_Billing
- type Notification_User_Subscriber_Delivery_Method
- type Notification_User_Subscriber_Mobile
- type Notification_User_Subscriber_Preference
- type Notification_User_Subscriber_Resource
- type Policy_Document_Acceptance_Quote
- type Product_Catalog
- type Product_Catalog_Item_Price
- type Product_Group
- type Product_Item
- type Product_Item_Attribute
- type Product_Item_Attribute_Type
- type Product_Item_Billing_Type
- type Product_Item_Bundles
- type Product_Item_Category
- type Product_Item_Category_Group
- type Product_Item_Category_Order_Option_Type
- type Product_Item_Category_Question
- type Product_Item_Category_Question_Field_Type
- type Product_Item_Category_Question_Xref
- type Product_Item_Overage_Price
- type Product_Item_Policy_Assignment
- type Product_Item_Price
- type Product_Item_Price_Account_Restriction
- type Product_Item_Price_Attribute
- type Product_Item_Price_Attribute_Type
- type Product_Item_Price_Premium
- type Product_Item_Requirement
- type Product_Item_Resource_Conflict
- type Product_Item_Resource_Conflict_Item
- type Product_Item_Resource_Conflict_Item_Category
- type Product_Item_Resource_Conflict_Location
- type Product_Item_Rule
- type Product_Item_Rule_Resource
- type Product_Item_Rule_Resource_Item
- type Product_Item_Rule_Resource_Item_Category
- type Product_Item_Rule_Resource_Location
- type Product_Item_Rule_Resource_Permission
- type Product_Item_Rule_Type
- type Product_Item_Server_Group
- type Product_Item_Tax_Category
- type Product_Order
- type Product_Package
- type Product_Package_Attribute
- type Product_Package_Attribute_Type
- type Product_Package_Inventory
- type Product_Package_Item_Category_Group
- type Product_Package_Item_Prices
- type Product_Package_Items
- type Product_Package_Locations
- type Product_Package_Order_Configuration
- type Product_Package_Order_Step
- type Product_Package_Order_Step_Next
- type Product_Package_Preset
- type Product_Package_Preset_Attribute
- type Product_Package_Preset_Attribute_Type
- type Product_Package_Preset_Configuration
- type Product_Package_Server
- type Product_Package_Server_Option
- type Product_Package_Type
- type Product_Promotion
- type Product_Upgrade_Request
- type Product_Upgrade_Request_Status
- type Provisioning_Hook
- type Provisioning_Hook_Type
- type Provisioning_Maintenance_Classification
- type Provisioning_Maintenance_Classification_Item_Category
- type Provisioning_Maintenance_Slots
- type Provisioning_Maintenance_Ticket
- type Provisioning_Maintenance_Window
- type Provisioning_Version1_Transaction
- type Provisioning_Version1_Transaction_Group
- type Provisioning_Version1_Transaction_History
- type Provisioning_Version1_Transaction_OrderTracking
- type Provisioning_Version1_Transaction_OrderTrackingState
- type Provisioning_Version1_Transaction_Status
- type Resource_Configuration
- type Resource_Group
- type Resource_Group_Attribute
- type Resource_Group_Attribute_Type
- type Resource_Group_Descendant_Reference
- type Resource_Group_Member
- type Resource_Group_Member_Attribute
- type Resource_Group_Member_Attribute_Type
- type Resource_Group_Member_CloudStack_Version3_Cluster
- type Resource_Group_Member_CloudStack_Version3_Pod
- type Resource_Group_Member_CloudStack_Version3_Zone
- type Resource_Group_Member_Hardware
- type Resource_Group_Member_Network_Storage
- type Resource_Group_Member_Network_Subnet
- type Resource_Group_Member_Network_Vlan
- type Resource_Group_Member_Resource_Group
- type Resource_Group_Member_Role_Link
- type Resource_Group_Member_Software_Component_Password
- type Resource_Group_Member_Type
- type Resource_Group_Member_Virtual_Host_Pool
- type Resource_Group_Role
- type Resource_Group_Template
- type Resource_Group_Template_Member
- type Resource_Metadata
- type Result_Detector
- type Sales_Presale_Event
- type Scale_Asset
- type Scale_Asset_Hardware
- type Scale_Asset_Virtual_Guest
- type Scale_Group
- type Scale_LoadBalancer
- type Scale_Member
- type Scale_Member_Virtual_Guest
- type Scale_Network_Vlan
- type Search
- type Security_Certificate
- type Security_Certificate_Entry
- type Security_Certificate_Request
- type Security_Certificate_Request_ServerType
- type Security_Certificate_Request_Status
- type Security_Directory_Service_Host_Xref_Hardware
- type Security_Level
- type Security_SecureTransportCipher
- type Security_SecureTransportProtocol
- type Security_Ssh_Key
- type Service_External_Resource
- type Service_Provider
- type Software_AccountLicense
- type Software_Component
- type Software_Component_Analytics
- type Software_Component_Analytics_Urchin
- type Software_Component_AntivirusSpyware
- type Software_Component_AntivirusSpyware_Mcafee
- type Software_Component_AntivirusSpyware_Mcafee_Epo_Version36
- type Software_Component_AntivirusSpyware_Mcafee_Epo_Version45
- type Software_Component_AntivirusSpyware_Mcafee_Epo_Version51
- type Software_Component_ControlPanel
- type Software_Component_ControlPanel_Cpanel
- type Software_Component_ControlPanel_Idera
- type Software_Component_ControlPanel_Idera_ServerBackup
- type Software_Component_ControlPanel_Microsoft
- type Software_Component_ControlPanel_Microsoft_WebPlatform
- type Software_Component_ControlPanel_Parallels
- type Software_Component_ControlPanel_Parallels_Plesk
- type Software_Component_ControlPanel_R1soft
- type Software_Component_ControlPanel_R1soft_Cdp
- type Software_Component_ControlPanel_R1soft_ServerBackup
- type Software_Component_ControlPanel_Swsoft
- type Software_Component_ControlPanel_WebhostAutomation
- type Software_Component_HostIps
- type Software_Component_HostIps_Mcafee
- type Software_Component_HostIps_Mcafee_Epo_Version36_Hips
- type Software_Component_HostIps_Mcafee_Epo_Version36_Hips_Version6
- type Software_Component_HostIps_Mcafee_Epo_Version36_Hips_Version7
- type Software_Component_HostIps_Mcafee_Epo_Version45_Hips
- type Software_Component_HostIps_Mcafee_Epo_Version45_Hips_Version7
- type Software_Component_HostIps_Mcafee_Epo_Version45_Hips_Version8
- type Software_Component_HostIps_Mcafee_Epo_Version51
- type Software_Component_OperatingSystem
- type Software_Component_Package
- type Software_Component_Package_Management
- type Software_Component_Package_Management_Ksplice
- type Software_Component_Password
- type Software_Component_Password_History
- type Software_Component_Security
- type Software_Component_Security_SafeNet
- type Software_Component_Trellix
- type Software_Description
- type Software_Description_Attribute
- type Software_Description_Attribute_Type
- type Software_Description_Feature
- type Software_Description_RequiredUser
- type Software_License
- type Software_VirtualLicense
- type Sprint_Container_CostRecovery
- type Survey
- type Survey_Answer
- type Survey_Question
- type Survey_Response
- type Survey_Status
- type Survey_Type
- type Tag
- type Tag_Reference
- type Tag_Reference_Hardware
- type Tag_Reference_Network_Application_Delivery_Controller
- type Tag_Reference_Network_Vlan
- type Tag_Reference_Network_Vlan_Firewall
- type Tag_Reference_Resource_Group
- type Tag_Reference_Virtual_DedicatedHost
- type Tag_Reference_Virtual_Guest
- type Tag_Reference_Virtual_Guest_Block_Device_Template_Group
- type Tag_Type
- type Ticket
- type Ticket_Activity
- type Ticket_Attachment
- type Ticket_Attachment_Assigned_Agent
- type Ticket_Attachment_CardChangeRequest
- type Ticket_Attachment_Dedicated_Host
- type Ticket_Attachment_File
- type Ticket_Attachment_File_ServiceNow
- type Ticket_Attachment_Hardware
- type Ticket_Attachment_Manual_Payment
- type Ticket_Attachment_Network_Storage_Mass_Data_Migration
- type Ticket_Attachment_Scheduled_Action
- type Ticket_Attachment_Virtual_Guest
- type Ticket_Chat
- type Ticket_Chat_Liveperson
- type Ticket_Chat_TranscriptLine
- type Ticket_Chat_TranscriptLine_Customer
- type Ticket_Chat_TranscriptLine_Employee
- type Ticket_EuCompliance
- type Ticket_Group
- type Ticket_Group_Category
- type Ticket_Priority
- type Ticket_State
- type Ticket_State_Type
- type Ticket_Status
- type Ticket_Subject
- type Ticket_Subject_Category
- type Ticket_Survey
- type Ticket_Type
- type Ticket_Update
- type Ticket_Update_Agent
- type Ticket_Update_Chat
- type Ticket_Update_Customer
- type Ticket_Update_Employee
- type Ticket_Update_Type
- type Time
- type Trellix_Epolicy_Orchestrator_Version51_Agent_Details
- type Trellix_Epolicy_Orchestrator_Version51_Policy_Object
- type Trellix_Epolicy_Orchestrator_Version51_Product_Properties
- type User_Access_Facility_Log
- type User_Access_Facility_Log_Type
- type User_Access_Facility_Visitor
- type User_Access_Facility_Visitor_Type
- type User_Customer
- type User_Customer_Access_Authentication
- type User_Customer_Access_Authentication_TokenValidation
- type User_Customer_AdditionalEmail
- type User_Customer_ApiAuthentication
- type User_Customer_CustomerPermission_Permission
- type User_Customer_External_Binding
- type User_Customer_External_Binding_Attribute
- type User_Customer_External_Binding_Totp
- type User_Customer_External_Binding_Type
- type User_Customer_External_Binding_Vendor
- type User_Customer_External_Binding_Verisign
- type User_Customer_Invitation
- type User_Customer_Link
- type User_Customer_Link_TrustedProfile
- type User_Customer_Link_VerifiedIamIdLinkCollection
- type User_Customer_Notification_Hardware
- type User_Customer_Notification_Virtual_Guest
- type User_Customer_OpenIdConnect
- type User_Customer_OpenIdConnect_TrustedProfile
- type User_Customer_Profile_Event_HyperWarp
- type User_Customer_Prospect
- type User_Customer_Prospect_ServiceProvider_EnrollRequest
- type User_Customer_Prospect_Type
- type User_Customer_Security_Answer
- type User_Customer_Status
- type User_Employee
- type User_Employee_Department
- type User_External_Binding
- type User_External_Binding_Attribute
- type User_External_Binding_Type
- type User_External_Binding_Vendor
- type User_Interface
- type User_Permission_Action
- type User_Permission_Department
- type User_Permission_Group
- type User_Permission_Group_Type
- type User_Permission_Resource_Type
- type User_Permission_Role
- type User_Preference
- type User_Preference_Type
- type User_Security_Question
- type Utility_Network
- type Utility_ObjectFilter
- type Utility_ObjectFilter_Operation
- type Utility_ObjectFilter_Operation_Option
- type Vendor_Type
- type Verify_Api_HttpObj
- type Verify_Api_HttpsObj
- type Virtual_BrowserConsoleAccessLog
- type Virtual_DedicatedHost
- type Virtual_Disk_Image
- type Virtual_Disk_Image_Software
- type Virtual_Disk_Image_Software_Password
- type Virtual_Disk_Image_Type
- type Virtual_Guest
- type Virtual_Guest_Attribute
- type Virtual_Guest_Attribute_Type
- type Virtual_Guest_Attribute_UserData
- type Virtual_Guest_Block_Device
- type Virtual_Guest_Block_Device_Status
- type Virtual_Guest_Block_Device_Template
- type Virtual_Guest_Block_Device_Template_Group
- type Virtual_Guest_Block_Device_Template_Group_Accounts
- type Virtual_Guest_Block_Device_Template_Group_Status
- type Virtual_Guest_Boot_Parameter
- type Virtual_Guest_Boot_Parameter_Type
- type Virtual_Guest_Network_Component
- type Virtual_Guest_Network_Component_IcpBinding
- type Virtual_Guest_Network_Component_IpAddress
- type Virtual_Guest_Power_State
- type Virtual_Guest_Status
- type Virtual_Guest_SupplementalCreateObjectOptions
- type Virtual_Guest_Type
- type Virtual_Guest_Vpc_IpAllocation
- type Virtual_Guest_Vpc_Subnet
- type Virtual_Host
- type Virtual_Host_PciDevice
- type Virtual_Network_SecurityGroup_NetworkComponentBinding
- type Virtual_PlacementGroup
- type Virtual_PlacementGroup_Rule
- type Virtual_ReservedCapacityGroup
- type Virtual_ReservedCapacityGroup_Instance
- type Virtual_Storage_Repository
- type Virtual_Storage_Repository_Type
- type Void
- type Workload_Citrix_Client
- type Workload_Citrix_Client_Response
- type Workload_Citrix_Client_Response_ResourceLocations
- type Workload_Citrix_Deployment
- type Workload_Citrix_Deployment_Resource
- type Workload_Citrix_Deployment_Resource_Response
- type Workload_Citrix_Deployment_Resource_Role
- type Workload_Citrix_Deployment_Response
- type Workload_Citrix_Deployment_Status
- type Workload_Citrix_Deployment_Type
- type Workload_Citrix_Request
- type Workload_Citrix_Request_CreateResourceLocation
- type Workload_Citrix_Workspace_Order
- type Workload_Citrix_Workspace_Order_Container
- type Workload_Citrix_Workspace_Order_LicenseKey
- type Workload_Citrix_Workspace_Order_SharedStorage
- type Workload_Citrix_Workspace_Order_VMwareContainer
- type Workload_Citrix_Workspace_Response
- type Workload_Citrix_Workspace_Response_Item
- type Workload_Citrix_Workspace_Response_Result
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func SetComplexType ¶
func SetComplexType(v interface{}) error
Used to set the appropriate complexType field in the passed product order. Employs reflection to determine the type of the passed value and use it to derive the complexType to send to SoftLayer.
Types ¶
type Abuse_Lockdown_Resource ¶
type Abuse_Lockdown_Resource struct { Entity // no documentation yet Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // no documentation yet InvoiceItem *Billing_Invoice_Item `json:"invoiceItem,omitempty" xmlrpc:"invoiceItem,omitempty"` }
no documentation yet
type Account ¶
type Account struct { Entity // 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. AbuseEmail *string `json:"abuseEmail,omitempty" xmlrpc:"abuseEmail,omitempty"` // 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. AbuseEmailCount *uint `json:"abuseEmailCount,omitempty" xmlrpc:"abuseEmailCount,omitempty"` // 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. AbuseEmails []Account_AbuseEmail `json:"abuseEmails,omitempty" xmlrpc:"abuseEmails,omitempty"` // A count of the account contacts on an account. AccountContactCount *uint `json:"accountContactCount,omitempty" xmlrpc:"accountContactCount,omitempty"` // The account contacts on an account. AccountContacts []Account_Contact `json:"accountContacts,omitempty" xmlrpc:"accountContacts,omitempty"` // A count of the account software licenses owned by an account AccountLicenseCount *uint `json:"accountLicenseCount,omitempty" xmlrpc:"accountLicenseCount,omitempty"` // The account software licenses owned by an account AccountLicenses []Software_AccountLicense `json:"accountLicenses,omitempty" xmlrpc:"accountLicenses,omitempty"` // A count of AccountLinkCount *uint `json:"accountLinkCount,omitempty" xmlrpc:"accountLinkCount,omitempty"` // no documentation yet AccountLinks []Account_Link `json:"accountLinks,omitempty" xmlrpc:"accountLinks,omitempty"` // A flag indicating that the account has a managed resource. AccountManagedResourcesFlag *bool `json:"accountManagedResourcesFlag,omitempty" xmlrpc:"accountManagedResourcesFlag,omitempty"` // An account's status presented in a more detailed data type. AccountStatus *Account_Status `json:"accountStatus,omitempty" xmlrpc:"accountStatus,omitempty"` // A number reflecting the state of an account. AccountStatusId *int `json:"accountStatusId,omitempty" xmlrpc:"accountStatusId,omitempty"` // The billing item associated with an account's monthly discount. ActiveAccountDiscountBillingItem *Billing_Item `json:"activeAccountDiscountBillingItem,omitempty" xmlrpc:"activeAccountDiscountBillingItem,omitempty"` // A count of the active account software licenses owned by an account ActiveAccountLicenseCount *uint `json:"activeAccountLicenseCount,omitempty" xmlrpc:"activeAccountLicenseCount,omitempty"` // The active account software licenses owned by an account ActiveAccountLicenses []Software_AccountLicense `json:"activeAccountLicenses,omitempty" xmlrpc:"activeAccountLicenses,omitempty"` // A count of the active address(es) that belong to an account. ActiveAddressCount *uint `json:"activeAddressCount,omitempty" xmlrpc:"activeAddressCount,omitempty"` // The active address(es) that belong to an account. ActiveAddresses []Account_Address `json:"activeAddresses,omitempty" xmlrpc:"activeAddresses,omitempty"` // A count of all active agreements for an account ActiveAgreementCount *uint `json:"activeAgreementCount,omitempty" xmlrpc:"activeAgreementCount,omitempty"` // All active agreements for an account ActiveAgreements []Account_Agreement `json:"activeAgreements,omitempty" xmlrpc:"activeAgreements,omitempty"` // A count of all billing agreements for an account ActiveBillingAgreementCount *uint `json:"activeBillingAgreementCount,omitempty" xmlrpc:"activeBillingAgreementCount,omitempty"` // All billing agreements for an account ActiveBillingAgreements []Account_Agreement `json:"activeBillingAgreements,omitempty" xmlrpc:"activeBillingAgreements,omitempty"` // no documentation yet ActiveCatalystEnrollment *Catalyst_Enrollment `json:"activeCatalystEnrollment,omitempty" xmlrpc:"activeCatalystEnrollment,omitempty"` // A count of deprecated. ActiveColocationContainerCount *uint `json:"activeColocationContainerCount,omitempty" xmlrpc:"activeColocationContainerCount,omitempty"` // Deprecated. // Deprecated: This function has been marked as deprecated. ActiveColocationContainers []Billing_Item `json:"activeColocationContainers,omitempty" xmlrpc:"activeColocationContainers,omitempty"` // [Deprecated] Please use SoftLayer_Account::activeFlexibleCreditEnrollments. ActiveFlexibleCreditEnrollment *FlexibleCredit_Enrollment `json:"activeFlexibleCreditEnrollment,omitempty" xmlrpc:"activeFlexibleCreditEnrollment,omitempty"` // A count of ActiveFlexibleCreditEnrollmentCount *uint `json:"activeFlexibleCreditEnrollmentCount,omitempty" xmlrpc:"activeFlexibleCreditEnrollmentCount,omitempty"` // no documentation yet ActiveFlexibleCreditEnrollments []FlexibleCredit_Enrollment `json:"activeFlexibleCreditEnrollments,omitempty" xmlrpc:"activeFlexibleCreditEnrollments,omitempty"` // A count of ActiveNotificationSubscriberCount *uint `json:"activeNotificationSubscriberCount,omitempty" xmlrpc:"activeNotificationSubscriberCount,omitempty"` // no documentation yet ActiveNotificationSubscribers []Notification_Subscriber `json:"activeNotificationSubscribers,omitempty" xmlrpc:"activeNotificationSubscribers,omitempty"` // A count of an account's non-expired quotes. ActiveQuoteCount *uint `json:"activeQuoteCount,omitempty" xmlrpc:"activeQuoteCount,omitempty"` // An account's non-expired quotes. ActiveQuotes []Billing_Order_Quote `json:"activeQuotes,omitempty" xmlrpc:"activeQuotes,omitempty"` // A count of active reserved capacity agreements for an account ActiveReservedCapacityAgreementCount *uint `json:"activeReservedCapacityAgreementCount,omitempty" xmlrpc:"activeReservedCapacityAgreementCount,omitempty"` // Active reserved capacity agreements for an account ActiveReservedCapacityAgreements []Account_Agreement `json:"activeReservedCapacityAgreements,omitempty" xmlrpc:"activeReservedCapacityAgreements,omitempty"` // A count of the virtual software licenses controlled by an account ActiveVirtualLicenseCount *uint `json:"activeVirtualLicenseCount,omitempty" xmlrpc:"activeVirtualLicenseCount,omitempty"` // The virtual software licenses controlled by an account ActiveVirtualLicenses []Software_VirtualLicense `json:"activeVirtualLicenses,omitempty" xmlrpc:"activeVirtualLicenses,omitempty"` // A count of an account's associated load balancers. AdcLoadBalancerCount *uint `json:"adcLoadBalancerCount,omitempty" xmlrpc:"adcLoadBalancerCount,omitempty"` // An account's associated load balancers. AdcLoadBalancers []Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress `json:"adcLoadBalancers,omitempty" xmlrpc:"adcLoadBalancers,omitempty"` // The first line of the mailing address belonging to an account. Address1 *string `json:"address1,omitempty" xmlrpc:"address1,omitempty"` // The second line of the mailing address belonging to an account. Address2 *string `json:"address2,omitempty" xmlrpc:"address2,omitempty"` // A count of all the address(es) that belong to an account. AddressCount *uint `json:"addressCount,omitempty" xmlrpc:"addressCount,omitempty"` // All the address(es) that belong to an account. Addresses []Account_Address `json:"addresses,omitempty" xmlrpc:"addresses,omitempty"` // An affiliate identifier associated with the customer account. AffiliateId *string `json:"affiliateId,omitempty" xmlrpc:"affiliateId,omitempty"` // The billing items that will be on an account's next invoice. AllBillingItems []Billing_Item `json:"allBillingItems,omitempty" xmlrpc:"allBillingItems,omitempty"` // A count of the billing items that will be on an account's next invoice. AllCommissionBillingItemCount *uint `json:"allCommissionBillingItemCount,omitempty" xmlrpc:"allCommissionBillingItemCount,omitempty"` // The billing items that will be on an account's next invoice. AllCommissionBillingItems []Billing_Item `json:"allCommissionBillingItems,omitempty" xmlrpc:"allCommissionBillingItems,omitempty"` // A count of the billing items that will be on an account's next invoice. AllRecurringTopLevelBillingItemCount *uint `json:"allRecurringTopLevelBillingItemCount,omitempty" xmlrpc:"allRecurringTopLevelBillingItemCount,omitempty"` // The billing items that will be on an account's next invoice. AllRecurringTopLevelBillingItems []Billing_Item `json:"allRecurringTopLevelBillingItems,omitempty" xmlrpc:"allRecurringTopLevelBillingItems,omitempty"` // The billing items that will be on an account's next invoice. Does not consider associated items. AllRecurringTopLevelBillingItemsUnfiltered []Billing_Item `json:"allRecurringTopLevelBillingItemsUnfiltered,omitempty" xmlrpc:"allRecurringTopLevelBillingItemsUnfiltered,omitempty"` // A count of the billing items that will be on an account's next invoice. Does not consider associated items. AllRecurringTopLevelBillingItemsUnfilteredCount *uint `` /* 131-byte string literal not displayed */ // A count of the billing items that will be on an account's next invoice. AllSubnetBillingItemCount *uint `json:"allSubnetBillingItemCount,omitempty" xmlrpc:"allSubnetBillingItemCount,omitempty"` // The billing items that will be on an account's next invoice. AllSubnetBillingItems []Billing_Item `json:"allSubnetBillingItems,omitempty" xmlrpc:"allSubnetBillingItems,omitempty"` // A count of all billing items of an account. AllTopLevelBillingItemCount *uint `json:"allTopLevelBillingItemCount,omitempty" xmlrpc:"allTopLevelBillingItemCount,omitempty"` // All billing items of an account. AllTopLevelBillingItems []Billing_Item `json:"allTopLevelBillingItems,omitempty" xmlrpc:"allTopLevelBillingItems,omitempty"` // The billing items that will be on an account's next invoice. Does not consider associated items. AllTopLevelBillingItemsUnfiltered []Billing_Item `json:"allTopLevelBillingItemsUnfiltered,omitempty" xmlrpc:"allTopLevelBillingItemsUnfiltered,omitempty"` // A count of the billing items that will be on an account's next invoice. Does not consider associated items. AllTopLevelBillingItemsUnfilteredCount *uint `json:"allTopLevelBillingItemsUnfilteredCount,omitempty" xmlrpc:"allTopLevelBillingItemsUnfilteredCount,omitempty"` // Indicates whether this account is allowed to silently migrate to use IBMid Authentication. AllowIbmIdSilentMigrationFlag *bool `json:"allowIbmIdSilentMigrationFlag,omitempty" xmlrpc:"allowIbmIdSilentMigrationFlag,omitempty"` // The number of PPTP VPN users allowed on an account. // Deprecated: This function has been marked as deprecated. AllowedPptpVpnQuantity *int `json:"allowedPptpVpnQuantity,omitempty" xmlrpc:"allowedPptpVpnQuantity,omitempty"` // Flag indicating if this account can be linked with Bluemix. AllowsBluemixAccountLinkingFlag *bool `json:"allowsBluemixAccountLinkingFlag,omitempty" xmlrpc:"allowsBluemixAccountLinkingFlag,omitempty"` // A secondary phone number assigned to an account. AlternatePhone *string `json:"alternatePhone,omitempty" xmlrpc:"alternatePhone,omitempty"` // A count of an account's associated application delivery controller records. ApplicationDeliveryControllerCount *uint `json:"applicationDeliveryControllerCount,omitempty" xmlrpc:"applicationDeliveryControllerCount,omitempty"` // An account's associated application delivery controller records. ApplicationDeliveryControllers []Network_Application_Delivery_Controller `json:"applicationDeliveryControllers,omitempty" xmlrpc:"applicationDeliveryControllers,omitempty"` // A count of the account attribute values for a SoftLayer customer account. AttributeCount *uint `json:"attributeCount,omitempty" xmlrpc:"attributeCount,omitempty"` // The account attribute values for a SoftLayer customer account. Attributes []Account_Attribute `json:"attributes,omitempty" xmlrpc:"attributes,omitempty"` // A count of the public network VLANs assigned to an account. AvailablePublicNetworkVlanCount *uint `json:"availablePublicNetworkVlanCount,omitempty" xmlrpc:"availablePublicNetworkVlanCount,omitempty"` // The public network VLANs assigned to an account. AvailablePublicNetworkVlans []Network_Vlan `json:"availablePublicNetworkVlans,omitempty" xmlrpc:"availablePublicNetworkVlans,omitempty"` // 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. Balance *Float64 `json:"balance,omitempty" xmlrpc:"balance,omitempty"` // A count of the bandwidth allotments for an account. BandwidthAllotmentCount *uint `json:"bandwidthAllotmentCount,omitempty" xmlrpc:"bandwidthAllotmentCount,omitempty"` // The bandwidth allotments for an account. BandwidthAllotments []Network_Bandwidth_Version1_Allotment `json:"bandwidthAllotments,omitempty" xmlrpc:"bandwidthAllotments,omitempty"` // The bandwidth allotments for an account currently over allocation. BandwidthAllotmentsOverAllocation []Network_Bandwidth_Version1_Allotment `json:"bandwidthAllotmentsOverAllocation,omitempty" xmlrpc:"bandwidthAllotmentsOverAllocation,omitempty"` // A count of the bandwidth allotments for an account currently over allocation. BandwidthAllotmentsOverAllocationCount *uint `json:"bandwidthAllotmentsOverAllocationCount,omitempty" xmlrpc:"bandwidthAllotmentsOverAllocationCount,omitempty"` // The bandwidth allotments for an account projected to go over allocation. BandwidthAllotmentsProjectedOverAllocation []Network_Bandwidth_Version1_Allotment `json:"bandwidthAllotmentsProjectedOverAllocation,omitempty" xmlrpc:"bandwidthAllotmentsProjectedOverAllocation,omitempty"` // A count of the bandwidth allotments for an account projected to go over allocation. BandwidthAllotmentsProjectedOverAllocationCount *uint `` /* 131-byte string literal not displayed */ // A count of an account's associated bare metal server objects. BareMetalInstanceCount *uint `json:"bareMetalInstanceCount,omitempty" xmlrpc:"bareMetalInstanceCount,omitempty"` // An account's associated bare metal server objects. BareMetalInstances []Hardware `json:"bareMetalInstances,omitempty" xmlrpc:"bareMetalInstances,omitempty"` // A count of all billing agreements for an account BillingAgreementCount *uint `json:"billingAgreementCount,omitempty" xmlrpc:"billingAgreementCount,omitempty"` // All billing agreements for an account BillingAgreements []Account_Agreement `json:"billingAgreements,omitempty" xmlrpc:"billingAgreements,omitempty"` // An account's billing information. BillingInfo *Billing_Info `json:"billingInfo,omitempty" xmlrpc:"billingInfo,omitempty"` // A count of private template group objects (parent and children) and the shared template group objects (parent only) for an account. BlockDeviceTemplateGroupCount *uint `json:"blockDeviceTemplateGroupCount,omitempty" xmlrpc:"blockDeviceTemplateGroupCount,omitempty"` // Private template group objects (parent and children) and the shared template group objects (parent only) for an account. BlockDeviceTemplateGroups []Virtual_Guest_Block_Device_Template_Group `json:"blockDeviceTemplateGroups,omitempty" xmlrpc:"blockDeviceTemplateGroups,omitempty"` // Flag indicating whether this account is restricted from performing a self-service brand migration by updating their credit card details. BlockSelfServiceBrandMigration *bool `json:"blockSelfServiceBrandMigration,omitempty" xmlrpc:"blockSelfServiceBrandMigration,omitempty"` // no documentation yet BluemixAccountId *string `json:"bluemixAccountId,omitempty" xmlrpc:"bluemixAccountId,omitempty"` // The Platform account link associated with this SoftLayer account, if one exists. BluemixAccountLink *Account_Link_Bluemix `json:"bluemixAccountLink,omitempty" xmlrpc:"bluemixAccountLink,omitempty"` // Returns true if this account is linked to IBM Bluemix, false if not. BluemixLinkedFlag *bool `json:"bluemixLinkedFlag,omitempty" xmlrpc:"bluemixLinkedFlag,omitempty"` // no documentation yet Brand *Brand `json:"brand,omitempty" xmlrpc:"brand,omitempty"` // no documentation yet BrandAccountFlag *bool `json:"brandAccountFlag,omitempty" xmlrpc:"brandAccountFlag,omitempty"` // The Brand tied to an account. BrandId *int `json:"brandId,omitempty" xmlrpc:"brandId,omitempty"` // The brand keyName. BrandKeyName *string `json:"brandKeyName,omitempty" xmlrpc:"brandKeyName,omitempty"` // The Business Partner details for the account. Country Enterprise Code, Channel, Segment, Reseller Level. BusinessPartner *Account_Business_Partner `json:"businessPartner,omitempty" xmlrpc:"businessPartner,omitempty"` // [DEPRECATED] All accounts may order VLANs. // Deprecated: This function has been marked as deprecated. CanOrderAdditionalVlansFlag *bool `json:"canOrderAdditionalVlansFlag,omitempty" xmlrpc:"canOrderAdditionalVlansFlag,omitempty"` // A count of an account's active carts. CartCount *uint `json:"cartCount,omitempty" xmlrpc:"cartCount,omitempty"` // An account's active carts. Carts []Billing_Order_Quote `json:"carts,omitempty" xmlrpc:"carts,omitempty"` // A count of CatalystEnrollmentCount *uint `json:"catalystEnrollmentCount,omitempty" xmlrpc:"catalystEnrollmentCount,omitempty"` // no documentation yet CatalystEnrollments []Catalyst_Enrollment `json:"catalystEnrollments,omitempty" xmlrpc:"catalystEnrollments,omitempty"` // The city of the mailing address belonging to an account. City *string `json:"city,omitempty" xmlrpc:"city,omitempty"` // Whether an account is exempt from taxes on their invoices. ClaimedTaxExemptTxFlag *bool `json:"claimedTaxExemptTxFlag,omitempty" xmlrpc:"claimedTaxExemptTxFlag,omitempty"` // A count of all closed tickets associated with an account. ClosedTicketCount *uint `json:"closedTicketCount,omitempty" xmlrpc:"closedTicketCount,omitempty"` // All closed tickets associated with an account. ClosedTickets []Ticket `json:"closedTickets,omitempty" xmlrpc:"closedTickets,omitempty"` // The company name associated with an account. CompanyName *string `json:"companyName,omitempty" xmlrpc:"companyName,omitempty"` // A two-letter abbreviation of the country in the mailing address belonging to an account. Country *string `json:"country,omitempty" xmlrpc:"country,omitempty"` // The date an account was created. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // A count of datacenters which contain subnets that the account has access to route. DatacentersWithSubnetAllocationCount *uint `json:"datacentersWithSubnetAllocationCount,omitempty" xmlrpc:"datacentersWithSubnetAllocationCount,omitempty"` // Datacenters which contain subnets that the account has access to route. DatacentersWithSubnetAllocations []Location `json:"datacentersWithSubnetAllocations,omitempty" xmlrpc:"datacentersWithSubnetAllocations,omitempty"` // A count of an account's associated virtual dedicated host objects. DedicatedHostCount *uint `json:"dedicatedHostCount,omitempty" xmlrpc:"dedicatedHostCount,omitempty"` // An account's associated virtual dedicated host objects. DedicatedHosts []Virtual_DedicatedHost `json:"dedicatedHosts,omitempty" xmlrpc:"dedicatedHosts,omitempty"` // Device Fingerprint Identifier - Used internally and can safely be ignored. DeviceFingerprintId *string `json:"deviceFingerprintId,omitempty" xmlrpc:"deviceFingerprintId,omitempty"` // A flag indicating whether payments are processed for this account. DisablePaymentProcessingFlag *bool `json:"disablePaymentProcessingFlag,omitempty" xmlrpc:"disablePaymentProcessingFlag,omitempty"` // A count of the SoftLayer employees that an account is assigned to. DisplaySupportRepresentativeAssignmentCount *uint `json:"displaySupportRepresentativeAssignmentCount,omitempty" xmlrpc:"displaySupportRepresentativeAssignmentCount,omitempty"` // The SoftLayer employees that an account is assigned to. DisplaySupportRepresentativeAssignments []Account_Attachment_Employee `json:"displaySupportRepresentativeAssignments,omitempty" xmlrpc:"displaySupportRepresentativeAssignments,omitempty"` // A count of the DNS domains associated with an account. DomainCount *uint `json:"domainCount,omitempty" xmlrpc:"domainCount,omitempty"` // The DNS domains associated with an account. Domains []Dns_Domain `json:"domains,omitempty" xmlrpc:"domains,omitempty"` // A count of the DNS domains associated with an account that were not created as a result of a secondary DNS zone transfer. DomainsWithoutSecondaryDnsRecordCount *uint `json:"domainsWithoutSecondaryDnsRecordCount,omitempty" xmlrpc:"domainsWithoutSecondaryDnsRecordCount,omitempty"` // The DNS domains associated with an account that were not created as a result of a secondary DNS zone transfer. DomainsWithoutSecondaryDnsRecords []Dns_Domain `json:"domainsWithoutSecondaryDnsRecords,omitempty" xmlrpc:"domainsWithoutSecondaryDnsRecords,omitempty"` // A general email address assigned to an account. Email *string `json:"email,omitempty" xmlrpc:"email,omitempty"` // 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. EuSupportedFlag *bool `json:"euSupportedFlag,omitempty" xmlrpc:"euSupportedFlag,omitempty"` // The total capacity of Legacy EVault Volumes on an account, in GB. EvaultCapacityGB *uint `json:"evaultCapacityGB,omitempty" xmlrpc:"evaultCapacityGB,omitempty"` // A count of an account's master EVault user. This is only used when an account has EVault service. EvaultMasterUserCount *uint `json:"evaultMasterUserCount,omitempty" xmlrpc:"evaultMasterUserCount,omitempty"` // An account's master EVault user. This is only used when an account has EVault service. EvaultMasterUsers []Account_Password `json:"evaultMasterUsers,omitempty" xmlrpc:"evaultMasterUsers,omitempty"` // An account's associated EVault storage volumes. EvaultNetworkStorage []Network_Storage `json:"evaultNetworkStorage,omitempty" xmlrpc:"evaultNetworkStorage,omitempty"` // A count of an account's associated EVault storage volumes. EvaultNetworkStorageCount *uint `json:"evaultNetworkStorageCount,omitempty" xmlrpc:"evaultNetworkStorageCount,omitempty"` // A count of stored security certificates that are expired (ie. SSL) ExpiredSecurityCertificateCount *uint `json:"expiredSecurityCertificateCount,omitempty" xmlrpc:"expiredSecurityCertificateCount,omitempty"` // Stored security certificates that are expired (ie. SSL) ExpiredSecurityCertificates []Security_Certificate `json:"expiredSecurityCertificates,omitempty" xmlrpc:"expiredSecurityCertificates,omitempty"` // 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. FacilityLogCount *uint `json:"facilityLogCount,omitempty" xmlrpc:"facilityLogCount,omitempty"` // Logs of who entered a colocation area which is assigned to this account, or when a user under this account enters a datacenter. FacilityLogs []User_Access_Facility_Log `json:"facilityLogs,omitempty" xmlrpc:"facilityLogs,omitempty"` // A fax phone number assigned to an account. FaxPhone *string `json:"faxPhone,omitempty" xmlrpc:"faxPhone,omitempty"` // no documentation yet FileBlockBetaAccessFlag *bool `json:"fileBlockBetaAccessFlag,omitempty" xmlrpc:"fileBlockBetaAccessFlag,omitempty"` // Each customer account is listed under a single individual. This is that individual's first name. FirstName *string `json:"firstName,omitempty" xmlrpc:"firstName,omitempty"` // A count of all of the account's current and former Flexible Credit enrollments. FlexibleCreditEnrollmentCount *uint `json:"flexibleCreditEnrollmentCount,omitempty" xmlrpc:"flexibleCreditEnrollmentCount,omitempty"` // All of the account's current and former Flexible Credit enrollments. FlexibleCreditEnrollments []FlexibleCredit_Enrollment `json:"flexibleCreditEnrollments,omitempty" xmlrpc:"flexibleCreditEnrollments,omitempty"` // Timestamp representing the point in time when an account is required to link with PaaS. ForcePaasAccountLinkDate *string `json:"forcePaasAccountLinkDate,omitempty" xmlrpc:"forcePaasAccountLinkDate,omitempty"` // A count of GlobalIpRecordCount *uint `json:"globalIpRecordCount,omitempty" xmlrpc:"globalIpRecordCount,omitempty"` // no documentation yet GlobalIpRecords []Network_Subnet_IpAddress_Global `json:"globalIpRecords,omitempty" xmlrpc:"globalIpRecords,omitempty"` // A count of GlobalIpv4RecordCount *uint `json:"globalIpv4RecordCount,omitempty" xmlrpc:"globalIpv4RecordCount,omitempty"` // no documentation yet GlobalIpv4Records []Network_Subnet_IpAddress_Global `json:"globalIpv4Records,omitempty" xmlrpc:"globalIpv4Records,omitempty"` // A count of GlobalIpv6RecordCount *uint `json:"globalIpv6RecordCount,omitempty" xmlrpc:"globalIpv6RecordCount,omitempty"` // no documentation yet GlobalIpv6Records []Network_Subnet_IpAddress_Global `json:"globalIpv6Records,omitempty" xmlrpc:"globalIpv6Records,omitempty"` // An account's associated hardware objects. Hardware []Hardware `json:"hardware,omitempty" xmlrpc:"hardware,omitempty"` // A count of an account's associated hardware objects. HardwareCount *uint `json:"hardwareCount,omitempty" xmlrpc:"hardwareCount,omitempty"` // An account's associated hardware objects currently over bandwidth allocation. HardwareOverBandwidthAllocation []Hardware `json:"hardwareOverBandwidthAllocation,omitempty" xmlrpc:"hardwareOverBandwidthAllocation,omitempty"` // A count of an account's associated hardware objects currently over bandwidth allocation. HardwareOverBandwidthAllocationCount *uint `json:"hardwareOverBandwidthAllocationCount,omitempty" xmlrpc:"hardwareOverBandwidthAllocationCount,omitempty"` // An account's associated hardware objects projected to go over bandwidth allocation. HardwareProjectedOverBandwidthAllocation []Hardware `json:"hardwareProjectedOverBandwidthAllocation,omitempty" xmlrpc:"hardwareProjectedOverBandwidthAllocation,omitempty"` // A count of an account's associated hardware objects projected to go over bandwidth allocation. HardwareProjectedOverBandwidthAllocationCount *uint `` /* 127-byte string literal not displayed */ // All hardware associated with an account that has the cPanel web hosting control panel installed. HardwareWithCpanel []Hardware `json:"hardwareWithCpanel,omitempty" xmlrpc:"hardwareWithCpanel,omitempty"` // A count of all hardware associated with an account that has the cPanel web hosting control panel installed. HardwareWithCpanelCount *uint `json:"hardwareWithCpanelCount,omitempty" xmlrpc:"hardwareWithCpanelCount,omitempty"` // All hardware associated with an account that has the Helm web hosting control panel installed. HardwareWithHelm []Hardware `json:"hardwareWithHelm,omitempty" xmlrpc:"hardwareWithHelm,omitempty"` // A count of all hardware associated with an account that has the Helm web hosting control panel installed. HardwareWithHelmCount *uint `json:"hardwareWithHelmCount,omitempty" xmlrpc:"hardwareWithHelmCount,omitempty"` // All hardware associated with an account that has McAfee Secure software components. HardwareWithMcafee []Hardware `json:"hardwareWithMcafee,omitempty" xmlrpc:"hardwareWithMcafee,omitempty"` // All hardware associated with an account that has McAfee Secure AntiVirus for Redhat software components. HardwareWithMcafeeAntivirusRedhat []Hardware `json:"hardwareWithMcafeeAntivirusRedhat,omitempty" xmlrpc:"hardwareWithMcafeeAntivirusRedhat,omitempty"` // A count of all hardware associated with an account that has McAfee Secure AntiVirus for Redhat software components. HardwareWithMcafeeAntivirusRedhatCount *uint `json:"hardwareWithMcafeeAntivirusRedhatCount,omitempty" xmlrpc:"hardwareWithMcafeeAntivirusRedhatCount,omitempty"` // A count of all hardware associated with an account that has McAfee Secure AntiVirus for Windows software components. HardwareWithMcafeeAntivirusWindowCount *uint `json:"hardwareWithMcafeeAntivirusWindowCount,omitempty" xmlrpc:"hardwareWithMcafeeAntivirusWindowCount,omitempty"` // All hardware associated with an account that has McAfee Secure AntiVirus for Windows software components. HardwareWithMcafeeAntivirusWindows []Hardware `json:"hardwareWithMcafeeAntivirusWindows,omitempty" xmlrpc:"hardwareWithMcafeeAntivirusWindows,omitempty"` // A count of all hardware associated with an account that has McAfee Secure software components. HardwareWithMcafeeCount *uint `json:"hardwareWithMcafeeCount,omitempty" xmlrpc:"hardwareWithMcafeeCount,omitempty"` // All hardware associated with an account that has McAfee Secure Intrusion Detection System software components. HardwareWithMcafeeIntrusionDetectionSystem []Hardware `json:"hardwareWithMcafeeIntrusionDetectionSystem,omitempty" xmlrpc:"hardwareWithMcafeeIntrusionDetectionSystem,omitempty"` // A count of all hardware associated with an account that has McAfee Secure Intrusion Detection System software components. HardwareWithMcafeeIntrusionDetectionSystemCount *uint `` /* 131-byte string literal not displayed */ // All hardware associated with an account that has the Plesk web hosting control panel installed. HardwareWithPlesk []Hardware `json:"hardwareWithPlesk,omitempty" xmlrpc:"hardwareWithPlesk,omitempty"` // A count of all hardware associated with an account that has the Plesk web hosting control panel installed. HardwareWithPleskCount *uint `json:"hardwareWithPleskCount,omitempty" xmlrpc:"hardwareWithPleskCount,omitempty"` // All hardware associated with an account that has the QuantaStor storage system installed. HardwareWithQuantastor []Hardware `json:"hardwareWithQuantastor,omitempty" xmlrpc:"hardwareWithQuantastor,omitempty"` // A count of all hardware associated with an account that has the QuantaStor storage system installed. HardwareWithQuantastorCount *uint `json:"hardwareWithQuantastorCount,omitempty" xmlrpc:"hardwareWithQuantastorCount,omitempty"` // All hardware associated with an account that has the Urchin web traffic analytics package installed. HardwareWithUrchin []Hardware `json:"hardwareWithUrchin,omitempty" xmlrpc:"hardwareWithUrchin,omitempty"` // A count of all hardware associated with an account that has the Urchin web traffic analytics package installed. HardwareWithUrchinCount *uint `json:"hardwareWithUrchinCount,omitempty" xmlrpc:"hardwareWithUrchinCount,omitempty"` // A count of all hardware associated with an account that is running a version of the Microsoft Windows operating system. HardwareWithWindowCount *uint `json:"hardwareWithWindowCount,omitempty" xmlrpc:"hardwareWithWindowCount,omitempty"` // All hardware associated with an account that is running a version of the Microsoft Windows operating system. HardwareWithWindows []Hardware `json:"hardwareWithWindows,omitempty" xmlrpc:"hardwareWithWindows,omitempty"` // Return 1 if one of the account's hardware has the EVault Bare Metal Server Restore Plugin otherwise 0. HasEvaultBareMetalRestorePluginFlag *bool `json:"hasEvaultBareMetalRestorePluginFlag,omitempty" xmlrpc:"hasEvaultBareMetalRestorePluginFlag,omitempty"` // Return 1 if one of the account's hardware has an installation of Idera Server Backup otherwise 0. HasIderaBareMetalRestorePluginFlag *bool `json:"hasIderaBareMetalRestorePluginFlag,omitempty" xmlrpc:"hasIderaBareMetalRestorePluginFlag,omitempty"` // The number of orders in a PENDING status for a SoftLayer customer account. HasPendingOrder *uint `json:"hasPendingOrder,omitempty" xmlrpc:"hasPendingOrder,omitempty"` // Return 1 if one of the account's hardware has an installation of R1Soft CDP otherwise 0. HasR1softBareMetalRestorePluginFlag *bool `json:"hasR1softBareMetalRestorePluginFlag,omitempty" xmlrpc:"hasR1softBareMetalRestorePluginFlag,omitempty"` // A count of an account's associated hourly bare metal server objects. HourlyBareMetalInstanceCount *uint `json:"hourlyBareMetalInstanceCount,omitempty" xmlrpc:"hourlyBareMetalInstanceCount,omitempty"` // An account's associated hourly bare metal server objects. HourlyBareMetalInstances []Hardware `json:"hourlyBareMetalInstances,omitempty" xmlrpc:"hourlyBareMetalInstances,omitempty"` // A count of hourly service billing items that will be on an account's next invoice. HourlyServiceBillingItemCount *uint `json:"hourlyServiceBillingItemCount,omitempty" xmlrpc:"hourlyServiceBillingItemCount,omitempty"` // Hourly service billing items that will be on an account's next invoice. HourlyServiceBillingItems []Billing_Item `json:"hourlyServiceBillingItems,omitempty" xmlrpc:"hourlyServiceBillingItems,omitempty"` // A count of an account's associated hourly virtual guest objects. HourlyVirtualGuestCount *uint `json:"hourlyVirtualGuestCount,omitempty" xmlrpc:"hourlyVirtualGuestCount,omitempty"` // An account's associated hourly virtual guest objects. HourlyVirtualGuests []Virtual_Guest `json:"hourlyVirtualGuests,omitempty" xmlrpc:"hourlyVirtualGuests,omitempty"` // An account's associated Virtual Storage volumes. HubNetworkStorage []Network_Storage `json:"hubNetworkStorage,omitempty" xmlrpc:"hubNetworkStorage,omitempty"` // A count of an account's associated Virtual Storage volumes. HubNetworkStorageCount *uint `json:"hubNetworkStorageCount,omitempty" xmlrpc:"hubNetworkStorageCount,omitempty"` // Unique identifier for a customer used throughout IBM. IbmCustomerNumber *string `json:"ibmCustomerNumber,omitempty" xmlrpc:"ibmCustomerNumber,omitempty"` // Indicates whether this account requires IBMid authentication. IbmIdAuthenticationRequiredFlag *bool `json:"ibmIdAuthenticationRequiredFlag,omitempty" xmlrpc:"ibmIdAuthenticationRequiredFlag,omitempty"` // This key is deprecated and should not be used. IbmIdMigrationExpirationTimestamp *string `json:"ibmIdMigrationExpirationTimestamp,omitempty" xmlrpc:"ibmIdMigrationExpirationTimestamp,omitempty"` // 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. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // An in progress request to switch billing systems. InProgressExternalAccountSetup *Account_External_Setup `json:"inProgressExternalAccountSetup,omitempty" xmlrpc:"inProgressExternalAccountSetup,omitempty"` // Account attribute flag indicating internal cci host account. InternalCciHostAccountFlag *bool `json:"internalCciHostAccountFlag,omitempty" xmlrpc:"internalCciHostAccountFlag,omitempty"` // Account attribute flag indicating account creates internal image templates. InternalImageTemplateCreationFlag *bool `json:"internalImageTemplateCreationFlag,omitempty" xmlrpc:"internalImageTemplateCreationFlag,omitempty"` // A count of InternalNoteCount *uint `json:"internalNoteCount,omitempty" xmlrpc:"internalNoteCount,omitempty"` // no documentation yet InternalNotes []Account_Note `json:"internalNotes,omitempty" xmlrpc:"internalNotes,omitempty"` // Account attribute flag indicating restricted account. InternalRestrictionFlag *bool `json:"internalRestrictionFlag,omitempty" xmlrpc:"internalRestrictionFlag,omitempty"` // A count of an account's associated billing invoices. InvoiceCount *uint `json:"invoiceCount,omitempty" xmlrpc:"invoiceCount,omitempty"` // An account's associated billing invoices. Invoices []Billing_Invoice `json:"invoices,omitempty" xmlrpc:"invoices,omitempty"` // A count of IpAddressCount *uint `json:"ipAddressCount,omitempty" xmlrpc:"ipAddressCount,omitempty"` // no documentation yet IpAddresses []Network_Subnet_IpAddress `json:"ipAddresses,omitempty" xmlrpc:"ipAddresses,omitempty"` // A flag indicating if an account belongs to a reseller or not. IsReseller *int `json:"isReseller,omitempty" xmlrpc:"isReseller,omitempty"` // no documentation yet IscsiIsolationDisabled *bool `json:"iscsiIsolationDisabled,omitempty" xmlrpc:"iscsiIsolationDisabled,omitempty"` // An account's associated iSCSI storage volumes. IscsiNetworkStorage []Network_Storage `json:"iscsiNetworkStorage,omitempty" xmlrpc:"iscsiNetworkStorage,omitempty"` // A count of an account's associated iSCSI storage volumes. IscsiNetworkStorageCount *uint `json:"iscsiNetworkStorageCount,omitempty" xmlrpc:"iscsiNetworkStorageCount,omitempty"` // The most recently canceled billing item. LastCanceledBillingItem *Billing_Item `json:"lastCanceledBillingItem,omitempty" xmlrpc:"lastCanceledBillingItem,omitempty"` // The most recent cancelled server billing item. LastCancelledServerBillingItem *Billing_Item `json:"lastCancelledServerBillingItem,omitempty" xmlrpc:"lastCancelledServerBillingItem,omitempty"` // A count of the five most recently closed abuse tickets associated with an account. LastFiveClosedAbuseTicketCount *uint `json:"lastFiveClosedAbuseTicketCount,omitempty" xmlrpc:"lastFiveClosedAbuseTicketCount,omitempty"` // The five most recently closed abuse tickets associated with an account. LastFiveClosedAbuseTickets []Ticket `json:"lastFiveClosedAbuseTickets,omitempty" xmlrpc:"lastFiveClosedAbuseTickets,omitempty"` // A count of the five most recently closed accounting tickets associated with an account. LastFiveClosedAccountingTicketCount *uint `json:"lastFiveClosedAccountingTicketCount,omitempty" xmlrpc:"lastFiveClosedAccountingTicketCount,omitempty"` // The five most recently closed accounting tickets associated with an account. LastFiveClosedAccountingTickets []Ticket `json:"lastFiveClosedAccountingTickets,omitempty" xmlrpc:"lastFiveClosedAccountingTickets,omitempty"` // 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. LastFiveClosedOtherTicketCount *uint `json:"lastFiveClosedOtherTicketCount,omitempty" xmlrpc:"lastFiveClosedOtherTicketCount,omitempty"` // The five most recently closed tickets that do not belong to the abuse, accounting, sales, or support groups associated with an account. LastFiveClosedOtherTickets []Ticket `json:"lastFiveClosedOtherTickets,omitempty" xmlrpc:"lastFiveClosedOtherTickets,omitempty"` // A count of the five most recently closed sales tickets associated with an account. LastFiveClosedSalesTicketCount *uint `json:"lastFiveClosedSalesTicketCount,omitempty" xmlrpc:"lastFiveClosedSalesTicketCount,omitempty"` // The five most recently closed sales tickets associated with an account. LastFiveClosedSalesTickets []Ticket `json:"lastFiveClosedSalesTickets,omitempty" xmlrpc:"lastFiveClosedSalesTickets,omitempty"` // A count of the five most recently closed support tickets associated with an account. LastFiveClosedSupportTicketCount *uint `json:"lastFiveClosedSupportTicketCount,omitempty" xmlrpc:"lastFiveClosedSupportTicketCount,omitempty"` // The five most recently closed support tickets associated with an account. LastFiveClosedSupportTickets []Ticket `json:"lastFiveClosedSupportTickets,omitempty" xmlrpc:"lastFiveClosedSupportTickets,omitempty"` // A count of the five most recently closed tickets associated with an account. LastFiveClosedTicketCount *uint `json:"lastFiveClosedTicketCount,omitempty" xmlrpc:"lastFiveClosedTicketCount,omitempty"` // The five most recently closed tickets associated with an account. LastFiveClosedTickets []Ticket `json:"lastFiveClosedTickets,omitempty" xmlrpc:"lastFiveClosedTickets,omitempty"` // Each customer account is listed under a single individual. This is that individual's last name. LastName *string `json:"lastName,omitempty" xmlrpc:"lastName,omitempty"` // Whether an account has late fee protection. LateFeeProtectionFlag *bool `json:"lateFeeProtectionFlag,omitempty" xmlrpc:"lateFeeProtectionFlag,omitempty"` // An account's most recent billing date. LatestBillDate *Time `json:"latestBillDate,omitempty" xmlrpc:"latestBillDate,omitempty"` // An account's latest recurring invoice. LatestRecurringInvoice *Billing_Invoice `json:"latestRecurringInvoice,omitempty" xmlrpc:"latestRecurringInvoice,omitempty"` // An account's latest recurring pending invoice. LatestRecurringPendingInvoice *Billing_Invoice `json:"latestRecurringPendingInvoice,omitempty" xmlrpc:"latestRecurringPendingInvoice,omitempty"` // The total capacity of Legacy iSCSI Volumes on an account, in GB. LegacyIscsiCapacityGB *uint `json:"legacyIscsiCapacityGB,omitempty" xmlrpc:"legacyIscsiCapacityGB,omitempty"` // A count of an account's associated load balancers. LoadBalancerCount *uint `json:"loadBalancerCount,omitempty" xmlrpc:"loadBalancerCount,omitempty"` // An account's associated load balancers. LoadBalancers []Network_LoadBalancer_VirtualIpAddress `json:"loadBalancers,omitempty" xmlrpc:"loadBalancers,omitempty"` // The total capacity of Legacy lockbox Volumes on an account, in GB. LockboxCapacityGB *uint `json:"lockboxCapacityGB,omitempty" xmlrpc:"lockboxCapacityGB,omitempty"` // An account's associated Lockbox storage volumes. LockboxNetworkStorage []Network_Storage `json:"lockboxNetworkStorage,omitempty" xmlrpc:"lockboxNetworkStorage,omitempty"` // A count of an account's associated Lockbox storage volumes. LockboxNetworkStorageCount *uint `json:"lockboxNetworkStorageCount,omitempty" xmlrpc:"lockboxNetworkStorageCount,omitempty"` // no documentation yet ManualPaymentsUnderReview []Billing_Payment_Card_ManualPayment `json:"manualPaymentsUnderReview,omitempty" xmlrpc:"manualPaymentsUnderReview,omitempty"` // A count of ManualPaymentsUnderReviewCount *uint `json:"manualPaymentsUnderReviewCount,omitempty" xmlrpc:"manualPaymentsUnderReviewCount,omitempty"` // An account's master user. MasterUser *User_Customer `json:"masterUser,omitempty" xmlrpc:"masterUser,omitempty"` // A count of an account's media transfer service requests. MediaDataTransferRequestCount *uint `json:"mediaDataTransferRequestCount,omitempty" xmlrpc:"mediaDataTransferRequestCount,omitempty"` // An account's media transfer service requests. MediaDataTransferRequests []Account_Media_Data_Transfer_Request `json:"mediaDataTransferRequests,omitempty" xmlrpc:"mediaDataTransferRequests,omitempty"` // Flag indicating whether this account is restricted to the IBM Cloud portal. MigratedToIbmCloudPortalFlag *bool `json:"migratedToIbmCloudPortalFlag,omitempty" xmlrpc:"migratedToIbmCloudPortalFlag,omitempty"` // The date an account was last modified. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // A count of an account's associated monthly bare metal server objects. MonthlyBareMetalInstanceCount *uint `json:"monthlyBareMetalInstanceCount,omitempty" xmlrpc:"monthlyBareMetalInstanceCount,omitempty"` // An account's associated monthly bare metal server objects. MonthlyBareMetalInstances []Hardware `json:"monthlyBareMetalInstances,omitempty" xmlrpc:"monthlyBareMetalInstances,omitempty"` // A count of an account's associated monthly virtual guest objects. MonthlyVirtualGuestCount *uint `json:"monthlyVirtualGuestCount,omitempty" xmlrpc:"monthlyVirtualGuestCount,omitempty"` // An account's associated monthly virtual guest objects. MonthlyVirtualGuests []Virtual_Guest `json:"monthlyVirtualGuests,omitempty" xmlrpc:"monthlyVirtualGuests,omitempty"` // An account's associated NAS storage volumes. NasNetworkStorage []Network_Storage `json:"nasNetworkStorage,omitempty" xmlrpc:"nasNetworkStorage,omitempty"` // A count of an account's associated NAS storage volumes. NasNetworkStorageCount *uint `json:"nasNetworkStorageCount,omitempty" xmlrpc:"nasNetworkStorageCount,omitempty"` // [Deprecated] Whether or not this account can define their own networks. NetworkCreationFlag *bool `json:"networkCreationFlag,omitempty" xmlrpc:"networkCreationFlag,omitempty"` // A count of all network gateway devices on this account. NetworkGatewayCount *uint `json:"networkGatewayCount,omitempty" xmlrpc:"networkGatewayCount,omitempty"` // All network gateway devices on this account. NetworkGateways []Network_Gateway `json:"networkGateways,omitempty" xmlrpc:"networkGateways,omitempty"` // An account's associated network hardware. NetworkHardware []Hardware `json:"networkHardware,omitempty" xmlrpc:"networkHardware,omitempty"` // A count of an account's associated network hardware. NetworkHardwareCount *uint `json:"networkHardwareCount,omitempty" xmlrpc:"networkHardwareCount,omitempty"` // A count of NetworkMessageDeliveryAccountCount *uint `json:"networkMessageDeliveryAccountCount,omitempty" xmlrpc:"networkMessageDeliveryAccountCount,omitempty"` // no documentation yet NetworkMessageDeliveryAccounts []Network_Message_Delivery `json:"networkMessageDeliveryAccounts,omitempty" xmlrpc:"networkMessageDeliveryAccounts,omitempty"` // Hardware which is currently experiencing a service failure. NetworkMonitorDownHardware []Hardware `json:"networkMonitorDownHardware,omitempty" xmlrpc:"networkMonitorDownHardware,omitempty"` // A count of hardware which is currently experiencing a service failure. NetworkMonitorDownHardwareCount *uint `json:"networkMonitorDownHardwareCount,omitempty" xmlrpc:"networkMonitorDownHardwareCount,omitempty"` // A count of virtual guest which is currently experiencing a service failure. NetworkMonitorDownVirtualGuestCount *uint `json:"networkMonitorDownVirtualGuestCount,omitempty" xmlrpc:"networkMonitorDownVirtualGuestCount,omitempty"` // Virtual guest which is currently experiencing a service failure. NetworkMonitorDownVirtualGuests []Virtual_Guest `json:"networkMonitorDownVirtualGuests,omitempty" xmlrpc:"networkMonitorDownVirtualGuests,omitempty"` // Hardware which is currently recovering from a service failure. NetworkMonitorRecoveringHardware []Hardware `json:"networkMonitorRecoveringHardware,omitempty" xmlrpc:"networkMonitorRecoveringHardware,omitempty"` // A count of hardware which is currently recovering from a service failure. NetworkMonitorRecoveringHardwareCount *uint `json:"networkMonitorRecoveringHardwareCount,omitempty" xmlrpc:"networkMonitorRecoveringHardwareCount,omitempty"` // A count of virtual guest which is currently recovering from a service failure. NetworkMonitorRecoveringVirtualGuestCount *uint `json:"networkMonitorRecoveringVirtualGuestCount,omitempty" xmlrpc:"networkMonitorRecoveringVirtualGuestCount,omitempty"` // Virtual guest which is currently recovering from a service failure. NetworkMonitorRecoveringVirtualGuests []Virtual_Guest `json:"networkMonitorRecoveringVirtualGuests,omitempty" xmlrpc:"networkMonitorRecoveringVirtualGuests,omitempty"` // Hardware which is currently online. NetworkMonitorUpHardware []Hardware `json:"networkMonitorUpHardware,omitempty" xmlrpc:"networkMonitorUpHardware,omitempty"` // A count of hardware which is currently online. NetworkMonitorUpHardwareCount *uint `json:"networkMonitorUpHardwareCount,omitempty" xmlrpc:"networkMonitorUpHardwareCount,omitempty"` // A count of virtual guest which is currently online. NetworkMonitorUpVirtualGuestCount *uint `json:"networkMonitorUpVirtualGuestCount,omitempty" xmlrpc:"networkMonitorUpVirtualGuestCount,omitempty"` // Virtual guest which is currently online. NetworkMonitorUpVirtualGuests []Virtual_Guest `json:"networkMonitorUpVirtualGuests,omitempty" xmlrpc:"networkMonitorUpVirtualGuests,omitempty"` // An account's associated storage volumes. This includes Lockbox, NAS, EVault, and iSCSI volumes. NetworkStorage []Network_Storage `json:"networkStorage,omitempty" xmlrpc:"networkStorage,omitempty"` // A count of an account's associated storage volumes. This includes Lockbox, NAS, EVault, and iSCSI volumes. NetworkStorageCount *uint `json:"networkStorageCount,omitempty" xmlrpc:"networkStorageCount,omitempty"` // A count of an account's Network Storage groups. NetworkStorageGroupCount *uint `json:"networkStorageGroupCount,omitempty" xmlrpc:"networkStorageGroupCount,omitempty"` // An account's Network Storage groups. NetworkStorageGroups []Network_Storage_Group `json:"networkStorageGroups,omitempty" xmlrpc:"networkStorageGroups,omitempty"` // A count of iPSec network tunnels for an account. NetworkTunnelContextCount *uint `json:"networkTunnelContextCount,omitempty" xmlrpc:"networkTunnelContextCount,omitempty"` // IPSec network tunnels for an account. NetworkTunnelContexts []Network_Tunnel_Module_Context `json:"networkTunnelContexts,omitempty" xmlrpc:"networkTunnelContexts,omitempty"` // A count of all network VLANs assigned to an account. NetworkVlanCount *uint `json:"networkVlanCount,omitempty" xmlrpc:"networkVlanCount,omitempty"` // Whether or not an account has automatic private VLAN spanning enabled. NetworkVlanSpan *Account_Network_Vlan_Span `json:"networkVlanSpan,omitempty" xmlrpc:"networkVlanSpan,omitempty"` // All network VLANs assigned to an account. NetworkVlans []Network_Vlan `json:"networkVlans,omitempty" xmlrpc:"networkVlans,omitempty"` // 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 NextInvoiceIncubatorExemptTotal *Float64 `json:"nextInvoiceIncubatorExemptTotal,omitempty" xmlrpc:"nextInvoiceIncubatorExemptTotal,omitempty"` // The pre-tax platform services total amount of an account's next invoice. NextInvoicePlatformServicesTotalAmount *Float64 `json:"nextInvoicePlatformServicesTotalAmount,omitempty" xmlrpc:"nextInvoicePlatformServicesTotalAmount,omitempty"` // 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. NextInvoiceRecurringAmountEligibleForAccountDiscount *Float64 `` /* 141-byte string literal not displayed */ // A count of the billing items that will be on an account's next invoice. NextInvoiceTopLevelBillingItemCount *uint `json:"nextInvoiceTopLevelBillingItemCount,omitempty" xmlrpc:"nextInvoiceTopLevelBillingItemCount,omitempty"` // The billing items that will be on an account's next invoice. NextInvoiceTopLevelBillingItems []Billing_Item `json:"nextInvoiceTopLevelBillingItems,omitempty" xmlrpc:"nextInvoiceTopLevelBillingItems,omitempty"` // 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. NextInvoiceTotalAmount *Float64 `json:"nextInvoiceTotalAmount,omitempty" xmlrpc:"nextInvoiceTotalAmount,omitempty"` // 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. NextInvoiceTotalOneTimeAmount *Float64 `json:"nextInvoiceTotalOneTimeAmount,omitempty" xmlrpc:"nextInvoiceTotalOneTimeAmount,omitempty"` // 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. NextInvoiceTotalOneTimeTaxAmount *Float64 `json:"nextInvoiceTotalOneTimeTaxAmount,omitempty" xmlrpc:"nextInvoiceTotalOneTimeTaxAmount,omitempty"` // 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. NextInvoiceTotalRecurringAmount *Float64 `json:"nextInvoiceTotalRecurringAmount,omitempty" xmlrpc:"nextInvoiceTotalRecurringAmount,omitempty"` // 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. NextInvoiceTotalRecurringAmountBeforeAccountDiscount *Float64 `` /* 141-byte string literal not displayed */ // 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. NextInvoiceTotalRecurringTaxAmount *Float64 `json:"nextInvoiceTotalRecurringTaxAmount,omitempty" xmlrpc:"nextInvoiceTotalRecurringTaxAmount,omitempty"` // 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. NextInvoiceTotalTaxableRecurringAmount *Float64 `json:"nextInvoiceTotalTaxableRecurringAmount,omitempty" xmlrpc:"nextInvoiceTotalTaxableRecurringAmount,omitempty"` // A count of NotificationSubscriberCount *uint `json:"notificationSubscriberCount,omitempty" xmlrpc:"notificationSubscriberCount,omitempty"` // no documentation yet NotificationSubscribers []Notification_Subscriber `json:"notificationSubscribers,omitempty" xmlrpc:"notificationSubscribers,omitempty"` // An office phone number assigned to an account. OfficePhone *string `json:"officePhone,omitempty" xmlrpc:"officePhone,omitempty"` // A count of the open abuse tickets associated with an account. OpenAbuseTicketCount *uint `json:"openAbuseTicketCount,omitempty" xmlrpc:"openAbuseTicketCount,omitempty"` // The open abuse tickets associated with an account. OpenAbuseTickets []Ticket `json:"openAbuseTickets,omitempty" xmlrpc:"openAbuseTickets,omitempty"` // A count of the open accounting tickets associated with an account. OpenAccountingTicketCount *uint `json:"openAccountingTicketCount,omitempty" xmlrpc:"openAccountingTicketCount,omitempty"` // The open accounting tickets associated with an account. OpenAccountingTickets []Ticket `json:"openAccountingTickets,omitempty" xmlrpc:"openAccountingTickets,omitempty"` // A count of the open billing tickets associated with an account. OpenBillingTicketCount *uint `json:"openBillingTicketCount,omitempty" xmlrpc:"openBillingTicketCount,omitempty"` // The open billing tickets associated with an account. OpenBillingTickets []Ticket `json:"openBillingTickets,omitempty" xmlrpc:"openBillingTickets,omitempty"` // A count of an open ticket requesting cancellation of this server, if one exists. OpenCancellationRequestCount *uint `json:"openCancellationRequestCount,omitempty" xmlrpc:"openCancellationRequestCount,omitempty"` // An open ticket requesting cancellation of this server, if one exists. OpenCancellationRequests []Billing_Item_Cancellation_Request `json:"openCancellationRequests,omitempty" xmlrpc:"openCancellationRequests,omitempty"` // A count of the open tickets that do not belong to the abuse, accounting, sales, or support groups associated with an account. OpenOtherTicketCount *uint `json:"openOtherTicketCount,omitempty" xmlrpc:"openOtherTicketCount,omitempty"` // The open tickets that do not belong to the abuse, accounting, sales, or support groups associated with an account. OpenOtherTickets []Ticket `json:"openOtherTickets,omitempty" xmlrpc:"openOtherTickets,omitempty"` // A count of an account's recurring invoices. OpenRecurringInvoiceCount *uint `json:"openRecurringInvoiceCount,omitempty" xmlrpc:"openRecurringInvoiceCount,omitempty"` // An account's recurring invoices. OpenRecurringInvoices []Billing_Invoice `json:"openRecurringInvoices,omitempty" xmlrpc:"openRecurringInvoices,omitempty"` // A count of the open sales tickets associated with an account. OpenSalesTicketCount *uint `json:"openSalesTicketCount,omitempty" xmlrpc:"openSalesTicketCount,omitempty"` // The open sales tickets associated with an account. OpenSalesTickets []Ticket `json:"openSalesTickets,omitempty" xmlrpc:"openSalesTickets,omitempty"` // A count of OpenStackAccountLinkCount *uint `json:"openStackAccountLinkCount,omitempty" xmlrpc:"openStackAccountLinkCount,omitempty"` // no documentation yet OpenStackAccountLinks []Account_Link `json:"openStackAccountLinks,omitempty" xmlrpc:"openStackAccountLinks,omitempty"` // An account's associated Openstack related Object Storage accounts. OpenStackObjectStorage []Network_Storage `json:"openStackObjectStorage,omitempty" xmlrpc:"openStackObjectStorage,omitempty"` // A count of an account's associated Openstack related Object Storage accounts. OpenStackObjectStorageCount *uint `json:"openStackObjectStorageCount,omitempty" xmlrpc:"openStackObjectStorageCount,omitempty"` // A count of the open support tickets associated with an account. OpenSupportTicketCount *uint `json:"openSupportTicketCount,omitempty" xmlrpc:"openSupportTicketCount,omitempty"` // The open support tickets associated with an account. OpenSupportTickets []Ticket `json:"openSupportTickets,omitempty" xmlrpc:"openSupportTickets,omitempty"` // A count of all open tickets associated with an account. OpenTicketCount *uint `json:"openTicketCount,omitempty" xmlrpc:"openTicketCount,omitempty"` // All open tickets associated with an account. OpenTickets []Ticket `json:"openTickets,omitempty" xmlrpc:"openTickets,omitempty"` // All open tickets associated with an account last edited by an employee. OpenTicketsWaitingOnCustomer []Ticket `json:"openTicketsWaitingOnCustomer,omitempty" xmlrpc:"openTicketsWaitingOnCustomer,omitempty"` // A count of all open tickets associated with an account last edited by an employee. OpenTicketsWaitingOnCustomerCount *uint `json:"openTicketsWaitingOnCustomerCount,omitempty" xmlrpc:"openTicketsWaitingOnCustomerCount,omitempty"` // A count of an account's associated billing orders excluding upgrades. OrderCount *uint `json:"orderCount,omitempty" xmlrpc:"orderCount,omitempty"` // An account's associated billing orders excluding upgrades. Orders []Billing_Order `json:"orders,omitempty" xmlrpc:"orders,omitempty"` // A count of the billing items that have no parent billing item. These are items that don't necessarily belong to a single server. OrphanBillingItemCount *uint `json:"orphanBillingItemCount,omitempty" xmlrpc:"orphanBillingItemCount,omitempty"` // The billing items that have no parent billing item. These are items that don't necessarily belong to a single server. OrphanBillingItems []Billing_Item `json:"orphanBillingItems,omitempty" xmlrpc:"orphanBillingItems,omitempty"` // A count of OwnedBrandCount *uint `json:"ownedBrandCount,omitempty" xmlrpc:"ownedBrandCount,omitempty"` // no documentation yet OwnedBrands []Brand `json:"ownedBrands,omitempty" xmlrpc:"ownedBrands,omitempty"` // A count of OwnedHardwareGenericComponentModelCount *uint `json:"ownedHardwareGenericComponentModelCount,omitempty" xmlrpc:"ownedHardwareGenericComponentModelCount,omitempty"` // no documentation yet OwnedHardwareGenericComponentModels []Hardware_Component_Model_Generic `json:"ownedHardwareGenericComponentModels,omitempty" xmlrpc:"ownedHardwareGenericComponentModels,omitempty"` // A count of PaymentProcessorCount *uint `json:"paymentProcessorCount,omitempty" xmlrpc:"paymentProcessorCount,omitempty"` // no documentation yet PaymentProcessors []Billing_Payment_Processor `json:"paymentProcessors,omitempty" xmlrpc:"paymentProcessors,omitempty"` // A count of PendingEventCount *uint `json:"pendingEventCount,omitempty" xmlrpc:"pendingEventCount,omitempty"` // no documentation yet PendingEvents []Notification_Occurrence_Event `json:"pendingEvents,omitempty" xmlrpc:"pendingEvents,omitempty"` // An account's latest open (pending) invoice. PendingInvoice *Billing_Invoice `json:"pendingInvoice,omitempty" xmlrpc:"pendingInvoice,omitempty"` // A count of a list of top-level invoice items that are on an account's currently pending invoice. PendingInvoiceTopLevelItemCount *uint `json:"pendingInvoiceTopLevelItemCount,omitempty" xmlrpc:"pendingInvoiceTopLevelItemCount,omitempty"` // A list of top-level invoice items that are on an account's currently pending invoice. PendingInvoiceTopLevelItems []Billing_Invoice_Item `json:"pendingInvoiceTopLevelItems,omitempty" xmlrpc:"pendingInvoiceTopLevelItems,omitempty"` // The total amount of an account's pending invoice, if one exists. PendingInvoiceTotalAmount *Float64 `json:"pendingInvoiceTotalAmount,omitempty" xmlrpc:"pendingInvoiceTotalAmount,omitempty"` // 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. PendingInvoiceTotalOneTimeAmount *Float64 `json:"pendingInvoiceTotalOneTimeAmount,omitempty" xmlrpc:"pendingInvoiceTotalOneTimeAmount,omitempty"` // The sum of all the taxes related to one time charges for an account's pending invoice, if one exists. PendingInvoiceTotalOneTimeTaxAmount *Float64 `json:"pendingInvoiceTotalOneTimeTaxAmount,omitempty" xmlrpc:"pendingInvoiceTotalOneTimeTaxAmount,omitempty"` // The total recurring amount of an account's pending invoice, if one exists. PendingInvoiceTotalRecurringAmount *Float64 `json:"pendingInvoiceTotalRecurringAmount,omitempty" xmlrpc:"pendingInvoiceTotalRecurringAmount,omitempty"` // The total amount of the recurring taxes on an account's pending invoice, if one exists. PendingInvoiceTotalRecurringTaxAmount *Float64 `json:"pendingInvoiceTotalRecurringTaxAmount,omitempty" xmlrpc:"pendingInvoiceTotalRecurringTaxAmount,omitempty"` // A count of an account's permission groups. PermissionGroupCount *uint `json:"permissionGroupCount,omitempty" xmlrpc:"permissionGroupCount,omitempty"` // An account's permission groups. PermissionGroups []User_Permission_Group `json:"permissionGroups,omitempty" xmlrpc:"permissionGroups,omitempty"` // A count of an account's user roles. PermissionRoleCount *uint `json:"permissionRoleCount,omitempty" xmlrpc:"permissionRoleCount,omitempty"` // An account's user roles. PermissionRoles []User_Permission_Role `json:"permissionRoles,omitempty" xmlrpc:"permissionRoles,omitempty"` // A count of an account's associated virtual placement groups. PlacementGroupCount *uint `json:"placementGroupCount,omitempty" xmlrpc:"placementGroupCount,omitempty"` // An account's associated virtual placement groups. PlacementGroups []Virtual_PlacementGroup `json:"placementGroups,omitempty" xmlrpc:"placementGroups,omitempty"` // A count of PortableStorageVolumeCount *uint `json:"portableStorageVolumeCount,omitempty" xmlrpc:"portableStorageVolumeCount,omitempty"` // no documentation yet PortableStorageVolumes []Virtual_Disk_Image `json:"portableStorageVolumes,omitempty" xmlrpc:"portableStorageVolumes,omitempty"` // 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. PostProvisioningHookCount *uint `json:"postProvisioningHookCount,omitempty" xmlrpc:"postProvisioningHookCount,omitempty"` // 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. PostProvisioningHooks []Provisioning_Hook `json:"postProvisioningHooks,omitempty" xmlrpc:"postProvisioningHooks,omitempty"` // The postal code of the mailing address belonging to an account. PostalCode *string `json:"postalCode,omitempty" xmlrpc:"postalCode,omitempty"` // (Deprecated) Boolean flag dictating whether or not this account supports PPTP VPN Access. PptpVpnAllowedFlag *bool `json:"pptpVpnAllowedFlag,omitempty" xmlrpc:"pptpVpnAllowedFlag,omitempty"` // A count of an account's associated portal users with PPTP VPN access. (Deprecated) PptpVpnUserCount *uint `json:"pptpVpnUserCount,omitempty" xmlrpc:"pptpVpnUserCount,omitempty"` // An account's associated portal users with PPTP VPN access. (Deprecated) PptpVpnUsers []User_Customer `json:"pptpVpnUsers,omitempty" xmlrpc:"pptpVpnUsers,omitempty"` // A count of an account's invoices in the PRE_OPEN status. PreOpenRecurringInvoiceCount *uint `json:"preOpenRecurringInvoiceCount,omitempty" xmlrpc:"preOpenRecurringInvoiceCount,omitempty"` // An account's invoices in the PRE_OPEN status. PreOpenRecurringInvoices []Billing_Invoice `json:"preOpenRecurringInvoices,omitempty" xmlrpc:"preOpenRecurringInvoices,omitempty"` // The total recurring amount for an accounts previous revenue. PreviousRecurringRevenue *Float64 `json:"previousRecurringRevenue,omitempty" xmlrpc:"previousRecurringRevenue,omitempty"` // A count of the item price that an account is restricted to. PriceRestrictionCount *uint `json:"priceRestrictionCount,omitempty" xmlrpc:"priceRestrictionCount,omitempty"` // The item price that an account is restricted to. PriceRestrictions []Product_Item_Price_Account_Restriction `json:"priceRestrictions,omitempty" xmlrpc:"priceRestrictions,omitempty"` // A count of all priority one tickets associated with an account. PriorityOneTicketCount *uint `json:"priorityOneTicketCount,omitempty" xmlrpc:"priorityOneTicketCount,omitempty"` // All priority one tickets associated with an account. PriorityOneTickets []Ticket `json:"priorityOneTickets,omitempty" xmlrpc:"priorityOneTickets,omitempty"` // A count of private and shared template group objects (parent only) for an account. PrivateBlockDeviceTemplateGroupCount *uint `json:"privateBlockDeviceTemplateGroupCount,omitempty" xmlrpc:"privateBlockDeviceTemplateGroupCount,omitempty"` // Private and shared template group objects (parent only) for an account. PrivateBlockDeviceTemplateGroups []Virtual_Guest_Block_Device_Template_Group `json:"privateBlockDeviceTemplateGroups,omitempty" xmlrpc:"privateBlockDeviceTemplateGroups,omitempty"` // A count of PrivateIpAddressCount *uint `json:"privateIpAddressCount,omitempty" xmlrpc:"privateIpAddressCount,omitempty"` // no documentation yet PrivateIpAddresses []Network_Subnet_IpAddress `json:"privateIpAddresses,omitempty" xmlrpc:"privateIpAddresses,omitempty"` // A count of the private network VLANs assigned to an account. PrivateNetworkVlanCount *uint `json:"privateNetworkVlanCount,omitempty" xmlrpc:"privateNetworkVlanCount,omitempty"` // The private network VLANs assigned to an account. PrivateNetworkVlans []Network_Vlan `json:"privateNetworkVlans,omitempty" xmlrpc:"privateNetworkVlans,omitempty"` // A count of all private subnets associated with an account. PrivateSubnetCount *uint `json:"privateSubnetCount,omitempty" xmlrpc:"privateSubnetCount,omitempty"` // All private subnets associated with an account. PrivateSubnets []Network_Subnet `json:"privateSubnets,omitempty" xmlrpc:"privateSubnets,omitempty"` // Boolean flag indicating whether or not this account is a Proof of Concept account. ProofOfConceptAccountFlag *bool `json:"proofOfConceptAccountFlag,omitempty" xmlrpc:"proofOfConceptAccountFlag,omitempty"` // A count of PublicIpAddressCount *uint `json:"publicIpAddressCount,omitempty" xmlrpc:"publicIpAddressCount,omitempty"` // no documentation yet PublicIpAddresses []Network_Subnet_IpAddress `json:"publicIpAddresses,omitempty" xmlrpc:"publicIpAddresses,omitempty"` // A count of the public network VLANs assigned to an account. PublicNetworkVlanCount *uint `json:"publicNetworkVlanCount,omitempty" xmlrpc:"publicNetworkVlanCount,omitempty"` // The public network VLANs assigned to an account. PublicNetworkVlans []Network_Vlan `json:"publicNetworkVlans,omitempty" xmlrpc:"publicNetworkVlans,omitempty"` // A count of all public network subnets associated with an account. PublicSubnetCount *uint `json:"publicSubnetCount,omitempty" xmlrpc:"publicSubnetCount,omitempty"` // All public network subnets associated with an account. PublicSubnets []Network_Subnet `json:"publicSubnets,omitempty" xmlrpc:"publicSubnets,omitempty"` // A count of an account's quotes. QuoteCount *uint `json:"quoteCount,omitempty" xmlrpc:"quoteCount,omitempty"` // An account's quotes. Quotes []Billing_Order_Quote `json:"quotes,omitempty" xmlrpc:"quotes,omitempty"` // A count of RecentEventCount *uint `json:"recentEventCount,omitempty" xmlrpc:"recentEventCount,omitempty"` // no documentation yet RecentEvents []Notification_Occurrence_Event `json:"recentEvents,omitempty" xmlrpc:"recentEvents,omitempty"` // The Referral Partner for this account, if any. ReferralPartner *Account `json:"referralPartner,omitempty" xmlrpc:"referralPartner,omitempty"` // A count of if this is a account is a referral partner, the accounts this referral partner has referred ReferredAccountCount *uint `json:"referredAccountCount,omitempty" xmlrpc:"referredAccountCount,omitempty"` // Flag indicating if the account was referred. ReferredAccountFlag *bool `json:"referredAccountFlag,omitempty" xmlrpc:"referredAccountFlag,omitempty"` // If this is a account is a referral partner, the accounts this referral partner has referred ReferredAccounts []Account `json:"referredAccounts,omitempty" xmlrpc:"referredAccounts,omitempty"` // A count of RegulatedWorkloadCount *uint `json:"regulatedWorkloadCount,omitempty" xmlrpc:"regulatedWorkloadCount,omitempty"` // no documentation yet RegulatedWorkloads []Legal_RegulatedWorkload `json:"regulatedWorkloads,omitempty" xmlrpc:"regulatedWorkloads,omitempty"` // A count of remote management command requests for an account RemoteManagementCommandRequestCount *uint `json:"remoteManagementCommandRequestCount,omitempty" xmlrpc:"remoteManagementCommandRequestCount,omitempty"` // Remote management command requests for an account RemoteManagementCommandRequests []Hardware_Component_RemoteManagement_Command_Request `json:"remoteManagementCommandRequests,omitempty" xmlrpc:"remoteManagementCommandRequests,omitempty"` // A count of the Replication events for all Network Storage volumes on an account. ReplicationEventCount *uint `json:"replicationEventCount,omitempty" xmlrpc:"replicationEventCount,omitempty"` // The Replication events for all Network Storage volumes on an account. ReplicationEvents []Network_Storage_Event `json:"replicationEvents,omitempty" xmlrpc:"replicationEvents,omitempty"` // Indicates whether newly created users under this account will be associated with IBMid via an email requiring a response, or not. RequireSilentIBMidUserCreation *bool `json:"requireSilentIBMidUserCreation,omitempty" xmlrpc:"requireSilentIBMidUserCreation,omitempty"` // The Reseller level of the account. ResellerLevel *int `json:"resellerLevel,omitempty" xmlrpc:"resellerLevel,omitempty"` // A count of all reserved capacity agreements for an account ReservedCapacityAgreementCount *uint `json:"reservedCapacityAgreementCount,omitempty" xmlrpc:"reservedCapacityAgreementCount,omitempty"` // All reserved capacity agreements for an account ReservedCapacityAgreements []Account_Agreement `json:"reservedCapacityAgreements,omitempty" xmlrpc:"reservedCapacityAgreements,omitempty"` // A count of the reserved capacity groups owned by this account. ReservedCapacityGroupCount *uint `json:"reservedCapacityGroupCount,omitempty" xmlrpc:"reservedCapacityGroupCount,omitempty"` // The reserved capacity groups owned by this account. ReservedCapacityGroups []Virtual_ReservedCapacityGroup `json:"reservedCapacityGroups,omitempty" xmlrpc:"reservedCapacityGroups,omitempty"` // A count of all Routers that an accounts VLANs reside on RouterCount *uint `json:"routerCount,omitempty" xmlrpc:"routerCount,omitempty"` // All Routers that an accounts VLANs reside on Routers []Hardware `json:"routers,omitempty" xmlrpc:"routers,omitempty"` // DEPRECATED // Deprecated: This function has been marked as deprecated. RwhoisData []Network_Subnet_Rwhois_Data `json:"rwhoisData,omitempty" xmlrpc:"rwhoisData,omitempty"` // A count of dEPRECATED RwhoisDataCount *uint `json:"rwhoisDataCount,omitempty" xmlrpc:"rwhoisDataCount,omitempty"` // The SAML configuration for this account. SamlAuthentication *Account_Authentication_Saml `json:"samlAuthentication,omitempty" xmlrpc:"samlAuthentication,omitempty"` // A count of the secondary DNS records for a SoftLayer customer account. SecondaryDomainCount *uint `json:"secondaryDomainCount,omitempty" xmlrpc:"secondaryDomainCount,omitempty"` // The secondary DNS records for a SoftLayer customer account. SecondaryDomains []Dns_Secondary `json:"secondaryDomains,omitempty" xmlrpc:"secondaryDomains,omitempty"` // A count of stored security certificates (ie. SSL) SecurityCertificateCount *uint `json:"securityCertificateCount,omitempty" xmlrpc:"securityCertificateCount,omitempty"` // Stored security certificates (ie. SSL) SecurityCertificates []Security_Certificate `json:"securityCertificates,omitempty" xmlrpc:"securityCertificates,omitempty"` // A count of the security groups belonging to this account. SecurityGroupCount *uint `json:"securityGroupCount,omitempty" xmlrpc:"securityGroupCount,omitempty"` // The security groups belonging to this account. SecurityGroups []Network_SecurityGroup `json:"securityGroups,omitempty" xmlrpc:"securityGroups,omitempty"` // no documentation yet SecurityLevel *Security_Level `json:"securityLevel,omitempty" xmlrpc:"securityLevel,omitempty"` // A count of an account's vulnerability scan requests. SecurityScanRequestCount *uint `json:"securityScanRequestCount,omitempty" xmlrpc:"securityScanRequestCount,omitempty"` // An account's vulnerability scan requests. SecurityScanRequests []Network_Security_Scanner_Request `json:"securityScanRequests,omitempty" xmlrpc:"securityScanRequests,omitempty"` // A count of the service billing items that will be on an account's next invoice. ServiceBillingItemCount *uint `json:"serviceBillingItemCount,omitempty" xmlrpc:"serviceBillingItemCount,omitempty"` // The service billing items that will be on an account's next invoice. ServiceBillingItems []Billing_Item `json:"serviceBillingItems,omitempty" xmlrpc:"serviceBillingItems,omitempty"` // A count of shipments that belong to the customer's account. ShipmentCount *uint `json:"shipmentCount,omitempty" xmlrpc:"shipmentCount,omitempty"` // Shipments that belong to the customer's account. Shipments []Account_Shipment `json:"shipments,omitempty" xmlrpc:"shipments,omitempty"` // A count of customer specified SSH keys that can be implemented onto a newly provisioned or reloaded server. SshKeyCount *uint `json:"sshKeyCount,omitempty" xmlrpc:"sshKeyCount,omitempty"` // Customer specified SSH keys that can be implemented onto a newly provisioned or reloaded server. SshKeys []Security_Ssh_Key `json:"sshKeys,omitempty" xmlrpc:"sshKeys,omitempty"` // A count of an account's associated portal users with SSL VPN access. SslVpnUserCount *uint `json:"sslVpnUserCount,omitempty" xmlrpc:"sslVpnUserCount,omitempty"` // An account's associated portal users with SSL VPN access. SslVpnUsers []User_Customer `json:"sslVpnUsers,omitempty" xmlrpc:"sslVpnUsers,omitempty"` // A count of an account's virtual guest objects that are hosted on a user provisioned hypervisor. StandardPoolVirtualGuestCount *uint `json:"standardPoolVirtualGuestCount,omitempty" xmlrpc:"standardPoolVirtualGuestCount,omitempty"` // An account's virtual guest objects that are hosted on a user provisioned hypervisor. StandardPoolVirtualGuests []Virtual_Guest `json:"standardPoolVirtualGuests,omitempty" xmlrpc:"standardPoolVirtualGuests,omitempty"` // 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. State *string `json:"state,omitempty" xmlrpc:"state,omitempty"` // The date of an account's last status change. StatusDate *Time `json:"statusDate,omitempty" xmlrpc:"statusDate,omitempty"` // A count of all network subnets associated with an account. SubnetCount *uint `json:"subnetCount,omitempty" xmlrpc:"subnetCount,omitempty"` // A count of SubnetRegistrationCount *uint `json:"subnetRegistrationCount,omitempty" xmlrpc:"subnetRegistrationCount,omitempty"` // A count of SubnetRegistrationDetailCount *uint `json:"subnetRegistrationDetailCount,omitempty" xmlrpc:"subnetRegistrationDetailCount,omitempty"` // no documentation yet // Deprecated: This function has been marked as deprecated. SubnetRegistrationDetails []Account_Regional_Registry_Detail `json:"subnetRegistrationDetails,omitempty" xmlrpc:"subnetRegistrationDetails,omitempty"` // no documentation yet // Deprecated: This function has been marked as deprecated. SubnetRegistrations []Network_Subnet_Registration `json:"subnetRegistrations,omitempty" xmlrpc:"subnetRegistrations,omitempty"` // All network subnets associated with an account. Subnets []Network_Subnet `json:"subnets,omitempty" xmlrpc:"subnets,omitempty"` // A count of the SoftLayer employees that an account is assigned to. SupportRepresentativeCount *uint `json:"supportRepresentativeCount,omitempty" xmlrpc:"supportRepresentativeCount,omitempty"` // The SoftLayer employees that an account is assigned to. SupportRepresentatives []User_Employee `json:"supportRepresentatives,omitempty" xmlrpc:"supportRepresentatives,omitempty"` // A count of the active support subscriptions for this account. SupportSubscriptionCount *uint `json:"supportSubscriptionCount,omitempty" xmlrpc:"supportSubscriptionCount,omitempty"` // The active support subscriptions for this account. SupportSubscriptions []Billing_Item `json:"supportSubscriptions,omitempty" xmlrpc:"supportSubscriptions,omitempty"` // no documentation yet SupportTier *string `json:"supportTier,omitempty" xmlrpc:"supportTier,omitempty"` // A flag indicating to suppress invoices. SuppressInvoicesFlag *bool `json:"suppressInvoicesFlag,omitempty" xmlrpc:"suppressInvoicesFlag,omitempty"` // A count of TagCount *uint `json:"tagCount,omitempty" xmlrpc:"tagCount,omitempty"` // no documentation yet Tags []Tag `json:"tags,omitempty" xmlrpc:"tags,omitempty"` // Account attribute flag indicating test account. TestAccountAttributeFlag *bool `json:"testAccountAttributeFlag,omitempty" xmlrpc:"testAccountAttributeFlag,omitempty"` // A count of an account's associated tickets. TicketCount *uint `json:"ticketCount,omitempty" xmlrpc:"ticketCount,omitempty"` // An account's associated tickets. Tickets []Ticket `json:"tickets,omitempty" xmlrpc:"tickets,omitempty"` // Tickets closed within the last 72 hours or last 10 tickets, whichever is less, associated with an account. TicketsClosedInTheLastThreeDays []Ticket `json:"ticketsClosedInTheLastThreeDays,omitempty" xmlrpc:"ticketsClosedInTheLastThreeDays,omitempty"` // A count of tickets closed within the last 72 hours or last 10 tickets, whichever is less, associated with an account. TicketsClosedInTheLastThreeDaysCount *uint `json:"ticketsClosedInTheLastThreeDaysCount,omitempty" xmlrpc:"ticketsClosedInTheLastThreeDaysCount,omitempty"` // Tickets closed today associated with an account. TicketsClosedToday []Ticket `json:"ticketsClosedToday,omitempty" xmlrpc:"ticketsClosedToday,omitempty"` // A count of tickets closed today associated with an account. TicketsClosedTodayCount *uint `json:"ticketsClosedTodayCount,omitempty" xmlrpc:"ticketsClosedTodayCount,omitempty"` // A count of an account's associated upgrade requests. UpgradeRequestCount *uint `json:"upgradeRequestCount,omitempty" xmlrpc:"upgradeRequestCount,omitempty"` // An account's associated upgrade requests. UpgradeRequests []Product_Upgrade_Request `json:"upgradeRequests,omitempty" xmlrpc:"upgradeRequests,omitempty"` // A count of an account's portal users. UserCount *uint `json:"userCount,omitempty" xmlrpc:"userCount,omitempty"` // An account's portal users. Users []User_Customer `json:"users,omitempty" xmlrpc:"users,omitempty"` // A count of stored security certificates that are not expired (ie. SSL) ValidSecurityCertificateCount *uint `json:"validSecurityCertificateCount,omitempty" xmlrpc:"validSecurityCertificateCount,omitempty"` // Stored security certificates that are not expired (ie. SSL) ValidSecurityCertificates []Security_Certificate `json:"validSecurityCertificates,omitempty" xmlrpc:"validSecurityCertificates,omitempty"` // A count of the bandwidth pooling for this account. VirtualDedicatedRackCount *uint `json:"virtualDedicatedRackCount,omitempty" xmlrpc:"virtualDedicatedRackCount,omitempty"` // The bandwidth pooling for this account. VirtualDedicatedRacks []Network_Bandwidth_Version1_Allotment `json:"virtualDedicatedRacks,omitempty" xmlrpc:"virtualDedicatedRacks,omitempty"` // A count of an account's associated virtual server virtual disk images. VirtualDiskImageCount *uint `json:"virtualDiskImageCount,omitempty" xmlrpc:"virtualDiskImageCount,omitempty"` // An account's associated virtual server virtual disk images. VirtualDiskImages []Virtual_Disk_Image `json:"virtualDiskImages,omitempty" xmlrpc:"virtualDiskImages,omitempty"` // A count of an account's associated virtual guest objects. VirtualGuestCount *uint `json:"virtualGuestCount,omitempty" xmlrpc:"virtualGuestCount,omitempty"` // An account's associated virtual guest objects. VirtualGuests []Virtual_Guest `json:"virtualGuests,omitempty" xmlrpc:"virtualGuests,omitempty"` // An account's associated virtual guest objects currently over bandwidth allocation. VirtualGuestsOverBandwidthAllocation []Virtual_Guest `json:"virtualGuestsOverBandwidthAllocation,omitempty" xmlrpc:"virtualGuestsOverBandwidthAllocation,omitempty"` // A count of an account's associated virtual guest objects currently over bandwidth allocation. VirtualGuestsOverBandwidthAllocationCount *uint `json:"virtualGuestsOverBandwidthAllocationCount,omitempty" xmlrpc:"virtualGuestsOverBandwidthAllocationCount,omitempty"` // An account's associated virtual guest objects currently over bandwidth allocation. VirtualGuestsProjectedOverBandwidthAllocation []Virtual_Guest `` /* 127-byte string literal not displayed */ // A count of an account's associated virtual guest objects currently over bandwidth allocation. VirtualGuestsProjectedOverBandwidthAllocationCount *uint `` /* 137-byte string literal not displayed */ // All virtual guests associated with an account that has the cPanel web hosting control panel installed. VirtualGuestsWithCpanel []Virtual_Guest `json:"virtualGuestsWithCpanel,omitempty" xmlrpc:"virtualGuestsWithCpanel,omitempty"` // A count of all virtual guests associated with an account that has the cPanel web hosting control panel installed. VirtualGuestsWithCpanelCount *uint `json:"virtualGuestsWithCpanelCount,omitempty" xmlrpc:"virtualGuestsWithCpanelCount,omitempty"` // All virtual guests associated with an account that have McAfee Secure software components. VirtualGuestsWithMcafee []Virtual_Guest `json:"virtualGuestsWithMcafee,omitempty" xmlrpc:"virtualGuestsWithMcafee,omitempty"` // All virtual guests associated with an account that have McAfee Secure AntiVirus for Redhat software components. VirtualGuestsWithMcafeeAntivirusRedhat []Virtual_Guest `json:"virtualGuestsWithMcafeeAntivirusRedhat,omitempty" xmlrpc:"virtualGuestsWithMcafeeAntivirusRedhat,omitempty"` // A count of all virtual guests associated with an account that have McAfee Secure AntiVirus for Redhat software components. VirtualGuestsWithMcafeeAntivirusRedhatCount *uint `json:"virtualGuestsWithMcafeeAntivirusRedhatCount,omitempty" xmlrpc:"virtualGuestsWithMcafeeAntivirusRedhatCount,omitempty"` // A count of all virtual guests associated with an account that has McAfee Secure AntiVirus for Windows software components. VirtualGuestsWithMcafeeAntivirusWindowCount *uint `json:"virtualGuestsWithMcafeeAntivirusWindowCount,omitempty" xmlrpc:"virtualGuestsWithMcafeeAntivirusWindowCount,omitempty"` // All virtual guests associated with an account that has McAfee Secure AntiVirus for Windows software components. VirtualGuestsWithMcafeeAntivirusWindows []Virtual_Guest `json:"virtualGuestsWithMcafeeAntivirusWindows,omitempty" xmlrpc:"virtualGuestsWithMcafeeAntivirusWindows,omitempty"` // A count of all virtual guests associated with an account that have McAfee Secure software components. VirtualGuestsWithMcafeeCount *uint `json:"virtualGuestsWithMcafeeCount,omitempty" xmlrpc:"virtualGuestsWithMcafeeCount,omitempty"` // All virtual guests associated with an account that has McAfee Secure Intrusion Detection System software components. VirtualGuestsWithMcafeeIntrusionDetectionSystem []Virtual_Guest `` /* 131-byte string literal not displayed */ // A count of all virtual guests associated with an account that has McAfee Secure Intrusion Detection System software components. VirtualGuestsWithMcafeeIntrusionDetectionSystemCount *uint `` /* 141-byte string literal not displayed */ // All virtual guests associated with an account that has the Plesk web hosting control panel installed. VirtualGuestsWithPlesk []Virtual_Guest `json:"virtualGuestsWithPlesk,omitempty" xmlrpc:"virtualGuestsWithPlesk,omitempty"` // A count of all virtual guests associated with an account that has the Plesk web hosting control panel installed. VirtualGuestsWithPleskCount *uint `json:"virtualGuestsWithPleskCount,omitempty" xmlrpc:"virtualGuestsWithPleskCount,omitempty"` // All virtual guests associated with an account that have the QuantaStor storage system installed. VirtualGuestsWithQuantastor []Virtual_Guest `json:"virtualGuestsWithQuantastor,omitempty" xmlrpc:"virtualGuestsWithQuantastor,omitempty"` // A count of all virtual guests associated with an account that have the QuantaStor storage system installed. VirtualGuestsWithQuantastorCount *uint `json:"virtualGuestsWithQuantastorCount,omitempty" xmlrpc:"virtualGuestsWithQuantastorCount,omitempty"` // All virtual guests associated with an account that has the Urchin web traffic analytics package installed. VirtualGuestsWithUrchin []Virtual_Guest `json:"virtualGuestsWithUrchin,omitempty" xmlrpc:"virtualGuestsWithUrchin,omitempty"` // A count of all virtual guests associated with an account that has the Urchin web traffic analytics package installed. VirtualGuestsWithUrchinCount *uint `json:"virtualGuestsWithUrchinCount,omitempty" xmlrpc:"virtualGuestsWithUrchinCount,omitempty"` // The bandwidth pooling for this account. VirtualPrivateRack *Network_Bandwidth_Version1_Allotment `json:"virtualPrivateRack,omitempty" xmlrpc:"virtualPrivateRack,omitempty"` // An account's associated virtual server archived storage repositories. VirtualStorageArchiveRepositories []Virtual_Storage_Repository `json:"virtualStorageArchiveRepositories,omitempty" xmlrpc:"virtualStorageArchiveRepositories,omitempty"` // A count of an account's associated virtual server archived storage repositories. VirtualStorageArchiveRepositoryCount *uint `json:"virtualStorageArchiveRepositoryCount,omitempty" xmlrpc:"virtualStorageArchiveRepositoryCount,omitempty"` // An account's associated virtual server public storage repositories. VirtualStoragePublicRepositories []Virtual_Storage_Repository `json:"virtualStoragePublicRepositories,omitempty" xmlrpc:"virtualStoragePublicRepositories,omitempty"` // A count of an account's associated virtual server public storage repositories. VirtualStoragePublicRepositoryCount *uint `json:"virtualStoragePublicRepositoryCount,omitempty" xmlrpc:"virtualStoragePublicRepositoryCount,omitempty"` // A count of an account's associated VPC configured virtual guest objects. VpcVirtualGuestCount *uint `json:"vpcVirtualGuestCount,omitempty" xmlrpc:"vpcVirtualGuestCount,omitempty"` // An account's associated VPC configured virtual guest objects. VpcVirtualGuests []Virtual_Guest `json:"vpcVirtualGuests,omitempty" xmlrpc:"vpcVirtualGuests,omitempty"` // no documentation yet VpnConfigRequiresVPNManageFlag *bool `json:"vpnConfigRequiresVPNManageFlag,omitempty" xmlrpc:"vpnConfigRequiresVPNManageFlag,omitempty"` }
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.
type Account_AbuseEmail ¶
type Account_AbuseEmail struct { Entity // The account associated with an abuse email address. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // A valid email address. Email *string `json:"email,omitempty" xmlrpc:"email,omitempty"` }
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.
type Account_Address ¶
type Account_Address struct { Entity // The account to which this address belongs. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // no documentation yet AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // Line 1 of the address (normally the street address). Address1 *string `json:"address1,omitempty" xmlrpc:"address1,omitempty"` // Line 2 of the address. Address2 *string `json:"address2,omitempty" xmlrpc:"address2,omitempty"` // The city of the address. City *string `json:"city,omitempty" xmlrpc:"city,omitempty"` // The contact name (person, office) of the address. ContactName *string `json:"contactName,omitempty" xmlrpc:"contactName,omitempty"` // The country of the address. Country *string `json:"country,omitempty" xmlrpc:"country,omitempty"` // The customer user who created this address. CreateUser *User_Customer `json:"createUser,omitempty" xmlrpc:"createUser,omitempty"` // The description of the address. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // The unique id of the address. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Flag to show whether the address is active. IsActive *int `json:"isActive,omitempty" xmlrpc:"isActive,omitempty"` // The location of this address. Location *Location `json:"location,omitempty" xmlrpc:"location,omitempty"` // The location id of the address. LocationId *int `json:"locationId,omitempty" xmlrpc:"locationId,omitempty"` // The employee who last modified this address. ModifyEmployee *User_Employee `json:"modifyEmployee,omitempty" xmlrpc:"modifyEmployee,omitempty"` // The customer user who last modified this address. ModifyUser *User_Customer `json:"modifyUser,omitempty" xmlrpc:"modifyUser,omitempty"` // The postal (zip) code of the address. PostalCode *string `json:"postalCode,omitempty" xmlrpc:"postalCode,omitempty"` // The state of the address. State *string `json:"state,omitempty" xmlrpc:"state,omitempty"` // An account address' type. Type *Account_Address_Type `json:"type,omitempty" xmlrpc:"type,omitempty"` }
The SoftLayer_Account_Address data type contains information on an address associated with a SoftLayer account.
type Account_Address_Type ¶
type Account_Address_Type struct { Entity // DEPRECATED // Deprecated: This function has been marked as deprecated. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
no documentation yet
type Account_Affiliation ¶
type Account_Affiliation struct { Entity // The account that an affiliation belongs to. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // A customer account's internal identifier. AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // An affiliate identifier associated with the customer account. AffiliateId *string `json:"affiliateId,omitempty" xmlrpc:"affiliateId,omitempty"` // The date an account affiliation was created. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // A customer affiliation internal identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The date an account affiliation was last modified. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` }
This service allows for a unique identifier to be associated to an existing customer account.
type Account_Agreement ¶
type Account_Agreement struct { Entity // no documentation yet Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // The type of agreement. AgreementType *Account_Agreement_Type `json:"agreementType,omitempty" xmlrpc:"agreementType,omitempty"` // The type of agreement identifier. AgreementTypeId *int `json:"agreementTypeId,omitempty" xmlrpc:"agreementTypeId,omitempty"` // A count of the files attached to an agreement. AttachedBillingAgreementFileCount *uint `json:"attachedBillingAgreementFileCount,omitempty" xmlrpc:"attachedBillingAgreementFileCount,omitempty"` // The files attached to an agreement. AttachedBillingAgreementFiles []Account_MasterServiceAgreement `json:"attachedBillingAgreementFiles,omitempty" xmlrpc:"attachedBillingAgreementFiles,omitempty"` // no documentation yet AutoRenew *int `json:"autoRenew,omitempty" xmlrpc:"autoRenew,omitempty"` // A count of the billing items associated with an agreement. BillingItemCount *uint `json:"billingItemCount,omitempty" xmlrpc:"billingItemCount,omitempty"` // The billing items associated with an agreement. BillingItems []Billing_Item `json:"billingItems,omitempty" xmlrpc:"billingItems,omitempty"` // no documentation yet CancellationFee *int `json:"cancellationFee,omitempty" xmlrpc:"cancellationFee,omitempty"` // The date an agreement was created. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // The duration in months of an agreement. DurationMonths *int `json:"durationMonths,omitempty" xmlrpc:"durationMonths,omitempty"` // The end date of an agreement. EndDate *Time `json:"endDate,omitempty" xmlrpc:"endDate,omitempty"` // An agreement's internal identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The effective start date of an agreement. StartDate *Time `json:"startDate,omitempty" xmlrpc:"startDate,omitempty"` // The status of the agreement. Status *Account_Agreement_Status `json:"status,omitempty" xmlrpc:"status,omitempty"` // The status identifier for an agreement. StatusId *int `json:"statusId,omitempty" xmlrpc:"statusId,omitempty"` // The title of an agreement. Title *string `json:"title,omitempty" xmlrpc:"title,omitempty"` // A count of the top level billing item associated with an agreement. TopLevelBillingItemCount *uint `json:"topLevelBillingItemCount,omitempty" xmlrpc:"topLevelBillingItemCount,omitempty"` // The top level billing item associated with an agreement. TopLevelBillingItems []Billing_Item `json:"topLevelBillingItems,omitempty" xmlrpc:"topLevelBillingItems,omitempty"` }
no documentation yet
type Account_Agreement_Status ¶
type Account_Agreement_Status struct { Entity // The name of the agreement status. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
no documentation yet
type Account_Agreement_Type ¶
type Account_Agreement_Type struct { Entity // The name of the agreement type. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
no documentation yet
type Account_Attachment_Employee ¶
type Account_Attachment_Employee struct { Entity // A [[SoftLayer_Account|account]] that is assigned to a [[SoftLayer_User_Employee|employee]]. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // A [[SoftLayer_User_Employee|employee]] that is assigned to a [[SoftLayer_Account|account]]. Employee *User_Employee `json:"employee,omitempty" xmlrpc:"employee,omitempty"` // A [[SoftLayer_User_Employee|employee]] that is assigned to a [[SoftLayer_Account|account]]. EmployeeRole *Account_Attachment_Employee_Role `json:"employeeRole,omitempty" xmlrpc:"employeeRole,omitempty"` // Role identifier. // Deprecated: This function has been marked as deprecated. RoleId *int `json:"roleId,omitempty" xmlrpc:"roleId,omitempty"` }
A SoftLayer_Account_Attachment_Employee models an assignment of a single [[SoftLayer_User_Employee|employee]] with a single [[SoftLayer_Account|account]]
type Account_Attachment_Employee_Role ¶
type Account_Attachment_Employee_Role struct { Entity // no documentation yet Keyname *string `json:"keyname,omitempty" xmlrpc:"keyname,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
no documentation yet
type Account_Attribute ¶
type Account_Attribute struct { Entity // The SoftLayer customer account that has an attribute. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // The type of attribute assigned to a SoftLayer customer account. AccountAttributeType *Account_Attribute_Type `json:"accountAttributeType,omitempty" xmlrpc:"accountAttributeType,omitempty"` // The internal identifier of the type of attribute that a SoftLayer customer account attribute belongs to. AccountAttributeTypeId *int `json:"accountAttributeTypeId,omitempty" xmlrpc:"accountAttributeTypeId,omitempty"` // The internal identifier of the SoftLayer customer account that is assigned an account attribute. AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // A SoftLayer customer account attribute's internal identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A SoftLayer account attribute's value. Value *string `json:"value,omitempty" xmlrpc:"value,omitempty"` }
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.
type Account_Attribute_Type ¶
type Account_Attribute_Type struct { Entity // A brief description of a SoftLayer account attribute type. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // A SoftLayer account attribute type's internal identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A SoftLayer account attribute type's key name. This is typically a shorter version of an attribute type's name. KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // A SoftLayer account attribute type's name. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
SoftLayer_Account_Attribute_Type models the type of attribute that can be assigned to a SoftLayer customer account.
type Account_Authentication_Attribute ¶
type Account_Authentication_Attribute struct { Entity // The SoftLayer customer account. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // The internal identifier of the SoftLayer customer account that is assigned an account authentication attribute. AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // The SoftLayer account authentication that has an attribute. AuthenticationRecord *Account_Authentication_Saml `json:"authenticationRecord,omitempty" xmlrpc:"authenticationRecord,omitempty"` // A SoftLayer account authentication attribute's internal identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The type of attribute assigned to a SoftLayer account authentication. Type *Account_Authentication_Attribute_Type `json:"type,omitempty" xmlrpc:"type,omitempty"` // The internal identifier of the type of attribute that a SoftLayer account authentication attribute belongs to. TypeId *int `json:"typeId,omitempty" xmlrpc:"typeId,omitempty"` // A SoftLayer account authentication attribute's value. Value *string `json:"value,omitempty" xmlrpc:"value,omitempty"` }
Account authentication has many different settings that can be set. This class allows the customer or employee to set these settings.
type Account_Authentication_Attribute_Type ¶
type Account_Authentication_Attribute_Type struct { Entity // A brief description of a SoftLayer account authentication attribute type. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // A SoftLayer account authentication attribute type's internal identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A SoftLayer account authentication attribute type's key name. This is typically a shorter version of an attribute type's name. KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // A SoftLayer account authentication attribute type's name. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // An example of what you can put in as your value. ValueExample *string `json:"valueExample,omitempty" xmlrpc:"valueExample,omitempty"` }
SoftLayer_Account_Authentication_Attribute_Type models the type of attribute that can be assigned to a SoftLayer customer account authentication.
type Account_Authentication_OpenIdConnect_Option ¶
type Account_Authentication_OpenIdConnect_Option struct { Entity // no documentation yet Key *string `json:"key,omitempty" xmlrpc:"key,omitempty"` // no documentation yet Value *string `json:"value,omitempty" xmlrpc:"value,omitempty"` }
no documentation yet
type Account_Authentication_OpenIdConnect_RegistrationInformation ¶
type Account_Authentication_OpenIdConnect_RegistrationInformation struct { Entity // no documentation yet ExistingBlueIdFlag *bool `json:"existingBlueIdFlag,omitempty" xmlrpc:"existingBlueIdFlag,omitempty"` // no documentation yet FederatedEmailDomainFlag *bool `json:"federatedEmailDomainFlag,omitempty" xmlrpc:"federatedEmailDomainFlag,omitempty"` // no documentation yet User *User_Customer `json:"user,omitempty" xmlrpc:"user,omitempty"` }
no documentation yet
type Account_Authentication_Saml ¶
type Account_Authentication_Saml struct { Entity // The account associated with this saml configuration. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // The saml account id. AccountId *string `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // A count of the saml attribute values for a SoftLayer customer account. AttributeCount *uint `json:"attributeCount,omitempty" xmlrpc:"attributeCount,omitempty"` // The saml attribute values for a SoftLayer customer account. Attributes []Account_Authentication_Attribute `json:"attributes,omitempty" xmlrpc:"attributes,omitempty"` // The identity provider x509 certificate. Certificate *string `json:"certificate,omitempty" xmlrpc:"certificate,omitempty"` // The identity provider x509 certificate fingerprint. CertificateFingerprint *string `json:"certificateFingerprint,omitempty" xmlrpc:"certificateFingerprint,omitempty"` // The identity provider entity ID. EntityId *string `json:"entityId,omitempty" xmlrpc:"entityId,omitempty"` // The saml internal identifying number. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The service provider x509 certificate. ServiceProviderCertificate *string `json:"serviceProviderCertificate,omitempty" xmlrpc:"serviceProviderCertificate,omitempty"` // The service provider entity IDs. ServiceProviderEntityId *string `json:"serviceProviderEntityId,omitempty" xmlrpc:"serviceProviderEntityId,omitempty"` // The service provider public key. ServiceProviderPublicKey *string `json:"serviceProviderPublicKey,omitempty" xmlrpc:"serviceProviderPublicKey,omitempty"` // The service provider signle logout encoding. ServiceProviderSingleLogoutEncoding *string `json:"serviceProviderSingleLogoutEncoding,omitempty" xmlrpc:"serviceProviderSingleLogoutEncoding,omitempty"` // The service provider signle logout address. ServiceProviderSingleLogoutUrl *string `json:"serviceProviderSingleLogoutUrl,omitempty" xmlrpc:"serviceProviderSingleLogoutUrl,omitempty"` // The service provider signle sign on encoding. ServiceProviderSingleSignOnEncoding *string `json:"serviceProviderSingleSignOnEncoding,omitempty" xmlrpc:"serviceProviderSingleSignOnEncoding,omitempty"` // The service provider signle sign on address. ServiceProviderSingleSignOnUrl *string `json:"serviceProviderSingleSignOnUrl,omitempty" xmlrpc:"serviceProviderSingleSignOnUrl,omitempty"` // The identity provider single logout encoding. SingleLogoutEncoding *string `json:"singleLogoutEncoding,omitempty" xmlrpc:"singleLogoutEncoding,omitempty"` // The identity provider sigle logout address. SingleLogoutUrl *string `json:"singleLogoutUrl,omitempty" xmlrpc:"singleLogoutUrl,omitempty"` // The identity provider single sign on encoding. SingleSignOnEncoding *string `json:"singleSignOnEncoding,omitempty" xmlrpc:"singleSignOnEncoding,omitempty"` // The identity provider signle sign on address. SingleSignOnUrl *string `json:"singleSignOnUrl,omitempty" xmlrpc:"singleSignOnUrl,omitempty"` }
no documentation yet
type Account_Brand_Migration_Request ¶ added in v1.1.3
type Account_Brand_Migration_Request struct { Entity // no documentation yet Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // ID of the [[SoftLayer_Account]]. AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // Timestamp of when the request was created. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // no documentation yet DestinationBrand *Brand `json:"destinationBrand,omitempty" xmlrpc:"destinationBrand,omitempty"` // ID of the target [[SoftLayer_Brand]]. DestinationBrandId *int `json:"destinationBrandId,omitempty" xmlrpc:"destinationBrandId,omitempty"` // ID of the request. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Timestamp of when the migration will happen, or happened in the past. MigrationDate *Time `json:"migrationDate,omitempty" xmlrpc:"migrationDate,omitempty"` // Timestamp of when the request was last modified. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // no documentation yet SourceBrand *Brand `json:"sourceBrand,omitempty" xmlrpc:"sourceBrand,omitempty"` // ID of the source [[SoftLayer_Brand]]. SourceBrandId *int `json:"sourceBrandId,omitempty" xmlrpc:"sourceBrandId,omitempty"` // Status of the request. Status *string `json:"status,omitempty" xmlrpc:"status,omitempty"` // If present, a message giving more details of the current status. StatusMessage *string `json:"statusMessage,omitempty" xmlrpc:"statusMessage,omitempty"` // no documentation yet User *User_Customer `json:"user,omitempty" xmlrpc:"user,omitempty"` }
Represents a request to migrate an account to the owned brand.
type Account_Business_Partner ¶
type Account_Business_Partner struct { Entity // Account associated with the business partner data Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // Channel indicator used to categorize business partner revenue. Channel *Business_Partner_Channel `json:"channel,omitempty" xmlrpc:"channel,omitempty"` // Account business partner channel identifier ChannelId *int `json:"channelId,omitempty" xmlrpc:"channelId,omitempty"` // Account business partner country enterprise code CountryEnterpriseCode *string `json:"countryEnterpriseCode,omitempty" xmlrpc:"countryEnterpriseCode,omitempty"` // Reseller level of an account business partner ResellerLevel *int `json:"resellerLevel,omitempty" xmlrpc:"resellerLevel,omitempty"` // Segment indicator used to categorize business partner revenue. Segment *Business_Partner_Segment `json:"segment,omitempty" xmlrpc:"segment,omitempty"` // Account business partner segment identifier SegmentId *int `json:"segmentId,omitempty" xmlrpc:"segmentId,omitempty"` }
Contains business partner details associated with an account. Country Enterprise Identifier (CEID), Channel ID, Segment ID and Reseller Level.
type Account_Classification_Group_Type ¶
type Account_Classification_Group_Type struct { Entity // no documentation yet KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` }
no documentation yet
type Account_Contact ¶
type Account_Contact struct { Entity // no documentation yet Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // no documentation yet AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // no documentation yet Address1 *string `json:"address1,omitempty" xmlrpc:"address1,omitempty"` // no documentation yet Address2 *string `json:"address2,omitempty" xmlrpc:"address2,omitempty"` // no documentation yet AlternatePhone *string `json:"alternatePhone,omitempty" xmlrpc:"alternatePhone,omitempty"` // no documentation yet City *string `json:"city,omitempty" xmlrpc:"city,omitempty"` // no documentation yet CompanyName *string `json:"companyName,omitempty" xmlrpc:"companyName,omitempty"` // no documentation yet Country *string `json:"country,omitempty" xmlrpc:"country,omitempty"` // no documentation yet CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // no documentation yet Email *string `json:"email,omitempty" xmlrpc:"email,omitempty"` // no documentation yet FaxPhone *string `json:"faxPhone,omitempty" xmlrpc:"faxPhone,omitempty"` // no documentation yet FirstName *string `json:"firstName,omitempty" xmlrpc:"firstName,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet JobTitle *string `json:"jobTitle,omitempty" xmlrpc:"jobTitle,omitempty"` // no documentation yet LastName *string `json:"lastName,omitempty" xmlrpc:"lastName,omitempty"` // no documentation yet ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // no documentation yet OfficePhone *string `json:"officePhone,omitempty" xmlrpc:"officePhone,omitempty"` // no documentation yet PostalCode *string `json:"postalCode,omitempty" xmlrpc:"postalCode,omitempty"` // no documentation yet ProfileName *string `json:"profileName,omitempty" xmlrpc:"profileName,omitempty"` // no documentation yet State *string `json:"state,omitempty" xmlrpc:"state,omitempty"` // no documentation yet Type *Account_Contact_Type `json:"type,omitempty" xmlrpc:"type,omitempty"` // no documentation yet TypeId *int `json:"typeId,omitempty" xmlrpc:"typeId,omitempty"` // no documentation yet Url *string `json:"url,omitempty" xmlrpc:"url,omitempty"` }
no documentation yet
type Account_Contact_Type ¶
type Account_Contact_Type struct { Entity // no documentation yet CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // no documentation yet Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // no documentation yet ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
no documentation yet
type Account_External_Setup ¶
type Account_External_Setup struct { Entity // The SoftLayer customer account the request belongs to. AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // The currency requested after the billing switch. CurrencyId *int `json:"currencyId,omitempty" xmlrpc:"currencyId,omitempty"` // The unique identifier for this setup request. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The external system that will handle billing. ServiceProviderId *int `json:"serviceProviderId,omitempty" xmlrpc:"serviceProviderId,omitempty"` // The status of the account setup request. StatusCode *string `json:"statusCode,omitempty" xmlrpc:"statusCode,omitempty"` // no documentation yet TypeCode *string `json:"typeCode,omitempty" xmlrpc:"typeCode,omitempty"` // The transaction information related to verifying the customer credit card. VerifyCardTransaction *Billing_Payment_Card_Transaction `json:"verifyCardTransaction,omitempty" xmlrpc:"verifyCardTransaction,omitempty"` // The related credit card transaction record for card verification. VerifyCardTransactionId *int `json:"verifyCardTransactionId,omitempty" xmlrpc:"verifyCardTransactionId,omitempty"` }
no documentation yet
type Account_Historical_Report ¶
type Account_Historical_Report struct {
Entity
}
no documentation yet
type Account_Internal_Ibm_CostRecovery_Validator ¶ added in v1.1.3
type Account_Internal_Ibm_CostRecovery_Validator struct {
Entity
}
no documentation yet
type Account_Link ¶
type Account_Link struct { Entity // no documentation yet Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // no documentation yet AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // Authorization token that's included on linking calls. AuthorizationToken *string `json:"authorizationToken,omitempty" xmlrpc:"authorizationToken,omitempty"` // no documentation yet CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // no documentation yet DestinationAccountAlphanumericId *string `json:"destinationAccountAlphanumericId,omitempty" xmlrpc:"destinationAccountAlphanumericId,omitempty"` // no documentation yet DestinationAccountId *int `json:"destinationAccountId,omitempty" xmlrpc:"destinationAccountId,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet ServiceProvider *Service_Provider `json:"serviceProvider,omitempty" xmlrpc:"serviceProvider,omitempty"` // no documentation yet ServiceProviderId *int `json:"serviceProviderId,omitempty" xmlrpc:"serviceProviderId,omitempty"` }
no documentation yet
type Account_Link_OpenStack ¶
type Account_Link_OpenStack struct { Account_Link // Pseudonym for destinationAccountAlphanumericId DomainId *string `json:"domainId,omitempty" xmlrpc:"domainId,omitempty"` }
no documentation yet
type Account_Link_OpenStack_DomainCreationDetails ¶
type Account_Link_OpenStack_DomainCreationDetails struct { Entity // Id for the domain this user was added to. DomainId *string `json:"domainId,omitempty" xmlrpc:"domainId,omitempty"` // Id for the user given the Cloud Admin role for this domain. UserId *string `json:"userId,omitempty" xmlrpc:"userId,omitempty"` // Name for the user given the Cloud Admin role for this domain. UserName *string `json:"userName,omitempty" xmlrpc:"userName,omitempty"` }
OpenStack domain creation details
type Account_Link_OpenStack_LinkRequest ¶
type Account_Link_OpenStack_LinkRequest struct { Entity // Optional password DesiredPassword *string `json:"desiredPassword,omitempty" xmlrpc:"desiredPassword,omitempty"` // Optional projectName DesiredProjectName *string `json:"desiredProjectName,omitempty" xmlrpc:"desiredProjectName,omitempty"` // Required username DesiredUsername *string `json:"desiredUsername,omitempty" xmlrpc:"desiredUsername,omitempty"` }
Details Deprecated.
type Account_Link_OpenStack_ProjectCreationDetails ¶
type Account_Link_OpenStack_ProjectCreationDetails struct { Entity // Id for the domain this project was added to. DomainId *string `json:"domainId,omitempty" xmlrpc:"domainId,omitempty"` // Id for this project. ProjectId *string `json:"projectId,omitempty" xmlrpc:"projectId,omitempty"` // Name for this project. ProjectName *string `json:"projectName,omitempty" xmlrpc:"projectName,omitempty"` // Id for the user given the Project Admin role for this project. UserId *string `json:"userId,omitempty" xmlrpc:"userId,omitempty"` // Name for the user given the Project Admin role for this project. UserName *string `json:"userName,omitempty" xmlrpc:"userName,omitempty"` }
OpenStack project creation details
type Account_Link_OpenStack_ProjectDetails ¶
type Account_Link_OpenStack_ProjectDetails struct { Entity // Id for this project. ProjectId *string `json:"projectId,omitempty" xmlrpc:"projectId,omitempty"` // Name for this project. ProjectName *string `json:"projectName,omitempty" xmlrpc:"projectName,omitempty"` }
OpenStack project details
type Account_Link_Vendor ¶
type Account_Link_Vendor struct { Entity // no documentation yet KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
no documentation yet
type Account_Lockdown_Request ¶
type Account_Lockdown_Request struct { Entity // Account ID associated with this lockdown request. AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // Type of request. Action *string `json:"action,omitempty" xmlrpc:"action,omitempty"` // Timestamp when the lockdown request was initially made. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // ID of this lockdown request. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Timestamp when the lockdown request was modified. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // Status of the lockdown request denoting whether it's been completed. Status *string `json:"status,omitempty" xmlrpc:"status,omitempty"` }
The SoftLayer_Account_Lockdown_Request data type holds information on API requests from brand customers.
type Account_MasterServiceAgreement ¶
type Account_MasterServiceAgreement struct { Entity // no documentation yet Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // no documentation yet AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // no documentation yet Guid *string `json:"guid,omitempty" xmlrpc:"guid,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
no documentation yet
type Account_Media ¶
type Account_Media struct { Entity // The account to which the media belongs. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // The customer user who created the media object. CreateUser *User_Customer `json:"createUser,omitempty" xmlrpc:"createUser,omitempty"` // The datacenter where the media resides. Datacenter *Location `json:"datacenter,omitempty" xmlrpc:"datacenter,omitempty"` // The description of the media. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // The unique id of the media. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The employee who last modified the media. ModifyEmployee *User_Employee `json:"modifyEmployee,omitempty" xmlrpc:"modifyEmployee,omitempty"` // The customer user who last modified the media. ModifyUser *User_Customer `json:"modifyUser,omitempty" xmlrpc:"modifyUser,omitempty"` // The request to which the media belongs. Request *Account_Media_Data_Transfer_Request `json:"request,omitempty" xmlrpc:"request,omitempty"` // The request id of the media. RequestId *int `json:"requestId,omitempty" xmlrpc:"requestId,omitempty"` // The manufacturer's serial number of the media. SerialNumber *string `json:"serialNumber,omitempty" xmlrpc:"serialNumber,omitempty"` // The media's type. Type *Account_Media_Type `json:"type,omitempty" xmlrpc:"type,omitempty"` // The type id of the media. TypeId *int `json:"typeId,omitempty" xmlrpc:"typeId,omitempty"` // A guest's associated EVault network storage service account. Volume *Network_Storage `json:"volume,omitempty" xmlrpc:"volume,omitempty"` }
The SoftLayer_Account_Media data type contains information on a single piece of media associated with a Data Transfer Service request.
type Account_Media_Data_Transfer_Request ¶
type Account_Media_Data_Transfer_Request struct { Entity // The account to which the request belongs. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // The account id of the request. AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // A count of the active tickets that are attached to the data transfer request. ActiveTicketCount *uint `json:"activeTicketCount,omitempty" xmlrpc:"activeTicketCount,omitempty"` // The active tickets that are attached to the data transfer request. ActiveTickets []Ticket `json:"activeTickets,omitempty" xmlrpc:"activeTickets,omitempty"` // The billing item for the original request. BillingItem *Billing_Item `json:"billingItem,omitempty" xmlrpc:"billingItem,omitempty"` // The customer user who created the request. CreateUser *User_Customer `json:"createUser,omitempty" xmlrpc:"createUser,omitempty"` // The create user id of the request. CreateUserId *int `json:"createUserId,omitempty" xmlrpc:"createUserId,omitempty"` // The end date of the request. EndDate *Time `json:"endDate,omitempty" xmlrpc:"endDate,omitempty"` // The unique id of the request. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The media of the request. Media *Account_Media `json:"media,omitempty" xmlrpc:"media,omitempty"` // The employee who last modified the request. ModifyEmployee *User_Employee `json:"modifyEmployee,omitempty" xmlrpc:"modifyEmployee,omitempty"` // The customer user who last modified the request. ModifyUser *User_Customer `json:"modifyUser,omitempty" xmlrpc:"modifyUser,omitempty"` // The modify user id of the request. ModifyUserId *int `json:"modifyUserId,omitempty" xmlrpc:"modifyUserId,omitempty"` // A count of the shipments of the request. ShipmentCount *uint `json:"shipmentCount,omitempty" xmlrpc:"shipmentCount,omitempty"` // The shipments of the request. Shipments []Account_Shipment `json:"shipments,omitempty" xmlrpc:"shipments,omitempty"` // The start date of the request. StartDate *Time `json:"startDate,omitempty" xmlrpc:"startDate,omitempty"` // The status of the request. Status *Account_Media_Data_Transfer_Request_Status `json:"status,omitempty" xmlrpc:"status,omitempty"` // The status id of the request. StatusId *int `json:"statusId,omitempty" xmlrpc:"statusId,omitempty"` // A count of all tickets that are attached to the data transfer request. TicketCount *uint `json:"ticketCount,omitempty" xmlrpc:"ticketCount,omitempty"` // All tickets that are attached to the data transfer request. Tickets []Ticket `json:"tickets,omitempty" xmlrpc:"tickets,omitempty"` }
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.
type Account_Media_Data_Transfer_Request_Status ¶
type Account_Media_Data_Transfer_Request_Status struct { Entity // The description of the request status. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // The unique id of the request status. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The unique keyname of the request status. KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // The name of the request status. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
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.
type Account_Media_Type ¶
type Account_Media_Type struct { Entity // The description of the media type. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // The unique id of the media type. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The unique keyname of the media type. KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // The name of the media type. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
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.
type Account_Network_Vlan_Span ¶
type Account_Network_Vlan_Span struct { Entity // The SoftLayer customer account associated with a VLAN. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // Flag indicating whether the customer wishes to have all private network VLANs associated with account automatically joined [0 or 1] EnabledFlag *bool `json:"enabledFlag,omitempty" xmlrpc:"enabledFlag,omitempty"` // The unique internal identifier of the SoftLayer_Account_Network_Vlan_Span object. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Timestamp of the last time the ACL for this account was applied. LastAppliedDate *Time `json:"lastAppliedDate,omitempty" xmlrpc:"lastAppliedDate,omitempty"` // Timestamp of the last time the subnet hash was verified for this VLAN span record. LastVerifiedDate *Time `json:"lastVerifiedDate,omitempty" xmlrpc:"lastVerifiedDate,omitempty"` // Timestamp of the last edit of the record. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` }
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.
type Account_Note ¶
type Account_Note struct { Entity // no documentation yet Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // no documentation yet AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // no documentation yet CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // no documentation yet Customer *User_Customer `json:"customer,omitempty" xmlrpc:"customer,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // no documentation yet Note *string `json:"note,omitempty" xmlrpc:"note,omitempty"` // no documentation yet NoteHistory []Account_Note_History `json:"noteHistory,omitempty" xmlrpc:"noteHistory,omitempty"` // A count of NoteHistoryCount *uint `json:"noteHistoryCount,omitempty" xmlrpc:"noteHistoryCount,omitempty"` // no documentation yet NoteTypeId *int `json:"noteTypeId,omitempty" xmlrpc:"noteTypeId,omitempty"` // no documentation yet UserId *int `json:"userId,omitempty" xmlrpc:"userId,omitempty"` }
no documentation yet
type Account_Note_History ¶
type Account_Note_History struct { Entity // no documentation yet AccountNote *Account_Note `json:"accountNote,omitempty" xmlrpc:"accountNote,omitempty"` // no documentation yet AccountNoteId *int `json:"accountNoteId,omitempty" xmlrpc:"accountNoteId,omitempty"` // no documentation yet CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // no documentation yet Customer *User_Customer `json:"customer,omitempty" xmlrpc:"customer,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // no documentation yet Note *string `json:"note,omitempty" xmlrpc:"note,omitempty"` // no documentation yet UserId *int `json:"userId,omitempty" xmlrpc:"userId,omitempty"` }
no documentation yet
type Account_Partner_Referral_Prospect ¶
type Account_Partner_Referral_Prospect struct { User_Customer_Prospect // no documentation yet CompanyName *string `json:"companyName,omitempty" xmlrpc:"companyName,omitempty"` // no documentation yet EmailAddress *string `json:"emailAddress,omitempty" xmlrpc:"emailAddress,omitempty"` // no documentation yet FirstName *string `json:"firstName,omitempty" xmlrpc:"firstName,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet LastName *string `json:"lastName,omitempty" xmlrpc:"lastName,omitempty"` }
no documentation yet
type Account_Password ¶
type Account_Password struct { Entity // no documentation yet Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // The SoftLayer customer account id that a username/password combination is associated with. AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // A username/password combination's internal identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A simple description of a username/password combination. These notes don't affect portal functionality. Notes *string `json:"notes,omitempty" xmlrpc:"notes,omitempty"` // The password portion of a username/password combination. Password *string `json:"password,omitempty" xmlrpc:"password,omitempty"` // The service that an account/password combination is tied to. Type *Account_Password_Type `json:"type,omitempty" xmlrpc:"type,omitempty"` // An identifier relating to a username/password combinations's associated service. TypeId *int `json:"typeId,omitempty" xmlrpc:"typeId,omitempty"` // The username portion of a username/password combination. Username *string `json:"username,omitempty" xmlrpc:"username,omitempty"` }
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.
type Account_Password_Type ¶
type Account_Password_Type struct { Entity // A description of the use for the account username/password combination. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` }
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.
type Account_ProofOfConcept_Approver ¶
type Account_ProofOfConcept_Approver struct { Entity // Approval slot of the approver. ApprovalOrder *int `json:"approvalOrder,omitempty" xmlrpc:"approvalOrder,omitempty"` // Internal identifier. BluepagesUid *string `json:"bluepagesUid,omitempty" xmlrpc:"bluepagesUid,omitempty"` // Email of the approver. Email *string `json:"email,omitempty" xmlrpc:"email,omitempty"` // First name of the approver. FirstName *string `json:"firstName,omitempty" xmlrpc:"firstName,omitempty"` // Internal identifier of a Proof of Concept account approver. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Last name of the approver. LastName *string `json:"lastName,omitempty" xmlrpc:"lastName,omitempty"` // SoftLayer_Account_ProofOfConcept_Approver_Region identifier of the approver. RegionKeyName *string `json:"regionKeyName,omitempty" xmlrpc:"regionKeyName,omitempty"` // no documentation yet Role *Account_ProofOfConcept_Approver_Role `json:"role,omitempty" xmlrpc:"role,omitempty"` // SoftLayer_Account_ProofOfConcept_Approver_Role identifier of the approver. RoleId *int `json:"roleId,omitempty" xmlrpc:"roleId,omitempty"` // no documentation yet Type *Account_ProofOfConcept_Approver_Type `json:"type,omitempty" xmlrpc:"type,omitempty"` // SoftLayer_Account_ProofOfConcept_Approver_Type identifier of the approver. TypeId *int `json:"typeId,omitempty" xmlrpc:"typeId,omitempty"` }
This class represents a Proof of Concept account approver.
type Account_ProofOfConcept_Approver_Role ¶
type Account_ProofOfConcept_Approver_Role struct { Entity // Description of a Proof of Concept account approver role. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // Internal identifier of a Proof of Concept account approver role. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Key name of a Proof of Concept account approver role. KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // Name of a Proof of Concept account approver role. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
This class represents a Proof of Concept account approver type. The current roles are Primary and Backup approvers.
type Account_ProofOfConcept_Approver_Type ¶
type Account_ProofOfConcept_Approver_Type struct { Entity // A count of ApproverCount *uint `json:"approverCount,omitempty" xmlrpc:"approverCount,omitempty"` // no documentation yet Approvers []Account_ProofOfConcept_Approver `json:"approvers,omitempty" xmlrpc:"approvers,omitempty"` // Description for a Proof of Concept account approver type. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // Internal identifier of a Proof of Concept account approver type. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Key name for a Proof of Concept account approver type. KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // Name of a Proof of Concept account approver type. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
This class represents a Proof of Concept account approver type.
type Account_ProofOfConcept_Campaign_Code ¶ added in v1.0.2
type Account_ProofOfConcept_Campaign_Code struct { Entity // no documentation yet Code *string `json:"code,omitempty" xmlrpc:"code,omitempty"` // no documentation yet Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` }
A [SoftLayer_Account_ProofOfConcept_Campaign_Code] provides a `code` and an optional `description`.
type Account_ProofOfConcept_Funding_Type ¶
type Account_ProofOfConcept_Funding_Type struct { Entity // A count of ApproverCount *uint `json:"approverCount,omitempty" xmlrpc:"approverCount,omitempty"` // A count of ApproverTypeCount *uint `json:"approverTypeCount,omitempty" xmlrpc:"approverTypeCount,omitempty"` // no documentation yet ApproverTypes []Account_ProofOfConcept_Approver_Type `json:"approverTypes,omitempty" xmlrpc:"approverTypes,omitempty"` // no documentation yet Approvers []Account_ProofOfConcept_Approver `json:"approvers,omitempty" xmlrpc:"approvers,omitempty"` // no documentation yet KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` }
no documentation yet
type Account_Regional_Registry_Detail ¶
type Account_Regional_Registry_Detail struct { Entity // [Deprecated] The account that this detail object belongs to. // Deprecated: This function has been marked as deprecated. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // The detail object's associated [[SoftLayer_Account|account]] id AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // The date and time the detail object was created CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // A count of [Deprecated] References to the [[SoftLayer_Network_Subnet_Registration|registration objects]] that consume this detail object. DetailCount *uint `json:"detailCount,omitempty" xmlrpc:"detailCount,omitempty"` // [Deprecated] The associated type of this detail object. // Deprecated: This function has been marked as deprecated. DetailType *Account_Regional_Registry_Detail_Type `json:"detailType,omitempty" xmlrpc:"detailType,omitempty"` // The detail object's associated [[SoftLayer_Account_Regional_Registry_Detail_Type|type]] id DetailTypeId *int `json:"detailTypeId,omitempty" xmlrpc:"detailTypeId,omitempty"` // [Deprecated] References to the [[SoftLayer_Network_Subnet_Registration|registration objects]] that consume this detail object. // Deprecated: This function has been marked as deprecated. Details []Network_Subnet_Registration_Details `json:"details,omitempty" xmlrpc:"details,omitempty"` // Unique ID of the detail object Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The date and time the detail object was last modified ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // [Deprecated] The individual properties that define this detail object's values. // Deprecated: This function has been marked as deprecated. Properties []Account_Regional_Registry_Detail_Property `json:"properties,omitempty" xmlrpc:"properties,omitempty"` // A count of [Deprecated] The individual properties that define this detail object's values. PropertyCount *uint `json:"propertyCount,omitempty" xmlrpc:"propertyCount,omitempty"` // [Deprecated] The associated RWhois handle of this detail object. Used only when detailed reassignments are necessary. // Deprecated: This function has been marked as deprecated. RegionalInternetRegistryHandle *Account_Rwhois_Handle `json:"regionalInternetRegistryHandle,omitempty" xmlrpc:"regionalInternetRegistryHandle,omitempty"` // The detail object's associated [[SoftLayer_Account_Rwhois_Handle|RIR handle]] id RegionalInternetRegistryHandleId *int `json:"regionalInternetRegistryHandleId,omitempty" xmlrpc:"regionalInternetRegistryHandleId,omitempty"` }
The subnet registration detail type has been deprecated.
type Account_Regional_Registry_Detail_Property ¶
type Account_Regional_Registry_Detail_Property struct { Entity // no documentation yet CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // [Deprecated] The [[SoftLayer_Account_Regional_Registry_Detail]] object this property belongs to // Deprecated: This function has been marked as deprecated. Detail *Account_Regional_Registry_Detail `json:"detail,omitempty" xmlrpc:"detail,omitempty"` // Unique ID of the property object Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // [Deprecated] The [[SoftLayer_Account_Regional_Registry_Detail_Property_Type]] object this property belongs to // Deprecated: This function has been marked as deprecated. PropertyType *Account_Regional_Registry_Detail_Property_Type `json:"propertyType,omitempty" xmlrpc:"propertyType,omitempty"` // The numeric ID of the related [[SoftLayer_Account_Regional_Registry_Detail_Property_Type|property type object]] PropertyTypeId *int `json:"propertyTypeId,omitempty" xmlrpc:"propertyTypeId,omitempty"` // The numeric ID of the related [[SoftLayer_Account_Regional_Registry_Detail|detail object]] RegistrationDetailId *int `json:"registrationDetailId,omitempty" xmlrpc:"registrationDetailId,omitempty"` // When multiple properties exist for a property type, defines the position in the sequence of those properties SequencePosition *int `json:"sequencePosition,omitempty" xmlrpc:"sequencePosition,omitempty"` // The value of the property Value *string `json:"value,omitempty" xmlrpc:"value,omitempty"` }
The subnet registration detail property type has been deprecated.
Subnet registration properties are used to define various attributes of the [[SoftLayer_Account_Regional_Registry_Detail|detail objects]]. These properties are defined by the [[SoftLayer_Account_Regional_Registry_Detail_Property_Type]] objects, which describe the available value formats.
type Account_Regional_Registry_Detail_Property_Type ¶
type Account_Regional_Registry_Detail_Property_Type struct { Entity // no documentation yet CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // Unique numeric ID of the property type object Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Code-friendly string name of the property type KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // no documentation yet ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // Human-readable name of the property type Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // A Perl-compatible regular expression used to describe the valid format of the property ValueExpression *string `json:"valueExpression,omitempty" xmlrpc:"valueExpression,omitempty"` }
The subnet registration detail property type type has been deprecated.
Subnet Registration Detail Property Type objects describe the nature of a [[SoftLayer_Account_Regional_Registry_Detail_Property]] object. These types use [http://php.net/pcre.pattern.php Perl-Compatible Regular Expressions] to validate the value of a property object.
type Account_Regional_Registry_Detail_Type ¶
type Account_Regional_Registry_Detail_Type struct { Entity // no documentation yet CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // Unique numeric ID of the detail type object Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Code-friendly string name of the detail type KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // no documentation yet ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // Human-readable name of the detail type Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
The subnet registration detail type type has been deprecated.
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: <ul> <li><strong>NETWORK</strong> - The detail object represents the information for a [[SoftLayer_Network_Subnet|subnet]]</li> <li><strong>NETWORK6</strong> - The detail object represents the information for an [[SoftLayer_Network_Subnet_Version6|IPv6 subnet]]</li> <li><strong>PERSON</strong> - The detail object represents the information for a customer with the RIR</li> </ul>
type Account_Regional_Registry_Detail_Version4_Person_Default ¶
type Account_Regional_Registry_Detail_Version4_Person_Default struct {
Account_Regional_Registry_Detail
}
The subnet registration default person detail type has been deprecated.
The SoftLayer_Account_Regional_Registry_Detail_Version4_Person_Default data type contains general information relating to a single SoftLayer RIR account. RIR account information in this type such as names, addresses, and phone numbers are assigned to the registry only and not to users belonging to the account.
type Account_Reports_Request ¶
type Account_Reports_Request struct { Entity // no documentation yet Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // A request's corresponding external contact, if one exists. AccountContact *Account_Contact `json:"accountContact,omitempty" xmlrpc:"accountContact,omitempty"` // no documentation yet AccountContactId *int `json:"accountContactId,omitempty" xmlrpc:"accountContactId,omitempty"` // no documentation yet AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // no documentation yet ComplianceReportTypeId *string `json:"complianceReportTypeId,omitempty" xmlrpc:"complianceReportTypeId,omitempty"` // no documentation yet CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // no documentation yet EmployeeRecordId *int `json:"employeeRecordId,omitempty" xmlrpc:"employeeRecordId,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // no documentation yet Nda *string `json:"nda,omitempty" xmlrpc:"nda,omitempty"` // no documentation yet Notes *string `json:"notes,omitempty" xmlrpc:"notes,omitempty"` // no documentation yet Report *string `json:"report,omitempty" xmlrpc:"report,omitempty"` // Type of the report customer is requesting for. ReportType *Compliance_Report_Type `json:"reportType,omitempty" xmlrpc:"reportType,omitempty"` // no documentation yet RequestKey *string `json:"requestKey,omitempty" xmlrpc:"requestKey,omitempty"` // A request's corresponding requestor contact, if one exists. RequestorContact *Account_Contact `json:"requestorContact,omitempty" xmlrpc:"requestorContact,omitempty"` // no documentation yet RequestorContactId *int `json:"requestorContactId,omitempty" xmlrpc:"requestorContactId,omitempty"` // no documentation yet Status *string `json:"status,omitempty" xmlrpc:"status,omitempty"` // no documentation yet Ticket *Ticket `json:"ticket,omitempty" xmlrpc:"ticket,omitempty"` // no documentation yet TicketId *int `json:"ticketId,omitempty" xmlrpc:"ticketId,omitempty"` // The customer user that initiated a report request. User *User_Customer `json:"user,omitempty" xmlrpc:"user,omitempty"` // no documentation yet UsrRecordId *int `json:"usrRecordId,omitempty" xmlrpc:"usrRecordId,omitempty"` }
no documentation yet
type Account_Rwhois_Handle ¶
type Account_Rwhois_Handle struct { Entity // [Deprecated] The account that this handle belongs to. // Deprecated: This function has been marked as deprecated. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // The handle object's associated [[SoftLayer_Account|account]] id AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // no documentation yet CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // The handle object's unique identifier as assigned by the RIR. Handle *string `json:"handle,omitempty" xmlrpc:"handle,omitempty"` // Unique ID of the handle object Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` }
The subnet registration handle type has been deprecated.
Provides a means of tracking handle identifiers at the various regional internet registries (RIRs). These objects are used by the [[SoftLayer_Network_Subnet_Registration (type)|SoftLayer_Network_Subnet_Registration]] objects to identify a customer or organization when a subnet is registered.
type Account_Shipment ¶
type Account_Shipment struct { Entity // The account to which the shipment belongs. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // The account id of the shipment. AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // The courier handling the shipment. Courier *Auxiliary_Shipping_Courier `json:"courier,omitempty" xmlrpc:"courier,omitempty"` // The courier id of the shipment. CourierId *int `json:"courierId,omitempty" xmlrpc:"courierId,omitempty"` // The courier name of the shipment. CourierName *string `json:"courierName,omitempty" xmlrpc:"courierName,omitempty"` // The employee who created the shipment. CreateEmployee *User_Employee `json:"createEmployee,omitempty" xmlrpc:"createEmployee,omitempty"` // The customer user who created the shipment. CreateUser *User_Customer `json:"createUser,omitempty" xmlrpc:"createUser,omitempty"` // The create user id of the shipment. CreateUserId *int `json:"createUserId,omitempty" xmlrpc:"createUserId,omitempty"` // no documentation yet Currency *Billing_Currency `json:"currency,omitempty" xmlrpc:"currency,omitempty"` // The address at which the shipment is received. DestinationAddress *Account_Address `json:"destinationAddress,omitempty" xmlrpc:"destinationAddress,omitempty"` // The destination address id of the shipment. DestinationAddressId *int `json:"destinationAddressId,omitempty" xmlrpc:"destinationAddressId,omitempty"` // The destination date of the shipment. DestinationDate *Time `json:"destinationDate,omitempty" xmlrpc:"destinationDate,omitempty"` // The unique id of the shipment. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The one master tracking data for the shipment. MasterTrackingData *Account_Shipment_Tracking_Data `json:"masterTrackingData,omitempty" xmlrpc:"masterTrackingData,omitempty"` // The employee who last modified the shipment. ModifyEmployee *User_Employee `json:"modifyEmployee,omitempty" xmlrpc:"modifyEmployee,omitempty"` // The customer user who last modified the shipment. ModifyUser *User_Customer `json:"modifyUser,omitempty" xmlrpc:"modifyUser,omitempty"` // The modify user id of the shipment. ModifyUserId *int `json:"modifyUserId,omitempty" xmlrpc:"modifyUserId,omitempty"` // The shipment note (special handling instructions). Note *string `json:"note,omitempty" xmlrpc:"note,omitempty"` // The address from which the shipment is sent. OriginationAddress *Account_Address `json:"originationAddress,omitempty" xmlrpc:"originationAddress,omitempty"` // The origination address id of the shipment. OriginationAddressId *int `json:"originationAddressId,omitempty" xmlrpc:"originationAddressId,omitempty"` // The origination date of the shipment. OriginationDate *Time `json:"originationDate,omitempty" xmlrpc:"originationDate,omitempty"` // A count of the items in the shipment. ShipmentItemCount *uint `json:"shipmentItemCount,omitempty" xmlrpc:"shipmentItemCount,omitempty"` // The items in the shipment. ShipmentItems []Account_Shipment_Item `json:"shipmentItems,omitempty" xmlrpc:"shipmentItems,omitempty"` // The status of the shipment. Status *Account_Shipment_Status `json:"status,omitempty" xmlrpc:"status,omitempty"` // The status id of the shipment. StatusId *int `json:"statusId,omitempty" xmlrpc:"statusId,omitempty"` // All tracking data for the shipment and packages. TrackingData []Account_Shipment_Tracking_Data `json:"trackingData,omitempty" xmlrpc:"trackingData,omitempty"` // A count of all tracking data for the shipment and packages. TrackingDataCount *uint `json:"trackingDataCount,omitempty" xmlrpc:"trackingDataCount,omitempty"` // The type of shipment (e.g. for Data Transfer Service or Colocation Service). Type *Account_Shipment_Type `json:"type,omitempty" xmlrpc:"type,omitempty"` // The type id of the shipment. TypeId *int `json:"typeId,omitempty" xmlrpc:"typeId,omitempty"` // The address at which the shipment is received. ViaAddress *Account_Address `json:"viaAddress,omitempty" xmlrpc:"viaAddress,omitempty"` // The via address id of the shipment. ViaAddressId *int `json:"viaAddressId,omitempty" xmlrpc:"viaAddressId,omitempty"` }
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.
type Account_Shipment_Item ¶
type Account_Shipment_Item struct { Entity // no documentation yet CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // The description of the shipping item. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // The unique id of the shipping item. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The package id of the shipping item. PackageId *int `json:"packageId,omitempty" xmlrpc:"packageId,omitempty"` // The shipment to which this item belongs. Shipment *Account_Shipment `json:"shipment,omitempty" xmlrpc:"shipment,omitempty"` // The shipment id of the shipping item. ShipmentId *int `json:"shipmentId,omitempty" xmlrpc:"shipmentId,omitempty"` // The item id of the shipping item. ShipmentItemId *int `json:"shipmentItemId,omitempty" xmlrpc:"shipmentItemId,omitempty"` // The type of this shipment item. ShipmentItemType *Account_Shipment_Item_Type `json:"shipmentItemType,omitempty" xmlrpc:"shipmentItemType,omitempty"` // The item type id of the shipping item. ShipmentItemTypeId *int `json:"shipmentItemTypeId,omitempty" xmlrpc:"shipmentItemTypeId,omitempty"` }
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.
type Account_Shipment_Item_Type ¶
type Account_Shipment_Item_Type struct { Entity // DEPRECATED // Deprecated: This function has been marked as deprecated. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
no documentation yet
type Account_Shipment_Resource_Type ¶
type Account_Shipment_Resource_Type struct {
Entity
}
no documentation yet
type Account_Shipment_Status ¶
type Account_Shipment_Status struct { Entity // DEPRECATED // Deprecated: This function has been marked as deprecated. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
no documentation yet
type Account_Shipment_Tracking_Data ¶
type Account_Shipment_Tracking_Data struct { Entity // The employee who created the tracking datum. CreateEmployee *User_Employee `json:"createEmployee,omitempty" xmlrpc:"createEmployee,omitempty"` // The customer user who created the tracking datum. CreateUser *User_Customer `json:"createUser,omitempty" xmlrpc:"createUser,omitempty"` // The create user id of the tracking data. CreateUserId *int `json:"createUserId,omitempty" xmlrpc:"createUserId,omitempty"` // The unique id of the tracking data. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The employee who last modified the tracking datum. ModifyEmployee *User_Employee `json:"modifyEmployee,omitempty" xmlrpc:"modifyEmployee,omitempty"` // The customer user who last modified the tracking datum. ModifyUser *User_Customer `json:"modifyUser,omitempty" xmlrpc:"modifyUser,omitempty"` // The user id of the tracking data. ModifyUserId *int `json:"modifyUserId,omitempty" xmlrpc:"modifyUserId,omitempty"` // The package id of the tracking data. PackageId *int `json:"packageId,omitempty" xmlrpc:"packageId,omitempty"` // The sequence of the tracking data. Sequence *int `json:"sequence,omitempty" xmlrpc:"sequence,omitempty"` // The shipment of the tracking datum. Shipment *Account_Shipment `json:"shipment,omitempty" xmlrpc:"shipment,omitempty"` // The shipment id of the tracking data. ShipmentId *int `json:"shipmentId,omitempty" xmlrpc:"shipmentId,omitempty"` // The tracking data (tracking number/reference number). TrackingData *string `json:"trackingData,omitempty" xmlrpc:"trackingData,omitempty"` }
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.
type Account_Shipment_Type ¶
type Account_Shipment_Type struct { Entity // DEPRECATED // Deprecated: This function has been marked as deprecated. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // no documentation yet Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
no documentation yet
type Account_Status ¶
type Account_Status struct { Entity // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
no documentation yet
type Account_Status_Change_Reason ¶ added in v1.1.4
type Account_Status_Change_Reason struct { Entity // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
no documentation yet
type Auxiliary_Network_Status ¶
type Auxiliary_Network_Status struct {
Entity
}
no documentation yet
type Auxiliary_Notification_Emergency ¶
type Auxiliary_Notification_Emergency struct { Entity // The date this event was created. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // The device (if any) effected by this event. Device *string `json:"device,omitempty" xmlrpc:"device,omitempty"` // The duration of this event. Duration *string `json:"duration,omitempty" xmlrpc:"duration,omitempty"` // The device (if any) effected by this event. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The location effected by this event. Location *string `json:"location,omitempty" xmlrpc:"location,omitempty"` // A message describing this event. Message *string `json:"message,omitempty" xmlrpc:"message,omitempty"` // The last date this event was modified. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // The service(s) (if any) effected by this event. ServicesAffected *string `json:"servicesAffected,omitempty" xmlrpc:"servicesAffected,omitempty"` // The signature of the SoftLayer employee department associated with this notification. Signature *Auxiliary_Notification_Emergency_Signature `json:"signature,omitempty" xmlrpc:"signature,omitempty"` // The date this event will start. StartDate *Time `json:"startDate,omitempty" xmlrpc:"startDate,omitempty"` // The status of this notification. Status *Auxiliary_Notification_Emergency_Status `json:"status,omitempty" xmlrpc:"status,omitempty"` // Current status record for this event. StatusId *int `json:"statusId,omitempty" xmlrpc:"statusId,omitempty"` }
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.
type Auxiliary_Notification_Emergency_Signature ¶
type Auxiliary_Notification_Emergency_Signature struct { Entity // The name or signature for the current Emergency Notification. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
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.
type Auxiliary_Notification_Emergency_Status ¶
type Auxiliary_Notification_Emergency_Status struct { Entity // A name describing the status of the current Emergency Notification. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
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.
type Auxiliary_Shipping_Courier ¶
type Auxiliary_Shipping_Courier struct { Entity // The unique id of the shipping courier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The unique keyname of the shipping courier. KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // The name of the shipping courier. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // The url to shipping courier's website. Url *string `json:"url,omitempty" xmlrpc:"url,omitempty"` }
The SoftLayer_Auxiliary_Shipping_Courier data type contains general information relating the different (major) couriers that SoftLayer may use for shipping.
type Auxiliary_Shipping_Courier_Type ¶
type Auxiliary_Shipping_Courier_Type struct { Entity // no documentation yet Courier []Auxiliary_Shipping_Courier `json:"courier,omitempty" xmlrpc:"courier,omitempty"` // A count of CourierCount *uint `json:"courierCount,omitempty" xmlrpc:"courierCount,omitempty"` // no documentation yet Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
no documentation yet
type BMS_Container_Country ¶ added in v1.1.3
type BMS_Container_Country struct { Entity // no documentation yet Code *string `json:"code,omitempty" xmlrpc:"code,omitempty"` // no documentation yet Id *string `json:"id,omitempty" xmlrpc:"id,omitempty"` }
no documentation yet
type Billing_Chargeback_Type ¶ added in v1.1.2
type Billing_Chargeback_Type struct { Entity // Chargeback Type key name. KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` }
no documentation yet
type Billing_Currency ¶
type Billing_Currency struct { Entity // The current exchange rate CurrentExchangeRate *Billing_Currency_ExchangeRate `json:"currentExchangeRate,omitempty" xmlrpc:"currentExchangeRate,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
no documentation yet
type Billing_Currency_Country ¶
type Billing_Currency_Country struct { Entity // A unique identifier for the related country. CountryId *int `json:"countryId,omitempty" xmlrpc:"countryId,omitempty"` // A unique identifier for the related currency. CurrencyId *int `json:"currencyId,omitempty" xmlrpc:"currencyId,omitempty"` // A unique identifier for a map between a country and currency. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The country currency locale. Locale *string `json:"locale,omitempty" xmlrpc:"locale,omitempty"` }
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.
type Billing_Currency_ExchangeRate ¶
type Billing_Currency_ExchangeRate struct { Entity // no documentation yet EffectiveDate *Time `json:"effectiveDate,omitempty" xmlrpc:"effectiveDate,omitempty"` // no documentation yet ExpirationDate *Time `json:"expirationDate,omitempty" xmlrpc:"expirationDate,omitempty"` // no documentation yet FundingCurrency *Billing_Currency `json:"fundingCurrency,omitempty" xmlrpc:"fundingCurrency,omitempty"` // The id of the exchange rate record. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet LocalCurrency *Billing_Currency `json:"localCurrency,omitempty" xmlrpc:"localCurrency,omitempty"` // no documentation yet Rate *Float64 `json:"rate,omitempty" xmlrpc:"rate,omitempty"` }
no documentation yet
type Billing_Info ¶
type Billing_Info struct { Entity // The SoftLayer customer account associated with this billing information. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // A SoftLayer account's identifier. AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // no documentation yet AchInformation []Billing_Info_Ach `json:"achInformation,omitempty" xmlrpc:"achInformation,omitempty"` // A count of AchInformationCount *uint `json:"achInformationCount,omitempty" xmlrpc:"achInformationCount,omitempty"` // The day of the month that a SoftLayer customer is billed. AnniversaryDayOfMonth *int `json:"anniversaryDayOfMonth,omitempty" xmlrpc:"anniversaryDayOfMonth,omitempty"` // This value doesn't persist to this object. It's used as part of the account creation process only; CardAccountNumber *string `json:"cardAccountNumber,omitempty" xmlrpc:"cardAccountNumber,omitempty"` // the expiration month of the credit card on file CardExpirationMonth *int `json:"cardExpirationMonth,omitempty" xmlrpc:"cardExpirationMonth,omitempty"` // the expiration year of the credit card on file CardExpirationYear *int `json:"cardExpirationYear,omitempty" xmlrpc:"cardExpirationYear,omitempty"` // no documentation yet CardNickname *string `json:"cardNickname,omitempty" xmlrpc:"cardNickname,omitempty"` // the type of the credit card on file CardType *string `json:"cardType,omitempty" xmlrpc:"cardType,omitempty"` // This value doesn't persist to this object. It's used as part of the account creation process only. CardVerificationNumber *string `json:"cardVerificationNumber,omitempty" xmlrpc:"cardVerificationNumber,omitempty"` // The date a customer's billing information was created. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // Currency to be used by this customer account. Currency *Billing_Currency `json:"currency,omitempty" xmlrpc:"currency,omitempty"` // Information related to an account's current and previous billing cycles. CurrentBillingCycle *Billing_Info_Cycle `json:"currentBillingCycle,omitempty" xmlrpc:"currentBillingCycle,omitempty"` // A SoftLayer customer's billing information identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The date on which an account was last billed. LastBillDate *Time `json:"lastBillDate,omitempty" xmlrpc:"lastBillDate,omitempty"` // 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. LastFourPaymentCardDigits *int `json:"lastFourPaymentCardDigits,omitempty" xmlrpc:"lastFourPaymentCardDigits,omitempty"` // The date of the last payment received by SoftLayer from the account holder. LastPaymentDate *Time `json:"lastPaymentDate,omitempty" xmlrpc:"lastPaymentDate,omitempty"` // The date a customer's billing information was last modified. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // The date on which an account will be billed next. NextBillDate *Time `json:"nextBillDate,omitempty" xmlrpc:"nextBillDate,omitempty"` // The payment terms for an account. PaymentTerms *int `json:"paymentTerms,omitempty" xmlrpc:"paymentTerms,omitempty"` // The percentage discount received on all one-time charges on a customer's monthly bill. PercentDiscountOnetime *int `json:"percentDiscountOnetime,omitempty" xmlrpc:"percentDiscountOnetime,omitempty"` // The percentage discount received on all recurring charges on a customer's monthly bill. PercentDiscountRecurring *int `json:"percentDiscountRecurring,omitempty" xmlrpc:"percentDiscountRecurring,omitempty"` // The total recurring fee amount for servers that are in the spare pool status. SparePoolAmount *int `json:"sparePoolAmount,omitempty" xmlrpc:"sparePoolAmount,omitempty"` // This property has been deprecated. // Deprecated: This function has been marked as deprecated. TaxCertificateId *string `json:"taxCertificateId,omitempty" xmlrpc:"taxCertificateId,omitempty"` // no documentation yet VatId *string `json:"vatId,omitempty" xmlrpc:"vatId,omitempty"` }
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.
type Billing_Info_Ach ¶
type Billing_Info_Ach struct { Entity // no documentation yet Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // no documentation yet AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // no documentation yet AccountNumber *string `json:"accountNumber,omitempty" xmlrpc:"accountNumber,omitempty"` // no documentation yet AccountType *string `json:"accountType,omitempty" xmlrpc:"accountType,omitempty"` // no documentation yet BankTransitNumber *string `json:"bankTransitNumber,omitempty" xmlrpc:"bankTransitNumber,omitempty"` // no documentation yet City *string `json:"city,omitempty" xmlrpc:"city,omitempty"` // no documentation yet Country *string `json:"country,omitempty" xmlrpc:"country,omitempty"` // no documentation yet FirstName *string `json:"firstName,omitempty" xmlrpc:"firstName,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet LastName *string `json:"lastName,omitempty" xmlrpc:"lastName,omitempty"` // no documentation yet PhoneNumber *string `json:"phoneNumber,omitempty" xmlrpc:"phoneNumber,omitempty"` // no documentation yet Postalcode *string `json:"postalcode,omitempty" xmlrpc:"postalcode,omitempty"` // no documentation yet State *string `json:"state,omitempty" xmlrpc:"state,omitempty"` // no documentation yet Status *string `json:"status,omitempty" xmlrpc:"status,omitempty"` // no documentation yet Street1 *string `json:"street1,omitempty" xmlrpc:"street1,omitempty"` // no documentation yet Street2 *string `json:"street2,omitempty" xmlrpc:"street2,omitempty"` // no documentation yet VerifiedDate *Time `json:"verifiedDate,omitempty" xmlrpc:"verifiedDate,omitempty"` }
no documentation yet
type Billing_Info_Cycle ¶
type Billing_Info_Cycle struct { Entity // The account that a current billing cycle is associated with. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // The ending date of an account's current billing cycle. CurrentCycleEndDate *Time `json:"currentCycleEndDate,omitempty" xmlrpc:"currentCycleEndDate,omitempty"` // The starting date of an account's current billing cycle. CurrentCycleStartDate *Time `json:"currentCycleStartDate,omitempty" xmlrpc:"currentCycleStartDate,omitempty"` // The start date of an account's next billing cycle. NextCycleStartDate *Time `json:"nextCycleStartDate,omitempty" xmlrpc:"nextCycleStartDate,omitempty"` // The ending date of an account's previous billing cycle. PreviousCycleEndDate *Time `json:"previousCycleEndDate,omitempty" xmlrpc:"previousCycleEndDate,omitempty"` // The starting date of an account's previous billing cycle. PreviousCycleStartDate *Time `json:"previousCycleStartDate,omitempty" xmlrpc:"previousCycleStartDate,omitempty"` }
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.
type Billing_Invoice ¶
type Billing_Invoice struct { Entity // The account that an invoice belongs to. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // The SoftLayer customer account that an invoice belongs to. AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // The first line of an address belonging to an account at the time an invoice is created. Address1 *string `json:"address1,omitempty" xmlrpc:"address1,omitempty"` // The second line of an address belonging to an account at the time an invoice is created. Address2 *string `json:"address2,omitempty" xmlrpc:"address2,omitempty"` // This is the amount of this invoice. Amount *Float64 `json:"amount,omitempty" xmlrpc:"amount,omitempty"` // no documentation yet BrandAtInvoiceCreation *Brand `json:"brandAtInvoiceCreation,omitempty" xmlrpc:"brandAtInvoiceCreation,omitempty"` // Chargeback type for invoice. ChargebackType *Billing_Chargeback_Type `json:"chargebackType,omitempty" xmlrpc:"chargebackType,omitempty"` // The city portion of an address belonging to an account at the time an invoice is created. City *string `json:"city,omitempty" xmlrpc:"city,omitempty"` // Whether an account was exempt from taxes on their invoices at the time an invoice is created. ClaimedTaxExemptTxFlag *bool `json:"claimedTaxExemptTxFlag,omitempty" xmlrpc:"claimedTaxExemptTxFlag,omitempty"` // The date an invoice was closed. Open invoices have a null closed date. ClosedDate *Time `json:"closedDate,omitempty" xmlrpc:"closedDate,omitempty"` // The company name belonging to an account at the time an invoice is created. CompanyName *string `json:"companyName,omitempty" xmlrpc:"companyName,omitempty"` // A two-letter abbreviation of the country portion of an address belonging to an account at the time an invoice is created. Country *string `json:"country,omitempty" xmlrpc:"country,omitempty"` // The date an invoice was created. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // Credit type detail identifier for this invoice. CreditTypeDetailId *int `json:"creditTypeDetailId,omitempty" xmlrpc:"creditTypeDetailId,omitempty"` // A flag that will reflect whether the detailed version of the pdf has been generated. DetailedPdfGeneratedFlag *bool `json:"detailedPdfGeneratedFlag,omitempty" xmlrpc:"detailedPdfGeneratedFlag,omitempty"` // no documentation yet DocumentsGeneratedFlag *bool `json:"documentsGeneratedFlag,omitempty" xmlrpc:"documentsGeneratedFlag,omitempty"` // The email address belonging to an account at the time an invoice is created. Email *string `json:"email,omitempty" xmlrpc:"email,omitempty"` // An SoftLayer account's balance at the time an invoice is closed. This value is measured in US Dollar ($USD) currency. EndingBalance *Float64 `json:"endingBalance,omitempty" xmlrpc:"endingBalance,omitempty"` // The fax telephone number belonging to an account at the time an invoice is created. FaxPhone *string `json:"faxPhone,omitempty" xmlrpc:"faxPhone,omitempty"` // The first name of the account holder at the time an invoice is created. FirstName *string `json:"firstName,omitempty" xmlrpc:"firstName,omitempty"` // An invoice's internal identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A count of a list of top-level invoice items that are on the currently pending invoice. InvoiceTopLevelItemCount *uint `json:"invoiceTopLevelItemCount,omitempty" xmlrpc:"invoiceTopLevelItemCount,omitempty"` // A list of top-level invoice items that are on the currently pending invoice. InvoiceTopLevelItems []Billing_Invoice_Item `json:"invoiceTopLevelItems,omitempty" xmlrpc:"invoiceTopLevelItems,omitempty"` // The total amount of this invoice. InvoiceTotalAmount *Float64 `json:"invoiceTotalAmount,omitempty" xmlrpc:"invoiceTotalAmount,omitempty"` // 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. InvoiceTotalOneTimeAmount *Float64 `json:"invoiceTotalOneTimeAmount,omitempty" xmlrpc:"invoiceTotalOneTimeAmount,omitempty"` // A sum of all the taxes related to one time charges for this invoice. InvoiceTotalOneTimeTaxAmount *Float64 `json:"invoiceTotalOneTimeTaxAmount,omitempty" xmlrpc:"invoiceTotalOneTimeTaxAmount,omitempty"` // The total amount of this invoice. This does not include taxes. InvoiceTotalPreTaxAmount *Float64 `json:"invoiceTotalPreTaxAmount,omitempty" xmlrpc:"invoiceTotalPreTaxAmount,omitempty"` // The total Recurring amount of this invoice. This amount does not include taxes or one time charges. InvoiceTotalRecurringAmount *Float64 `json:"invoiceTotalRecurringAmount,omitempty" xmlrpc:"invoiceTotalRecurringAmount,omitempty"` // The total amount of the recurring taxes on this invoice. InvoiceTotalRecurringTaxAmount *Float64 `json:"invoiceTotalRecurringTaxAmount,omitempty" xmlrpc:"invoiceTotalRecurringTaxAmount,omitempty"` // A count of the items that belong to this invoice. ItemCount *uint `json:"itemCount,omitempty" xmlrpc:"itemCount,omitempty"` // The items that belong to this invoice. Items []Billing_Invoice_Item `json:"items,omitempty" xmlrpc:"items,omitempty"` // The last name of the account holder at the time an invoice is created. LastName *string `json:"lastName,omitempty" xmlrpc:"lastName,omitempty"` // Exchange rate used for billing this invoice. LocalCurrencyExchangeRate *Billing_Currency_ExchangeRate `json:"localCurrencyExchangeRate,omitempty" xmlrpc:"localCurrencyExchangeRate,omitempty"` // The date an invoice was last modified. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // The telephone number belonging to an account at the time an invoice is created. OfficePhone *string `json:"officePhone,omitempty" xmlrpc:"officePhone,omitempty"` // This is the total payment made on this invoice. Payment *Float64 `json:"payment,omitempty" xmlrpc:"payment,omitempty"` // A count of the payments for the invoice. PaymentCount *uint `json:"paymentCount,omitempty" xmlrpc:"paymentCount,omitempty"` // The payments for the invoice. Payments []Billing_Invoice_Receivable_Payment `json:"payments,omitempty" xmlrpc:"payments,omitempty"` // The postal code portion of an address belonging to an account at the time an invoice is created. PostalCode *string `json:"postalCode,omitempty" xmlrpc:"postalCode,omitempty"` // no documentation yet PurchaseOrderNumber *string `json:"purchaseOrderNumber,omitempty" xmlrpc:"purchaseOrderNumber,omitempty"` // This is the seller's tax registration. SellerRegistration *string `json:"sellerRegistration,omitempty" xmlrpc:"sellerRegistration,omitempty"` // An SoftLayer account's balance at the time an invoice is created. This value is measured in US Dollar ($USD) currency. StartingBalance *Float64 `json:"startingBalance,omitempty" xmlrpc:"startingBalance,omitempty"` // 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". State *string `json:"state,omitempty" xmlrpc:"state,omitempty"` // 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. StatusCode *string `json:"statusCode,omitempty" xmlrpc:"statusCode,omitempty"` // This is the tax information that applies to tax auditing. This is the official tax record for this invoice. TaxInfo *Billing_Invoice_Tax_Info `json:"taxInfo,omitempty" xmlrpc:"taxInfo,omitempty"` // 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. TaxInfoHistory []Billing_Invoice_Tax_Info `json:"taxInfoHistory,omitempty" xmlrpc:"taxInfoHistory,omitempty"` // 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. TaxInfoHistoryCount *uint `json:"taxInfoHistoryCount,omitempty" xmlrpc:"taxInfoHistoryCount,omitempty"` // This is a message explaining the tax treatment for this invoice. TaxMessage *string `json:"taxMessage,omitempty" xmlrpc:"taxMessage,omitempty"` // no documentation yet TaxStatusId *int `json:"taxStatusId,omitempty" xmlrpc:"taxStatusId,omitempty"` // This is the strategy used to calculate tax on this invoice. TaxType *Billing_Invoice_Tax_Type `json:"taxType,omitempty" xmlrpc:"taxType,omitempty"` // no documentation yet TaxTypeId *int `json:"taxTypeId,omitempty" xmlrpc:"taxTypeId,omitempty"` // 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. TypeCode *string `json:"typeCode,omitempty" xmlrpc:"typeCode,omitempty"` }
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.
type Billing_Invoice_Item ¶
type Billing_Invoice_Item struct { Entity // 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. AssociatedChildren []Billing_Invoice_Item `json:"associatedChildren,omitempty" xmlrpc:"associatedChildren,omitempty"` // 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. AssociatedChildrenCount *uint `json:"associatedChildrenCount,omitempty" xmlrpc:"associatedChildrenCount,omitempty"` // 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. AssociatedInvoiceItem *Billing_Invoice_Item `json:"associatedInvoiceItem,omitempty" xmlrpc:"associatedInvoiceItem,omitempty"` // The associated invoice Item ID. AssociatedInvoiceItemId *int `json:"associatedInvoiceItemId,omitempty" xmlrpc:"associatedInvoiceItemId,omitempty"` // An Invoice Item's billing item, from which this item was generated. BillingItem *Billing_Item `json:"billingItem,omitempty" xmlrpc:"billingItem,omitempty"` // The billing item from which this invoice item was generated. BillingItemId *int `json:"billingItemId,omitempty" xmlrpc:"billingItemId,omitempty"` // This invoice item's "item category". Category *Product_Item_Category `json:"category,omitempty" xmlrpc:"category,omitempty"` // The item category of the invoice item being invoiced. CategoryCode *string `json:"categoryCode,omitempty" xmlrpc:"categoryCode,omitempty"` // An Invoice Item's child invoice items. Only parent invoice items have children. For instance, a server invoice item will have children. Children []Billing_Invoice_Item `json:"children,omitempty" xmlrpc:"children,omitempty"` // 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. ChildrenCount *uint `json:"childrenCount,omitempty" xmlrpc:"childrenCount,omitempty"` // The date the invoice item was created. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // This is the DPart for invoice item. DPart *string `json:"dPart,omitempty" xmlrpc:"dPart,omitempty"` // The item description for this invoice item. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // The invoice item ID from which the discount is derived. DiscountingInvoiceItemId *int `json:"discountingInvoiceItemId,omitempty" xmlrpc:"discountingInvoiceItemId,omitempty"` // The domain name of the invoiced item. This is only used on invoice items whose category is "server". DomainName *string `json:"domainName,omitempty" xmlrpc:"domainName,omitempty"` // The end date of the invoice item. EndDate *Time `json:"endDate,omitempty" xmlrpc:"endDate,omitempty"` // 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. FilteredAssociatedChildren []Billing_Invoice_Item `json:"filteredAssociatedChildren,omitempty" xmlrpc:"filteredAssociatedChildren,omitempty"` // 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. FilteredAssociatedChildrenCount *uint `json:"filteredAssociatedChildrenCount,omitempty" xmlrpc:"filteredAssociatedChildrenCount,omitempty"` // The Host name of the invoiced item. This is only used on invoice items whose category is "server". HostName *string `json:"hostName,omitempty" xmlrpc:"hostName,omitempty"` // Indicating whether this invoice item is billed on an hourly basis. HourlyFlag *bool `json:"hourlyFlag,omitempty" xmlrpc:"hourlyFlag,omitempty"` // The hourly recurring fee of the invoice item represented by a floating point decimal in US Dollars ($USD) HourlyRecurringFee *Float64 `json:"hourlyRecurringFee,omitempty" xmlrpc:"hourlyRecurringFee,omitempty"` // The ID of the invoice item. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The invoice to which this item belongs. Invoice *Billing_Invoice `json:"invoice,omitempty" xmlrpc:"invoice,omitempty"` // The invoice to which this invoice item belongs. InvoiceId *int `json:"invoiceId,omitempty" xmlrpc:"invoiceId,omitempty"` // An invoice item's labor fee total after taxes. This does not include any child invoice items. LaborAfterTaxAmount *Float64 `json:"laborAfterTaxAmount,omitempty" xmlrpc:"laborAfterTaxAmount,omitempty"` // This also a one-time fee of a special type. LaborFee *Float64 `json:"laborFee,omitempty" xmlrpc:"laborFee,omitempty"` // The tax rate at which the labor fee is taxed. LaborFeeTaxRate *Float64 `json:"laborFeeTaxRate,omitempty" xmlrpc:"laborFeeTaxRate,omitempty"` // An invoice item's labor tax amount. This does not include any child invoice items. LaborTaxAmount *Float64 `json:"laborTaxAmount,omitempty" xmlrpc:"laborTaxAmount,omitempty"` // An invoice item's location, if one exists.' Location *Location `json:"location,omitempty" xmlrpc:"location,omitempty"` // 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. NonZeroAssociatedChildren []Billing_Invoice_Item `json:"nonZeroAssociatedChildren,omitempty" xmlrpc:"nonZeroAssociatedChildren,omitempty"` // 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. NonZeroAssociatedChildrenCount *uint `json:"nonZeroAssociatedChildrenCount,omitempty" xmlrpc:"nonZeroAssociatedChildrenCount,omitempty"` // A note to help describe more about the item. This normally holds usernames, or some other bit of extra information. Notes *string `json:"notes,omitempty" xmlrpc:"notes,omitempty"` // An invoice item's one-time fee total after taxes. This does not include any child invoice items. OneTimeAfterTaxAmount *Float64 `json:"oneTimeAfterTaxAmount,omitempty" xmlrpc:"oneTimeAfterTaxAmount,omitempty"` // If there are any one-time charges assessed, it will show up here represented by a floating point decimal in US Dollars ($USD) OneTimeFee *Float64 `json:"oneTimeFee,omitempty" xmlrpc:"oneTimeFee,omitempty"` // The rate at which the one-time fee is taxed. OneTimeFeeTaxRate *Float64 `json:"oneTimeFeeTaxRate,omitempty" xmlrpc:"oneTimeFeeTaxRate,omitempty"` // An invoice item's one-time tax amount. This does not include any child invoice items. OneTimeTaxAmount *Float64 `json:"oneTimeTaxAmount,omitempty" xmlrpc:"oneTimeTaxAmount,omitempty"` // This is the package id for this invoice item. PackageId *int `json:"packageId,omitempty" xmlrpc:"packageId,omitempty"` // 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. Parent *Billing_Invoice_Item `json:"parent,omitempty" xmlrpc:"parent,omitempty"` // The parent invoice item, usually the server invoice item. ParentId *int `json:"parentId,omitempty" xmlrpc:"parentId,omitempty"` // The entry in the product catalog that a invoice item is based upon. Product *Product_Item `json:"product,omitempty" xmlrpc:"product,omitempty"` // The entry in the product catalog that a invoice item is based upon. ProductItemId *int `json:"productItemId,omitempty" xmlrpc:"productItemId,omitempty"` // An invoice item's recurring fee total after taxes. This does not include any child invoice items. RecurringAfterTaxAmount *Float64 `json:"recurringAfterTaxAmount,omitempty" xmlrpc:"recurringAfterTaxAmount,omitempty"` // The recurring fee of the invoice item represented by a floating point decimal in US Dollars ($USD) RecurringFee *Float64 `json:"recurringFee,omitempty" xmlrpc:"recurringFee,omitempty"` // the rate at which the recurring fee is taxed. RecurringFeeTaxRate *Float64 `json:"recurringFeeTaxRate,omitempty" xmlrpc:"recurringFeeTaxRate,omitempty"` // An invoice item's recurring tax amount. This does not include any child invoice items. RecurringTaxAmount *Float64 `json:"recurringTaxAmount,omitempty" xmlrpc:"recurringTaxAmount,omitempty"` // A unique identifier for a SoftLayer Service that is associated to an invoice item. ResourceTableId *int `json:"resourceTableId,omitempty" xmlrpc:"resourceTableId,omitempty"` // The service provider for the invoice item. ServiceProviderId *int `json:"serviceProviderId,omitempty" xmlrpc:"serviceProviderId,omitempty"` // An invoice item's setup fee total after taxes. This does not include any child invoice items. SetupAfterTaxAmount *Float64 `json:"setupAfterTaxAmount,omitempty" xmlrpc:"setupAfterTaxAmount,omitempty"` // If there were any setup fees they will show up here. These are normally a one-time fee. SetupFee *Float64 `json:"setupFee,omitempty" xmlrpc:"setupFee,omitempty"` // The number of months the setup fee is being deferred. SetupFeeDeferralMonths *int `json:"setupFeeDeferralMonths,omitempty" xmlrpc:"setupFeeDeferralMonths,omitempty"` // The tax rate at which the setup fee is taxed. SetupFeeTaxRate *Float64 `json:"setupFeeTaxRate,omitempty" xmlrpc:"setupFeeTaxRate,omitempty"` // An invoice item's setup tax amount. This does not include any child invoice items. SetupTaxAmount *Float64 `json:"setupTaxAmount,omitempty" xmlrpc:"setupTaxAmount,omitempty"` // A string representing the name of parent level product group of an invoice item. TopLevelProductGroupName *string `json:"topLevelProductGroupName,omitempty" xmlrpc:"topLevelProductGroupName,omitempty"` // An invoice Item's total, including any child invoice items if they exist. TotalOneTimeAmount *Float64 `json:"totalOneTimeAmount,omitempty" xmlrpc:"totalOneTimeAmount,omitempty"` // An invoice Item's total, including any child invoice items if they exist. TotalOneTimeTaxAmount *Float64 `json:"totalOneTimeTaxAmount,omitempty" xmlrpc:"totalOneTimeTaxAmount,omitempty"` // An invoice Item's total, including any child invoice items if they exist. TotalRecurringAmount *Float64 `json:"totalRecurringAmount,omitempty" xmlrpc:"totalRecurringAmount,omitempty"` // A Billing Item's total, including any child billing items if they exist.' TotalRecurringTaxAmount *Float64 `json:"totalRecurringTaxAmount,omitempty" xmlrpc:"totalRecurringTaxAmount,omitempty"` // Indicating whether this invoice item is for the usage charge. UsageChargeFlag *bool `json:"usageChargeFlag,omitempty" xmlrpc:"usageChargeFlag,omitempty"` }
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.
type Billing_Invoice_Item_Hardware ¶
type Billing_Invoice_Item_Hardware struct { Billing_Invoice_Item // The resource for a server invoice item. Resource *Hardware `json:"resource,omitempty" xmlrpc:"resource,omitempty"` }
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".
type Billing_Invoice_Item_Tax_Info ¶
type Billing_Invoice_Item_Tax_Info struct { Entity // The date and time the tax information was recorded. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // The invoice description with special information about the invoice. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // The tax rate that can be multiplied by the subtotal to get the EffectiveTaxRate *Float64 `json:"effectiveTaxRate,omitempty" xmlrpc:"effectiveTaxRate,omitempty"` // The amount that is exempt from tax. ExemptAmount *Float64 `json:"exemptAmount,omitempty" xmlrpc:"exemptAmount,omitempty"` // The type of fee being tracked for this particular set of tax information. FeeProperty *string `json:"feeProperty,omitempty" xmlrpc:"feeProperty,omitempty"` // An invoice item's tax information internal identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet InvoiceItem *Billing_Invoice_Item `json:"invoiceItem,omitempty" xmlrpc:"invoiceItem,omitempty"` // A reference to the related invoice item. InvoiceItemId *int `json:"invoiceItemId,omitempty" xmlrpc:"invoiceItemId,omitempty"` // no documentation yet InvoiceTaxInfo *Billing_Invoice_Tax_Info `json:"invoiceTaxInfo,omitempty" xmlrpc:"invoiceTaxInfo,omitempty"` // A reference to the tax information for the parent invoice. InvoiceTaxInfoId *int `json:"invoiceTaxInfoId,omitempty" xmlrpc:"invoiceTaxInfoId,omitempty"` // The date and time the tax information was modified. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // The amount that is exempt from tax. NonTaxableBasis *Float64 `json:"nonTaxableBasis,omitempty" xmlrpc:"nonTaxableBasis,omitempty"` // A flag to indicate whether this is the official record for this invoice item. ReportedFlag *bool `json:"reportedFlag,omitempty" xmlrpc:"reportedFlag,omitempty"` // The registration that the seller will use to report the invoice. SellerRegistration *string `json:"sellerRegistration,omitempty" xmlrpc:"sellerRegistration,omitempty"` // The tax amount associated with this line item. TaxAmount *Float64 `json:"taxAmount,omitempty" xmlrpc:"taxAmount,omitempty"` // The tax amount (converted to the 'to' currency) associated with this line item. TaxAmountToCurrency *Float64 `json:"taxAmountToCurrency,omitempty" xmlrpc:"taxAmountToCurrency,omitempty"` // The tax rate used. Note that this might apply to only part of the TaxRate *Float64 `json:"taxRate,omitempty" xmlrpc:"taxRate,omitempty"` // The amount that is subject to tax. TaxableBasis *Float64 `json:"taxableBasis,omitempty" xmlrpc:"taxableBasis,omitempty"` // This is the currency the invoice will be converted to. ToCurrency *Billing_Currency `json:"toCurrency,omitempty" xmlrpc:"toCurrency,omitempty"` // The currency code that the invoice is being converted to. ToCurrencyId *int `json:"toCurrencyId,omitempty" xmlrpc:"toCurrencyId,omitempty"` }
Information about the tax rates that apply to a particular invoice item.
type Billing_Invoice_Receivable_Payment ¶
type Billing_Invoice_Receivable_Payment struct { Entity // no documentation yet Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // The amount of the payment. Amount *Float64 `json:"amount,omitempty" xmlrpc:"amount,omitempty"` // The date of the payment. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // no documentation yet CreditCardTransaction *Billing_Payment_Card_Transaction `json:"creditCardTransaction,omitempty" xmlrpc:"creditCardTransaction,omitempty"` // no documentation yet ExchangeRate *Billing_Currency_ExchangeRate `json:"exchangeRate,omitempty" xmlrpc:"exchangeRate,omitempty"` // no documentation yet Invoice *Billing_Invoice `json:"invoice,omitempty" xmlrpc:"invoice,omitempty"` // The invoice that the payment is for. InvoiceId *int `json:"invoiceId,omitempty" xmlrpc:"invoiceId,omitempty"` // no documentation yet PaypalTransaction *Billing_Payment_PayPal_Transaction `json:"paypalTransaction,omitempty" xmlrpc:"paypalTransaction,omitempty"` // The type of payment. TypeCode *string `json:"typeCode,omitempty" xmlrpc:"typeCode,omitempty"` }
The SoftLayer_Billing_Invoice_Receivable_Payment data type contains general information relating to payments made against invoices.
type Billing_Invoice_Tax_Info ¶
type Billing_Invoice_Tax_Info struct { Entity // The date and time this tax information was recorded. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // This is the currency used for the invoice. Currency *Billing_Currency `json:"currency,omitempty" xmlrpc:"currency,omitempty"` // The currency code that the invoice should be recorded in. CurrencyId *int `json:"currencyId,omitempty" xmlrpc:"currencyId,omitempty"` // This is the functional currency used for the invoice. FunctionalCurrency *Billing_Currency `json:"functionalCurrency,omitempty" xmlrpc:"functionalCurrency,omitempty"` // The internal identifier for this invoice tax information. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // This is the related invoice for this tax-related information. Invoice *Billing_Invoice `json:"invoice,omitempty" xmlrpc:"invoice,omitempty"` // A reference to the related invoice. InvoiceId *int `json:"invoiceId,omitempty" xmlrpc:"invoiceId,omitempty"` // A count of this is the collection of tax information for each of the related invoice items. ItemCount *uint `json:"itemCount,omitempty" xmlrpc:"itemCount,omitempty"` // This tax information on the invoice item that includes currency details. ItemWithCurrencyInfo *Billing_Invoice_Item_Tax_Info `json:"itemWithCurrencyInfo,omitempty" xmlrpc:"itemWithCurrencyInfo,omitempty"` // This is the collection of tax information for each of the related invoice items. Items []Billing_Invoice_Item_Tax_Info `json:"items,omitempty" xmlrpc:"items,omitempty"` // The date and time this tax information was updated. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // A flag to indicate whether the invoice will be auditable. ReportedFlag *bool `json:"reportedFlag,omitempty" xmlrpc:"reportedFlag,omitempty"` // This the total tax amount (converted to the 'to' currency) for the invoice. TotalTaxAmountToCurrency *Float64 `json:"totalTaxAmountToCurrency,omitempty" xmlrpc:"totalTaxAmountToCurrency,omitempty"` }
Invoice tax information contains top-level information about the taxes recorded for a particular invoice.
type Billing_Invoice_Tax_Status ¶
type Billing_Invoice_Tax_Status struct { Entity // no documentation yet CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // no documentation yet ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
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.
type Billing_Invoice_Tax_Type ¶
type Billing_Invoice_Tax_Type struct { Entity // A tax type's internal identifier. Each type of tax calculation strategy has a unique ID value. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A unique string that identifies each strategy and is guaranteed to be stable over time. KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // A human-readable label for each tax strategy. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
The invoice tax type data type models a single strategy for handling tax calculations.
type Billing_Item ¶
type Billing_Item struct { Entity // The account that a billing item belongs to. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // no documentation yet ActiveAgreement *Account_Agreement `json:"activeAgreement,omitempty" xmlrpc:"activeAgreement,omitempty"` // A flag indicating that the billing item is under an active agreement. ActiveAgreementFlag *Account_Agreement `json:"activeAgreementFlag,omitempty" xmlrpc:"activeAgreementFlag,omitempty"` // A billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item. ActiveAssociatedChildren []Billing_Item `json:"activeAssociatedChildren,omitempty" xmlrpc:"activeAssociatedChildren,omitempty"` // 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. ActiveAssociatedChildrenCount *uint `json:"activeAssociatedChildrenCount,omitempty" xmlrpc:"activeAssociatedChildrenCount,omitempty"` // A count of ActiveAssociatedGuestDiskBillingItemCount *uint `json:"activeAssociatedGuestDiskBillingItemCount,omitempty" xmlrpc:"activeAssociatedGuestDiskBillingItemCount,omitempty"` // no documentation yet ActiveAssociatedGuestDiskBillingItems []Billing_Item `json:"activeAssociatedGuestDiskBillingItems,omitempty" xmlrpc:"activeAssociatedGuestDiskBillingItems,omitempty"` // A count of a Billing Item's active bundled billing items. ActiveBundledItemCount *uint `json:"activeBundledItemCount,omitempty" xmlrpc:"activeBundledItemCount,omitempty"` // A Billing Item's active bundled billing items. ActiveBundledItems []Billing_Item `json:"activeBundledItems,omitempty" xmlrpc:"activeBundledItems,omitempty"` // A service cancellation request item that corresponds to the billing item. ActiveCancellationItem *Billing_Item_Cancellation_Request_Item `json:"activeCancellationItem,omitempty" xmlrpc:"activeCancellationItem,omitempty"` // A Billing Item's active child billing items. ActiveChildren []Billing_Item `json:"activeChildren,omitempty" xmlrpc:"activeChildren,omitempty"` // A count of a Billing Item's active child billing items. ActiveChildrenCount *uint `json:"activeChildrenCount,omitempty" xmlrpc:"activeChildrenCount,omitempty"` // no documentation yet ActiveFlag *bool `json:"activeFlag,omitempty" xmlrpc:"activeFlag,omitempty"` // A count of ActiveSparePoolAssociatedGuestDiskBillingItemCount *uint `` /* 137-byte string literal not displayed */ // no documentation yet ActiveSparePoolAssociatedGuestDiskBillingItems []Billing_Item `` /* 129-byte string literal not displayed */ // A count of a Billing Item's spare pool bundled billing items. ActiveSparePoolBundledItemCount *uint `json:"activeSparePoolBundledItemCount,omitempty" xmlrpc:"activeSparePoolBundledItemCount,omitempty"` // A Billing Item's spare pool bundled billing items. ActiveSparePoolBundledItems []Billing_Item `json:"activeSparePoolBundledItems,omitempty" xmlrpc:"activeSparePoolBundledItems,omitempty"` // Flag to check if a billing item can be cancelled. 1 = yes. 0 = no. AllowCancellationFlag *int `json:"allowCancellationFlag,omitempty" xmlrpc:"allowCancellationFlag,omitempty"` // 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. AssociatedBillingItem *Billing_Item `json:"associatedBillingItem,omitempty" xmlrpc:"associatedBillingItem,omitempty"` // A history of billing items which a billing item has been associated with. AssociatedBillingItemHistory []Billing_Item_Association_History `json:"associatedBillingItemHistory,omitempty" xmlrpc:"associatedBillingItemHistory,omitempty"` // A count of a history of billing items which a billing item has been associated with. AssociatedBillingItemHistoryCount *uint `json:"associatedBillingItemHistoryCount,omitempty" xmlrpc:"associatedBillingItemHistoryCount,omitempty"` // 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. AssociatedBillingItemId *string `json:"associatedBillingItemId,omitempty" xmlrpc:"associatedBillingItemId,omitempty"` // A Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. AssociatedChildren []Billing_Item `json:"associatedChildren,omitempty" xmlrpc:"associatedChildren,omitempty"` // 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. AssociatedChildrenCount *uint `json:"associatedChildrenCount,omitempty" xmlrpc:"associatedChildrenCount,omitempty"` // A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set. AssociatedParent []Billing_Item `json:"associatedParent,omitempty" xmlrpc:"associatedParent,omitempty"` // 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. AssociatedParentCount *uint `json:"associatedParentCount,omitempty" xmlrpc:"associatedParentCount,omitempty"` // A count of AvailableMatchingVlanCount *uint `json:"availableMatchingVlanCount,omitempty" xmlrpc:"availableMatchingVlanCount,omitempty"` // no documentation yet AvailableMatchingVlans []Network_Vlan `json:"availableMatchingVlans,omitempty" xmlrpc:"availableMatchingVlans,omitempty"` // The bandwidth allocation for a billing item. BandwidthAllocation *Network_Bandwidth_Version1_Allocation `json:"bandwidthAllocation,omitempty" xmlrpc:"bandwidthAllocation,omitempty"` // A billing item's recurring child items that have once been billed and are scheduled to be billed in the future. BillableChildren []Billing_Item `json:"billableChildren,omitempty" xmlrpc:"billableChildren,omitempty"` // A count of a billing item's recurring child items that have once been billed and are scheduled to be billed in the future. BillableChildrenCount *uint `json:"billableChildrenCount,omitempty" xmlrpc:"billableChildrenCount,omitempty"` // A count of a Billing Item's bundled billing items. BundledItemCount *uint `json:"bundledItemCount,omitempty" xmlrpc:"bundledItemCount,omitempty"` // A Billing Item's bundled billing items. BundledItems []Billing_Item `json:"bundledItems,omitempty" xmlrpc:"bundledItems,omitempty"` // A Billing Item's active child billing items. CanceledChildren []Billing_Item `json:"canceledChildren,omitempty" xmlrpc:"canceledChildren,omitempty"` // A count of a Billing Item's active child billing items. CanceledChildrenCount *uint `json:"canceledChildrenCount,omitempty" xmlrpc:"canceledChildrenCount,omitempty"` // 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. CancellationDate *Time `json:"cancellationDate,omitempty" xmlrpc:"cancellationDate,omitempty"` // The billing item's cancellation reason. CancellationReason *Billing_Item_Cancellation_Reason `json:"cancellationReason,omitempty" xmlrpc:"cancellationReason,omitempty"` // A count of this will return any cancellation requests that are associated with this billing item. CancellationRequestCount *uint `json:"cancellationRequestCount,omitempty" xmlrpc:"cancellationRequestCount,omitempty"` // This will return any cancellation requests that are associated with this billing item. CancellationRequests []Billing_Item_Cancellation_Request `json:"cancellationRequests,omitempty" xmlrpc:"cancellationRequests,omitempty"` // The item category to which the billing item's item belongs. Category *Product_Item_Category `json:"category,omitempty" xmlrpc:"category,omitempty"` // 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. CategoryCode *string `json:"categoryCode,omitempty" xmlrpc:"categoryCode,omitempty"` // A Billing Item's child billing items' Children []Billing_Item `json:"children,omitempty" xmlrpc:"children,omitempty"` // A count of a Billing Item's child billing items' ChildrenCount *uint `json:"childrenCount,omitempty" xmlrpc:"childrenCount,omitempty"` // A Billing Item's active child billing items. ChildrenWithActiveAgreement []Billing_Item `json:"childrenWithActiveAgreement,omitempty" xmlrpc:"childrenWithActiveAgreement,omitempty"` // A count of a Billing Item's active child billing items. ChildrenWithActiveAgreementCount *uint `json:"childrenWithActiveAgreementCount,omitempty" xmlrpc:"childrenWithActiveAgreementCount,omitempty"` // The date the billing item was created. You can see this date on the invoice. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // This is the total charge for the billing item for this billing item. It is calculated based on the hourlyRecurringFee * hoursUsed. CurrentHourlyCharge *string `json:"currentHourlyCharge,omitempty" xmlrpc:"currentHourlyCharge,omitempty"` // The last time this billing item was charged. CycleStartDate *Time `json:"cycleStartDate,omitempty" xmlrpc:"cycleStartDate,omitempty"` // A brief description of a billing item. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // The domain name is provided for server billing items. DomainName *string `json:"domainName,omitempty" xmlrpc:"domainName,omitempty"` // A count of for product items which have a downgrade path defined, this will return those product items. DowngradeItemCount *uint `json:"downgradeItemCount,omitempty" xmlrpc:"downgradeItemCount,omitempty"` // For product items which have a downgrade path defined, this will return those product items. DowngradeItems []Product_Item `json:"downgradeItems,omitempty" xmlrpc:"downgradeItems,omitempty"` // A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. FilteredNextInvoiceChildren []Billing_Item `json:"filteredNextInvoiceChildren,omitempty" xmlrpc:"filteredNextInvoiceChildren,omitempty"` // A count of a Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee. FilteredNextInvoiceChildrenCount *uint `json:"filteredNextInvoiceChildrenCount,omitempty" xmlrpc:"filteredNextInvoiceChildrenCount,omitempty"` // The hostname is provided for server billing items HostName *string `json:"hostName,omitempty" xmlrpc:"hostName,omitempty"` // A flag that will reflect whether this billing item is billed on an hourly basis or not. HourlyFlag *bool `json:"hourlyFlag,omitempty" xmlrpc:"hourlyFlag,omitempty"` // The amount of money charged per hour for a billing item, if applicable. hourlyRecurringFee is measured in US Dollars ($USD). HourlyRecurringFee *Float64 `json:"hourlyRecurringFee,omitempty" xmlrpc:"hourlyRecurringFee,omitempty"` // 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. HoursUsed *string `json:"hoursUsed,omitempty" xmlrpc:"hoursUsed,omitempty"` // The unique identifier for this billing item. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Invoice items associated with this billing item InvoiceItem *Billing_Invoice_Item `json:"invoiceItem,omitempty" xmlrpc:"invoiceItem,omitempty"` // A count of all invoice items associated with the billing item InvoiceItemCount *uint `json:"invoiceItemCount,omitempty" xmlrpc:"invoiceItemCount,omitempty"` // All invoice items associated with the billing item InvoiceItems []Billing_Invoice_Item `json:"invoiceItems,omitempty" xmlrpc:"invoiceItems,omitempty"` // The entry in the SoftLayer product catalog that a billing item is based upon. Item *Product_Item `json:"item,omitempty" xmlrpc:"item,omitempty"` // The labor fee, if any. This is a one time charge. LaborFee *Float64 `json:"laborFee,omitempty" xmlrpc:"laborFee,omitempty"` // The rate at which labor fees are taxed if you are a taxable customer. LaborFeeTaxRate *Float64 `json:"laborFeeTaxRate,omitempty" xmlrpc:"laborFeeTaxRate,omitempty"` // The last time this billing item was charged. LastBillDate *Time `json:"lastBillDate,omitempty" xmlrpc:"lastBillDate,omitempty"` // 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. Location *Location `json:"location,omitempty" xmlrpc:"location,omitempty"` // The date that a billing item was last modified. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // The date on which your account will be charged for this billing item. NextBillDate *Time `json:"nextBillDate,omitempty" xmlrpc:"nextBillDate,omitempty"` // A Billing Item's child billing items and associated items' NextInvoiceChildren []Billing_Item `json:"nextInvoiceChildren,omitempty" xmlrpc:"nextInvoiceChildren,omitempty"` // A count of a Billing Item's child billing items and associated items' NextInvoiceChildrenCount *uint `json:"nextInvoiceChildrenCount,omitempty" xmlrpc:"nextInvoiceChildrenCount,omitempty"` // A Billing Item's total, including any child billing items if they exist.' NextInvoiceTotalOneTimeAmount *Float64 `json:"nextInvoiceTotalOneTimeAmount,omitempty" xmlrpc:"nextInvoiceTotalOneTimeAmount,omitempty"` // A Billing Item's total, including any child billing items if they exist.' NextInvoiceTotalOneTimeTaxAmount *Float64 `json:"nextInvoiceTotalOneTimeTaxAmount,omitempty" xmlrpc:"nextInvoiceTotalOneTimeTaxAmount,omitempty"` // A Billing Item's total, including any child billing items and associated billing items if they exist.' NextInvoiceTotalRecurringAmount *Float64 `json:"nextInvoiceTotalRecurringAmount,omitempty" xmlrpc:"nextInvoiceTotalRecurringAmount,omitempty"` // This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only. NextInvoiceTotalRecurringTaxAmount *Float64 `json:"nextInvoiceTotalRecurringTaxAmount,omitempty" xmlrpc:"nextInvoiceTotalRecurringTaxAmount,omitempty"` // A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. NonZeroNextInvoiceChildren []Billing_Item `json:"nonZeroNextInvoiceChildren,omitempty" xmlrpc:"nonZeroNextInvoiceChildren,omitempty"` // A count of a Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee. NonZeroNextInvoiceChildrenCount *uint `json:"nonZeroNextInvoiceChildrenCount,omitempty" xmlrpc:"nonZeroNextInvoiceChildrenCount,omitempty"` // 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. Notes *string `json:"notes,omitempty" xmlrpc:"notes,omitempty"` // The amount of money charged as a one-time charge for a billing item, if applicable. oneTimeFee is measured in US Dollars ($USD). OneTimeFee *Float64 `json:"oneTimeFee,omitempty" xmlrpc:"oneTimeFee,omitempty"` // The rate at which one time fees are taxed if you are a taxable customer. OneTimeFeeTaxRate *Float64 `json:"oneTimeFeeTaxRate,omitempty" xmlrpc:"oneTimeFeeTaxRate,omitempty"` // A billing item's original order item. Simply a reference to the original order from which this billing item was created. OrderItem *Billing_Order_Item `json:"orderItem,omitempty" xmlrpc:"orderItem,omitempty"` // the SoftLayer_Billing_Order_Item ID. This is a reference to the original order item from which this billing item was originally created. OrderItemId *int `json:"orderItemId,omitempty" xmlrpc:"orderItemId,omitempty"` // The original physical location for this billing item--may differ from current. OriginalLocation *Location `json:"originalLocation,omitempty" xmlrpc:"originalLocation,omitempty"` // The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms. Package *Product_Package `json:"package,omitempty" xmlrpc:"package,omitempty"` // This is the package id for this billing item. PackageId *int `json:"packageId,omitempty" xmlrpc:"packageId,omitempty"` // A billing item's parent item. If a billing item has no parent item then this value is null. Parent *Billing_Item `json:"parent,omitempty" xmlrpc:"parent,omitempty"` // The unique identifier of the parent of this billing item. ParentId *int `json:"parentId,omitempty" xmlrpc:"parentId,omitempty"` // A billing item's parent item. If a billing item has no parent item then this value is null. ParentVirtualGuestBillingItem *Billing_Item_Virtual_Guest `json:"parentVirtualGuestBillingItem,omitempty" xmlrpc:"parentVirtualGuestBillingItem,omitempty"` // This flag indicates whether a billing item is scheduled to be canceled or not. PendingCancellationFlag *bool `json:"pendingCancellationFlag,omitempty" xmlrpc:"pendingCancellationFlag,omitempty"` // The new order item that will replace this billing item. PendingOrderItem *Billing_Order_Item `json:"pendingOrderItem,omitempty" xmlrpc:"pendingOrderItem,omitempty"` // Provisioning transaction for this billing item ProvisionTransaction *Provisioning_Version1_Transaction `json:"provisionTransaction,omitempty" xmlrpc:"provisionTransaction,omitempty"` // The amount of money charged per month for a billing item, if applicable. recurringFee is measured in US Dollars ($USD). RecurringFee *Float64 `json:"recurringFee,omitempty" xmlrpc:"recurringFee,omitempty"` // The rate at which recurring fees are taxed if you are a taxable customer. RecurringFeeTaxRate *Float64 `json:"recurringFeeTaxRate,omitempty" xmlrpc:"recurringFeeTaxRate,omitempty"` // The number of months in which the recurring fees will be incurred. RecurringMonths *int `json:"recurringMonths,omitempty" xmlrpc:"recurringMonths,omitempty"` // This is the service provider for this billing item. ServiceProviderId *int `json:"serviceProviderId,omitempty" xmlrpc:"serviceProviderId,omitempty"` // The setup fee, if any. This is a one time charge. SetupFee *Float64 `json:"setupFee,omitempty" xmlrpc:"setupFee,omitempty"` // The rate at which setup fees are taxed if you are a taxable customer. SetupFeeTaxRate *Float64 `json:"setupFeeTaxRate,omitempty" xmlrpc:"setupFeeTaxRate,omitempty"` // A friendly description of software component SoftwareDescription *Software_Description `json:"softwareDescription,omitempty" xmlrpc:"softwareDescription,omitempty"` // Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path. UpgradeItem *Product_Item `json:"upgradeItem,omitempty" xmlrpc:"upgradeItem,omitempty"` // 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. UpgradeItemCount *uint `json:"upgradeItemCount,omitempty" xmlrpc:"upgradeItemCount,omitempty"` // Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path. UpgradeItems []Product_Item `json:"upgradeItems,omitempty" xmlrpc:"upgradeItems,omitempty"` }
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|invoices]] 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.
type Billing_Item_Account_Media_Data_Transfer_Request ¶
type Billing_Item_Account_Media_Data_Transfer_Request struct { Billing_Item // The data transfer request to which the billing item points. Resource *Account_Media_Data_Transfer_Request `json:"resource,omitempty" xmlrpc:"resource,omitempty"` }
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.
type Billing_Item_Association_History ¶
type Billing_Item_Association_History struct { Entity // The server billing item that an orphaned billing item was associated with. AssociatedBillingItem *Billing_Item `json:"associatedBillingItem,omitempty" xmlrpc:"associatedBillingItem,omitempty"` // The internal identifier of the server billing item that an orphaned billing item was associated with. AssociatedBillingItemId *int `json:"associatedBillingItemId,omitempty" xmlrpc:"associatedBillingItemId,omitempty"` // The billing item that was associated with a server billing item. BillingItem *Billing_Item `json:"billingItem,omitempty" xmlrpc:"billingItem,omitempty"` // The internal identifier of the billing item that was associated with a server billing item. BillingItemId *int `json:"billingItemId,omitempty" xmlrpc:"billingItemId,omitempty"` // The date that a billing item association was last changed. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // A billing item association history's internal identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` }
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.
type Billing_Item_Cancellation_Reason ¶
type Billing_Item_Cancellation_Reason struct { Entity // A cancel reason category internal identifier. BillingCancelReasonCategoryId *int `json:"billingCancelReasonCategoryId,omitempty" xmlrpc:"billingCancelReasonCategoryId,omitempty"` // An billing cancellation reason category. BillingCancellationReasonCategory *Billing_Item_Cancellation_Reason_Category `json:"billingCancellationReasonCategory,omitempty" xmlrpc:"billingCancellationReasonCategory,omitempty"` // A count of the corresponding billing items having the specific cancellation reason. BillingItemCount *uint `json:"billingItemCount,omitempty" xmlrpc:"billingItemCount,omitempty"` // The corresponding billing items having the specific cancellation reason. BillingItems []Billing_Item `json:"billingItems,omitempty" xmlrpc:"billingItems,omitempty"` // A reason internal identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A standardized reason internal identifier. KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // The descriptoin of the reason Reason *string `json:"reason,omitempty" xmlrpc:"reason,omitempty"` // no documentation yet TranslatedReason *string `json:"translatedReason,omitempty" xmlrpc:"translatedReason,omitempty"` }
The SoftLayer_Billing_Item_Cancellation_Reason data type contains cancellation reasons.
type Billing_Item_Cancellation_Reason_Category ¶
type Billing_Item_Cancellation_Reason_Category struct { Entity // A count of the corresponding billing cancellation reasons having the specific billing cancellation reason category. BillingCancellationReasonCount *uint `json:"billingCancellationReasonCount,omitempty" xmlrpc:"billingCancellationReasonCount,omitempty"` // The corresponding billing cancellation reasons having the specific billing cancellation reason category. BillingCancellationReasons []Billing_Item_Cancellation_Reason `json:"billingCancellationReasons,omitempty" xmlrpc:"billingCancellationReasons,omitempty"` // A category internal identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The description of the category Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
The SoftLayer_Billing_Item_Cancellation_Reason_Category data type contains cancellation reason categories.
type Billing_Item_Cancellation_Request ¶
type Billing_Item_Cancellation_Request struct { Entity // The SoftLayer account that a service cancellation request belongs to. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // The internal identifier of the customer account that a service cancellation record belongs to. AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // The last modified date. BillingCancelReasonId *int `json:"billingCancelReasonId,omitempty" xmlrpc:"billingCancelReasonId,omitempty"` // The date that a cancellation request was created. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // A cancellation record's internal identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A count of a collection of service cancellation items. ItemCount *uint `json:"itemCount,omitempty" xmlrpc:"itemCount,omitempty"` // A collection of service cancellation items. Items []Billing_Item_Cancellation_Request_Item `json:"items,omitempty" xmlrpc:"items,omitempty"` // The last modified date. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // Brief cancellation note. Notes *string `json:"notes,omitempty" xmlrpc:"notes,omitempty"` // The status of a service cancellation request. Status *Billing_Item_Cancellation_Request_Status `json:"status,omitempty" xmlrpc:"status,omitempty"` // 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. StatusId *int `json:"statusId,omitempty" xmlrpc:"statusId,omitempty"` // The ticket that is associated with the service cancellation request. Ticket *Ticket `json:"ticket,omitempty" xmlrpc:"ticket,omitempty"` // 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. TicketId *int `json:"ticketId,omitempty" xmlrpc:"ticketId,omitempty"` // The user that initiated a service cancellation request. User *User_Customer `json:"user,omitempty" xmlrpc:"user,omitempty"` }
SoftLayer_Billing_Item_Cancellation_Request data type is used to cancel service billing items.
type Billing_Item_Cancellation_Request_Item ¶
type Billing_Item_Cancellation_Request_Item struct { Entity // The billing item for cancellation. BillingItem *Billing_Item `json:"billingItem,omitempty" xmlrpc:"billingItem,omitempty"` // The internal identifier of a billing item BillingItemId *int `json:"billingItemId,omitempty" xmlrpc:"billingItemId,omitempty"` // The service cancellation request that a cancellation item belongs to. CancellationRequest *Billing_Item_Cancellation_Request `json:"cancellationRequest,omitempty" xmlrpc:"cancellationRequest,omitempty"` // A cancellation request's internal identifier. CancellationRequestId *int `json:"cancellationRequestId,omitempty" xmlrpc:"cancellationRequestId,omitempty"` // A cancellation request item's internal identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // This flag indicated if a billing item should be canceled immediately or not. Set this flag to true when creating a cancellation request. ImmediateCancellationFlag *bool `json:"immediateCancellationFlag,omitempty" xmlrpc:"immediateCancellationFlag,omitempty"` // The scheduled cancellation date ScheduledCancellationDate *Time `json:"scheduledCancellationDate,omitempty" xmlrpc:"scheduledCancellationDate,omitempty"` // The reclaim status of a service. ServiceReclaimStatusCode *string `json:"serviceReclaimStatusCode,omitempty" xmlrpc:"serviceReclaimStatusCode,omitempty"` }
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.
type Billing_Item_Cancellation_Request_Status ¶
type Billing_Item_Cancellation_Request_Status struct { Entity // The short description of a cancellation request status Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // The internal identifier of a cancellation request status. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // status key name KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // The status name Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
SoftLayer_Billing_Item_Cancellation_Request_Status data type represents the status of a service cancellation request.
type Billing_Item_Chronicle ¶ added in v1.0.6
type Billing_Item_Chronicle struct { Entity // no documentation yet AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // no documentation yet AssociatedBillingItemId *int `json:"associatedBillingItemId,omitempty" xmlrpc:"associatedBillingItemId,omitempty"` // A Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item. AssociatedChildren []Billing_Item_Chronicle `json:"associatedChildren,omitempty" xmlrpc:"associatedChildren,omitempty"` // no documentation yet AssociatedChildrenCount *int `json:"associatedChildrenCount,omitempty" xmlrpc:"associatedChildrenCount,omitempty"` // no documentation yet CancellationDate *Time `json:"cancellationDate,omitempty" xmlrpc:"cancellationDate,omitempty"` // no documentation yet CategoryCode *string `json:"categoryCode,omitempty" xmlrpc:"categoryCode,omitempty"` // no documentation yet CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // no documentation yet CurrentHourlyCharge *Float64 `json:"currentHourlyCharge,omitempty" xmlrpc:"currentHourlyCharge,omitempty"` // no documentation yet CycleStartDate *Time `json:"cycleStartDate,omitempty" xmlrpc:"cycleStartDate,omitempty"` // no documentation yet DPart *string `json:"dPart,omitempty" xmlrpc:"dPart,omitempty"` // no documentation yet Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // no documentation yet DomainName *string `json:"domainName,omitempty" xmlrpc:"domainName,omitempty"` // no documentation yet ExternalAccountId *string `json:"externalAccountId,omitempty" xmlrpc:"externalAccountId,omitempty"` // no documentation yet HostName *string `json:"hostName,omitempty" xmlrpc:"hostName,omitempty"` // no documentation yet HourlyFlag *bool `json:"hourlyFlag,omitempty" xmlrpc:"hourlyFlag,omitempty"` // no documentation yet HourlyRecurringFee *Float64 `json:"hourlyRecurringFee,omitempty" xmlrpc:"hourlyRecurringFee,omitempty"` // no documentation yet HoursUsed *int `json:"hoursUsed,omitempty" xmlrpc:"hoursUsed,omitempty"` // The id for the chronicle record will match one to one the id for the corresponding billing item. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet ItemId *int `json:"itemId,omitempty" xmlrpc:"itemId,omitempty"` // no documentation yet LaborFee *Float64 `json:"laborFee,omitempty" xmlrpc:"laborFee,omitempty"` // no documentation yet LastBillDate *Time `json:"lastBillDate,omitempty" xmlrpc:"lastBillDate,omitempty"` // no documentation yet Location *Location `json:"location,omitempty" xmlrpc:"location,omitempty"` // no documentation yet ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // no documentation yet NextBillDate *Time `json:"nextBillDate,omitempty" xmlrpc:"nextBillDate,omitempty"` // no documentation yet OneTimeFee *Float64 `json:"oneTimeFee,omitempty" xmlrpc:"oneTimeFee,omitempty"` // no documentation yet PackageId *int `json:"packageId,omitempty" xmlrpc:"packageId,omitempty"` // no documentation yet ParentId *int `json:"parentId,omitempty" xmlrpc:"parentId,omitempty"` // The entry in the product catalog that the underlying billing item is based on. Product *Product_Item `json:"product,omitempty" xmlrpc:"product,omitempty"` // no documentation yet RecurringFee *Float64 `json:"recurringFee,omitempty" xmlrpc:"recurringFee,omitempty"` // no documentation yet RecurringMonths *int `json:"recurringMonths,omitempty" xmlrpc:"recurringMonths,omitempty"` // no documentation yet ResourceTableId *int `json:"resourceTableId,omitempty" xmlrpc:"resourceTableId,omitempty"` // no documentation yet ResourceTableName *string `json:"resourceTableName,omitempty" xmlrpc:"resourceTableName,omitempty"` // no documentation yet SetupFee *Float64 `json:"setupFee,omitempty" xmlrpc:"setupFee,omitempty"` // no documentation yet TopLevelProductGroupName *string `json:"topLevelProductGroupName,omitempty" xmlrpc:"topLevelProductGroupName,omitempty"` // no documentation yet UsageChargeFlag *bool `json:"usageChargeFlag,omitempty" xmlrpc:"usageChargeFlag,omitempty"` }
no documentation yet
type Billing_Item_Ctc_Account ¶
type Billing_Item_Ctc_Account struct {
Billing_Item
}
The SoftLayer_Billing_Item_Ctc_Account data type contains general information relating to a single SoftLayer billing item for a CTC client account creation
type Billing_Item_Gateway_Appliance_Cluster ¶
type Billing_Item_Gateway_Appliance_Cluster struct {
Billing_Item
}
The SoftLayer_Billing_Item_Big_Data_Cluster data type contains general information relating to a single SoftLayer billing item for a big data cluster.
type Billing_Item_Gateway_License ¶ added in v1.1.4
type Billing_Item_Gateway_License struct { Billing_Item // no documentation yet Resource *Network_Gateway `json:"resource,omitempty" xmlrpc:"resource,omitempty"` }
The SoftLayer_Billing_Item_Gateway_License data type contains general information relating to a single SoftLayer billing item for a bare_metal_gateway_license
type Billing_Item_Hardware ¶
type Billing_Item_Hardware struct { Billing_Item // The raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to. BillingCycleBandwidthUsage []Network_Bandwidth_Usage `json:"billingCycleBandwidthUsage,omitempty" xmlrpc:"billingCycleBandwidthUsage,omitempty"` // 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. BillingCycleBandwidthUsageCount *uint `json:"billingCycleBandwidthUsageCount,omitempty" xmlrpc:"billingCycleBandwidthUsageCount,omitempty"` // The raw private bandwidth usage data for the current billing cycle. BillingCyclePrivateBandwidthUsage []Network_Bandwidth_Usage `json:"billingCyclePrivateBandwidthUsage,omitempty" xmlrpc:"billingCyclePrivateBandwidthUsage,omitempty"` // A count of the raw private bandwidth usage data for the current billing cycle. BillingCyclePrivateBandwidthUsageCount *uint `json:"billingCyclePrivateBandwidthUsageCount,omitempty" xmlrpc:"billingCyclePrivateBandwidthUsageCount,omitempty"` // The total private inbound bandwidth for this hardware for the current billing cycle. BillingCyclePrivateUsageIn *Float64 `json:"billingCyclePrivateUsageIn,omitempty" xmlrpc:"billingCyclePrivateUsageIn,omitempty"` // The total private outbound bandwidth for this hardware for the current billing cycle. BillingCyclePrivateUsageOut *Float64 `json:"billingCyclePrivateUsageOut,omitempty" xmlrpc:"billingCyclePrivateUsageOut,omitempty"` // The total private bandwidth for this hardware for the current billing cycle. BillingCyclePrivateUsageTotal *uint `json:"billingCyclePrivateUsageTotal,omitempty" xmlrpc:"billingCyclePrivateUsageTotal,omitempty"` // The raw public bandwidth usage data for the current billing cycle. BillingCyclePublicBandwidthUsage []Network_Bandwidth_Usage `json:"billingCyclePublicBandwidthUsage,omitempty" xmlrpc:"billingCyclePublicBandwidthUsage,omitempty"` // A count of the raw public bandwidth usage data for the current billing cycle. BillingCyclePublicBandwidthUsageCount *uint `json:"billingCyclePublicBandwidthUsageCount,omitempty" xmlrpc:"billingCyclePublicBandwidthUsageCount,omitempty"` // The total public inbound bandwidth for this hardware for the current billing cycle. BillingCyclePublicUsageIn *Float64 `json:"billingCyclePublicUsageIn,omitempty" xmlrpc:"billingCyclePublicUsageIn,omitempty"` // The total public outbound bandwidth for this hardware for the current billing cycle. BillingCyclePublicUsageOut *Float64 `json:"billingCyclePublicUsageOut,omitempty" xmlrpc:"billingCyclePublicUsageOut,omitempty"` // The total public bandwidth for this hardware for the current billing cycle. BillingCyclePublicUsageTotal *uint `json:"billingCyclePublicUsageTotal,omitempty" xmlrpc:"billingCyclePublicUsageTotal,omitempty"` // A lockbox account associated with a server. LockboxNetworkStorage *Billing_Item_Network_Storage `json:"lockboxNetworkStorage,omitempty" xmlrpc:"lockboxNetworkStorage,omitempty"` // A count of MonitoringBillingItemCount *uint `json:"monitoringBillingItemCount,omitempty" xmlrpc:"monitoringBillingItemCount,omitempty"` // no documentation yet MonitoringBillingItems []Billing_Item `json:"monitoringBillingItems,omitempty" xmlrpc:"monitoringBillingItems,omitempty"` // The resource for a server billing item. Resource *Hardware_Server `json:"resource,omitempty" xmlrpc:"resource,omitempty"` // The resource (unique identifier) for a server billing item. ResourceTableId *int `json:"resourceTableId,omitempty" xmlrpc:"resourceTableId,omitempty"` }
The SoftLayer_Billing_Item_Hardware data type contains general information relating to a single SoftLayer billing item for hardware.
type Billing_Item_Hardware_Colocation ¶
type Billing_Item_Hardware_Colocation struct {
Billing_Item_Hardware
}
The SoftLayer_Billing_Item_Hardware data type contains general information relating to a single SoftLayer billing item for hardware.
type Billing_Item_Hardware_Component ¶
type Billing_Item_Hardware_Component struct { Billing_Item // The hardware component that this billing item points to. Resource []Hardware_Component `json:"resource,omitempty" xmlrpc:"resource,omitempty"` // A count of the hardware component that this billing item points to. ResourceCount *uint `json:"resourceCount,omitempty" xmlrpc:"resourceCount,omitempty"` // The resource (unique identifier) for a server billing item. ResourceTableId *int `json:"resourceTableId,omitempty" xmlrpc:"resourceTableId,omitempty"` }
The SoftLayer_Billing_Item_Hardware data type contains general information relating to a single SoftLayer billing item for hardware components.
type Billing_Item_Hardware_Security_Module ¶
type Billing_Item_Hardware_Security_Module struct {
Billing_Item_Hardware
}
The SoftLayer_Billing_Item_Hardware_Security_Module data type contains general information relating to a single SoftLayer billing item for a hardware security module.
type Billing_Item_Hardware_Server ¶
type Billing_Item_Hardware_Server struct {
Billing_Item_Hardware
}
The SoftLayer_Billing_Item_Hardware_Server data type contains billing information about a bare metal server and its relationship to a particular customer account.
type Billing_Item_Network_Application_Delivery_Controller ¶
type Billing_Item_Network_Application_Delivery_Controller struct { Billing_Item // The bandwidth allotment detail for a billing item. BandwidthAllotmentDetail *Network_Bandwidth_Version1_Allotment_Detail `json:"bandwidthAllotmentDetail,omitempty" xmlrpc:"bandwidthAllotmentDetail,omitempty"` // The network application controller that a billing item is associated with. Resource *Network_Application_Delivery_Controller `json:"resource,omitempty" xmlrpc:"resource,omitempty"` }
The SoftLayer_Billing_Item_Network_Application_Delivery_Controller data type describes the billing item related to a NetScaler VPX
type Billing_Item_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress ¶
type Billing_Item_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress struct { Billing_Item // The load balancer that a load balancer billing item is associated with. Resource *Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress `json:"resource,omitempty" xmlrpc:"resource,omitempty"` }
A SoftLayer_Billing_Item_Network_Application_Delivery_Controller_LoadBalancer represents the [[SoftLayer_Billing_Item|billing item]] related to a single [[SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress|load balancer]] instance.
type Billing_Item_Network_Bandwidth ¶
type Billing_Item_Network_Bandwidth struct {
Billing_Item
}
The SoftLayer_Billing_Item_Hardware data type contains general information relating to a single SoftLayer billing item for hardware.
type Billing_Item_Network_Firewall ¶
type Billing_Item_Network_Firewall struct { Billing_Item // The VLAN firewall that a VLAN firewall billing item is associated with. Resource *Network_Component_Firewall `json:"resource,omitempty" xmlrpc:"resource,omitempty"` }
The SoftLayer_Billing_Item_Network_Firewall data type contains general information relating to a single SoftLayer billing item whose item category code is 'firewall'
type Billing_Item_Network_Firewall_Module_Context ¶
type Billing_Item_Network_Firewall_Module_Context struct { Billing_Item // The total public outbound bandwidth for this firewall for the current billing cycle. BillingCyclePublicUsageOut *Float64 `json:"billingCyclePublicUsageOut,omitempty" xmlrpc:"billingCyclePublicUsageOut,omitempty"` }
The SoftLayer_Billing_Item_Network_Firewall_Module_Context data type describes the billing items related to VLAN Firewalls.
type Billing_Item_Network_Interconnect ¶
type Billing_Item_Network_Interconnect struct { Billing_Item // The interconnect tenant that the billing item is associated with. Resource *Network_Interconnect_Tenant `json:"resource,omitempty" xmlrpc:"resource,omitempty"` }
A SoftLayer_Billing_Item_Network_Interconnect represents the [[SoftLayer_Billing_Item|billing item]] related to a network interconnect instance.
type Billing_Item_Network_Interconnect_Routing ¶ added in v1.0.2
type Billing_Item_Network_Interconnect_Routing struct { Billing_Item // The interconnect tenant that the billing item is associated with. Resource *Network_Interconnect_Tenant `json:"resource,omitempty" xmlrpc:"resource,omitempty"` }
A SoftLayer_Billing_Item_Network_Interconnect_Routing represents the [[SoftLayer_Billing_Item|billing item]] related to a network interconnect global routing.
type Billing_Item_Network_LoadBalancer ¶
type Billing_Item_Network_LoadBalancer struct {
Billing_Item
}
A SoftLayer_Billing_Item_Network_LoadBalancer represents the [[SoftLayer_Billing_Item|billing item]] related to a single [[SoftLayer_Network_LoadBalancer|load balancer]] instance.
type Billing_Item_Network_LoadBalancer_VirtualIpAddress ¶
type Billing_Item_Network_LoadBalancer_VirtualIpAddress struct { Billing_Item // The load balancer's virtual IP address that the billing item is associated with. Resource *Network_LoadBalancer_VirtualIpAddress `json:"resource,omitempty" xmlrpc:"resource,omitempty"` }
A SoftLayer_Billing_Item_Network_LoadBalancer_VirtualIpAddress represents the [[SoftLayer_Billing_Item|billing item]] related to a single [[SoftLayer_Network_LoadBalancer_VirtualIpAddress|load balancer]] instance.
type Billing_Item_Network_Message_Delivery ¶
type Billing_Item_Network_Message_Delivery struct { Billing_Item // The object this billing item is associated with. Resource *Network_Message_Delivery `json:"resource,omitempty" xmlrpc:"resource,omitempty"` }
The SoftLayer_Billing_Item_Network_Message_Delivery data describes the related billing item.
type Billing_Item_Network_PerformanceStorage_Iscsi ¶
type Billing_Item_Network_PerformanceStorage_Iscsi struct {
Billing_Item_Network_Storage
}
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'
type Billing_Item_Network_PerformanceStorage_Nfs ¶
type Billing_Item_Network_PerformanceStorage_Nfs struct {
Billing_Item_Network_Storage
}
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'
type Billing_Item_Network_Storage ¶
type Billing_Item_Network_Storage struct { Billing_Item // The StorageLayer account that a network storage billing item is associated with. Resource *Network_Storage `json:"resource,omitempty" xmlrpc:"resource,omitempty"` }
The SoftLayer_Billing_Item_Network_Storage data type describes the billing items related to StorageLayer accounts.
type Billing_Item_Network_Storage_Hub ¶
type Billing_Item_Network_Storage_Hub struct {
Billing_Item_Network_Storage
}
The SoftLayer_Billing_Item_Network_Storage_Hub models all billing items related to hub-based StorageLayer offerings, such as CloudLayer storage.
type Billing_Item_Network_Storage_Hub_Bandwidth ¶
type Billing_Item_Network_Storage_Hub_Bandwidth struct {
Billing_Item_Network_Storage
}
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.
type Billing_Item_Network_Subnet ¶
type Billing_Item_Network_Subnet struct { Billing_Item // The resource for a subnet-related billing item. Resource *Network_Subnet `json:"resource,omitempty" xmlrpc:"resource,omitempty"` // The resource name for a subnet billing item. ResourceName *string `json:"resourceName,omitempty" xmlrpc:"resourceName,omitempty"` // The resource (unique identifier) for a server billing item. ResourceTableId *int `json:"resourceTableId,omitempty" xmlrpc:"resourceTableId,omitempty"` }
The SoftLayer_Billing_Item_Network_Subnet data type contains general information relating to a single SoftLayer billing item whose item category code is one of the following: * pri_ip_address * static_sec_ip_addresses (static secondary) * sov_sec_ip_addresses (secondary on vlan, also known as "portable ips") * sov_sec_ip_addresses_pub (sov_sec_ip_addresses public only) * sov_sec_ip_addresses_priv (sov_sec_ip_addresses private only) * sec_ip_addresses (old style, secondary ip addresses)
These item categories denote that the billing item has subnet information attached.
type Billing_Item_Network_Subnet_IpAddress_Global ¶
type Billing_Item_Network_Subnet_IpAddress_Global struct {
Billing_Item_Network_Subnet
}
The SoftLayer_Billing_Item_Network_Subnet_IpAddress_Global data type contains general information relating to a single SoftLayer billing item whose item category code is one of the following: * global_ipv4 * global_ipv6
These item categories denote that the billing item has subnet information attached.
type Billing_Item_Network_Tunnel ¶
type Billing_Item_Network_Tunnel struct { Billing_Item // The IPsec VPN that a network tunnel billing item is associated with. Resource *Network_Tunnel_Module_Context `json:"resource,omitempty" xmlrpc:"resource,omitempty"` }
The SoftLayer_Billing_Item_Network_Storage data type describes the billing items related to StorageLayer accounts.
type Billing_Item_Network_Vlan ¶
type Billing_Item_Network_Vlan struct { Billing_Item // The network vlan resource for this billing item. Resource *Network_Vlan `json:"resource,omitempty" xmlrpc:"resource,omitempty"` }
The SoftLayer_Billing_Item_Network_Vlan data type contains general information relating to a single SoftLayer billing item whose item category code is one of the following: * network_vlan
These item categories denote that the billing item has network vlan information attached.
type Billing_Item_NewCustomerSetup ¶
type Billing_Item_NewCustomerSetup struct {
Billing_Item
}
no documentation yet
type Billing_Item_Private_Cloud ¶
type Billing_Item_Private_Cloud struct {
Billing_Item
}
The SoftLayer_Billing_Item_Private_Cloud data type contains general information relating to a single billing item for a private cloud.
type Billing_Item_Software_Component ¶
type Billing_Item_Software_Component struct { Billing_Item // The software component that this billing item points to. Resource *Software_Component `json:"resource,omitempty" xmlrpc:"resource,omitempty"` // The resource (unique identifier) for a software component billing item. ResourceTableId *int `json:"resourceTableId,omitempty" xmlrpc:"resourceTableId,omitempty"` }
The SoftLayer_Billing_Item_Hardware data type contains general information relating to a single SoftLayer billing item for hardware components.
type Billing_Item_Software_Component_Analytics_Urchin ¶
type Billing_Item_Software_Component_Analytics_Urchin struct {
Billing_Item
}
The SoftLayer_Billing_Item_Software_Component_Analytics_Urchin data type contains general information relating to a single SoftLayer billing item for Urchin software components.
type Billing_Item_Software_Component_ControlPanel ¶
type Billing_Item_Software_Component_ControlPanel struct {
Billing_Item
}
The SoftLayer_Billing_Item_Software_Component_ControlPanel data type contains general information relating to a single SoftLayer billing item for control panel software components.
type Billing_Item_Software_Component_ControlPanel_Parallels_Plesk_Billing ¶
type Billing_Item_Software_Component_ControlPanel_Parallels_Plesk_Billing struct {
Billing_Item
}
The SoftLayer_Billing_Item_Software_Component_ControlPanel data type contains general information relating to a single SoftLayer billing item for control panel software components.
type Billing_Item_Software_Component_OperatingSystem_Addon ¶
type Billing_Item_Software_Component_OperatingSystem_Addon struct {
Billing_Item
}
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.
type Billing_Item_Software_Component_OperatingSystem_Addon_Citrix_Essentials ¶
type Billing_Item_Software_Component_OperatingSystem_Addon_Citrix_Essentials struct { Billing_Item_Software_Component_OperatingSystem_Addon // The Citrix Essentials software component that a billing item is associated with. Resource *Software_Component `json:"resource,omitempty" xmlrpc:"resource,omitempty"` }
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.
type Billing_Item_Software_Component_Virtual_OperatingSystem ¶
type Billing_Item_Software_Component_Virtual_OperatingSystem struct {
Billing_Item
}
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.
type Billing_Item_Software_Component_Virtual_OperatingSystem_Microsoft ¶
type Billing_Item_Software_Component_Virtual_OperatingSystem_Microsoft struct { Billing_Item_Software_Component_Virtual_OperatingSystem // The software virtual license to which this billing item points. Resource *Software_VirtualLicense `json:"resource,omitempty" xmlrpc:"resource,omitempty"` // The resource (unique identifier) for a software virtual license billing item. ResourceTableId *int `json:"resourceTableId,omitempty" xmlrpc:"resourceTableId,omitempty"` }
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.
type Billing_Item_Software_Component_Virtual_OperatingSystem_Redhat ¶
type Billing_Item_Software_Component_Virtual_OperatingSystem_Redhat struct { Billing_Item_Software_Component_Virtual_OperatingSystem // The software component to which this billing item points. Resource *Software_Component `json:"resource,omitempty" xmlrpc:"resource,omitempty"` // The resource (unique identifier) for a software component billing item. ResourceTableId *int `json:"resourceTableId,omitempty" xmlrpc:"resourceTableId,omitempty"` }
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.
type Billing_Item_Software_License ¶
type Billing_Item_Software_License struct { Billing_Item // The resource for a software license billing item. Resource *Software_AccountLicense `json:"resource,omitempty" xmlrpc:"resource,omitempty"` }
The SoftLayer_Billing_Item_Software_License data type contains general information relating to a single SoftLayer billing item for a software license.
type Billing_Item_Support ¶
type Billing_Item_Support struct {
Billing_Item
}
The SoftLayer_Billing_Item_Support data type contains general information relating to a premium support offering
type Billing_Item_User_Customer_External_Binding ¶
type Billing_Item_User_Customer_External_Binding struct { Billing_Item // The external authentication binding that a billing item is associated with. Resource *User_Customer_External_Binding `json:"resource,omitempty" xmlrpc:"resource,omitempty"` }
The SoftLayer_Billing_Item_Network_Application_Delivery_Controller data type describes the billing item related to an external authentication binding
type Billing_Item_Virtual_DedicatedHost ¶
type Billing_Item_Virtual_DedicatedHost struct { Billing_Item // The resource for a virtual dedicated host billing item. Resource *Virtual_DedicatedHost `json:"resource,omitempty" xmlrpc:"resource,omitempty"` // The resource (unique identifier) for a server billing item. ResourceTableId *int `json:"resourceTableId,omitempty" xmlrpc:"resourceTableId,omitempty"` }
no documentation yet
type Billing_Item_Virtual_Dedicated_Rack ¶
type Billing_Item_Virtual_Dedicated_Rack struct { Billing_Item // The raw bandwidth usage data for the current billing cycle. One object is returned for each network a virtual rack is attached to. BillingCycleBandwidthUsage []Network_Bandwidth_Usage `json:"billingCycleBandwidthUsage,omitempty" xmlrpc:"billingCycleBandwidthUsage,omitempty"` // 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. BillingCycleBandwidthUsageCount *uint `json:"billingCycleBandwidthUsageCount,omitempty" xmlrpc:"billingCycleBandwidthUsageCount,omitempty"` // The raw private bandwidth usage data for the current billing cycle. BillingCyclePrivateBandwidthUsage []Network_Bandwidth_Usage `json:"billingCyclePrivateBandwidthUsage,omitempty" xmlrpc:"billingCyclePrivateBandwidthUsage,omitempty"` // A count of the raw private bandwidth usage data for the current billing cycle. BillingCyclePrivateBandwidthUsageCount *uint `json:"billingCyclePrivateBandwidthUsageCount,omitempty" xmlrpc:"billingCyclePrivateBandwidthUsageCount,omitempty"` // The total private network inbound bandwidth for this virtual rack for the current billing cycle. BillingCyclePrivateUsageIn *Float64 `json:"billingCyclePrivateUsageIn,omitempty" xmlrpc:"billingCyclePrivateUsageIn,omitempty"` // The total private network outbound bandwidth for this virtual rack for the current billing cycle. BillingCyclePrivateUsageOut *Float64 `json:"billingCyclePrivateUsageOut,omitempty" xmlrpc:"billingCyclePrivateUsageOut,omitempty"` // The total private network bandwidth for this virtual rack for the current billing cycle. BillingCyclePrivateUsageTotal *uint `json:"billingCyclePrivateUsageTotal,omitempty" xmlrpc:"billingCyclePrivateUsageTotal,omitempty"` // The raw public bandwidth usage data for the current billing cycle. BillingCyclePublicBandwidthUsage []Network_Bandwidth_Usage `json:"billingCyclePublicBandwidthUsage,omitempty" xmlrpc:"billingCyclePublicBandwidthUsage,omitempty"` // A count of the raw public bandwidth usage data for the current billing cycle. BillingCyclePublicBandwidthUsageCount *uint `json:"billingCyclePublicBandwidthUsageCount,omitempty" xmlrpc:"billingCyclePublicBandwidthUsageCount,omitempty"` // The total public inbound bandwidth for this virtual rack for the current billing cycle. BillingCyclePublicUsageIn *Float64 `json:"billingCyclePublicUsageIn,omitempty" xmlrpc:"billingCyclePublicUsageIn,omitempty"` // The total public outbound bandwidth for this virtual rack for the current billing cycle. BillingCyclePublicUsageOut *Float64 `json:"billingCyclePublicUsageOut,omitempty" xmlrpc:"billingCyclePublicUsageOut,omitempty"` // The total public bandwidth for this virtual rack for the current billing cycle. BillingCyclePublicUsageTotal *uint `json:"billingCyclePublicUsageTotal,omitempty" xmlrpc:"billingCyclePublicUsageTotal,omitempty"` // The virtual rack that a virtual rack billing item is associated with. Resource *Network_Bandwidth_Version1_Allotment `json:"resource,omitempty" xmlrpc:"resource,omitempty"` }
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.
type Billing_Item_Virtual_Disk_Image ¶
type Billing_Item_Virtual_Disk_Image struct { Billing_Item // The disk image to which the billing item points. Resource *Virtual_Disk_Image `json:"resource,omitempty" xmlrpc:"resource,omitempty"` // The resource (unique identifier) for a disk image billing item. ResourceTableId *int `json:"resourceTableId,omitempty" xmlrpc:"resourceTableId,omitempty"` }
The SoftLayer_Billing_Item_Virtual_Disk_Image data type contains general information relating to a single SoftLayer billing item for disk images.
type Billing_Item_Virtual_Guest ¶
type Billing_Item_Virtual_Guest struct { Billing_Item // The raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to. BillingCycleBandwidthUsage []Network_Bandwidth_Usage `json:"billingCycleBandwidthUsage,omitempty" xmlrpc:"billingCycleBandwidthUsage,omitempty"` // 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. BillingCycleBandwidthUsageCount *uint `json:"billingCycleBandwidthUsageCount,omitempty" xmlrpc:"billingCycleBandwidthUsageCount,omitempty"` // The raw private bandwidth usage data for the current billing cycle. BillingCyclePrivateBandwidthUsage []Network_Bandwidth_Usage `json:"billingCyclePrivateBandwidthUsage,omitempty" xmlrpc:"billingCyclePrivateBandwidthUsage,omitempty"` // A count of the raw private bandwidth usage data for the current billing cycle. BillingCyclePrivateBandwidthUsageCount *uint `json:"billingCyclePrivateBandwidthUsageCount,omitempty" xmlrpc:"billingCyclePrivateBandwidthUsageCount,omitempty"` // The total private inbound bandwidth for this virtual server for the current billing cycle. BillingCyclePrivateUsageIn *Float64 `json:"billingCyclePrivateUsageIn,omitempty" xmlrpc:"billingCyclePrivateUsageIn,omitempty"` // The total private outbound bandwidth for this virtual server for the current billing cycle. BillingCyclePrivateUsageOut *Float64 `json:"billingCyclePrivateUsageOut,omitempty" xmlrpc:"billingCyclePrivateUsageOut,omitempty"` // The total private bandwidth for this virtual server for the current billing cycle. BillingCyclePrivateUsageTotal *uint `json:"billingCyclePrivateUsageTotal,omitempty" xmlrpc:"billingCyclePrivateUsageTotal,omitempty"` // The raw public bandwidth usage data for the current billing cycle. BillingCyclePublicBandwidthUsage []Network_Bandwidth_Usage `json:"billingCyclePublicBandwidthUsage,omitempty" xmlrpc:"billingCyclePublicBandwidthUsage,omitempty"` // A count of the raw public bandwidth usage data for the current billing cycle. BillingCyclePublicBandwidthUsageCount *uint `json:"billingCyclePublicBandwidthUsageCount,omitempty" xmlrpc:"billingCyclePublicBandwidthUsageCount,omitempty"` // The total public inbound bandwidth for this virtual server for the current billing cycle. BillingCyclePublicUsageIn *Float64 `json:"billingCyclePublicUsageIn,omitempty" xmlrpc:"billingCyclePublicUsageIn,omitempty"` // The total public outbound bandwidth for this virtual server for the current billing cycle. BillingCyclePublicUsageOut *Float64 `json:"billingCyclePublicUsageOut,omitempty" xmlrpc:"billingCyclePublicUsageOut,omitempty"` // The total public bandwidth for this virtual server for the current billing cycle. BillingCyclePublicUsageTotal *uint `json:"billingCyclePublicUsageTotal,omitempty" xmlrpc:"billingCyclePublicUsageTotal,omitempty"` // A count of MonitoringBillingItemCount *uint `json:"monitoringBillingItemCount,omitempty" xmlrpc:"monitoringBillingItemCount,omitempty"` // no documentation yet MonitoringBillingItems []Billing_Item `json:"monitoringBillingItems,omitempty" xmlrpc:"monitoringBillingItems,omitempty"` // The resource for a cloud server billing item. Resource *Virtual_Guest `json:"resource,omitempty" xmlrpc:"resource,omitempty"` // The resource (unique identifier) for a server billing item. ResourceTableId *int `json:"resourceTableId,omitempty" xmlrpc:"resourceTableId,omitempty"` }
The SoftLayer_Billing_Item_Virtual_Guest data type contains general information relating to a single SoftLayer billing item for guests.
type Billing_Item_Virtual_Host_Usage ¶
type Billing_Item_Virtual_Host_Usage struct { Billing_Item // The resource for a peak virtual machine usage billing item. Resource *Hardware `json:"resource,omitempty" xmlrpc:"resource,omitempty"` // The resource (unique identifier) for a server billing item. ResourceTableId *int `json:"resourceTableId,omitempty" xmlrpc:"resourceTableId,omitempty"` }
The SoftLayer_Billing_Item_Virtual_Host_Usage data type contains general information relating to a single SoftLayer billing item for virtual machine peak usage
type Billing_Item_Virtual_ReservedCapacity ¶
type Billing_Item_Virtual_ReservedCapacity struct { Billing_Item // The resource for a virtual dedicated host billing item. Resource *Virtual_ReservedCapacityGroup_Instance `json:"resource,omitempty" xmlrpc:"resource,omitempty"` }
no documentation yet
type Billing_Item_Workspace ¶
type Billing_Item_Workspace struct {
Billing_Item
}
The SoftLayer_Billing_Item_Workspace data type contains general information relating to a single SoftLayer billing item whose item category code is 'workspace'
type Billing_Order ¶
type Billing_Order struct { Entity // The [[SoftLayer_Account|account]] to which an order belongs. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // The account ID to which an order belongs. AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // no documentation yet Brand *Brand `json:"brand,omitempty" xmlrpc:"brand,omitempty"` // 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. Cart *Billing_Order_Cart `json:"cart,omitempty" xmlrpc:"cart,omitempty"` // A count of the [[SoftLayer_Billing_Order_Item (type)|order items]] that are core restricted CoreRestrictedItemCount *uint `json:"coreRestrictedItemCount,omitempty" xmlrpc:"coreRestrictedItemCount,omitempty"` // The [[SoftLayer_Billing_Order_Item (type)|order items]] that are core restricted CoreRestrictedItems []Billing_Order_Item `json:"coreRestrictedItems,omitempty" xmlrpc:"coreRestrictedItems,omitempty"` // The point in time at which a billing item was created. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // A count of all credit card transactions associated with this order. If this order was not placed with a credit card, this will be empty. CreditCardTransactionCount *uint `json:"creditCardTransactionCount,omitempty" xmlrpc:"creditCardTransactionCount,omitempty"` // All credit card transactions associated with this order. If this order was not placed with a credit card, this will be empty. CreditCardTransactions []Billing_Payment_Card_Transaction `json:"creditCardTransactions,omitempty" xmlrpc:"creditCardTransactions,omitempty"` // no documentation yet ExchangeRate *Billing_Currency_ExchangeRate `json:"exchangeRate,omitempty" xmlrpc:"exchangeRate,omitempty"` // * Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The SoftLayer_User_Customer id of the portal or API user who impersonated the user which submitted an order. ImpersonatingUserRecordId *int `json:"impersonatingUserRecordId,omitempty" xmlrpc:"impersonatingUserRecordId,omitempty"` // no documentation yet InitialInvoice *Billing_Invoice `json:"initialInvoice,omitempty" xmlrpc:"initialInvoice,omitempty"` // A count of the SoftLayer_Billing_Order_items included in an order. ItemCount *uint `json:"itemCount,omitempty" xmlrpc:"itemCount,omitempty"` // The SoftLayer_Billing_Order_items included in an order. Items []Billing_Order_Item `json:"items,omitempty" xmlrpc:"items,omitempty"` // The last time an order was updated. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // no documentation yet OrderApprovalDate *Time `json:"orderApprovalDate,omitempty" xmlrpc:"orderApprovalDate,omitempty"` // An order's non-server items total monthly fee. OrderNonServerMonthlyAmount *Float64 `json:"orderNonServerMonthlyAmount,omitempty" xmlrpc:"orderNonServerMonthlyAmount,omitempty"` // The SoftLayer_Billing_Order_Quote id of the quote's user who finalized an order. OrderQuoteId *int `json:"orderQuoteId,omitempty" xmlrpc:"orderQuoteId,omitempty"` // An order's server items total monthly fee. OrderServerMonthlyAmount *Float64 `json:"orderServerMonthlyAmount,omitempty" xmlrpc:"orderServerMonthlyAmount,omitempty"` // 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. OrderTopLevelItemCount *uint `json:"orderTopLevelItemCount,omitempty" xmlrpc:"orderTopLevelItemCount,omitempty"` // An order's top level items. This normally includes the server line item and any non-server additional services such as NAS or ISCSI. OrderTopLevelItems []Billing_Order_Item `json:"orderTopLevelItems,omitempty" xmlrpc:"orderTopLevelItems,omitempty"` // This amount represents the order's initial charge including set up fee and taxes. OrderTotalAmount *Float64 `json:"orderTotalAmount,omitempty" xmlrpc:"orderTotalAmount,omitempty"` // 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. OrderTotalOneTime *Float64 `json:"orderTotalOneTime,omitempty" xmlrpc:"orderTotalOneTime,omitempty"` // An order's total one time amount. This amount represents the initial fees before tax. OrderTotalOneTimeAmount *Float64 `json:"orderTotalOneTimeAmount,omitempty" xmlrpc:"orderTotalOneTimeAmount,omitempty"` // 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. OrderTotalOneTimeTaxAmount *Float64 `json:"orderTotalOneTimeTaxAmount,omitempty" xmlrpc:"orderTotalOneTimeTaxAmount,omitempty"` // 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. OrderTotalRecurring *Float64 `json:"orderTotalRecurring,omitempty" xmlrpc:"orderTotalRecurring,omitempty"` // An order's total recurring amount. This amount represents the fees that will be charged on a recurring (usually monthly) basis. OrderTotalRecurringAmount *Float64 `json:"orderTotalRecurringAmount,omitempty" xmlrpc:"orderTotalRecurringAmount,omitempty"` // The total tax amount of the recurring fees, if the SoftLayer_Account tied to a SoftLayer_Billing_Order is a taxable account. OrderTotalRecurringTaxAmount *Float64 `json:"orderTotalRecurringTaxAmount,omitempty" xmlrpc:"orderTotalRecurringTaxAmount,omitempty"` // An order's total setup fee. OrderTotalSetupAmount *Float64 `json:"orderTotalSetupAmount,omitempty" xmlrpc:"orderTotalSetupAmount,omitempty"` // The type of an order. This lets you know where this order was generated from. OrderType *Billing_Order_Type `json:"orderType,omitempty" xmlrpc:"orderType,omitempty"` // The SoftLayer_Billing_Order_Type id of the order. OrderTypeId *int `json:"orderTypeId,omitempty" xmlrpc:"orderTypeId,omitempty"` // A count of all PayPal transactions associated with this order. If this order was not placed with PayPal, this will be empty. PaypalTransactionCount *uint `json:"paypalTransactionCount,omitempty" xmlrpc:"paypalTransactionCount,omitempty"` // All PayPal transactions associated with this order. If this order was not placed with PayPal, this will be empty. PaypalTransactions []Billing_Payment_PayPal_Transaction `json:"paypalTransactions,omitempty" xmlrpc:"paypalTransactions,omitempty"` // no documentation yet PresaleEvent *Sales_Presale_Event `json:"presaleEvent,omitempty" xmlrpc:"presaleEvent,omitempty"` // no documentation yet PresaleEventId *int `json:"presaleEventId,omitempty" xmlrpc:"presaleEventId,omitempty"` // Deprecated. // Deprecated: This function has been marked as deprecated. PrivateCloudOrderFlag *bool `json:"privateCloudOrderFlag,omitempty" xmlrpc:"privateCloudOrderFlag,omitempty"` // 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' Quote *Billing_Order_Quote `json:"quote,omitempty" xmlrpc:"quote,omitempty"` // The Referral Partner who referred this order. (Only necessary for new customer orders) ReferralPartner *Account `json:"referralPartner,omitempty" xmlrpc:"referralPartner,omitempty"` // Purchaser current status e.i. Approved, Pending_Approval Status *string `json:"status,omitempty" xmlrpc:"status,omitempty"` // This flag indicates an order is an upgrade. UpgradeRequestFlag *bool `json:"upgradeRequestFlag,omitempty" xmlrpc:"upgradeRequestFlag,omitempty"` // The SoftLayer_User_Customer object tied to an order. UserRecord *User_Customer `json:"userRecord,omitempty" xmlrpc:"userRecord,omitempty"` // The SoftLayer_User_Customer id of the portal or API user who submitted an order. UserRecordId *int `json:"userRecordId,omitempty" xmlrpc:"userRecordId,omitempty"` }
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.
type Billing_Order_Cart ¶
type Billing_Order_Cart struct {
Billing_Order_Quote
}
no documentation yet
type Billing_Order_Item ¶
type Billing_Order_Item struct { Entity // The SoftLayer_Billing_Item tied to the order item. BillingItem *Billing_Item `json:"billingItem,omitempty" xmlrpc:"billingItem,omitempty"` // A count of the other items included with an ordered item. BundledItemCount *uint `json:"bundledItemCount,omitempty" xmlrpc:"bundledItemCount,omitempty"` // The other items included with an ordered item. BundledItems []Billing_Order_Item `json:"bundledItems,omitempty" xmlrpc:"bundledItems,omitempty"` // The item category tied to an order item. Category *Product_Item_Category `json:"category,omitempty" xmlrpc:"category,omitempty"` // The category code for the order item. CategoryCode *string `json:"categoryCode,omitempty" xmlrpc:"categoryCode,omitempty"` // The child order items for an order item. All server order items should have children. These children are considered a part of the server. Children []Billing_Order_Item `json:"children,omitempty" xmlrpc:"children,omitempty"` // 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. ChildrenCount *uint `json:"childrenCount,omitempty" xmlrpc:"childrenCount,omitempty"` // friendly description of purchase item. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // The domain name of the server as designated by the purchaser at the time of order placement. DomainName *string `json:"domainName,omitempty" xmlrpc:"domainName,omitempty"` // A hardware's universally unique identifier. GlobalIdentifier *string `json:"globalIdentifier,omitempty" xmlrpc:"globalIdentifier,omitempty"` // The component type tied to an order item. All hardware-specific items should have a generic hardware component. HardwareGenericComponent *Hardware_Component_Model_Generic `json:"hardwareGenericComponent,omitempty" xmlrpc:"hardwareGenericComponent,omitempty"` // The hostname of the server as designated by the purchaser at the time of order placement. HostName *string `json:"hostName,omitempty" xmlrpc:"hostName,omitempty"` // 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). HourlyRecurringFee *Float64 `json:"hourlyRecurringFee,omitempty" xmlrpc:"hourlyRecurringFee,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The SoftLayer_Product_Item tied to an order item. The item is the actual definition of the product being sold. Item *Product_Item `json:"item,omitempty" xmlrpc:"item,omitempty"` // A count of this is an item's category answers. ItemCategoryAnswerCount *uint `json:"itemCategoryAnswerCount,omitempty" xmlrpc:"itemCategoryAnswerCount,omitempty"` // This is an item's category answers. ItemCategoryAnswers []Billing_Order_Item_Category_Answer `json:"itemCategoryAnswers,omitempty" xmlrpc:"itemCategoryAnswers,omitempty"` // The SoftLayer_Product_Item ID for this order item. ItemId *int `json:"itemId,omitempty" xmlrpc:"itemId,omitempty"` // The SoftLayer_Product_Item_Price tied to an order item. The item price object describes the cost of an item. ItemPrice *Product_Item_Price `json:"itemPrice,omitempty" xmlrpc:"itemPrice,omitempty"` // the item price id (SoftLayer_Product_Item_Price->id) of the ordered item. ItemPriceId *Float64 `json:"itemPriceId,omitempty" xmlrpc:"itemPriceId,omitempty"` // An order item's labor fee total after taxes. This does not include any child invoice items. LaborAfterTaxAmount *Float64 `json:"laborAfterTaxAmount,omitempty" xmlrpc:"laborAfterTaxAmount,omitempty"` // The labor fee, if any. This is a one time charge. LaborFee *Float64 `json:"laborFee,omitempty" xmlrpc:"laborFee,omitempty"` // The rate at which labor fees are taxed if you are a taxable customer. LaborFeeTaxRate *Float64 `json:"laborFeeTaxRate,omitempty" xmlrpc:"laborFeeTaxRate,omitempty"` // An order item's labor tax amount. This does not include any child invoice items. LaborTaxAmount *Float64 `json:"laborTaxAmount,omitempty" xmlrpc:"laborTaxAmount,omitempty"` // 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. Location *Location `json:"location,omitempty" xmlrpc:"location,omitempty"` // no documentation yet NextOrderChildren []Billing_Order_Item `json:"nextOrderChildren,omitempty" xmlrpc:"nextOrderChildren,omitempty"` // A count of NextOrderChildrenCount *uint `json:"nextOrderChildrenCount,omitempty" xmlrpc:"nextOrderChildrenCount,omitempty"` // This is only populated when an upgrade order is placed. The old billing item represents what the billing was before the upgrade happened. OldBillingItem *Billing_Item `json:"oldBillingItem,omitempty" xmlrpc:"oldBillingItem,omitempty"` // An order item's one-time fee total after taxes. This does not include any child invoice items. OneTimeAfterTaxAmount *Float64 `json:"oneTimeAfterTaxAmount,omitempty" xmlrpc:"oneTimeAfterTaxAmount,omitempty"` // The amount of money charged as a one-time charge for an order item, if applicable. oneTimeFee is measured in US Dollars ($USD). OneTimeFee *Float64 `json:"oneTimeFee,omitempty" xmlrpc:"oneTimeFee,omitempty"` // The rate at which one time fees are taxed if you are a taxable customer. OneTimeFeeTaxRate *Float64 `json:"oneTimeFeeTaxRate,omitempty" xmlrpc:"oneTimeFeeTaxRate,omitempty"` // An order item's one-time tax amount. This does not include any child invoice items. OneTimeTaxAmount *Float64 `json:"oneTimeTaxAmount,omitempty" xmlrpc:"oneTimeTaxAmount,omitempty"` // The order to which this item belongs. The order contains all the information related to the items included in an order Order *Billing_Order `json:"order,omitempty" xmlrpc:"order,omitempty"` // no documentation yet OrderApprovalDate *Time `json:"orderApprovalDate,omitempty" xmlrpc:"orderApprovalDate,omitempty"` // The SoftLayer_Product_Package an order item is a part of. Package *Product_Package `json:"package,omitempty" xmlrpc:"package,omitempty"` // 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. Parent *Billing_Order_Item `json:"parent,omitempty" xmlrpc:"parent,omitempty"` // no documentation yet ParentId *int `json:"parentId,omitempty" xmlrpc:"parentId,omitempty"` // The SoftLayer_Product_Package_Preset related to this order item. Preset *Product_Package_Preset `json:"preset,omitempty" xmlrpc:"preset,omitempty"` // The id for the preset configuration ordered. PresetId *int `json:"presetId,omitempty" xmlrpc:"presetId,omitempty"` // no documentation yet PromoCode *Product_Promotion `json:"promoCode,omitempty" xmlrpc:"promoCode,omitempty"` // no documentation yet PromoCodeId *int `json:"promoCodeId,omitempty" xmlrpc:"promoCodeId,omitempty"` // the quantity of the ordered item in a quote. Quantity *int `json:"quantity,omitempty" xmlrpc:"quantity,omitempty"` // An order item's recurring fee total after taxes. This does not include any child invoice items. RecurringAfterTaxAmount *Float64 `json:"recurringAfterTaxAmount,omitempty" xmlrpc:"recurringAfterTaxAmount,omitempty"` // The amount of money charged per month for an order item, if applicable. recurringFee is measured in US Dollars ($USD). RecurringFee *Float64 `json:"recurringFee,omitempty" xmlrpc:"recurringFee,omitempty"` // An order item's recurring tax amount. This does not include any child invoice items. RecurringTaxAmount *Float64 `json:"recurringTaxAmount,omitempty" xmlrpc:"recurringTaxAmount,omitempty"` // A count of power supplies contained within this SoftLayer_Billing_Order RedundantPowerSupplyCount *uint `json:"redundantPowerSupplyCount,omitempty" xmlrpc:"redundantPowerSupplyCount,omitempty"` // An order item's setup fee total after taxes. This does not include any child invoice items. SetupAfterTaxAmount *Float64 `json:"setupAfterTaxAmount,omitempty" xmlrpc:"setupAfterTaxAmount,omitempty"` // The setup fee, if any. This is a one time charge. SetupFee *Float64 `json:"setupFee,omitempty" xmlrpc:"setupFee,omitempty"` // The month set up fee deferral. SetupFeeDeferralMonths *int `json:"setupFeeDeferralMonths,omitempty" xmlrpc:"setupFeeDeferralMonths,omitempty"` // The rate at which setup fees are taxed if you are a taxable customer. SetupFeeTaxRate *Float64 `json:"setupFeeTaxRate,omitempty" xmlrpc:"setupFeeTaxRate,omitempty"` // An order item's setup tax amount. This does not include any child invoice items. SetupTaxAmount *Float64 `json:"setupTaxAmount,omitempty" xmlrpc:"setupTaxAmount,omitempty"` // For ordered items that are software items, a full description of that software can be found with this property. SoftwareDescription *Software_Description `json:"softwareDescription,omitempty" xmlrpc:"softwareDescription,omitempty"` // A count of the drive storage groups that are attached to this billing order item. StorageGroupCount *uint `json:"storageGroupCount,omitempty" xmlrpc:"storageGroupCount,omitempty"` // The drive storage groups that are attached to this billing order item. StorageGroups []Configuration_Storage_Group_Order `json:"storageGroups,omitempty" xmlrpc:"storageGroups,omitempty"` // The recurring fee of an ordered item. This amount represents the fees that will be charged on a recurring (usually monthly) basis. TotalRecurringAmount *Float64 `json:"totalRecurringAmount,omitempty" xmlrpc:"totalRecurringAmount,omitempty"` // The next SoftLayer_Product_Item in the upgrade path for this order item. UpgradeItem *Product_Item `json:"upgradeItem,omitempty" xmlrpc:"upgradeItem,omitempty"` }
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|invoices]] 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.
type Billing_Order_Item_Category_Answer ¶
type Billing_Order_Item_Category_Answer struct { Entity // The answer to the question. Answer *string `json:"answer,omitempty" xmlrpc:"answer,omitempty"` // The date that the answer was created. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // The billing order item that the answer is for. OrderItem *Billing_Order_Item `json:"orderItem,omitempty" xmlrpc:"orderItem,omitempty"` // The question that is being answered. Question *Product_Item_Category_Question `json:"question,omitempty" xmlrpc:"question,omitempty"` // The identifier for the question that the answer belongs to. QuestionId *int `json:"questionId,omitempty" xmlrpc:"questionId,omitempty"` }
The SoftLayer_Billing_Order_Item_Category_Answer data type represents a single answer to an item category question.
type Billing_Order_Quote ¶
type Billing_Order_Quote struct { Entity // A quote's corresponding account. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // Identification Number of the account record tied to the quote AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // Identification Number of the order record tied to the quote. CompletedPurchaseDataId *int `json:"completedPurchaseDataId,omitempty" xmlrpc:"completedPurchaseDataId,omitempty"` // Holds the date the quote record was created CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // Indicates whether the owner of the quote chosen to no longer be contacted. DoNotContactFlag *bool `json:"doNotContactFlag,omitempty" xmlrpc:"doNotContactFlag,omitempty"` // This property holds the date of expiration of a quote, after that date the quote would be deem expired ExpirationDate *Time `json:"expirationDate,omitempty" xmlrpc:"expirationDate,omitempty"` // The id use to identify a quote. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Holds the date when the quote record was modified with reference to its creation date ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // The name given to quote by the initiator Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // This order contains the records for which products were selected for this quote. Order *Billing_Order `json:"order,omitempty" xmlrpc:"order,omitempty"` // These are all the orders that were created from this quote. OrdersFromQuote []Billing_Order `json:"ordersFromQuote,omitempty" xmlrpc:"ordersFromQuote,omitempty"` // A count of these are all the orders that were created from this quote. OrdersFromQuoteCount *uint `json:"ordersFromQuoteCount,omitempty" xmlrpc:"ordersFromQuoteCount,omitempty"` // 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. PublicNote *string `json:"publicNote,omitempty" xmlrpc:"publicNote,omitempty"` // Holds system generated hash password for the Quote QuoteKey *string `json:"quoteKey,omitempty" xmlrpc:"quoteKey,omitempty"` // This property Holds the current status of a Quote: pending,expired, saved or deleted Status *string `json:"status,omitempty" xmlrpc:"status,omitempty"` }
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.
type Billing_Order_Type ¶
type Billing_Order_Type struct { Entity // A brief description of where a SoftLayer order originated from. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // A SoftLayer order type's internal identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A simple keyname stating where a SoftLayer order originated from. Type *string `json:"type,omitempty" xmlrpc:"type,omitempty"` }
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.
type Billing_Payment_Card_ChangeRequest ¶
type Billing_Payment_Card_ChangeRequest struct { Entity // no documentation yet Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // The account ID to which the credit card and billing information is associated with. AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // The total amount of the attempted transaction, represented in decimal format as US Dollars ($USD). Amount *Float64 `json:"amount,omitempty" xmlrpc:"amount,omitempty"` // The SoftLayer_Billing_Payment_Card_Transaction tied to the authorization performed as part of this change request. AuthorizedCreditCardTransaction *Billing_Payment_Card_Transaction `json:"authorizedCreditCardTransaction,omitempty" xmlrpc:"authorizedCreditCardTransaction,omitempty"` // The physical street address. Reserve information such as "apartment #123" or "Suite 2" for line 1. BillingAddressLine1 *string `json:"billingAddressLine1,omitempty" xmlrpc:"billingAddressLine1,omitempty"` // The second line in the address. Information such as suite number goes here. BillingAddressLine2 *string `json:"billingAddressLine2,omitempty" xmlrpc:"billingAddressLine2,omitempty"` // The city in which a customer's account resides. BillingCity *string `json:"billingCity,omitempty" xmlrpc:"billingCity,omitempty"` // The 2-character Country code for an account's address. (i.e. US) BillingCountryCode *string `json:"billingCountryCode,omitempty" xmlrpc:"billingCountryCode,omitempty"` // The email address associated with a customer account. BillingEmail *string `json:"billingEmail,omitempty" xmlrpc:"billingEmail,omitempty"` // the company name for an account. BillingNameCompany *string `json:"billingNameCompany,omitempty" xmlrpc:"billingNameCompany,omitempty"` // The first name of the customer account owner. BillingNameFirst *string `json:"billingNameFirst,omitempty" xmlrpc:"billingNameFirst,omitempty"` // The last name of the customer account owner BillingNameLast *string `json:"billingNameLast,omitempty" xmlrpc:"billingNameLast,omitempty"` // The fax number associated with a customer account. BillingPhoneFax *string `json:"billingPhoneFax,omitempty" xmlrpc:"billingPhoneFax,omitempty"` // The phone number associated with a customer account. BillingPhoneVoice *string `json:"billingPhoneVoice,omitempty" xmlrpc:"billingPhoneVoice,omitempty"` // The Zip or Postal Code for the billing address on an account. BillingPostalCode *string `json:"billingPostalCode,omitempty" xmlrpc:"billingPostalCode,omitempty"` // The State for the account. BillingState *string `json:"billingState,omitempty" xmlrpc:"billingState,omitempty"` // Total height of browser screen in pixels. BrowserScreenHeight *string `json:"browserScreenHeight,omitempty" xmlrpc:"browserScreenHeight,omitempty"` // Total width of browser screen in pixels. BrowserScreenWidth *string `json:"browserScreenWidth,omitempty" xmlrpc:"browserScreenWidth,omitempty"` // The SoftLayer_Billing_Payment_Card_Transaction tied to the capture of funds performed as part of this change request. CaptureCreditCardTransaction *Billing_Payment_Card_Transaction `json:"captureCreditCardTransaction,omitempty" xmlrpc:"captureCreditCardTransaction,omitempty"` // The last 4 digits of a customer's credit card. CardAccountLast4 *string `json:"cardAccountLast4,omitempty" xmlrpc:"cardAccountLast4,omitempty"` // The card number submitted in the change request. CardAccountNumber *string `json:"cardAccountNumber,omitempty" xmlrpc:"cardAccountNumber,omitempty"` // The month (MM) in which a customer's payment card will expire. CardExpirationMonth *string `json:"cardExpirationMonth,omitempty" xmlrpc:"cardExpirationMonth,omitempty"` // The year (YYYY) in which a customer's payment card will expire. CardExpirationYear *string `json:"cardExpirationYear,omitempty" xmlrpc:"cardExpirationYear,omitempty"` // no documentation yet CardNickname *string `json:"cardNickname,omitempty" xmlrpc:"cardNickname,omitempty"` // The type of payment card a customer has. (i.e. Visa, MasterCard, American Express). CardType *string `json:"cardType,omitempty" xmlrpc:"cardType,omitempty"` // The credit card verification number submitted in the change request. CreditCardVerificationNumber *string `json:"creditCardVerificationNumber,omitempty" xmlrpc:"creditCardVerificationNumber,omitempty"` // Describes the currency selected for payment CurrencyShortName *string `json:"currencyShortName,omitempty" xmlrpc:"currencyShortName,omitempty"` // Device Fingerprint Identifier - Used internally and can safely be ignored. DeviceFingerprintId *string `json:"deviceFingerprintId,omitempty" xmlrpc:"deviceFingerprintId,omitempty"` // The unique identifier for a single change request. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // the notes stored about a customer's payment card. Notes *string `json:"notes,omitempty" xmlrpc:"notes,omitempty"` // 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. PayerAuthenticationEnrollmentReferenceId *string `json:"payerAuthenticationEnrollmentReferenceId,omitempty" xmlrpc:"payerAuthenticationEnrollmentReferenceId,omitempty"` // The URL where the issuing bank will redirect. PayerAuthenticationEnrollmentReturnUrl *string `json:"payerAuthenticationEnrollmentReturnUrl,omitempty" xmlrpc:"payerAuthenticationEnrollmentReturnUrl,omitempty"` // "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. PayerAuthenticationWebToken *string `json:"payerAuthenticationWebToken,omitempty" xmlrpc:"payerAuthenticationWebToken,omitempty"` // no documentation yet PaymentRoleId *int `json:"paymentRoleId,omitempty" xmlrpc:"paymentRoleId,omitempty"` // The description of the type of payment sent in a change transaction. PaymentType *string `json:"paymentType,omitempty" xmlrpc:"paymentType,omitempty"` // A count of these are tickets tied to a credit card change request. TicketAttachmentReferenceCount *uint `json:"ticketAttachmentReferenceCount,omitempty" xmlrpc:"ticketAttachmentReferenceCount,omitempty"` // These are tickets tied to a credit card change request. TicketAttachmentReferences []Ticket_Attachment `json:"ticketAttachmentReferences,omitempty" xmlrpc:"ticketAttachmentReferences,omitempty"` // Unique identifier for a ticket discussing the switch between payment methods. TicketId *int `json:"ticketId,omitempty" xmlrpc:"ticketId,omitempty"` }
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.
type Billing_Payment_Card_ManualPayment ¶
type Billing_Payment_Card_ManualPayment struct { Entity // no documentation yet Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // The account ID to which the credit card and billing information is associated with. AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // The total amount of the attempted transaction, represented in decimal format as US Dollars ($USD). Amount *Float64 `json:"amount,omitempty" xmlrpc:"amount,omitempty"` // This is the credit card transaction data tied to a credit card manual payment. AuthorizedCreditCardTransaction *Billing_Payment_Card_Transaction `json:"authorizedCreditCardTransaction,omitempty" xmlrpc:"authorizedCreditCardTransaction,omitempty"` // The unique identifier of an attempted credit card transaction. AuthorizedCreditCardTransactionId *int `json:"authorizedCreditCardTransactionId,omitempty" xmlrpc:"authorizedCreditCardTransactionId,omitempty"` // This is the PayPal transaction data tied to a PayPal manual payment. AuthorizedPayPalTransaction *Billing_Payment_PayPal_Transaction `json:"authorizedPayPalTransaction,omitempty" xmlrpc:"authorizedPayPalTransaction,omitempty"` // The unique identifier of an attempted PayPal transaction. AuthorizedPayPalTransactionId *int `json:"authorizedPayPalTransactionId,omitempty" xmlrpc:"authorizedPayPalTransactionId,omitempty"` // The physical street address. Reserve information such as "apartment #123" or "Suite 2" for line 1. BillingAddressLine1 *string `json:"billingAddressLine1,omitempty" xmlrpc:"billingAddressLine1,omitempty"` // The second line in the address. Information such as suite number goes here. BillingAddressLine2 *string `json:"billingAddressLine2,omitempty" xmlrpc:"billingAddressLine2,omitempty"` // The city in which a customer's account resides. BillingCity *string `json:"billingCity,omitempty" xmlrpc:"billingCity,omitempty"` // The 2-character Country code for an account's address. (i.e. US) BillingCountryCode *string `json:"billingCountryCode,omitempty" xmlrpc:"billingCountryCode,omitempty"` // The email address associated with a customer account. BillingEmail *string `json:"billingEmail,omitempty" xmlrpc:"billingEmail,omitempty"` // the company name for an account. BillingNameCompany *string `json:"billingNameCompany,omitempty" xmlrpc:"billingNameCompany,omitempty"` // The first name of the customer account owner. BillingNameFirst *string `json:"billingNameFirst,omitempty" xmlrpc:"billingNameFirst,omitempty"` // The last name of the customer account owner. BillingNameLast *string `json:"billingNameLast,omitempty" xmlrpc:"billingNameLast,omitempty"` // The fax number associated with a customer account. BillingPhoneFax *string `json:"billingPhoneFax,omitempty" xmlrpc:"billingPhoneFax,omitempty"` // The phone number associated with a customer account. BillingPhoneVoice *string `json:"billingPhoneVoice,omitempty" xmlrpc:"billingPhoneVoice,omitempty"` // The Zip or Postal Code for the billing address on an account. BillingPostalCode *string `json:"billingPostalCode,omitempty" xmlrpc:"billingPostalCode,omitempty"` // The State for the account. BillingState *string `json:"billingState,omitempty" xmlrpc:"billingState,omitempty"` // Total height of browser screen in pixels. BrowserScreenHeight *string `json:"browserScreenHeight,omitempty" xmlrpc:"browserScreenHeight,omitempty"` // Total width of browser screen in pixels. BrowserScreenWidth *string `json:"browserScreenWidth,omitempty" xmlrpc:"browserScreenWidth,omitempty"` // The cancel URL is the page to which PayPal redirects if payment is not approved. CancelUrl *string `json:"cancelUrl,omitempty" xmlrpc:"cancelUrl,omitempty"` // 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. CaptureCreditCardTransaction *Billing_Payment_Card_Transaction `json:"captureCreditCardTransaction,omitempty" xmlrpc:"captureCreditCardTransaction,omitempty"` // 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. CapturePayPalTransaction *Billing_Payment_PayPal_Transaction `json:"capturePayPalTransaction,omitempty" xmlrpc:"capturePayPalTransaction,omitempty"` // A hash value of the credit card number. CardAccountHash *string `json:"cardAccountHash,omitempty" xmlrpc:"cardAccountHash,omitempty"` // The last 4 digits of a customer's credit card. CardAccountLast4 *string `json:"cardAccountLast4,omitempty" xmlrpc:"cardAccountLast4,omitempty"` // The card number submitted in the change request. CardAccountNumber *string `json:"cardAccountNumber,omitempty" xmlrpc:"cardAccountNumber,omitempty"` // The month (MM) in which a customer's payment card will expire. CardExpirationMonth *string `json:"cardExpirationMonth,omitempty" xmlrpc:"cardExpirationMonth,omitempty"` // The year (YYYY) in which a customer's payment card will expire. CardExpirationYear *string `json:"cardExpirationYear,omitempty" xmlrpc:"cardExpirationYear,omitempty"` // The method key of the type payment issued (Visa - 001, Mastercard - 002, American Express - 003, Discover - 004, PayPal - paypal). CardType *string `json:"cardType,omitempty" xmlrpc:"cardType,omitempty"` // The credit card verification number submitted in the change request. CreditCardVerificationNumber *string `json:"creditCardVerificationNumber,omitempty" xmlrpc:"creditCardVerificationNumber,omitempty"` // Describes the currency selected for payment CurrencyShortName *string `json:"currencyShortName,omitempty" xmlrpc:"currencyShortName,omitempty"` // Device Fingerprint Identifier - Used internally and can safely be ignored. DeviceFingerprintId *string `json:"deviceFingerprintId,omitempty" xmlrpc:"deviceFingerprintId,omitempty"` // The IP address from which the transaction originates. FromIpAddress *string `json:"fromIpAddress,omitempty" xmlrpc:"fromIpAddress,omitempty"` // The unique identifier for a single manual payment request. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Notes generated as a result of the payment request. Notes *string `json:"notes,omitempty" xmlrpc:"notes,omitempty"` // 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. PayerAuthenticationEnrollmentReferenceId *string `json:"payerAuthenticationEnrollmentReferenceId,omitempty" xmlrpc:"payerAuthenticationEnrollmentReferenceId,omitempty"` // The URL where the issuing bank will redirect. PayerAuthenticationEnrollmentReturnUrl *string `json:"payerAuthenticationEnrollmentReturnUrl,omitempty" xmlrpc:"payerAuthenticationEnrollmentReturnUrl,omitempty"` // "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. PayerAuthenticationWebToken *string `json:"payerAuthenticationWebToken,omitempty" xmlrpc:"payerAuthenticationWebToken,omitempty"` // The description of the type of payment sent in a change transaction. PaymentType *string `json:"paymentType,omitempty" xmlrpc:"paymentType,omitempty"` // The return URL is the page to which PayPal redirects after payment is approved. ReturnUrl *string `json:"returnUrl,omitempty" xmlrpc:"returnUrl,omitempty"` // A count of these are tickets tied to a credit card manual payment. TicketAttachmentReferenceCount *uint `json:"ticketAttachmentReferenceCount,omitempty" xmlrpc:"ticketAttachmentReferenceCount,omitempty"` // These are tickets tied to a credit card manual payment. TicketAttachmentReferences []Ticket_Attachment `json:"ticketAttachmentReferences,omitempty" xmlrpc:"ticketAttachmentReferences,omitempty"` // Describes the type of manual payment (PAYPAL or CREDIT_CARD). Type *string `json:"type,omitempty" xmlrpc:"type,omitempty"` }
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.
type Billing_Payment_Card_PayerAuthentication_Setup ¶ added in v1.1.2
type Billing_Payment_Card_PayerAuthentication_Setup struct { Entity // This is used to authenticate the customer with the authentication provider. AccessToken *string `json:"accessToken,omitempty" xmlrpc:"accessToken,omitempty"` // Location to send the authentication when you invoke device data collection. DeviceDataCollectionUrl *string `json:"deviceDataCollectionUrl,omitempty" xmlrpc:"deviceDataCollectionUrl,omitempty"` // This identifier indicates that the device data collection ReferenceId *string `json:"referenceId,omitempty" xmlrpc:"referenceId,omitempty"` }
This datatype payer authentication setup
type Billing_Payment_Card_PayerAuthentication_Setup_Information ¶ added in v1.1.2
type Billing_Payment_Card_PayerAuthentication_Setup_Information struct { Entity // The physical street address. Reserve information such as "apartment #123" or "Suite 2" for line 1. BillingAddressLine1 *string `json:"billingAddressLine1,omitempty" xmlrpc:"billingAddressLine1,omitempty"` // The second line in the address. Information such as suite number goes here. BillingAddressLine2 *string `json:"billingAddressLine2,omitempty" xmlrpc:"billingAddressLine2,omitempty"` // The city in which a customer's account resides. BillingCity *string `json:"billingCity,omitempty" xmlrpc:"billingCity,omitempty"` // The 2-character Country code for an account's address. (i.e. US) BillingCountryCode *string `json:"billingCountryCode,omitempty" xmlrpc:"billingCountryCode,omitempty"` // The email address associated with a customer account. BillingEmail *string `json:"billingEmail,omitempty" xmlrpc:"billingEmail,omitempty"` // The first name of the customer account owner. BillingNameFirst *string `json:"billingNameFirst,omitempty" xmlrpc:"billingNameFirst,omitempty"` // The last name of the customer account owner BillingNameLast *string `json:"billingNameLast,omitempty" xmlrpc:"billingNameLast,omitempty"` // The Zip or Postal Code for the billing address on an account. BillingPostalCode *string `json:"billingPostalCode,omitempty" xmlrpc:"billingPostalCode,omitempty"` // The State for the account. BillingState *string `json:"billingState,omitempty" xmlrpc:"billingState,omitempty"` // The credit card number to use. CardAccountNumber *string `json:"cardAccountNumber,omitempty" xmlrpc:"cardAccountNumber,omitempty"` // The payment card expiration month CardExpirationMonth *int `json:"cardExpirationMonth,omitempty" xmlrpc:"cardExpirationMonth,omitempty"` // The payment card expiration year CardExpirationYear *int `json:"cardExpirationYear,omitempty" xmlrpc:"cardExpirationYear,omitempty"` // The method key of the type payment issued CardType *string `json:"cardType,omitempty" xmlrpc:"cardType,omitempty"` // The credit card verification number CreditCardVerificationNumber *string `json:"creditCardVerificationNumber,omitempty" xmlrpc:"creditCardVerificationNumber,omitempty"` }
This is the datatype that needs to be populated and sent to SoftLayer_Account::initiatePayerAuthentication.
type Billing_Payment_Card_Transaction ¶
type Billing_Payment_Card_Transaction struct { Billing_Payment_Transaction // The account to which a transaction belongs. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // The account ID to which the credit card and billing information is associated with. AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // The total amount of the attempted transaction, represented in decimal format as US Dollars ($USD). Amount *Float64 `json:"amount,omitempty" xmlrpc:"amount,omitempty"` // The physical street address. Reserve information such as "apartment #123" or "Suite 2" for line 1. BillingAddressLine1 *string `json:"billingAddressLine1,omitempty" xmlrpc:"billingAddressLine1,omitempty"` // The second line in the address. Information such as suite number goes here. BillingAddressLine2 *string `json:"billingAddressLine2,omitempty" xmlrpc:"billingAddressLine2,omitempty"` // The city in which a customer's account resides. BillingCity *string `json:"billingCity,omitempty" xmlrpc:"billingCity,omitempty"` // The 2-character Country code for an account's address. (i.e. US) BillingCountryCode *string `json:"billingCountryCode,omitempty" xmlrpc:"billingCountryCode,omitempty"` // The email address associated with a customer account. BillingEmail *string `json:"billingEmail,omitempty" xmlrpc:"billingEmail,omitempty"` // the company name for an account. BillingNameCompany *string `json:"billingNameCompany,omitempty" xmlrpc:"billingNameCompany,omitempty"` // The first name of the customer account owner. BillingNameFirst *string `json:"billingNameFirst,omitempty" xmlrpc:"billingNameFirst,omitempty"` // The last name of the customer account owner. BillingNameLast *string `json:"billingNameLast,omitempty" xmlrpc:"billingNameLast,omitempty"` // The fax number associated with a customer account. BillingPhoneFax *string `json:"billingPhoneFax,omitempty" xmlrpc:"billingPhoneFax,omitempty"` // The phone number associated with a customer account. BillingPhoneVoice *string `json:"billingPhoneVoice,omitempty" xmlrpc:"billingPhoneVoice,omitempty"` // The Zip or Postal Code for the billing address on an account. BillingPostalCode *string `json:"billingPostalCode,omitempty" xmlrpc:"billingPostalCode,omitempty"` // The State for the account. BillingState *string `json:"billingState,omitempty" xmlrpc:"billingState,omitempty"` // The last 4 digits of a customer's credit card. CardAccountLast4 *int `json:"cardAccountLast4,omitempty" xmlrpc:"cardAccountLast4,omitempty"` // The month (MM) in which a customer's payment card will expire. CardExpirationMonth *int `json:"cardExpirationMonth,omitempty" xmlrpc:"cardExpirationMonth,omitempty"` // The year (YYYY) in which a customer's payment card will expire. CardExpirationYear *int `json:"cardExpirationYear,omitempty" xmlrpc:"cardExpirationYear,omitempty"` // The type of payment issued (i.e. Visa, MasterCard, American Express). CardType *string `json:"cardType,omitempty" xmlrpc:"cardType,omitempty"` // The date that the transaction was attempted. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // The unique identifier for a single credit card transaction request. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Unique identifier of the invoice to which funds will be applied. InvoiceId *int `json:"invoiceId,omitempty" xmlrpc:"invoiceId,omitempty"` // The date that the transaction was modified. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // no documentation yet Order *Billing_Order `json:"order,omitempty" xmlrpc:"order,omitempty"` // The IP address from which the transaction originates. OrderFromIpAddress *string `json:"orderFromIpAddress,omitempty" xmlrpc:"orderFromIpAddress,omitempty"` // A code used by the financial institution to refer to the requested transaction. ReferenceCode *string `json:"referenceCode,omitempty" xmlrpc:"referenceCode,omitempty"` // The unique identifier of the request submitted to the financial institution. RequestId *string `json:"requestId,omitempty" xmlrpc:"requestId,omitempty"` // The status code returned from the financial institution. ReturnStatus *int `json:"returnStatus,omitempty" xmlrpc:"returnStatus,omitempty"` // A serialized, delimited string of the transaction request sent to the financial institution. SerializedReply *string `json:"serializedReply,omitempty" xmlrpc:"serializedReply,omitempty"` // A serialized, delimited string of the transaction request sent to the financial institution. SerializedRequest *string `json:"serializedRequest,omitempty" xmlrpc:"serializedRequest,omitempty"` }
The SoftLayer_Billing_Payment_Card_Transaction data type contains general information relating to attempted credit card transactions.
type Billing_Payment_PayPal_Transaction ¶
type Billing_Payment_PayPal_Transaction struct { Billing_Payment_Transaction // The account to which a transaction belongs. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // The account ID to which the PayPal and billing information is associated with. AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // City given in the address of the PayPal user. AddressCityName *string `json:"addressCityName,omitempty" xmlrpc:"addressCityName,omitempty"` // Country given in the named address of the PayPal user. AddressCountry *string `json:"addressCountry,omitempty" xmlrpc:"addressCountry,omitempty"` // Name given to the address provided for the PayPal user. AddressName *string `json:"addressName,omitempty" xmlrpc:"addressName,omitempty"` // Postal Code of the address of the PayPal user. AddressPostalCode *string `json:"addressPostalCode,omitempty" xmlrpc:"addressPostalCode,omitempty"` // State or Province in the address of the PayPal user. AddressStateProvence *string `json:"addressStateProvence,omitempty" xmlrpc:"addressStateProvence,omitempty"` // PayPal defined status of the address of the PayPal user. AddressStatus *string `json:"addressStatus,omitempty" xmlrpc:"addressStatus,omitempty"` // First line of the street address of the PayPal user. AddressStreet1 *string `json:"addressStreet1,omitempty" xmlrpc:"addressStreet1,omitempty"` // Second line of the street address of the PayPal user. AddressStreet2 *string `json:"addressStreet2,omitempty" xmlrpc:"addressStreet2,omitempty"` // Phone number provided for the PayPal user. ContactPhone *string `json:"contactPhone,omitempty" xmlrpc:"contactPhone,omitempty"` // The date that the transaction was attempted. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // Exchange rate imposed on the payment amount. ExchangeRate *string `json:"exchangeRate,omitempty" xmlrpc:"exchangeRate,omitempty"` // PayPal fee applied to the payment. FeeAmount *Float64 `json:"feeAmount,omitempty" xmlrpc:"feeAmount,omitempty"` // The total amount of the payment executed by PayPal, represented in decimal format as US Dollars ($USD). GrossAmount *Float64 `json:"grossAmount,omitempty" xmlrpc:"grossAmount,omitempty"` // The unique identifier for a single PayPal transaction request. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Unique identifier of the invoice to which funds will be applied. InvoiceId *int `json:"invoiceId,omitempty" xmlrpc:"invoiceId,omitempty"` // The name of the command issued to PayPal with regards to the attempted transaction. LastPaypalCommand *string `json:"lastPaypalCommand,omitempty" xmlrpc:"lastPaypalCommand,omitempty"` // The date that the transaction was modified. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // no documentation yet Order *Billing_Order `json:"order,omitempty" xmlrpc:"order,omitempty"` // The IP address from where the PayPal payment request originated. OrderFromIpAddress *string `json:"orderFromIpAddress,omitempty" xmlrpc:"orderFromIpAddress,omitempty"` // The amount of the payment submitted through the SoftLayer interface, represented in decimal format as US Dollars ($USD). OrderTotal *Float64 `json:"orderTotal,omitempty" xmlrpc:"orderTotal,omitempty"` // The PayPal user account name (email address) associated with the customer account. Payer *string `json:"payer,omitempty" xmlrpc:"payer,omitempty"` // The name of the business associated with the PayPal user. PayerBusiness *string `json:"payerBusiness,omitempty" xmlrpc:"payerBusiness,omitempty"` // Country given in the address of the PayPal user. PayerCountry *string `json:"payerCountry,omitempty" xmlrpc:"payerCountry,omitempty"` // First name of the PayPal user. PayerFirstName *string `json:"payerFirstName,omitempty" xmlrpc:"payerFirstName,omitempty"` // Unique PayPal user account identifier. PayerId *string `json:"payerId,omitempty" xmlrpc:"payerId,omitempty"` // Last name of the PayPal user. PayerLastName *string `json:"payerLastName,omitempty" xmlrpc:"payerLastName,omitempty"` // Current PayPal status associated with the user account. PayerStatus *string `json:"payerStatus,omitempty" xmlrpc:"payerStatus,omitempty"` // Date that the payment was confirmed in PayPal by the user. PaymentDate *Time `json:"paymentDate,omitempty" xmlrpc:"paymentDate,omitempty"` // PayPal defined status of the attempted payment. PaymentStatus *string `json:"paymentStatus,omitempty" xmlrpc:"paymentStatus,omitempty"` // PayPal defined code used to identify the type of payment. Provided in a PayPal response. PaymentType *string `json:"paymentType,omitempty" xmlrpc:"paymentType,omitempty"` // Reason provided by PayPal for a payment given a pending status. PendingReason *string `json:"pendingReason,omitempty" xmlrpc:"pendingReason,omitempty"` // A serialized, delimited string of the reply received from PayPal. SerializedReply *string `json:"serializedReply,omitempty" xmlrpc:"serializedReply,omitempty"` // A serialized, delimited string of the request submitted to PayPal. SerializedRequest *string `json:"serializedRequest,omitempty" xmlrpc:"serializedRequest,omitempty"` // PayPal defined fee. SettleAmount *Float64 `json:"settleAmount,omitempty" xmlrpc:"settleAmount,omitempty"` // Tax applied by PayPal to the payment amount. TaxAmount *Float64 `json:"taxAmount,omitempty" xmlrpc:"taxAmount,omitempty"` // Value issued by PayPal for referencing the attempted transaction. Token *string `json:"token,omitempty" xmlrpc:"token,omitempty"` // Unique transaction ID provided in a PayPal response. TransactionId *string `json:"transactionId,omitempty" xmlrpc:"transactionId,omitempty"` // PayPal defined code used to identify the type of transaction. Provided in a PayPal response. TransactionType *string `json:"transactionType,omitempty" xmlrpc:"transactionType,omitempty"` }
The SoftLayer_Billing_Payment_PayPal_Transaction data type contains general information relating to attempted PayPal transactions.
type Billing_Payment_Processor ¶
type Billing_Payment_Processor struct { Entity // A count of BrandAssignmentCount *uint `json:"brandAssignmentCount,omitempty" xmlrpc:"brandAssignmentCount,omitempty"` // no documentation yet BrandAssignments []Brand_Payment_Processor `json:"brandAssignments,omitempty" xmlrpc:"brandAssignments,omitempty"` // no documentation yet Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // no documentation yet OwnerAccount *Account `json:"ownerAccount,omitempty" xmlrpc:"ownerAccount,omitempty"` // A count of PaymentMethodCount *uint `json:"paymentMethodCount,omitempty" xmlrpc:"paymentMethodCount,omitempty"` // no documentation yet PaymentMethods []Billing_Payment_Processor_Method `json:"paymentMethods,omitempty" xmlrpc:"paymentMethods,omitempty"` // no documentation yet Type *Billing_Payment_Processor_Type `json:"type,omitempty" xmlrpc:"type,omitempty"` }
no documentation yet
type Billing_Payment_Processor_Method ¶
type Billing_Payment_Processor_Method struct { Entity // no documentation yet MethodKey *string `json:"methodKey,omitempty" xmlrpc:"methodKey,omitempty"` // no documentation yet MultipleCurrencyFlag *bool `json:"multipleCurrencyFlag,omitempty" xmlrpc:"multipleCurrencyFlag,omitempty"` // no documentation yet PaymentProcessor *Billing_Payment_Processor `json:"paymentProcessor,omitempty" xmlrpc:"paymentProcessor,omitempty"` // no documentation yet PaymentType *Billing_Payment_Type `json:"paymentType,omitempty" xmlrpc:"paymentType,omitempty"` }
no documentation yet
type Billing_Payment_Processor_Type ¶
type Billing_Payment_Processor_Type struct { Entity // no documentation yet Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // no documentation yet KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // A count of PaymentProcessorCount *uint `json:"paymentProcessorCount,omitempty" xmlrpc:"paymentProcessorCount,omitempty"` // no documentation yet PaymentProcessors []Billing_Payment_Processor `json:"paymentProcessors,omitempty" xmlrpc:"paymentProcessors,omitempty"` }
no documentation yet
type Billing_Payment_Transaction ¶
type Billing_Payment_Transaction struct {
Entity
}
Implementation for payment transactions.
type Billing_Payment_Type ¶
type Billing_Payment_Type struct { Entity // no documentation yet Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // no documentation yet KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
no documentation yet
type Brand ¶
type Brand struct { Entity // no documentation yet Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // A count of all accounts owned by the brand. AllOwnedAccountCount *uint `json:"allOwnedAccountCount,omitempty" xmlrpc:"allOwnedAccountCount,omitempty"` // All accounts owned by the brand. AllOwnedAccounts []Account `json:"allOwnedAccounts,omitempty" xmlrpc:"allOwnedAccounts,omitempty"` // This flag indicates if creation of accounts is allowed. AllowAccountCreationFlag *bool `json:"allowAccountCreationFlag,omitempty" xmlrpc:"allowAccountCreationFlag,omitempty"` // A count of returns snapshots of billing items recorded periodically given an account ID owned by the brand those billing items belong to. Retrieving billing item snapshots is more performant than retrieving billing items directly and performs less relational joins improving retrieval efficiency. The downside is, they are not real time, and do not share relational parity with the original billing item. BillingItemSnapshotCount *uint `json:"billingItemSnapshotCount,omitempty" xmlrpc:"billingItemSnapshotCount,omitempty"` // Returns snapshots of billing items recorded periodically given an account ID owned by the brand those billing items belong to. Retrieving billing item snapshots is more performant than retrieving billing items directly and performs less relational joins improving retrieval efficiency. The downside is, they are not real time, and do not share relational parity with the original billing item. BillingItemSnapshots []Billing_Item_Chronicle `json:"billingItemSnapshots,omitempty" xmlrpc:"billingItemSnapshots,omitempty"` // Business Partner details for the brand. Country Enterprise Code, Channel, Segment, Reseller Level. BusinessPartner *Brand_Business_Partner `json:"businessPartner,omitempty" xmlrpc:"businessPartner,omitempty"` // Flag indicating if the brand is a business partner. BusinessPartnerFlag *bool `json:"businessPartnerFlag,omitempty" xmlrpc:"businessPartnerFlag,omitempty"` // The Product Catalog for the Brand Catalog *Product_Catalog `json:"catalog,omitempty" xmlrpc:"catalog,omitempty"` // ID of the Catalog used by this Brand CatalogId *int `json:"catalogId,omitempty" xmlrpc:"catalogId,omitempty"` // A count of the contacts for the brand. ContactCount *uint `json:"contactCount,omitempty" xmlrpc:"contactCount,omitempty"` // The contacts for the brand. Contacts []Brand_Contact `json:"contacts,omitempty" xmlrpc:"contacts,omitempty"` // 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. CustomerCountryLocationRestrictionCount *uint `json:"customerCountryLocationRestrictionCount,omitempty" xmlrpc:"customerCountryLocationRestrictionCount,omitempty"` // 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. CustomerCountryLocationRestrictions []Brand_Restriction_Location_CustomerCountry `json:"customerCountryLocationRestrictions,omitempty" xmlrpc:"customerCountryLocationRestrictions,omitempty"` // no documentation yet Distributor *Brand `json:"distributor,omitempty" xmlrpc:"distributor,omitempty"` // no documentation yet DistributorChildFlag *bool `json:"distributorChildFlag,omitempty" xmlrpc:"distributorChildFlag,omitempty"` // no documentation yet DistributorFlag *string `json:"distributorFlag,omitempty" xmlrpc:"distributorFlag,omitempty"` // An account's associated hardware objects. Hardware []Hardware `json:"hardware,omitempty" xmlrpc:"hardware,omitempty"` // A count of an account's associated hardware objects. HardwareCount *uint `json:"hardwareCount,omitempty" xmlrpc:"hardwareCount,omitempty"` // no documentation yet HasAgentAdvancedSupportFlag *bool `json:"hasAgentAdvancedSupportFlag,omitempty" xmlrpc:"hasAgentAdvancedSupportFlag,omitempty"` // no documentation yet HasAgentSupportFlag *bool `json:"hasAgentSupportFlag,omitempty" xmlrpc:"hasAgentSupportFlag,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The brand key name. KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // The brand long name. LongName *string `json:"longName,omitempty" xmlrpc:"longName,omitempty"` // The brand name. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // A count of OpenTicketCount *uint `json:"openTicketCount,omitempty" xmlrpc:"openTicketCount,omitempty"` // no documentation yet OpenTickets []Ticket `json:"openTickets,omitempty" xmlrpc:"openTickets,omitempty"` // A count of active accounts owned by the brand. OwnedAccountCount *uint `json:"ownedAccountCount,omitempty" xmlrpc:"ownedAccountCount,omitempty"` // Active accounts owned by the brand. OwnedAccounts []Account `json:"ownedAccounts,omitempty" xmlrpc:"ownedAccounts,omitempty"` // no documentation yet SecurityLevel *Security_Level `json:"securityLevel,omitempty" xmlrpc:"securityLevel,omitempty"` // A count of TicketCount *uint `json:"ticketCount,omitempty" xmlrpc:"ticketCount,omitempty"` // A count of TicketGroupCount *uint `json:"ticketGroupCount,omitempty" xmlrpc:"ticketGroupCount,omitempty"` // no documentation yet TicketGroups []Ticket_Group `json:"ticketGroups,omitempty" xmlrpc:"ticketGroups,omitempty"` // no documentation yet Tickets []Ticket `json:"tickets,omitempty" xmlrpc:"tickets,omitempty"` // A count of UserCount *uint `json:"userCount,omitempty" xmlrpc:"userCount,omitempty"` // no documentation yet Users []User_Customer `json:"users,omitempty" xmlrpc:"users,omitempty"` // A count of an account's associated virtual guest objects. VirtualGuestCount *uint `json:"virtualGuestCount,omitempty" xmlrpc:"virtualGuestCount,omitempty"` // An account's associated virtual guest objects. VirtualGuests []Virtual_Guest `json:"virtualGuests,omitempty" xmlrpc:"virtualGuests,omitempty"` }
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.
type Brand_Attribute ¶
type Brand_Attribute struct { Entity // no documentation yet Brand *Brand `json:"brand,omitempty" xmlrpc:"brand,omitempty"` }
no documentation yet
type Brand_Business_Partner ¶
type Brand_Business_Partner struct { Entity // Brand associated with the business partner data Brand *Brand `json:"brand,omitempty" xmlrpc:"brand,omitempty"` // Channel indicator used to categorize business partner revenue. Channel *Business_Partner_Channel `json:"channel,omitempty" xmlrpc:"channel,omitempty"` // Brand business partner channel identifier ChannelId *int `json:"channelId,omitempty" xmlrpc:"channelId,omitempty"` // Brand business partner country enterprise code CountryEnterpriseCode *string `json:"countryEnterpriseCode,omitempty" xmlrpc:"countryEnterpriseCode,omitempty"` // Reseller level of a brand business partner ResellerLevel *int `json:"resellerLevel,omitempty" xmlrpc:"resellerLevel,omitempty"` // Segment indicator used to categorize business partner revenue. Segment *Business_Partner_Segment `json:"segment,omitempty" xmlrpc:"segment,omitempty"` // Brand business partner segment identifier SegmentId *int `json:"segmentId,omitempty" xmlrpc:"segmentId,omitempty"` }
Contains business partner details associated with a brand. Country Enterprise Identifier (CEID), Channel ID, Segment ID and Reseller Level.
type Brand_Contact ¶
type Brand_Contact struct { Entity // The contact's address 1. Address1 *string `json:"address1,omitempty" xmlrpc:"address1,omitempty"` // The contact's address 2. Address2 *string `json:"address2,omitempty" xmlrpc:"address2,omitempty"` // The contact's alternate phone number. AlternatePhone *string `json:"alternatePhone,omitempty" xmlrpc:"alternatePhone,omitempty"` // no documentation yet Brand *Brand `json:"brand,omitempty" xmlrpc:"brand,omitempty"` // no documentation yet BrandContactType *Brand_Contact_Type `json:"brandContactType,omitempty" xmlrpc:"brandContactType,omitempty"` // The contact's type identifier. BrandContactTypeId *int `json:"brandContactTypeId,omitempty" xmlrpc:"brandContactTypeId,omitempty"` // The contact's city. City *string `json:"city,omitempty" xmlrpc:"city,omitempty"` // The contact's country. Country *string `json:"country,omitempty" xmlrpc:"country,omitempty"` // The contact's email address. Email *string `json:"email,omitempty" xmlrpc:"email,omitempty"` // The contact's fax number. FaxPhone *string `json:"faxPhone,omitempty" xmlrpc:"faxPhone,omitempty"` // The contact's first name. FirstName *string `json:"firstName,omitempty" xmlrpc:"firstName,omitempty"` // The contact's last name. LastName *string `json:"lastName,omitempty" xmlrpc:"lastName,omitempty"` // The contact's phone number. OfficePhone *string `json:"officePhone,omitempty" xmlrpc:"officePhone,omitempty"` // The contact's postal code. PostalCode *string `json:"postalCode,omitempty" xmlrpc:"postalCode,omitempty"` // The contact's state. State *string `json:"state,omitempty" xmlrpc:"state,omitempty"` }
SoftLayer_Brand_Contact contains the contact information for the brand such as Corporate or Support contact information
type Brand_Contact_Type ¶
type Brand_Contact_Type struct { Entity // Contact type description. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // Contact type key name. KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // Contact type name. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
SoftLayer_Brand_Contact_Type contains the contact type information for the brand contacts such as Corporate or Support contact type
type Brand_Payment_Processor ¶
type Brand_Payment_Processor struct { Entity // no documentation yet Brand *Brand `json:"brand,omitempty" xmlrpc:"brand,omitempty"` // no documentation yet PaymentProcessor *Billing_Payment_Processor `json:"paymentProcessor,omitempty" xmlrpc:"paymentProcessor,omitempty"` }
no documentation yet
type Brand_Restriction_Location_CustomerCountry ¶
type Brand_Restriction_Location_CustomerCountry struct { Entity // This references the brand that has a brand-location-country restriction setup. Brand *Brand `json:"brand,omitempty" xmlrpc:"brand,omitempty"` // The brand associated with customer's account. BrandId *int `json:"brandId,omitempty" xmlrpc:"brandId,omitempty"` // country code associated with customer's account. CustomerCountryCode *string `json:"customerCountryCode,omitempty" xmlrpc:"customerCountryCode,omitempty"` // 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. Location *Location `json:"location,omitempty" xmlrpc:"location,omitempty"` // The id for datacenter location. LocationId *int `json:"locationId,omitempty" xmlrpc:"locationId,omitempty"` }
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.
type Business_Partner_Channel ¶
type Business_Partner_Channel struct { Entity // Business partner channel description Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // Business partner channel name KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` }
Contains business partner channel information
type Business_Partner_Segment ¶
type Business_Partner_Segment struct { Entity // Business partner segment description Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // Business partner segment name KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` }
Contains business partner segment information
type Catalyst_Affiliate ¶
type Catalyst_Affiliate struct { Entity // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // no documentation yet SkipCreditCardVerificationFlag *bool `json:"skipCreditCardVerificationFlag,omitempty" xmlrpc:"skipCreditCardVerificationFlag,omitempty"` }
no documentation yet
type Catalyst_Company_Type ¶
type Catalyst_Company_Type struct { Entity // no documentation yet Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` }
no documentation yet
type Catalyst_Enrollment ¶
type Catalyst_Enrollment struct { Entity // no documentation yet Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // no documentation yet AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // no documentation yet Affiliate *Catalyst_Affiliate `json:"affiliate,omitempty" xmlrpc:"affiliate,omitempty"` // no documentation yet AffiliateId *int `json:"affiliateId,omitempty" xmlrpc:"affiliateId,omitempty"` // no documentation yet AgreementCompleteFlag *int `json:"agreementCompleteFlag,omitempty" xmlrpc:"agreementCompleteFlag,omitempty"` // no documentation yet CompanyDescription *string `json:"companyDescription,omitempty" xmlrpc:"companyDescription,omitempty"` // no documentation yet CompanyType *Catalyst_Company_Type `json:"companyType,omitempty" xmlrpc:"companyType,omitempty"` // no documentation yet CompanyTypeId *int `json:"companyTypeId,omitempty" xmlrpc:"companyTypeId,omitempty"` // no documentation yet EnrollmentDate *Time `json:"enrollmentDate,omitempty" xmlrpc:"enrollmentDate,omitempty"` // no documentation yet GraduationDate *Time `json:"graduationDate,omitempty" xmlrpc:"graduationDate,omitempty"` // no documentation yet IsActiveFlag *bool `json:"isActiveFlag,omitempty" xmlrpc:"isActiveFlag,omitempty"` // no documentation yet MonthlyCreditAmount *Float64 `json:"monthlyCreditAmount,omitempty" xmlrpc:"monthlyCreditAmount,omitempty"` // no documentation yet Representative *User_Employee `json:"representative,omitempty" xmlrpc:"representative,omitempty"` // no documentation yet RepresentativeEmployeeId *int `json:"representativeEmployeeId,omitempty" xmlrpc:"representativeEmployeeId,omitempty"` }
no documentation yet
type Catalyst_Enrollment_Request ¶
type Catalyst_Enrollment_Request struct { Entity // Applicant's address Address1 *string `json:"address1,omitempty" xmlrpc:"address1,omitempty"` // Additional field for extended address Address2 *string `json:"address2,omitempty" xmlrpc:"address2,omitempty"` // no documentation yet Affiliate *Catalyst_Affiliate `json:"affiliate,omitempty" xmlrpc:"affiliate,omitempty"` // Id of the affiliate who referred applicant's AffiliateId *int `json:"affiliateId,omitempty" xmlrpc:"affiliateId,omitempty"` // no documentation yet AgreementCompleteFlag *bool `json:"agreementCompleteFlag,omitempty" xmlrpc:"agreementCompleteFlag,omitempty"` // Determines whether or not to also apply to the GEP program ApplyToGepFlag *bool `json:"applyToGepFlag,omitempty" xmlrpc:"applyToGepFlag,omitempty"` // no documentation yet CardAccountNumber *string `json:"cardAccountNumber,omitempty" xmlrpc:"cardAccountNumber,omitempty"` // no documentation yet CardExpirationMonth *string `json:"cardExpirationMonth,omitempty" xmlrpc:"cardExpirationMonth,omitempty"` // no documentation yet CardExpirationYear *string `json:"cardExpirationYear,omitempty" xmlrpc:"cardExpirationYear,omitempty"` // no documentation yet CardType *string `json:"cardType,omitempty" xmlrpc:"cardType,omitempty"` // no documentation yet CardVerificationNumber *string `json:"cardVerificationNumber,omitempty" xmlrpc:"cardVerificationNumber,omitempty"` // Applicant's city City *string `json:"city,omitempty" xmlrpc:"city,omitempty"` // Brief description of Startup's product and key differentiators CompanyDescription *string `json:"companyDescription,omitempty" xmlrpc:"companyDescription,omitempty"` // Name of the applicant's company CompanyName *string `json:"companyName,omitempty" xmlrpc:"companyName,omitempty"` // no documentation yet CompanyType *Catalyst_Company_Type `json:"companyType,omitempty" xmlrpc:"companyType,omitempty"` // Id of the company type which best describes applicant's company CompanyTypeId *int `json:"companyTypeId,omitempty" xmlrpc:"companyTypeId,omitempty"` // URL to the Startup's site CompanyUrl *string `json:"companyUrl,omitempty" xmlrpc:"companyUrl,omitempty"` // Applicant's country code Country *string `json:"country,omitempty" xmlrpc:"country,omitempty"` // Index of answer chosen for how many current users question CurrentUserChoice *int `json:"currentUserChoice,omitempty" xmlrpc:"currentUserChoice,omitempty"` // Id of the fingerprint DeviceFingerprintId *string `json:"deviceFingerprintId,omitempty" xmlrpc:"deviceFingerprintId,omitempty"` // Applicant's email address Email *string `json:"email,omitempty" xmlrpc:"email,omitempty"` // Applicant's first name FirstName *string `json:"firstName,omitempty" xmlrpc:"firstName,omitempty"` // Index of answer chosen for how many future users question FutureUserChoice *int `json:"futureUserChoice,omitempty" xmlrpc:"futureUserChoice,omitempty"` // Master user's IBMId username IbmIdUsername *string `json:"ibmIdUsername,omitempty" xmlrpc:"ibmIdUsername,omitempty"` // Name of accelerator or incubator startup belongs to, if any IncubatorName *string `json:"incubatorName,omitempty" xmlrpc:"incubatorName,omitempty"` // Name of the investor, if any InvestorName *string `json:"investorName,omitempty" xmlrpc:"investorName,omitempty"` // Applicant's last name LastName *string `json:"lastName,omitempty" xmlrpc:"lastName,omitempty"` // Applicant's primary phone number OfficePhone *string `json:"officePhone,omitempty" xmlrpc:"officePhone,omitempty"` // Whether or not the startup has been operating for more than five years OverFiveYearsOldFlag *bool `json:"overFiveYearsOldFlag,omitempty" xmlrpc:"overFiveYearsOldFlag,omitempty"` // Applicant's postal code PostalCode *string `json:"postalCode,omitempty" xmlrpc:"postalCode,omitempty"` // IBM referral code, if any ReferralCode *string `json:"referralCode,omitempty" xmlrpc:"referralCode,omitempty"` // Whether or not the startup has over one million in annual revenue RevenueOverOneMillionFlag *bool `json:"revenueOverOneMillionFlag,omitempty" xmlrpc:"revenueOverOneMillionFlag,omitempty"` // Determines whether or not to apply to the Catalyst program SkipCatalystApplicationFlag *bool `json:"skipCatalystApplicationFlag,omitempty" xmlrpc:"skipCatalystApplicationFlag,omitempty"` // Applicant's state/region code State *string `json:"state,omitempty" xmlrpc:"state,omitempty"` // Applicant's vatId, if one exists VatId *string `json:"vatId,omitempty" xmlrpc:"vatId,omitempty"` }
Contains user information for Catalyst self-enrollment.
type Catalyst_Enrollment_Request_Container_AnswerOption ¶
type Catalyst_Enrollment_Request_Container_AnswerOption struct { Entity // no documentation yet Answer *string `json:"answer,omitempty" xmlrpc:"answer,omitempty"` // no documentation yet Index *int `json:"index,omitempty" xmlrpc:"index,omitempty"` }
no documentation yet
type Compliance_Report_Type ¶
type Compliance_Report_Type struct { Entity // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
no documentation yet
type Configuration_Storage_Filesystem_Type ¶
type Configuration_Storage_Filesystem_Type struct { Entity // no documentation yet KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
no documentation yet
type Configuration_Storage_Group ¶ added in v1.0.2
type Configuration_Storage_Group struct { Entity // A count of this class represents a storage groups ancestors AncestorGroupCount *uint `json:"ancestorGroupCount,omitempty" xmlrpc:"ancestorGroupCount,omitempty"` // This class represents a storage groups ancestors AncestorGroups []Configuration_Storage_Group `json:"ancestorGroups,omitempty" xmlrpc:"ancestorGroups,omitempty"` // This class represents a storage group disk array type ArrayType *Configuration_Storage_Group_Array_Type `json:"arrayType,omitempty" xmlrpc:"arrayType,omitempty"` // Determine if the storage group is able to be image captured. If unable to image capture the reasons will be provided. CaptureEnabledFlag *Container_Hardware_CaptureEnabled `json:"captureEnabledFlag,omitempty" xmlrpc:"captureEnabledFlag,omitempty"` // no documentation yet CreateEmployee *User_Employee `json:"createEmployee,omitempty" xmlrpc:"createEmployee,omitempty"` // A count of this class represents a storage groups descendants DescendantGroupCount *uint `json:"descendantGroupCount,omitempty" xmlrpc:"descendantGroupCount,omitempty"` // This class represents a storage groups descendants DescendantGroups []Configuration_Storage_Group `json:"descendantGroups,omitempty" xmlrpc:"descendantGroups,omitempty"` // Storage group description Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // Storage group disk space DiskSpace *Float64 `json:"diskSpace,omitempty" xmlrpc:"diskSpace,omitempty"` // A count of the hard drives contained within this storage group. HardDriveCount *uint `json:"hardDriveCount,omitempty" xmlrpc:"hardDriveCount,omitempty"` // The hard drives contained within this storage group. HardDrives []Hardware_Component `json:"hardDrives,omitempty" xmlrpc:"hardDrives,omitempty"` // Storage group type id Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Flag to indicate if the storage group is setup for lvm LvmFlag *bool `json:"lvmFlag,omitempty" xmlrpc:"lvmFlag,omitempty"` // Storage group name Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // Storage group disk size units Units *string `json:"units,omitempty" xmlrpc:"units,omitempty"` }
This class describes the base Storage Group for a Complex Drive Configuration
type Configuration_Storage_Group_Array_Type ¶
type Configuration_Storage_Group_Array_Type struct { Entity // no documentation yet Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // no documentation yet DriveMultiplier *int `json:"driveMultiplier,omitempty" xmlrpc:"driveMultiplier,omitempty"` // A count of HardwareComponentModelCount *uint `json:"hardwareComponentModelCount,omitempty" xmlrpc:"hardwareComponentModelCount,omitempty"` // no documentation yet HardwareComponentModels []Hardware_Component_Model `json:"hardwareComponentModels,omitempty" xmlrpc:"hardwareComponentModels,omitempty"` // no documentation yet HotspareAllow *bool `json:"hotspareAllow,omitempty" xmlrpc:"hotspareAllow,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // no documentation yet MaximumDrives *int `json:"maximumDrives,omitempty" xmlrpc:"maximumDrives,omitempty"` // no documentation yet MinimumDrives *int `json:"minimumDrives,omitempty" xmlrpc:"minimumDrives,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
Supported hardware raid modes
type Configuration_Storage_Group_Order ¶
type Configuration_Storage_Group_Order struct { Entity // no documentation yet ArrayNumber *int `json:"arrayNumber,omitempty" xmlrpc:"arrayNumber,omitempty"` // no documentation yet ArraySize *Float64 `json:"arraySize,omitempty" xmlrpc:"arraySize,omitempty"` // Raid mode for the storage group. ArrayType *Configuration_Storage_Group_Array_Type `json:"arrayType,omitempty" xmlrpc:"arrayType,omitempty"` // no documentation yet ArrayTypeId *int `json:"arrayTypeId,omitempty" xmlrpc:"arrayTypeId,omitempty"` // The order item that relates to this storage group. BillingOrderItem *Billing_Order_Item `json:"billingOrderItem,omitempty" xmlrpc:"billingOrderItem,omitempty"` // no documentation yet BillingOrderItemId *int `json:"billingOrderItemId,omitempty" xmlrpc:"billingOrderItemId,omitempty"` // no documentation yet Controller *int `json:"controller,omitempty" xmlrpc:"controller,omitempty"` // no documentation yet HardDrives []string `json:"hardDrives,omitempty" xmlrpc:"hardDrives,omitempty"` // no documentation yet HotSpareDrives []int `json:"hotSpareDrives,omitempty" xmlrpc:"hotSpareDrives,omitempty"` // no documentation yet LvmFlag *bool `json:"lvmFlag,omitempty" xmlrpc:"lvmFlag,omitempty"` // no documentation yet PartitionData *string `json:"partitionData,omitempty" xmlrpc:"partitionData,omitempty"` }
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.
type Configuration_Storage_Group_Template_Group ¶
type Configuration_Storage_Group_Template_Group struct { Entity // The disk controller for the array. DiskControllerIndex *int `json:"diskControllerIndex,omitempty" xmlrpc:"diskControllerIndex,omitempty"` // Flag to use all available space. Grow *bool `json:"grow,omitempty" xmlrpc:"grow,omitempty"` // Comma delimited integers of drive indexes for the array. This can also be the string 'all' to specify all drives in the server HardDrivesString *string `json:"hardDrivesString,omitempty" xmlrpc:"hardDrivesString,omitempty"` // Comma delimited integers of drive indexes for hot spares on the array. HotSpareDrivesString *string `json:"hotSpareDrivesString,omitempty" xmlrpc:"hotSpareDrivesString,omitempty"` // The order of the arrays in the template. OrderIndex *int `json:"orderIndex,omitempty" xmlrpc:"orderIndex,omitempty"` // Size of array. Must be within limitations of the smallest drive and raid mode Size *Float64 `json:"size,omitempty" xmlrpc:"size,omitempty"` // no documentation yet Type *Configuration_Storage_Group_Array_Type `json:"type,omitempty" xmlrpc:"type,omitempty"` }
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.
type Configuration_Template ¶
type Configuration_Template struct { Entity // no documentation yet Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // Internal identifier of a SoftLayer account that this configuration template belongs to AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // A count of ConfigurationSectionCount *uint `json:"configurationSectionCount,omitempty" xmlrpc:"configurationSectionCount,omitempty"` // no documentation yet ConfigurationSections []Configuration_Template_Section `json:"configurationSections,omitempty" xmlrpc:"configurationSections,omitempty"` // Created date CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // A count of DefaultValueCount *uint `json:"defaultValueCount,omitempty" xmlrpc:"defaultValueCount,omitempty"` // no documentation yet DefaultValues []Configuration_Template_Section_Definition_Value `json:"defaultValues,omitempty" xmlrpc:"defaultValues,omitempty"` // A count of DefinitionCount *uint `json:"definitionCount,omitempty" xmlrpc:"definitionCount,omitempty"` // no documentation yet Definitions []Configuration_Template_Section_Definition `json:"definitions,omitempty" xmlrpc:"definitions,omitempty"` // Configuration template description Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // Internal identifier of a configuration template. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet Item *Product_Item `json:"item,omitempty" xmlrpc:"item,omitempty"` // Internal identifier of a product item that this configuration template is associated with ItemId *int `json:"itemId,omitempty" xmlrpc:"itemId,omitempty"` // no documentation yet LinkedSectionReferences *Configuration_Template_Section_Reference `json:"linkedSectionReferences,omitempty" xmlrpc:"linkedSectionReferences,omitempty"` // Last modified date ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // Configuration template name Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // no documentation yet Parent *Configuration_Template `json:"parent,omitempty" xmlrpc:"parent,omitempty"` // Internal identifier of the parent configuration template ParentId *int `json:"parentId,omitempty" xmlrpc:"parentId,omitempty"` // no documentation yet User *User_Customer `json:"user,omitempty" xmlrpc:"user,omitempty"` // Internal identifier of a user that last modified this configuration template UserRecordId *int `json:"userRecordId,omitempty" xmlrpc:"userRecordId,omitempty"` }
The SoftLayer_Configuration_Template data type contains general information of an arbitrary resource.
type Configuration_Template_Attribute ¶
type Configuration_Template_Attribute struct { Entity // no documentation yet ConfigurationTemplate *Configuration_Template `json:"configurationTemplate,omitempty" xmlrpc:"configurationTemplate,omitempty"` // Value of a configuration template attribute Value *string `json:"value,omitempty" xmlrpc:"value,omitempty"` }
Configuration template attribute class contains supplementary information for a configuration template.
type Configuration_Template_Section ¶
type Configuration_Template_Section struct { Entity // Created date CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // A count of DefinitionCount *uint `json:"definitionCount,omitempty" xmlrpc:"definitionCount,omitempty"` // no documentation yet Definitions []Configuration_Template_Section_Definition `json:"definitions,omitempty" xmlrpc:"definitions,omitempty"` // Configuration section description Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // no documentation yet DisallowedDeletionFlag *bool `json:"disallowedDeletionFlag,omitempty" xmlrpc:"disallowedDeletionFlag,omitempty"` // Internal identifier of a configuration section. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet LinkedTemplate *Configuration_Template `json:"linkedTemplate,omitempty" xmlrpc:"linkedTemplate,omitempty"` // 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. LinkedTemplateId *string `json:"linkedTemplateId,omitempty" xmlrpc:"linkedTemplateId,omitempty"` // no documentation yet LinkedTemplateReference *Configuration_Template_Section_Reference `json:"linkedTemplateReference,omitempty" xmlrpc:"linkedTemplateReference,omitempty"` // Last modified date ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // Configuration section name Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // Internal identifier of the parent configuration section ParentId *int `json:"parentId,omitempty" xmlrpc:"parentId,omitempty"` // A count of ProfileCount *uint `json:"profileCount,omitempty" xmlrpc:"profileCount,omitempty"` // no documentation yet Profiles []Configuration_Template_Section_Profile `json:"profiles,omitempty" xmlrpc:"profiles,omitempty"` // no documentation yet SectionType *Configuration_Template_Section_Type `json:"sectionType,omitempty" xmlrpc:"sectionType,omitempty"` // no documentation yet SectionTypeName *string `json:"sectionTypeName,omitempty" xmlrpc:"sectionTypeName,omitempty"` // Sort order Sort *int `json:"sort,omitempty" xmlrpc:"sort,omitempty"` // A count of SubSectionCount *uint `json:"subSectionCount,omitempty" xmlrpc:"subSectionCount,omitempty"` // no documentation yet SubSections []Configuration_Template_Section `json:"subSections,omitempty" xmlrpc:"subSections,omitempty"` // no documentation yet Template *Configuration_Template `json:"template,omitempty" xmlrpc:"template,omitempty"` // Internal identifier of a configuration template that this section belongs to TemplateId *string `json:"templateId,omitempty" xmlrpc:"templateId,omitempty"` // Internal identifier of the configuration section type TypeId *int `json:"typeId,omitempty" xmlrpc:"typeId,omitempty"` }
The SoftLayer_Configuration_Template_Section data type contains information of a configuration section.
Configuration can contain sub-sections.
type Configuration_Template_Section_Attribute ¶
type Configuration_Template_Section_Attribute struct { Entity // no documentation yet ConfigurationSection *Configuration_Template_Section `json:"configurationSection,omitempty" xmlrpc:"configurationSection,omitempty"` // Value of a configuration section attribute Value *string `json:"value,omitempty" xmlrpc:"value,omitempty"` }
Configuration section attribute class contains supplementary information for a configuration section.
type Configuration_Template_Section_Definition ¶
type Configuration_Template_Section_Definition struct { Entity // A count of AttributeCount *uint `json:"attributeCount,omitempty" xmlrpc:"attributeCount,omitempty"` // no documentation yet Attributes []Configuration_Template_Section_Definition_Attribute `json:"attributes,omitempty" xmlrpc:"attributes,omitempty"` // Created date CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // no documentation yet DefaultValue *Configuration_Template_Section_Definition_Value `json:"defaultValue,omitempty" xmlrpc:"defaultValue,omitempty"` // Description of a configuration definition. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // Enumeration values separated by comma. EnumerationValues *string `json:"enumerationValues,omitempty" xmlrpc:"enumerationValues,omitempty"` // no documentation yet Group *Configuration_Template_Section_Definition_Group `json:"group,omitempty" xmlrpc:"group,omitempty"` // Definition group id. GroupId *string `json:"groupId,omitempty" xmlrpc:"groupId,omitempty"` // Internal identifier of a configuration definition. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Maximum value of a configuration definition. MaximumValue *string `json:"maximumValue,omitempty" xmlrpc:"maximumValue,omitempty"` // Minimum value of a configuration definition. MinimumValue *string `json:"minimumValue,omitempty" xmlrpc:"minimumValue,omitempty"` // Last modify date ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // no documentation yet MonitoringDataFlag *bool `json:"monitoringDataFlag,omitempty" xmlrpc:"monitoringDataFlag,omitempty"` // Configuration definition name. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // Definition path. Path *string `json:"path,omitempty" xmlrpc:"path,omitempty"` // Indicates if a configuration value is required for this definition. RequireValueFlag *int `json:"requireValueFlag,omitempty" xmlrpc:"requireValueFlag,omitempty"` // no documentation yet Section *Configuration_Template_Section `json:"section,omitempty" xmlrpc:"section,omitempty"` // Internal identifier of a configuration section. SectionId *int `json:"sectionId,omitempty" xmlrpc:"sectionId,omitempty"` // Shortened configuration definition name. ShortName *string `json:"shortName,omitempty" xmlrpc:"shortName,omitempty"` // Sort order Sort *int `json:"sort,omitempty" xmlrpc:"sort,omitempty"` // Internal identifier of a configuration definition type. TypeId *int `json:"typeId,omitempty" xmlrpc:"typeId,omitempty"` // no documentation yet ValueType *Configuration_Template_Section_Definition_Type `json:"valueType,omitempty" xmlrpc:"valueType,omitempty"` }
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.
type Configuration_Template_Section_Definition_Attribute ¶
type Configuration_Template_Section_Definition_Attribute struct { Entity // no documentation yet AttributeType *Configuration_Template_Section_Definition_Attribute_Type `json:"attributeType,omitempty" xmlrpc:"attributeType,omitempty"` // no documentation yet ConfigurationDefinition *Configuration_Template_Section_Definition `json:"configurationDefinition,omitempty" xmlrpc:"configurationDefinition,omitempty"` // Value of a configuration definition attribute Value *string `json:"value,omitempty" xmlrpc:"value,omitempty"` }
Configuration definition attribute class contains supplementary information for a configuration definition.
type Configuration_Template_Section_Definition_Attribute_Type ¶
type Configuration_Template_Section_Definition_Attribute_Type struct { Entity // Description of a definition attribute type Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // Name of a definition attribute type Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
SoftLayer_Configuration_Template_Attribute_Type models the type of attribute that can be assigned to a configuration definition.
type Configuration_Template_Section_Definition_Group ¶
type Configuration_Template_Section_Definition_Group struct { Entity // Created date CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // Internal Description of a definition group. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // Internal identifier of a definition group. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Internal Definition group name. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // no documentation yet Parent *Configuration_Template_Section_Definition_Group `json:"parent,omitempty" xmlrpc:"parent,omitempty"` // Sort order SortOrder *int `json:"sortOrder,omitempty" xmlrpc:"sortOrder,omitempty"` }
Configuration definition group gives you details of the definition and allows extra functionality.
type Configuration_Template_Section_Definition_Type ¶
type Configuration_Template_Section_Definition_Type struct { Entity // Description of a configuration value type Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // Internal identifier of a configuration value type Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Name of a configuration value type Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
SoftLayer_Configuration_Template_Section_Definition_Type further defines the value of a configuration definition.
type Configuration_Template_Section_Definition_Value ¶
type Configuration_Template_Section_Definition_Value struct { Entity // Created date CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // no documentation yet Definition *Configuration_Template_Section_Definition `json:"definition,omitempty" xmlrpc:"definition,omitempty"` // Internal identifier of a configuration definition that this configuration value if defined by DefinitionId *int `json:"definitionId,omitempty" xmlrpc:"definitionId,omitempty"` // Internal Last modified date ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // no documentation yet Template *Configuration_Template `json:"template,omitempty" xmlrpc:"template,omitempty"` // Internal identifier of a configuration template that this configuration value belongs to TemplateId *int `json:"templateId,omitempty" xmlrpc:"templateId,omitempty"` // Internal Configuration value Value *string `json:"value,omitempty" xmlrpc:"value,omitempty"` }
SoftLayer_Configuration_Section_Value is used to set the value for a configuration definition
type Configuration_Template_Section_Profile ¶
type Configuration_Template_Section_Profile struct { Entity // Internal identifier of a monitoring agent this profile belongs to. AgentId *int `json:"agentId,omitempty" xmlrpc:"agentId,omitempty"` // no documentation yet ConfigurationSection *Configuration_Template_Section `json:"configurationSection,omitempty" xmlrpc:"configurationSection,omitempty"` // Created date CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // Internal identifier of a configuration profile. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Name of a configuration profile Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // Internal identifier of a configuration section that this profile belongs to. SectionId *int `json:"sectionId,omitempty" xmlrpc:"sectionId,omitempty"` }
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.
type Configuration_Template_Section_Reference ¶
type Configuration_Template_Section_Reference struct { Entity // Created date CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // Internal identifier of a configuration section reference. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Modified date ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // no documentation yet Section *Configuration_Template_Section `json:"section,omitempty" xmlrpc:"section,omitempty"` // Internal identifier of a configuration section. SectionId *int `json:"sectionId,omitempty" xmlrpc:"sectionId,omitempty"` // no documentation yet Template *Configuration_Template `json:"template,omitempty" xmlrpc:"template,omitempty"` // Internal identifier of a configuration template. TemplateId *int `json:"templateId,omitempty" xmlrpc:"templateId,omitempty"` }
The SoftLayer_Configuration_Template_Section_Reference data type contains information of a configuration section and its associated configuration template.
type Configuration_Template_Section_Type ¶
type Configuration_Template_Section_Type struct { Entity // Configuration section type description Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // Internal identifier of a configuration section type Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Configuration section type name Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
The SoftLayer_Configuration_Template_Section_Type data type contains information of a configuration section type.
Configuration can contain sub-sections.
type Configuration_Template_Type ¶
type Configuration_Template_Type struct { Entity // Created date. This is deprecated now. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // Description of a configuration template Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // Internal identifier of a configuration template type Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Name of a configuration template type Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
The SoftLayer_Configuration_Template_Type data type contains configuration template type information.
type Container_Account_Authentication_OpenIdConnect_UsernameLookupContainer ¶
type Container_Account_Authentication_OpenIdConnect_UsernameLookupContainer struct { Entity // no documentation yet Active *bool `json:"active,omitempty" xmlrpc:"active,omitempty"` // no documentation yet EmailAddress *string `json:"emailAddress,omitempty" xmlrpc:"emailAddress,omitempty"` // no documentation yet FamilyName *string `json:"familyName,omitempty" xmlrpc:"familyName,omitempty"` // no documentation yet Federated *bool `json:"federated,omitempty" xmlrpc:"federated,omitempty"` // no documentation yet FoundAs *string `json:"foundAs,omitempty" xmlrpc:"foundAs,omitempty"` // no documentation yet GivenName *string `json:"givenName,omitempty" xmlrpc:"givenName,omitempty"` // no documentation yet NumberOfIbmIdsWithEmailAddress *int `json:"numberOfIbmIdsWithEmailAddress,omitempty" xmlrpc:"numberOfIbmIdsWithEmailAddress,omitempty"` // no documentation yet Realm *string `json:"realm,omitempty" xmlrpc:"realm,omitempty"` // no documentation yet UniqueId *string `json:"uniqueId,omitempty" xmlrpc:"uniqueId,omitempty"` // no documentation yet Username *string `json:"username,omitempty" xmlrpc:"username,omitempty"` }
no documentation yet
type Container_Account_Discount_Program ¶
type Container_Account_Discount_Program struct { Entity // 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. AppliedCredit *Float64 `json:"appliedCredit,omitempty" xmlrpc:"appliedCredit,omitempty"` // Flag to signify whether the account is a participant in the discount program. IsParticipant *bool `json:"isParticipant,omitempty" xmlrpc:"isParticipant,omitempty"` // 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. LifetimeAppliedCredit *Float64 `json:"lifetimeAppliedCredit,omitempty" xmlrpc:"lifetimeAppliedCredit,omitempty"` // 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. LifetimeCredit *Float64 `json:"lifetimeCredit,omitempty" xmlrpc:"lifetimeCredit,omitempty"` // 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. LifetimeRemainingCredit *Float64 `json:"lifetimeRemainingCredit,omitempty" xmlrpc:"lifetimeRemainingCredit,omitempty"` // 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. MaximumActiveOrders *Float64 `json:"maximumActiveOrders,omitempty" xmlrpc:"maximumActiveOrders,omitempty"` // The monthly credit allowance that is available at the beginning of the billing cycle. MonthlyCredit *Float64 `json:"monthlyCredit,omitempty" xmlrpc:"monthlyCredit,omitempty"` // 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. PostTaxRemainingCredit *Float64 `json:"postTaxRemainingCredit,omitempty" xmlrpc:"postTaxRemainingCredit,omitempty"` // The date at which the program expires in MM/DD/YYYY format. ProgramEndDate *Time `json:"programEndDate,omitempty" xmlrpc:"programEndDate,omitempty"` // Name of the Flexible Credit Program the account is enrolled in. ProgramName *string `json:"programName,omitempty" xmlrpc:"programName,omitempty"` // 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. RemainingCredit *Float64 `json:"remainingCredit,omitempty" xmlrpc:"remainingCredit,omitempty"` // 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. RemainingCreditTax *Float64 `json:"remainingCreditTax,omitempty" xmlrpc:"remainingCreditTax,omitempty"` }
SoftLayer_Container_Account_Discount_Program models a single outbound object for a graph of given data sets.
type Container_Account_Discount_Program_Collection ¶
type Container_Account_Discount_Program_Collection struct { Entity // The amount of credit that has been used by all account level enrollments in the billing cycle. AccountLevelAppliedCredit *Float64 `json:"accountLevelAppliedCredit,omitempty" xmlrpc:"accountLevelAppliedCredit,omitempty"` // 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. AccountLevelLifetimeAppliedCredit *Float64 `json:"accountLevelLifetimeAppliedCredit,omitempty" xmlrpc:"accountLevelLifetimeAppliedCredit,omitempty"` // 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. AccountLevelLifetimeCredit *Float64 `json:"accountLevelLifetimeCredit,omitempty" xmlrpc:"accountLevelLifetimeCredit,omitempty"` // 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. AccountLevelLifetimeRemainingCredit *Float64 `json:"accountLevelLifetimeRemainingCredit,omitempty" xmlrpc:"accountLevelLifetimeRemainingCredit,omitempty"` // The total account level monthly credit allowance available at the beginning of a billing cycle. AccountLevelMonthlyCredit *Float64 `json:"accountLevelMonthlyCredit,omitempty" xmlrpc:"accountLevelMonthlyCredit,omitempty"` // The total account level credit allowance still available during the current billing cycle. AccountLevelRemainingCredit *Float64 `json:"accountLevelRemainingCredit,omitempty" xmlrpc:"accountLevelRemainingCredit,omitempty"` // The active enrollments for this account. Enrollments []FlexibleCredit_Enrollment `json:"enrollments,omitempty" xmlrpc:"enrollments,omitempty"` // Indicates whether or not the account is participating in any account level Flexible Credit programs. IsAccountLevelParticipantFlag *bool `json:"isAccountLevelParticipantFlag,omitempty" xmlrpc:"isAccountLevelParticipantFlag,omitempty"` // Indicates whether or not the account is participating in any Flexible Credit programs. IsParticipantFlag *bool `json:"isParticipantFlag,omitempty" xmlrpc:"isParticipantFlag,omitempty"` // Indicates whether or not the account is participating in any product specific level Flexible Credit programs. IsProductSpecificParticipantFlag *bool `json:"isProductSpecificParticipantFlag,omitempty" xmlrpc:"isProductSpecificParticipantFlag,omitempty"` // The amount of credit that has been used by all product specific enrollments in the billing cycle. ProductSpecificAppliedCredit *Float64 `json:"productSpecificAppliedCredit,omitempty" xmlrpc:"productSpecificAppliedCredit,omitempty"` // 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. ProductSpecificLifetimeAppliedCredit *Float64 `json:"productSpecificLifetimeAppliedCredit,omitempty" xmlrpc:"productSpecificLifetimeAppliedCredit,omitempty"` // 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. ProductSpecificLifetimeCredit *Float64 `json:"productSpecificLifetimeCredit,omitempty" xmlrpc:"productSpecificLifetimeCredit,omitempty"` // 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. ProductSpecificLifetimeRemainingCredit *Float64 `json:"productSpecificLifetimeRemainingCredit,omitempty" xmlrpc:"productSpecificLifetimeRemainingCredit,omitempty"` // The total product specific monthly credit allowance available at the beginning of a billing cycle. ProductSpecificMonthlyCredit *Float64 `json:"productSpecificMonthlyCredit,omitempty" xmlrpc:"productSpecificMonthlyCredit,omitempty"` // The total product specific credit allowance still available during the current billing cycle. ProductSpecificRemainingCredit *Float64 `json:"productSpecificRemainingCredit,omitempty" xmlrpc:"productSpecificRemainingCredit,omitempty"` // 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. TotalAppliedCredit *Float64 `json:"totalAppliedCredit,omitempty" xmlrpc:"totalAppliedCredit,omitempty"` // 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. TotalRemainingCredit *Float64 `json:"totalRemainingCredit,omitempty" xmlrpc:"totalRemainingCredit,omitempty"` }
no documentation yet
type Container_Account_External_Setup_ProvisioningHoldLifted ¶
type Container_Account_External_Setup_ProvisioningHoldLifted struct { Entity // no documentation yet AdditionalAttributes *Container_Account_External_Setup_ProvisioningHoldLifted_Attributes `json:"additionalAttributes,omitempty" xmlrpc:"additionalAttributes,omitempty"` // no documentation yet Code *string `json:"code,omitempty" xmlrpc:"code,omitempty"` // no documentation yet Error *string `json:"error,omitempty" xmlrpc:"error,omitempty"` // no documentation yet State *string `json:"state,omitempty" xmlrpc:"state,omitempty"` }
no documentation yet
type Container_Account_External_Setup_ProvisioningHoldLifted_Attributes ¶
type Container_Account_External_Setup_ProvisioningHoldLifted_Attributes struct { Entity // no documentation yet BrandKeyName *string `json:"brandKeyName,omitempty" xmlrpc:"brandKeyName,omitempty"` // no documentation yet SoftLayerBrandMoveDate *Time `json:"softLayerBrandMoveDate,omitempty" xmlrpc:"softLayerBrandMoveDate,omitempty"` }
no documentation yet
type Container_Account_Historical_Summary ¶
type Container_Account_Historical_Summary struct { Entity // Array of server uptime detail containers Details []Container_Account_Historical_Summary_Detail `json:"details,omitempty" xmlrpc:"details,omitempty"` // The maximum date included in the summary. EndDate *Time `json:"endDate,omitempty" xmlrpc:"endDate,omitempty"` // The minimum date included in the summary. StartDate *Time `json:"startDate,omitempty" xmlrpc:"startDate,omitempty"` }
Historical Summary Container for account resource details
type Container_Account_Historical_Summary_Detail ¶
type Container_Account_Historical_Summary_Detail struct { Entity // The maximum date included in the detail. EndDate *Time `json:"endDate,omitempty" xmlrpc:"endDate,omitempty"` // The minimum date included in the detail. StartDate *Time `json:"startDate,omitempty" xmlrpc:"startDate,omitempty"` }
Historical Summary Details Container for a resource's data
type Container_Account_Historical_Summary_Detail_Uptime ¶
type Container_Account_Historical_Summary_Detail_Uptime struct { Container_Account_Historical_Summary_Detail // The hardware for uptime details. CloudComputingInstance *Virtual_Guest `json:"cloudComputingInstance,omitempty" xmlrpc:"cloudComputingInstance,omitempty"` // The data associated with a host uptime details. Data []Metric_Tracking_Object_Data `json:"data,omitempty" xmlrpc:"data,omitempty"` // The hardware for uptime details. Hardware *Hardware `json:"hardware,omitempty" xmlrpc:"hardware,omitempty"` }
Historical Summary Details Container for a host resource uptime
type Container_Account_Historical_Summary_Uptime ¶
type Container_Account_Historical_Summary_Uptime struct {
Container_Account_Historical_Summary
}
Historical Summary Container for account host's resource uptime details
type Container_Account_Internal_Ibm_CostRecovery ¶ added in v1.1.3
type Container_Account_Internal_Ibm_CostRecovery struct { Entity // no documentation yet AccountId *string `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // no documentation yet CountryId *string `json:"countryId,omitempty" xmlrpc:"countryId,omitempty"` }
no documentation yet
type Container_Account_Internal_Ibm_Request ¶
type Container_Account_Internal_Ibm_Request struct { Entity // Purpose of the internal IBM account chosen from the list of available AccountType *string `json:"accountType,omitempty" xmlrpc:"accountType,omitempty"` // If not provided, will attempt to retrieve from BluePages Address1 *string `json:"address1,omitempty" xmlrpc:"address1,omitempty"` // If no address provided, will attempt to retrieve from BluePages Address2 *string `json:"address2,omitempty" xmlrpc:"address2,omitempty"` // If not provided, will attempt to retrieve from BluePages City *string `json:"city,omitempty" xmlrpc:"city,omitempty"` // Name of the company displayed on the IaaS account CompanyName *string `json:"companyName,omitempty" xmlrpc:"companyName,omitempty"` // no documentation yet CostRecoveryAccountId *string `json:"costRecoveryAccountId,omitempty" xmlrpc:"costRecoveryAccountId,omitempty"` // no documentation yet CostRecoveryCountryId *string `json:"costRecoveryCountryId,omitempty" xmlrpc:"costRecoveryCountryId,omitempty"` // If not provided, will attempt to retrieve from BluePages Country *string `json:"country,omitempty" xmlrpc:"country,omitempty"` // True if the request has been denied by either the IaaS team or the DeniedFlag *bool `json:"deniedFlag,omitempty" xmlrpc:"deniedFlag,omitempty"` // Department within the division which will be changed during cost recovery. [DEPRECATED] // Deprecated: This function has been marked as deprecated. DepartmentCode *string `json:"departmentCode,omitempty" xmlrpc:"departmentCode,omitempty"` // Country code assigned to the department for cost recovery. [DEPRECATED] // Deprecated: This function has been marked as deprecated. DepartmentCountry *string `json:"departmentCountry,omitempty" xmlrpc:"departmentCountry,omitempty"` // Division code used for cost recovery. [DEPRECATED] // Deprecated: This function has been marked as deprecated. DivisionCode *string `json:"divisionCode,omitempty" xmlrpc:"divisionCode,omitempty"` // Account owner's IBM email address. Must be a discoverable email EmailAddress *string `json:"emailAddress,omitempty" xmlrpc:"emailAddress,omitempty"` // Applicant's first name, as provided by IBM BluePages API. FirstName *string `json:"firstName,omitempty" xmlrpc:"firstName,omitempty"` // Applicant's last name, as provided by IBM BluePages API. LastName *string `json:"lastName,omitempty" xmlrpc:"lastName,omitempty"` // APPROVED if the request has been approved by the first-line manager, ManagerApprovalStatus *string `json:"managerApprovalStatus,omitempty" xmlrpc:"managerApprovalStatus,omitempty"` // True for accounts intended to be multi-tenant and false otherwise MultiTenantFlag *bool `json:"multiTenantFlag,omitempty" xmlrpc:"multiTenantFlag,omitempty"` // Account owner's primary phone number. If no phone number is available OfficePhone *string `json:"officePhone,omitempty" xmlrpc:"officePhone,omitempty"` // Bluemix PaaS 32 digit hexadecimal account id being automatically linked PaasAccountId *string `json:"paasAccountId,omitempty" xmlrpc:"paasAccountId,omitempty"` // If not provided, will attempt to retrieve from BluePages PostalCode *string `json:"postalCode,omitempty" xmlrpc:"postalCode,omitempty"` // Stated purpose of the new account this request would create Purpose *string `json:"purpose,omitempty" xmlrpc:"purpose,omitempty"` // Division's security SME's email address, if available SecuritySubjectMatterExpertEmail *string `json:"securitySubjectMatterExpertEmail,omitempty" xmlrpc:"securitySubjectMatterExpertEmail,omitempty"` // Division's security SME's name, if available SecuritySubjectMatterExpertName *string `json:"securitySubjectMatterExpertName,omitempty" xmlrpc:"securitySubjectMatterExpertName,omitempty"` // Division's security SME's phone, if available SecuritySubjectMatterExpertPhone *string `json:"securitySubjectMatterExpertPhone,omitempty" xmlrpc:"securitySubjectMatterExpertPhone,omitempty"` // If required for chosen country and not provided, will attempt State *string `json:"state,omitempty" xmlrpc:"state,omitempty"` }
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.
type Container_Account_Payment_Method_CreditCard ¶
type Container_Account_Payment_Method_CreditCard struct { Entity // no documentation yet Address1 *string `json:"address1,omitempty" xmlrpc:"address1,omitempty"` // no documentation yet Address2 *string `json:"address2,omitempty" xmlrpc:"address2,omitempty"` // no documentation yet City *string `json:"city,omitempty" xmlrpc:"city,omitempty"` // no documentation yet Country *string `json:"country,omitempty" xmlrpc:"country,omitempty"` // no documentation yet CurrencyShortName *string `json:"currencyShortName,omitempty" xmlrpc:"currencyShortName,omitempty"` // no documentation yet CybersourceAssignedCardType *string `json:"cybersourceAssignedCardType,omitempty" xmlrpc:"cybersourceAssignedCardType,omitempty"` // no documentation yet ExpireMonth *string `json:"expireMonth,omitempty" xmlrpc:"expireMonth,omitempty"` // no documentation yet ExpireYear *string `json:"expireYear,omitempty" xmlrpc:"expireYear,omitempty"` // no documentation yet FirstName *string `json:"firstName,omitempty" xmlrpc:"firstName,omitempty"` // no documentation yet LastFourDigits *string `json:"lastFourDigits,omitempty" xmlrpc:"lastFourDigits,omitempty"` // no documentation yet LastName *string `json:"lastName,omitempty" xmlrpc:"lastName,omitempty"` // no documentation yet Nickname *string `json:"nickname,omitempty" xmlrpc:"nickname,omitempty"` // no documentation yet PaymentMethodRoleName *string `json:"paymentMethodRoleName,omitempty" xmlrpc:"paymentMethodRoleName,omitempty"` // no documentation yet PaymentTypeId *string `json:"paymentTypeId,omitempty" xmlrpc:"paymentTypeId,omitempty"` // no documentation yet PaymentTypeName *string `json:"paymentTypeName,omitempty" xmlrpc:"paymentTypeName,omitempty"` // no documentation yet PostalCode *string `json:"postalCode,omitempty" xmlrpc:"postalCode,omitempty"` // no documentation yet State *string `json:"state,omitempty" xmlrpc:"state,omitempty"` }
no documentation yet
type Container_Account_PersonalInformation ¶
type Container_Account_PersonalInformation struct { Entity // no documentation yet AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // no documentation yet Address1 *string `json:"address1,omitempty" xmlrpc:"address1,omitempty"` // no documentation yet Address2 *string `json:"address2,omitempty" xmlrpc:"address2,omitempty"` // no documentation yet AlternatePhone *string `json:"alternatePhone,omitempty" xmlrpc:"alternatePhone,omitempty"` // no documentation yet City *string `json:"city,omitempty" xmlrpc:"city,omitempty"` // no documentation yet Country *string `json:"country,omitempty" xmlrpc:"country,omitempty"` // no documentation yet Email *string `json:"email,omitempty" xmlrpc:"email,omitempty"` // no documentation yet FirstName *string `json:"firstName,omitempty" xmlrpc:"firstName,omitempty"` // no documentation yet LastName *string `json:"lastName,omitempty" xmlrpc:"lastName,omitempty"` // no documentation yet OfficePhone *string `json:"officePhone,omitempty" xmlrpc:"officePhone,omitempty"` // no documentation yet PostalCode *string `json:"postalCode,omitempty" xmlrpc:"postalCode,omitempty"` // no documentation yet RequestDate *Time `json:"requestDate,omitempty" xmlrpc:"requestDate,omitempty"` // no documentation yet RequestId *int `json:"requestId,omitempty" xmlrpc:"requestId,omitempty"` // no documentation yet State *string `json:"state,omitempty" xmlrpc:"state,omitempty"` }
no documentation yet
type Container_Account_ProofOfConcept_Contact_Customer ¶
type Container_Account_ProofOfConcept_Contact_Customer struct { Entity // Customer's address Address1 *string `json:"address1,omitempty" xmlrpc:"address1,omitempty"` // Customer's address Address2 *string `json:"address2,omitempty" xmlrpc:"address2,omitempty"` // Customer's city City *string `json:"city,omitempty" xmlrpc:"city,omitempty"` // Customer's ISO country code Country *string `json:"country,omitempty" xmlrpc:"country,omitempty"` // Customer's email address Email *string `json:"email,omitempty" xmlrpc:"email,omitempty"` // Customer's first name FirstName *string `json:"firstName,omitempty" xmlrpc:"firstName,omitempty"` // Customer's last name LastName *string `json:"lastName,omitempty" xmlrpc:"lastName,omitempty"` // Customer's primary phone number Phone *string `json:"phone,omitempty" xmlrpc:"phone,omitempty"` // Customer's postal code PostalCode *string `json:"postalCode,omitempty" xmlrpc:"postalCode,omitempty"` // Customer's state State *string `json:"state,omitempty" xmlrpc:"state,omitempty"` // Customer's VAT ID VatId *string `json:"vatId,omitempty" xmlrpc:"vatId,omitempty"` }
The customer and prospective owner of a proof of concept account established by an IBMer.
type Container_Account_ProofOfConcept_Contact_Ibmer_Requester ¶
type Container_Account_ProofOfConcept_Contact_Ibmer_Requester struct { Entity // Customer's address Address1 *string `json:"address1,omitempty" xmlrpc:"address1,omitempty"` // Customer's address Address2 *string `json:"address2,omitempty" xmlrpc:"address2,omitempty"` // no documentation yet BusinessUnit *string `json:"businessUnit,omitempty" xmlrpc:"businessUnit,omitempty"` // Customer's city City *string `json:"city,omitempty" xmlrpc:"city,omitempty"` // Customer's ISO country code Country *string `json:"country,omitempty" xmlrpc:"country,omitempty"` // Customer's email address Email *string `json:"email,omitempty" xmlrpc:"email,omitempty"` // Customer's first name FirstName *string `json:"firstName,omitempty" xmlrpc:"firstName,omitempty"` // Customer's last name LastName *string `json:"lastName,omitempty" xmlrpc:"lastName,omitempty"` // no documentation yet OrganizationCountry *string `json:"organizationCountry,omitempty" xmlrpc:"organizationCountry,omitempty"` // no documentation yet PaasAccountId *string `json:"paasAccountId,omitempty" xmlrpc:"paasAccountId,omitempty"` // Customer's primary phone number Phone *string `json:"phone,omitempty" xmlrpc:"phone,omitempty"` // Customer's postal code PostalCode *string `json:"postalCode,omitempty" xmlrpc:"postalCode,omitempty"` // Customer's state State *string `json:"state,omitempty" xmlrpc:"state,omitempty"` // no documentation yet SubOrganization *string `json:"subOrganization,omitempty" xmlrpc:"subOrganization,omitempty"` // no documentation yet Uid *string `json:"uid,omitempty" xmlrpc:"uid,omitempty"` // Customer's VAT ID VatId *string `json:"vatId,omitempty" xmlrpc:"vatId,omitempty"` }
IBMer who is submitting a proof of concept request on behalf of a prospective customer.
type Container_Account_ProofOfConcept_Contact_Ibmer_Technical ¶
type Container_Account_ProofOfConcept_Contact_Ibmer_Technical struct { Entity // Customer's address Address1 *string `json:"address1,omitempty" xmlrpc:"address1,omitempty"` // Customer's address Address2 *string `json:"address2,omitempty" xmlrpc:"address2,omitempty"` // Customer's city City *string `json:"city,omitempty" xmlrpc:"city,omitempty"` // Customer's ISO country code Country *string `json:"country,omitempty" xmlrpc:"country,omitempty"` // Customer's email address Email *string `json:"email,omitempty" xmlrpc:"email,omitempty"` // Customer's first name FirstName *string `json:"firstName,omitempty" xmlrpc:"firstName,omitempty"` // Customer's last name LastName *string `json:"lastName,omitempty" xmlrpc:"lastName,omitempty"` // Customer's primary phone number Phone *string `json:"phone,omitempty" xmlrpc:"phone,omitempty"` // Customer's postal code PostalCode *string `json:"postalCode,omitempty" xmlrpc:"postalCode,omitempty"` // Customer's state State *string `json:"state,omitempty" xmlrpc:"state,omitempty"` // no documentation yet Uid *string `json:"uid,omitempty" xmlrpc:"uid,omitempty"` // Customer's VAT ID VatId *string `json:"vatId,omitempty" xmlrpc:"vatId,omitempty"` }
IBMer who will assist the requester with technical aspects of configuring the proof of concept account.
type Container_Account_ProofOfConcept_Request_AccountFunded ¶
type Container_Account_ProofOfConcept_Request_AccountFunded struct { Container_Account_ProofOfConcept_Request_GlobalFunded // Billing codes for the department paying for the proof of concept account CostRecoveryRequest *Container_Account_ProofOfConcept_Request_CostRecovery `json:"costRecoveryRequest,omitempty" xmlrpc:"costRecoveryRequest,omitempty"` }
Proof of concept request using the account team funding model. Note that proof of concept account request are available only to internal IBM employees.
type Container_Account_ProofOfConcept_Request_CostRecovery ¶
type Container_Account_ProofOfConcept_Request_CostRecovery struct { Entity // Internal billing system country code CountryCode *string `json:"countryCode,omitempty" xmlrpc:"countryCode,omitempty"` // Customer's Internal billing system department code DepartmentCode *string `json:"departmentCode,omitempty" xmlrpc:"departmentCode,omitempty"` // Internal billing system division code DivisionCode *string `json:"divisionCode,omitempty" xmlrpc:"divisionCode,omitempty"` }
Funding codes for the department paying for the proof of concept account.
type Container_Account_ProofOfConcept_Request_GlobalFunded ¶
type Container_Account_ProofOfConcept_Request_GlobalFunded struct { Entity // Dollar amount of funding requested for the proof of concept period Amount *Float64 `json:"amount,omitempty" xmlrpc:"amount,omitempty"` // Customer intended to take over ownership and and billing of the account Customer *Container_Account_ProofOfConcept_Contact_Customer `json:"customer,omitempty" xmlrpc:"customer,omitempty"` // Explanation of the purpose of the proof of concept request Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // End date for the proof of concept period EndDate *Time `json:"endDate,omitempty" xmlrpc:"endDate,omitempty"` // Internal opportunity system details Opportunity *Container_Account_ProofOfConcept_Request_Opportunity `json:"opportunity,omitempty" xmlrpc:"opportunity,omitempty"` // Name of the project or company and will become the account companyName ProjectName *string `json:"projectName,omitempty" xmlrpc:"projectName,omitempty"` // IBM region responsible for overseeing the proof of concept account RegionKeyName *string `json:"regionKeyName,omitempty" xmlrpc:"regionKeyName,omitempty"` // IBMer requesting the proof of concept account Requester *Container_Account_ProofOfConcept_Contact_Ibmer_Requester `json:"requester,omitempty" xmlrpc:"requester,omitempty"` // Start date for the proof of concept period StartDate *Time `json:"startDate,omitempty" xmlrpc:"startDate,omitempty"` // IBMer assisting with technical aspects of account configuration TechnicalContact *Container_Account_ProofOfConcept_Contact_Ibmer_Technical `json:"technicalContact,omitempty" xmlrpc:"technicalContact,omitempty"` }
Proof of concept request using the global funding model. Note that proof of concept account request are available only to internal IBM employees.
type Container_Account_ProofOfConcept_Request_Opportunity ¶
type Container_Account_ProofOfConcept_Request_Opportunity struct { Entity // The campaign or promotion code for this request, provided by Sales. CampaignCode *string `json:"campaignCode,omitempty" xmlrpc:"campaignCode,omitempty"` // Expected monthly revenue. MonthlyRecurringRevenue *Float64 `json:"monthlyRecurringRevenue,omitempty" xmlrpc:"monthlyRecurringRevenue,omitempty"` // Internal system identifier. OpportunityNumber *string `json:"opportunityNumber,omitempty" xmlrpc:"opportunityNumber,omitempty"` // Expected overall contract value. TotalContractValue *Float64 `json:"totalContractValue,omitempty" xmlrpc:"totalContractValue,omitempty"` }
Internal IBM opportunity codes required when applying for a Proof of Concept account.
type Container_Account_ProofOfConcept_Review ¶
type Container_Account_ProofOfConcept_Review struct { Entity // Type of brand the account will use AccountType *string `json:"accountType,omitempty" xmlrpc:"accountType,omitempty"` // Internal billing codes CostRecoveryCodes *Container_Account_ProofOfConcept_Request_CostRecovery `json:"costRecoveryCodes,omitempty" xmlrpc:"costRecoveryCodes,omitempty"` // Customer intended to take over billing after the proof of concept period Customer *Container_Account_ProofOfConcept_Contact_Customer `json:"customer,omitempty" xmlrpc:"customer,omitempty"` // Describes the purpose and rationale of the request Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // Expected end date of the proof of concept period EndDate *Time `json:"endDate,omitempty" xmlrpc:"endDate,omitempty"` // Dollar amount of funding requested FundingAmount *Float64 `json:"fundingAmount,omitempty" xmlrpc:"fundingAmount,omitempty"` // Funding option chosen for the request FundingType *string `json:"fundingType,omitempty" xmlrpc:"fundingType,omitempty"` // System id of the request Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Name of the integrated offering team lead reviewing the request IotLeadName *string `json:"iotLeadName,omitempty" xmlrpc:"iotLeadName,omitempty"` // Name of the integrated offering team region IotRegionName *string `json:"iotRegionName,omitempty" xmlrpc:"iotRegionName,omitempty"` // Name of requesting IBMer's manager ManagerName *string `json:"managerName,omitempty" xmlrpc:"managerName,omitempty"` // Internal opportunity tracking information Opportunity *Container_Account_ProofOfConcept_Request_Opportunity `json:"opportunity,omitempty" xmlrpc:"opportunity,omitempty"` // Project name chosen by the requesting IBMer ProjectName *string `json:"projectName,omitempty" xmlrpc:"projectName,omitempty"` // IBMer requesting the account on behalf of a customer Requester *Container_Account_ProofOfConcept_Contact_Ibmer_Requester `json:"requester,omitempty" xmlrpc:"requester,omitempty"` // Summary of request's review activity ReviewHistory *Container_Account_ProofOfConcept_Review_History `json:"reviewHistory,omitempty" xmlrpc:"reviewHistory,omitempty"` // URL for the individual review ReviewUrl *string `json:"reviewUrl,omitempty" xmlrpc:"reviewUrl,omitempty"` // Expected start date of the proof of concept period StartDate *Time `json:"startDate,omitempty" xmlrpc:"startDate,omitempty"` // Additional IBMer responsible for configuring the cloud capabilities TechnicalContact *Container_Account_ProofOfConcept_Contact_Ibmer_Technical `json:"technicalContact,omitempty" xmlrpc:"technicalContact,omitempty"` }
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.
type Container_Account_ProofOfConcept_Review_Event ¶
type Container_Account_ProofOfConcept_Review_Event struct { Entity // Explanation of the event. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // Reviewer's email address. ReviewerEmail *string `json:"reviewerEmail,omitempty" xmlrpc:"reviewerEmail,omitempty"` // Reviewer's BluePages UID. ReviewerUid *string `json:"reviewerUid,omitempty" xmlrpc:"reviewerUid,omitempty"` }
Review event within proof of concept request review period.
type Container_Account_ProofOfConcept_Review_History ¶
type Container_Account_ProofOfConcept_Review_History struct { Entity // True for approved requests associated with a new account and false otherwise. AccountCreatedFlag *bool `json:"accountCreatedFlag,omitempty" xmlrpc:"accountCreatedFlag,omitempty"` // True for denied requests and false otherwise. DeniedFlag *bool `json:"deniedFlag,omitempty" xmlrpc:"deniedFlag,omitempty"` // List of events occurring during the review. Events []Container_Account_ProofOfConcept_Review_Event `json:"events,omitempty" xmlrpc:"events,omitempty"` // True for fully reviewed requests and false otherwise. ReviewCompleteFlag *bool `json:"reviewCompleteFlag,omitempty" xmlrpc:"reviewCompleteFlag,omitempty"` }
Summary of review activity for a proof of concept request.
type Container_Account_ProofOfConcept_Review_Summary ¶
type Container_Account_ProofOfConcept_Review_Summary struct { Entity // Account's companyName AccountName *string `json:"accountName,omitempty" xmlrpc:"accountName,omitempty"` // Current account owner AccountOwnerName *string `json:"accountOwnerName,omitempty" xmlrpc:"accountOwnerName,omitempty"` // Dollar amount requested Amount *Float64 `json:"amount,omitempty" xmlrpc:"amount,omitempty"` // Date the request was submitted CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // Email of the customer receiving the proof of concept account CustomerEmail *string `json:"customerEmail,omitempty" xmlrpc:"customerEmail,omitempty"` // Name of the customer receiving the proof of concept account CustomerName *string `json:"customerName,omitempty" xmlrpc:"customerName,omitempty"` // Request record's id Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Date of the last state change on the request LastUpdate *Time `json:"lastUpdate,omitempty" xmlrpc:"lastUpdate,omitempty"` // Email address of the reviewer, if any, currently reviewing the request NextApproverEmail *string `json:"nextApproverEmail,omitempty" xmlrpc:"nextApproverEmail,omitempty"` // Email address of the requester RequesterEmail *string `json:"requesterEmail,omitempty" xmlrpc:"requesterEmail,omitempty"` // Requesting IBMer's full name RequesterName *string `json:"requesterName,omitempty" xmlrpc:"requesterName,omitempty"` // URL for the individual review ReviewUrl *string `json:"reviewUrl,omitempty" xmlrpc:"reviewUrl,omitempty"` // Request's current status (Pending, Denied, or Approved) Status *string `json:"status,omitempty" xmlrpc:"status,omitempty"` }
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.
type Container_Account_Update_Response ¶
type Container_Account_Update_Response struct { Entity // Whether or not the update was accepted and applied. AcceptedFlag *bool `json:"acceptedFlag,omitempty" xmlrpc:"acceptedFlag,omitempty"` // The updated SoftLayer_Account. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // If a manual review is required, this will be populated with the SoftLayer_Ticket for that review. Ticket *Ticket `json:"ticket,omitempty" xmlrpc:"ticket,omitempty"` }
Contains data related to an account after editing its information.
type Container_Authentication_Request_Common ¶
type Container_Authentication_Request_Common struct { Container_Authentication_Request_Contract // The answer to your security question. SecurityQuestionAnswer *string `json:"securityQuestionAnswer,omitempty" xmlrpc:"securityQuestionAnswer,omitempty"` // 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. SecurityQuestionId *int `json:"securityQuestionId,omitempty" xmlrpc:"securityQuestionId,omitempty"` }
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).
type Container_Authentication_Request_Contract ¶
type Container_Authentication_Request_Contract struct {
Entity
}
The SoftLayer_Container_Authentication_Request_Contract provides a common set of operations for implementing classes.
type Container_Authentication_Request_Native ¶
type Container_Authentication_Request_Native struct { Container_Authentication_Request_Common // no documentation yet AuxiliaryClaimsMiniToken *string `json:"auxiliaryClaimsMiniToken,omitempty" xmlrpc:"auxiliaryClaimsMiniToken,omitempty"` // Your SoftLayer customer portal user's portal password. Password *string `json:"password,omitempty" xmlrpc:"password,omitempty"` // The username you wish to authenticate to the SoftLayer customer portal with. Username *string `json:"username,omitempty" xmlrpc:"username,omitempty"` }
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.
type Container_Authentication_Request_Native_External ¶
type Container_Authentication_Request_Native_External struct {
Container_Authentication_Request_Native
}
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).
type Container_Authentication_Request_Native_External_Totp ¶
type Container_Authentication_Request_Native_External_Totp struct { Container_Authentication_Request_Native_External // no documentation yet SecondSecurityCode *string `json:"secondSecurityCode,omitempty" xmlrpc:"secondSecurityCode,omitempty"` // no documentation yet SecurityCode *string `json:"securityCode,omitempty" xmlrpc:"securityCode,omitempty"` // no documentation yet Vendor *string `json:"vendor,omitempty" xmlrpc:"vendor,omitempty"` }
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.
type Container_Authentication_Request_Native_External_Verisign ¶
type Container_Authentication_Request_Native_External_Verisign struct { Container_Authentication_Request_Native_External // no documentation yet SecondSecurityCode *string `json:"secondSecurityCode,omitempty" xmlrpc:"secondSecurityCode,omitempty"` // no documentation yet SecurityCode *string `json:"securityCode,omitempty" xmlrpc:"securityCode,omitempty"` // no documentation yet Vendor *string `json:"vendor,omitempty" xmlrpc:"vendor,omitempty"` }
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.
type Container_Authentication_Request_OpenIdConnect ¶
type Container_Authentication_Request_OpenIdConnect struct { Container_Authentication_Request_Common // no documentation yet OpenIdConnectAccessToken *string `json:"openIdConnectAccessToken,omitempty" xmlrpc:"openIdConnectAccessToken,omitempty"` // no documentation yet OpenIdConnectAccountId *int `json:"openIdConnectAccountId,omitempty" xmlrpc:"openIdConnectAccountId,omitempty"` // no documentation yet OpenIdConnectProvider *string `json:"openIdConnectProvider,omitempty" xmlrpc:"openIdConnectProvider,omitempty"` }
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.
type Container_Authentication_Request_OpenIdConnect_External ¶
type Container_Authentication_Request_OpenIdConnect_External struct {
Container_Authentication_Request_OpenIdConnect
}
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.
type Container_Authentication_Request_OpenIdConnect_External_Totp ¶
type Container_Authentication_Request_OpenIdConnect_External_Totp struct { Container_Authentication_Request_OpenIdConnect_External // no documentation yet SecondSecurityCode *string `json:"secondSecurityCode,omitempty" xmlrpc:"secondSecurityCode,omitempty"` // no documentation yet SecurityCode *string `json:"securityCode,omitempty" xmlrpc:"securityCode,omitempty"` // no documentation yet Vendor *string `json:"vendor,omitempty" xmlrpc:"vendor,omitempty"` }
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.
type Container_Authentication_Request_OpenIdConnect_External_Verisign ¶
type Container_Authentication_Request_OpenIdConnect_External_Verisign struct { Container_Authentication_Request_OpenIdConnect_External // no documentation yet SecondSecurityCode *string `json:"secondSecurityCode,omitempty" xmlrpc:"secondSecurityCode,omitempty"` // no documentation yet SecurityCode *int `json:"securityCode,omitempty" xmlrpc:"securityCode,omitempty"` // no documentation yet Vendor *string `json:"vendor,omitempty" xmlrpc:"vendor,omitempty"` }
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.
type Container_Authentication_Response_2FactorAuthenticationNeeded ¶
type Container_Authentication_Response_2FactorAuthenticationNeeded struct { Container_Authentication_Response_Common // no documentation yet AdditionalData *Container_Authentication_Response_Common `json:"additionalData,omitempty" xmlrpc:"additionalData,omitempty"` // no documentation yet StatusKeyName *string `json:"statusKeyName,omitempty" xmlrpc:"statusKeyName,omitempty"` }
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.
type Container_Authentication_Response_Account ¶
type Container_Authentication_Response_Account struct { Entity // no documentation yet AccountCompanyName *string `json:"accountCompanyName,omitempty" xmlrpc:"accountCompanyName,omitempty"` // no documentation yet AccountCountry *string `json:"accountCountry,omitempty" xmlrpc:"accountCountry,omitempty"` // no documentation yet AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // no documentation yet AccountStatusName *string `json:"accountStatusName,omitempty" xmlrpc:"accountStatusName,omitempty"` // no documentation yet BluemixAccountId *string `json:"bluemixAccountId,omitempty" xmlrpc:"bluemixAccountId,omitempty"` // no documentation yet CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // no documentation yet DefaultAccount *bool `json:"defaultAccount,omitempty" xmlrpc:"defaultAccount,omitempty"` // no documentation yet IpAddressCheckRequired *bool `json:"ipAddressCheckRequired,omitempty" xmlrpc:"ipAddressCheckRequired,omitempty"` // no documentation yet IsMasterUserFlag *bool `json:"isMasterUserFlag,omitempty" xmlrpc:"isMasterUserFlag,omitempty"` // no documentation yet ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // no documentation yet SecurityQuestionRequired *bool `json:"securityQuestionRequired,omitempty" xmlrpc:"securityQuestionRequired,omitempty"` // no documentation yet TotpExternalAuthenticationRequired *bool `json:"totpExternalAuthenticationRequired,omitempty" xmlrpc:"totpExternalAuthenticationRequired,omitempty"` // no documentation yet UserId *int `json:"userId,omitempty" xmlrpc:"userId,omitempty"` // no documentation yet VerisignExternalAuthenticationRequired *bool `json:"verisignExternalAuthenticationRequired,omitempty" xmlrpc:"verisignExternalAuthenticationRequired,omitempty"` }
The SoftLayer_Container_Authentication_Response_Account data type contains account information for responses from the getPortalLogin API.
type Container_Authentication_Response_AccountIdMissing ¶
type Container_Authentication_Response_AccountIdMissing struct { Container_Authentication_Response_Common // no documentation yet StatusKeyName *string `json:"statusKeyName,omitempty" xmlrpc:"statusKeyName,omitempty"` }
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.
type Container_Authentication_Response_Common ¶
type Container_Authentication_Response_Common struct { Entity // The list of linked accounts for the authenticated SoftLayer customer portal user. Accounts []Container_Authentication_Response_Account `json:"accounts,omitempty" xmlrpc:"accounts,omitempty"` }
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.
type Container_Authentication_Response_IpAddressRestrictionCheckNeeded ¶
type Container_Authentication_Response_IpAddressRestrictionCheckNeeded struct { Container_Authentication_Response_Common // no documentation yet StatusKeyName *string `json:"statusKeyName,omitempty" xmlrpc:"statusKeyName,omitempty"` }
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.
type Container_Authentication_Response_LoginFailed ¶
type Container_Authentication_Response_LoginFailed struct { Container_Authentication_Response_Common // no documentation yet ErrorMessage *string `json:"errorMessage,omitempty" xmlrpc:"errorMessage,omitempty"` // no documentation yet StatusKeyName *string `json:"statusKeyName,omitempty" xmlrpc:"statusKeyName,omitempty"` }
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.
type Container_Authentication_Response_Success ¶
type Container_Authentication_Response_Success struct { Container_Authentication_Response_Common // no documentation yet StatusKeyName *string `json:"statusKeyName,omitempty" xmlrpc:"statusKeyName,omitempty"` // The token for interacting with the SoftLayer customer portal. Token *Container_User_Authentication_Token `json:"token,omitempty" xmlrpc:"token,omitempty"` }
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.
type Container_Auxiliary_Network_Status_Reading ¶
type Container_Auxiliary_Network_Status_Reading struct { Entity // no documentation yet // Deprecated: This function has been marked as deprecated. AveragePing *Float64 `json:"averagePing,omitempty" xmlrpc:"averagePing,omitempty"` // no documentation yet // Deprecated: This function has been marked as deprecated. Fails *int `json:"fails,omitempty" xmlrpc:"fails,omitempty"` // no documentation yet // Deprecated: This function has been marked as deprecated. Frequency *int `json:"frequency,omitempty" xmlrpc:"frequency,omitempty"` // no documentation yet // Deprecated: This function has been marked as deprecated. Label *string `json:"label,omitempty" xmlrpc:"label,omitempty"` // no documentation yet // Deprecated: This function has been marked as deprecated. LastCheckDate *Time `json:"lastCheckDate,omitempty" xmlrpc:"lastCheckDate,omitempty"` // no documentation yet // Deprecated: This function has been marked as deprecated. LastDownDate *Time `json:"lastDownDate,omitempty" xmlrpc:"lastDownDate,omitempty"` // no documentation yet // Deprecated: This function has been marked as deprecated. Latency *Float64 `json:"latency,omitempty" xmlrpc:"latency,omitempty"` // no documentation yet // Deprecated: This function has been marked as deprecated. Location *string `json:"location,omitempty" xmlrpc:"location,omitempty"` // no documentation yet // Deprecated: This function has been marked as deprecated. MaximumPing *Float64 `json:"maximumPing,omitempty" xmlrpc:"maximumPing,omitempty"` // no documentation yet // Deprecated: This function has been marked as deprecated. MinimumPing *Float64 `json:"minimumPing,omitempty" xmlrpc:"minimumPing,omitempty"` // no documentation yet // Deprecated: This function has been marked as deprecated. PingLoss *Float64 `json:"pingLoss,omitempty" xmlrpc:"pingLoss,omitempty"` // no documentation yet // Deprecated: This function has been marked as deprecated. StartDate *Time `json:"startDate,omitempty" xmlrpc:"startDate,omitempty"` // no documentation yet // Deprecated: This function has been marked as deprecated. StatusCode *string `json:"statusCode,omitempty" xmlrpc:"statusCode,omitempty"` // no documentation yet // Deprecated: This function has been marked as deprecated. StatusMessage *string `json:"statusMessage,omitempty" xmlrpc:"statusMessage,omitempty"` // no documentation yet // Deprecated: This function has been marked as deprecated. Target *string `json:"target,omitempty" xmlrpc:"target,omitempty"` // no documentation yet // Deprecated: This function has been marked as deprecated. TargetType *string `json:"targetType,omitempty" xmlrpc:"targetType,omitempty"` }
no documentation yet
type Container_Bandwidth_GraphInputs ¶
type Container_Bandwidth_GraphInputs struct { Entity // This is a unix timestamp that represents the stop date/time for a graph. EndDate *Time `json:"endDate,omitempty" xmlrpc:"endDate,omitempty"` // The front-end or back-end network uplink interface associated with this server. NetworkInterfaceId *int `json:"networkInterfaceId,omitempty" xmlrpc:"networkInterfaceId,omitempty"` // * Pod *int `json:"pod,omitempty" xmlrpc:"pod,omitempty"` // This is a human readable name for the server or rack being graphed. ServerName *string `json:"serverName,omitempty" xmlrpc:"serverName,omitempty"` // This is a unix timestamp that represents the begin date/time for a graph. StartDate *Time `json:"startDate,omitempty" xmlrpc:"startDate,omitempty"` }
SoftLayer_Container_Bandwidth_GraphInputs models a single inbound object for a given bandwidth graph.
type Container_Bandwidth_GraphOutputs ¶
type Container_Bandwidth_GraphOutputs struct { Entity // The raw PNG binary data to be displayed once the graph is drawn. GraphImage *[]byte `json:"graphImage,omitempty" xmlrpc:"graphImage,omitempty"` // The title that ended up being displayed as part of the graph image. GraphTitle *string `json:"graphTitle,omitempty" xmlrpc:"graphTitle,omitempty"` // The maximum date included in this graph. MaxEndDate *Time `json:"maxEndDate,omitempty" xmlrpc:"maxEndDate,omitempty"` // The minimum date included in this graph. MinStartDate *Time `json:"minStartDate,omitempty" xmlrpc:"minStartDate,omitempty"` }
SoftLayer_Container_Bandwidth_GraphOutputs models a single outbound object for a given bandwidth graph.
type Container_Bandwidth_Projection ¶
type Container_Bandwidth_Projection struct { Entity // Bandwidth limit for this hardware. AllowedUsage *string `json:"allowedUsage,omitempty" xmlrpc:"allowedUsage,omitempty"` // Estimated bandwidth usage so far this billing cycle. EstimatedUsage *string `json:"estimatedUsage,omitempty" xmlrpc:"estimatedUsage,omitempty"` // Hardware ID of server to monitor. HardwareId *int `json:"hardwareId,omitempty" xmlrpc:"hardwareId,omitempty"` // Projected usage for this hardware based on previous usage this billing cycle. ProjectedUsage *string `json:"projectedUsage,omitempty" xmlrpc:"projectedUsage,omitempty"` // the text name of the server being monitored. ServerName *string `json:"serverName,omitempty" xmlrpc:"serverName,omitempty"` // The minimum date included in this list. StartDate *Time `json:"startDate,omitempty" xmlrpc:"startDate,omitempty"` }
SoftLayer_Container_Bandwidth_Projection models projected bandwidth use over a time range.
type Container_Bandwidth_Usage ¶ added in v1.0.1
type Container_Bandwidth_Usage struct { Entity // no documentation yet EndDate *Time `json:"endDate,omitempty" xmlrpc:"endDate,omitempty"` // no documentation yet HardwareId *int `json:"hardwareId,omitempty" xmlrpc:"hardwareId,omitempty"` // no documentation yet PrivateInUsage *Float64 `json:"privateInUsage,omitempty" xmlrpc:"privateInUsage,omitempty"` // no documentation yet PrivateOutUsage *Float64 `json:"privateOutUsage,omitempty" xmlrpc:"privateOutUsage,omitempty"` // no documentation yet PublicInUsage *Float64 `json:"publicInUsage,omitempty" xmlrpc:"publicInUsage,omitempty"` // no documentation yet PublicOutUsage *Float64 `json:"publicOutUsage,omitempty" xmlrpc:"publicOutUsage,omitempty"` // no documentation yet StartDate *Time `json:"startDate,omitempty" xmlrpc:"startDate,omitempty"` }
When a customer uses SoftLayer_Account::getBandwidthUsage, this container is used to return their usage information in bytes
type Container_Billing_Currency_Country ¶
type Container_Billing_Currency_Country struct { Entity // no documentation yet AvailableCurrencies []Billing_Currency `json:"availableCurrencies,omitempty" xmlrpc:"availableCurrencies,omitempty"` // no documentation yet Country *Locale_Country `json:"country,omitempty" xmlrpc:"country,omitempty"` // no documentation yet CurrencyCountryLocales []Billing_Currency_Country `json:"currencyCountryLocales,omitempty" xmlrpc:"currencyCountryLocales,omitempty"` }
no documentation yet
type Container_Billing_Currency_Format ¶
type Container_Billing_Currency_Format struct { Entity // no documentation yet Currency *string `json:"currency,omitempty" xmlrpc:"currency,omitempty"` // no documentation yet Display *int `json:"display,omitempty" xmlrpc:"display,omitempty"` // no documentation yet Format *string `json:"format,omitempty" xmlrpc:"format,omitempty"` // no documentation yet Locale *string `json:"locale,omitempty" xmlrpc:"locale,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // no documentation yet Position *int `json:"position,omitempty" xmlrpc:"position,omitempty"` // no documentation yet Precision *int `json:"precision,omitempty" xmlrpc:"precision,omitempty"` // no documentation yet Script *string `json:"script,omitempty" xmlrpc:"script,omitempty"` // no documentation yet Service *string `json:"service,omitempty" xmlrpc:"service,omitempty"` // no documentation yet Symbol *string `json:"symbol,omitempty" xmlrpc:"symbol,omitempty"` // no documentation yet Tag *string `json:"tag,omitempty" xmlrpc:"tag,omitempty"` // no documentation yet Value *Float64 `json:"value,omitempty" xmlrpc:"value,omitempty"` }
no documentation yet
type Container_Billing_Info_Ach ¶
type Container_Billing_Info_Ach struct { Entity // no documentation yet AccountNumber *string `json:"accountNumber,omitempty" xmlrpc:"accountNumber,omitempty"` // no documentation yet AccountType *string `json:"accountType,omitempty" xmlrpc:"accountType,omitempty"` // no documentation yet BankTransitNumber *string `json:"bankTransitNumber,omitempty" xmlrpc:"bankTransitNumber,omitempty"` // no documentation yet City *string `json:"city,omitempty" xmlrpc:"city,omitempty"` // no documentation yet Country *string `json:"country,omitempty" xmlrpc:"country,omitempty"` // no documentation yet FederalTaxId *string `json:"federalTaxId,omitempty" xmlrpc:"federalTaxId,omitempty"` // no documentation yet FirstName *string `json:"firstName,omitempty" xmlrpc:"firstName,omitempty"` // no documentation yet LastName *string `json:"lastName,omitempty" xmlrpc:"lastName,omitempty"` // no documentation yet PhoneNumber *string `json:"phoneNumber,omitempty" xmlrpc:"phoneNumber,omitempty"` // no documentation yet PostalCode *string `json:"postalCode,omitempty" xmlrpc:"postalCode,omitempty"` // no documentation yet State *string `json:"state,omitempty" xmlrpc:"state,omitempty"` // no documentation yet Street1 *string `json:"street1,omitempty" xmlrpc:"street1,omitempty"` // no documentation yet Street2 *string `json:"street2,omitempty" xmlrpc:"street2,omitempty"` }
no documentation yet
type Container_Billing_Invoice_Email ¶
type Container_Billing_Invoice_Email struct { Entity // Excel Invoices to email ExcelInvoiceIds []int `json:"excelInvoiceIds,omitempty" xmlrpc:"excelInvoiceIds,omitempty"` // PDF Invoice Details to email PdfDetailedInvoiceIds []int `json:"pdfDetailedInvoiceIds,omitempty" xmlrpc:"pdfDetailedInvoiceIds,omitempty"` // PDF Invoices to email PdfInvoiceIds []int `json:"pdfInvoiceIds,omitempty" xmlrpc:"pdfInvoiceIds,omitempty"` // The type of Invoices to be emailed [current|next]. If next is selected, the account id will be used. Type *string `json:"type,omitempty" xmlrpc:"type,omitempty"` }
This container is used to provide all the options for [[SoftLayer_Billing_Invoice/emailInvoices|emailInvoices]] in order to have the necessary invoices generated and links sent to the user's email.
type Container_Billing_Order_Status ¶
type Container_Billing_Order_Status struct { Entity // The description of the status. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // The keyname of the status. Status *string `json:"status,omitempty" xmlrpc:"status,omitempty"` }
SoftLayer_Container_Billing_Order_Status models an order status.
type Container_Catalyst_ManualEnrollmentRequest ¶
type Container_Catalyst_ManualEnrollmentRequest struct { Entity // Applicant's email address CustomerEmail *string `json:"customerEmail,omitempty" xmlrpc:"customerEmail,omitempty"` // Applicant's first and last name CustomerName *string `json:"customerName,omitempty" xmlrpc:"customerName,omitempty"` // Name of applicant's startup company StartupName *string `json:"startupName,omitempty" xmlrpc:"startupName,omitempty"` // Flag indicating whether (true) or not (false) and applicant is VentureAffiliationFlag *bool `json:"ventureAffiliationFlag,omitempty" xmlrpc:"ventureAffiliationFlag,omitempty"` // Name of the venture capital fund, if any, applicant is affiliated with VentureFundName *string `json:"ventureFundName,omitempty" xmlrpc:"ventureFundName,omitempty"` }
Contains user information used to request a manual Catalyst enrollment.
type Container_Collection_Locale_CountryCode ¶
type Container_Collection_Locale_CountryCode struct { Entity // no documentation yet LongName *string `json:"longName,omitempty" xmlrpc:"longName,omitempty"` // no documentation yet ShortName *string `json:"shortName,omitempty" xmlrpc:"shortName,omitempty"` // no documentation yet StateCodes []Container_Collection_Locale_StateCode `json:"stateCodes,omitempty" xmlrpc:"stateCodes,omitempty"` }
This container is used to hold country locale information.
type Container_Collection_Locale_StateCode ¶
type Container_Collection_Locale_StateCode struct { Entity // no documentation yet LongName *string `json:"longName,omitempty" xmlrpc:"longName,omitempty"` // no documentation yet ShortName *string `json:"shortName,omitempty" xmlrpc:"shortName,omitempty"` }
This container is used to hold information regarding a state or province.
type Container_Collection_Locale_VatCountryCodeAndFormat ¶
type Container_Collection_Locale_VatCountryCodeAndFormat struct { Entity // no documentation yet CountryCode *string `json:"countryCode,omitempty" xmlrpc:"countryCode,omitempty"` // no documentation yet Regex *string `json:"regex,omitempty" xmlrpc:"regex,omitempty"` }
This container is used to hold VAT information.
type Container_Disk_Image_Capture_Template ¶
type Container_Disk_Image_Capture_Template struct { Entity // no documentation yet Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // no documentation yet Summary *string `json:"summary,omitempty" xmlrpc:"summary,omitempty"` // no documentation yet Volumes []Container_Disk_Image_Capture_Template_Volume `json:"volumes,omitempty" xmlrpc:"volumes,omitempty"` }
no documentation yet
type Container_Disk_Image_Capture_Template_Volume ¶
type Container_Disk_Image_Capture_Template_Volume struct { Entity // A customer provided flag to indicate that the current volume is the boot drive BootVolumeFlag *bool `json:"bootVolumeFlag,omitempty" xmlrpc:"bootVolumeFlag,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // no documentation yet Partitions []Container_Disk_Image_Capture_Template_Volume_Partition `json:"partitions,omitempty" xmlrpc:"partitions,omitempty"` // The storage group to capture StorageGroupId *int `json:"storageGroupId,omitempty" xmlrpc:"storageGroupId,omitempty"` }
no documentation yet
type Container_Disk_Image_Capture_Template_Volume_Partition ¶
type Container_Disk_Image_Capture_Template_Volume_Partition struct { Entity // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
no documentation yet
type Container_Exception ¶
type Container_Exception struct { Entity // The SoftLayer_Exception class that the error is. ExceptionClass *string `json:"exceptionClass,omitempty" xmlrpc:"exceptionClass,omitempty"` // The exception message. ExceptionMessage *string `json:"exceptionMessage,omitempty" xmlrpc:"exceptionMessage,omitempty"` }
The SoftLayer_Container_Exception data type represents a SoftLayer_Exception.
type Container_Graph ¶
type Container_Graph struct { Entity // base units associated with the graph. BaseUnit *string `json:"baseUnit,omitempty" xmlrpc:"baseUnit,omitempty"` // Graph range end datetime. EndDatetime *string `json:"endDatetime,omitempty" xmlrpc:"endDatetime,omitempty"` // The height of the graph image. Height *int `json:"height,omitempty" xmlrpc:"height,omitempty"` // The graph image. Image *[]byte `json:"image,omitempty" xmlrpc:"image,omitempty"` // The graph interval in seconds. Interval *int `json:"interval,omitempty" xmlrpc:"interval,omitempty"` // Metric types associated with the graph. Metrics []Container_Metric_Data_Type `json:"metrics,omitempty" xmlrpc:"metrics,omitempty"` // Indicator to control whether the graph data is normalized. NormalizeFlag *[]byte `json:"normalizeFlag,omitempty" xmlrpc:"normalizeFlag,omitempty"` // The options used to control the graph appearance. Options []Container_Graph_Option `json:"options,omitempty" xmlrpc:"options,omitempty"` // A collection of graph plots. Plots []Container_Graph_Plot `json:"plots,omitempty" xmlrpc:"plots,omitempty"` // Graph range start datetime. StartDatetime *string `json:"startDatetime,omitempty" xmlrpc:"startDatetime,omitempty"` // The name of the template to use; may be null. Template *string `json:"template,omitempty" xmlrpc:"template,omitempty"` // The title of the graph image. Title *string `json:"title,omitempty" xmlrpc:"title,omitempty"` // The width of the graph image. Width *int `json:"width,omitempty" xmlrpc:"width,omitempty"` }
no documentation yet
type Container_Graph_Option ¶
type Container_Graph_Option struct { Entity // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // no documentation yet Value *string `json:"value,omitempty" xmlrpc:"value,omitempty"` }
no documentation yet
type Container_Graph_Plot ¶
type Container_Graph_Plot struct { Entity // no documentation yet Data []Container_Graph_Plot_Coordinate `json:"data,omitempty" xmlrpc:"data,omitempty"` // no documentation yet Metric *Container_Metric_Data_Type `json:"metric,omitempty" xmlrpc:"metric,omitempty"` // no documentation yet Unit *string `json:"unit,omitempty" xmlrpc:"unit,omitempty"` }
no documentation yet
type Container_Graph_Plot_Coordinate ¶
type Container_Graph_Plot_Coordinate struct { Entity // no documentation yet XValue *Float64 `json:"xValue,omitempty" xmlrpc:"xValue,omitempty"` // no documentation yet YValue *Float64 `json:"yValue,omitempty" xmlrpc:"yValue,omitempty"` // no documentation yet ZValue *Float64 `json:"zValue,omitempty" xmlrpc:"zValue,omitempty"` }
no documentation yet
type Container_Hardware_CaptureEnabled ¶ added in v1.0.2
type Container_Hardware_CaptureEnabled struct { Entity // no documentation yet Enabled *bool `json:"enabled,omitempty" xmlrpc:"enabled,omitempty"` // no documentation yet Reasons []string `json:"reasons,omitempty" xmlrpc:"reasons,omitempty"` }
no documentation yet
type Container_Hardware_Configuration ¶
type Container_Hardware_Configuration struct { Entity // // <div style="width: 200%"> // Available datacenter options. // // // The <code>datacenter.name</code> value in the template represents which datacenter the server will be provisioned in. // </div> Datacenters []Container_Hardware_Configuration_Option `json:"datacenters,omitempty" xmlrpc:"datacenters,omitempty"` // // <div style="width: 200%"> // Available fixed configuration preset options. // // // The <code>fixedConfigurationPreset.keyName</code> value in the template is an identifier for a particular fixed configuration. When provided exactly as shown in the template, that fixed configuration will be used. // // // When providing a <code>fixedConfigurationPreset.keyName</code> while ordering a server the <code>processors</code> and <code>hardDrives</code> configuration options cannot be used. // </div> FixedConfigurationPresets []Container_Hardware_Configuration_Option `json:"fixedConfigurationPresets,omitempty" xmlrpc:"fixedConfigurationPresets,omitempty"` // // <div style="width: 200%"> // Available hard drive options. // // // A server will have at least one hard drive. // // // The <code>hardDrives.capacity</code> value in the template represents the size, in gigabytes, of the disk. // </div> HardDrives []Container_Hardware_Configuration_Option `json:"hardDrives,omitempty" xmlrpc:"hardDrives,omitempty"` // // <div style="width: 200%"> // Available network component options. // // // The <code>networkComponent.maxSpeed</code> value in the template represents the link speed, in megabits per second, of the network connections for a server. // </div> NetworkComponents []Container_Hardware_Configuration_Option `json:"networkComponents,omitempty" xmlrpc:"networkComponents,omitempty"` // // <div style="width: 200%"> // Available operating system options. // // // The <code>operatingSystemReferenceCode</code> value in the template is an identifier for a particular operating system. When provided exactly as shown in the template, that operating system will be used. // // // 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 OS is 32 or 64bit. // // // When providing an <code>operatingSystemReferenceCode</code> while ordering a server the only token required to match exactly is the product. The version token may be given as 'LATEST', else it will require an exact match as well. When the bits token is not provided, 64 bits will be assumed. // // // Providing the value of 'LATEST' for a version will select the latest release of that product for the operating system. As this may change over time, you should be sure that the release version is irrelevant for your applications. // // // 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. // </div> OperatingSystems []Container_Hardware_Configuration_Option `json:"operatingSystems,omitempty" xmlrpc:"operatingSystems,omitempty"` // // <div style="width: 200%"> // Available processor options. // // // The <code>processorCoreAmount</code> value in the template represents the number of cores allocated to the server. // The <code>memoryCapacity</code> value in the template represents the amount of memory, in gigabytes, allocated to the server. // </div> Processors []Container_Hardware_Configuration_Option `json:"processors,omitempty" xmlrpc:"processors,omitempty"` }
The hardware configuration container is used to provide configuration options for servers.
Each configuration option will include both an <code>itemPrice</code> and a <code>template</code>.
The <code>itemPrice</code> value will provide hourly and monthly costs (if either are applicable), and a description of the option.
The <code>template</code> will provide a fragment of the request with the properties and values that must be sent when creating a server with the option.
The [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] method returns this data structure.
<style type="text/css">#properties .views-field-body p { margin-top: 1.5em; };</style>
type Container_Hardware_Configuration_Option ¶
type Container_Hardware_Configuration_Option struct { Entity // // Provides hourly and monthly costs (if either are applicable), and a description of the option. ItemPrice *Product_Item_Price `json:"itemPrice,omitempty" xmlrpc:"itemPrice,omitempty"` // // Provides a description of a fixed configuration preset with monthly and hourly costs. Preset *Product_Package_Preset `json:"preset,omitempty" xmlrpc:"preset,omitempty"` // // Provides a fragment of the request with the properties and values that must be sent when creating a server with the option. Template *Hardware `json:"template,omitempty" xmlrpc:"template,omitempty"` }
An option found within a [[SoftLayer_Container_Hardware_Configuration (type)]] structure.
type Container_Hardware_DiskImageMap ¶ added in v1.0.3
type Container_Hardware_DiskImageMap struct { Entity // no documentation yet BootFlag *int `json:"bootFlag,omitempty" xmlrpc:"bootFlag,omitempty"` // no documentation yet DiskImageUUID *string `json:"diskImageUUID,omitempty" xmlrpc:"diskImageUUID,omitempty"` // no documentation yet DiskSerialNumber *string `json:"diskSerialNumber,omitempty" xmlrpc:"diskSerialNumber,omitempty"` }
no documentation yet
type Container_Hardware_MassUpdate ¶
type Container_Hardware_MassUpdate struct { Entity // The hardwares updated by the mass update tool HardwareId *int `json:"hardwareId,omitempty" xmlrpc:"hardwareId,omitempty"` // Errors encountered while mass updating hardwares Message *string `json:"message,omitempty" xmlrpc:"message,omitempty"` // The hardwares that failed to update SuccessFlag *string `json:"successFlag,omitempty" xmlrpc:"successFlag,omitempty"` }
no documentation yet
type Container_Hardware_Pool_Details ¶
type Container_Hardware_Pool_Details struct { Entity // no documentation yet PendingOrders *int `json:"pendingOrders,omitempty" xmlrpc:"pendingOrders,omitempty"` // no documentation yet PendingTransactions *int `json:"pendingTransactions,omitempty" xmlrpc:"pendingTransactions,omitempty"` // no documentation yet PoolDescription *string `json:"poolDescription,omitempty" xmlrpc:"poolDescription,omitempty"` // no documentation yet PoolKeyName *string `json:"poolKeyName,omitempty" xmlrpc:"poolKeyName,omitempty"` // no documentation yet PoolName *string `json:"poolName,omitempty" xmlrpc:"poolName,omitempty"` // no documentation yet Routers []Container_Hardware_Pool_Details_Router `json:"routers,omitempty" xmlrpc:"routers,omitempty"` // no documentation yet TotalHardware *int `json:"totalHardware,omitempty" xmlrpc:"totalHardware,omitempty"` // no documentation yet TotalInventoryHardware *int `json:"totalInventoryHardware,omitempty" xmlrpc:"totalInventoryHardware,omitempty"` // no documentation yet TotalProvisionedHardware *int `json:"totalProvisionedHardware,omitempty" xmlrpc:"totalProvisionedHardware,omitempty"` // no documentation yet TotalTestedHardware *int `json:"totalTestedHardware,omitempty" xmlrpc:"totalTestedHardware,omitempty"` // no documentation yet TotalTestingHardware *int `json:"totalTestingHardware,omitempty" xmlrpc:"totalTestingHardware,omitempty"` }
no documentation yet
type Container_Hardware_Pool_Details_Router ¶
type Container_Hardware_Pool_Details_Router struct { Entity // no documentation yet PoolThreshold *int `json:"poolThreshold,omitempty" xmlrpc:"poolThreshold,omitempty"` // no documentation yet RouterId *int `json:"routerId,omitempty" xmlrpc:"routerId,omitempty"` // no documentation yet RouterName *string `json:"routerName,omitempty" xmlrpc:"routerName,omitempty"` // no documentation yet TotalHardware *int `json:"totalHardware,omitempty" xmlrpc:"totalHardware,omitempty"` // no documentation yet TotalInventoryHardware *int `json:"totalInventoryHardware,omitempty" xmlrpc:"totalInventoryHardware,omitempty"` // no documentation yet TotalProvisionedHardware *int `json:"totalProvisionedHardware,omitempty" xmlrpc:"totalProvisionedHardware,omitempty"` // no documentation yet TotalTestedHardware *int `json:"totalTestedHardware,omitempty" xmlrpc:"totalTestedHardware,omitempty"` // no documentation yet TotalTestingHardware *int `json:"totalTestingHardware,omitempty" xmlrpc:"totalTestingHardware,omitempty"` }
no documentation yet
type Container_Hardware_Server_Configuration ¶
type Container_Hardware_Server_Configuration struct { Entity // A flag indicating that the server will be moved into the spare pool after an Operating system reload. AddToSparePoolAfterOsReload *int `json:"addToSparePoolAfterOsReload,omitempty" xmlrpc:"addToSparePoolAfterOsReload,omitempty"` // The customer provision uri will be used to download and execute a customer defined script on the host at the end of provisioning. CustomProvisionScriptUri *string `json:"customProvisionScriptUri,omitempty" xmlrpc:"customProvisionScriptUri,omitempty"` // A flag indicating that the primary drive will be converted to a portable storage volume during an Operating System reload. DriveRetentionFlag *bool `json:"driveRetentionFlag,omitempty" xmlrpc:"driveRetentionFlag,omitempty"` // A flag indicating that all data will be erased from drives during an Operating System reload. EraseHardDrives *int `json:"eraseHardDrives,omitempty" xmlrpc:"eraseHardDrives,omitempty"` // The hard drive partitions that a server can be partitioned with. HardDrives []Hardware_Component `json:"hardDrives,omitempty" xmlrpc:"hardDrives,omitempty"` // 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. ImageTemplateId *int `json:"imageTemplateId,omitempty" xmlrpc:"imageTemplateId,omitempty"` // Whether the OS reload will be in-place for accounts that support it. InPlaceFlag *bool `json:"inPlaceFlag,omitempty" xmlrpc:"inPlaceFlag,omitempty"` // The item prices that a server can be configured with. ItemPrices []Product_Item_Price `json:"itemPrices,omitempty" xmlrpc:"itemPrices,omitempty"` // A flag indicating that the provision should use LVM for all logical drives. LvmFlag *int `json:"lvmFlag,omitempty" xmlrpc:"lvmFlag,omitempty"` // A flag indicating that the remote management cards password will be reset. ResetIpmiPassword *int `json:"resetIpmiPassword,omitempty" xmlrpc:"resetIpmiPassword,omitempty"` // The token of the requesting service. Do not set. ServiceToken *string `json:"serviceToken,omitempty" xmlrpc:"serviceToken,omitempty"` // 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. SshKeyIds []int `json:"sshKeyIds,omitempty" xmlrpc:"sshKeyIds,omitempty"` // A flag indicating that the BIOS will be updated when installing the operating system. UpgradeBios *int `json:"upgradeBios,omitempty" xmlrpc:"upgradeBios,omitempty"` // A flag indicating that the firmware on all hard drives will be updated when installing the operating system. UpgradeHardDriveFirmware *int `json:"upgradeHardDriveFirmware,omitempty" xmlrpc:"upgradeHardDriveFirmware,omitempty"` }
The SoftLayer_Container_Hardware_Server_Configuration data type contains information relating to a server's item price information, and hard drive partition information.
type Container_Hardware_Server_Details ¶
type Container_Hardware_Server_Details struct { Entity // The components that belong to a piece of hardware. Components []Hardware_Component `json:"components,omitempty" xmlrpc:"components,omitempty"` // The network components that belong to a piece of hardware. NetworkComponents []Network_Component `json:"networkComponents,omitempty" xmlrpc:"networkComponents,omitempty"` // The software that belong to a piece of hardware. Software []Software_Component `json:"software,omitempty" xmlrpc:"software,omitempty"` }
The SoftLayer_Container_Hardware_Server_Details data type contains information relating to a server's component information, network information, and software information.
type Container_Hardware_Server_Request ¶
type Container_Hardware_Server_Request struct { Entity // no documentation yet HardwareId *int `json:"hardwareId,omitempty" xmlrpc:"hardwareId,omitempty"` // no documentation yet Message *string `json:"message,omitempty" xmlrpc:"message,omitempty"` // no documentation yet SuccessFlag *bool `json:"successFlag,omitempty" xmlrpc:"successFlag,omitempty"` }
no documentation yet
type Container_Image_StorageGroupDetails ¶ added in v1.0.2
type Container_Image_StorageGroupDetails struct { Entity // no documentation yet Drives []Container_Image_StorageGroupDetails_Drives `json:"drives,omitempty" xmlrpc:"drives,omitempty"` // no documentation yet StorageGroupName *string `json:"storageGroupName,omitempty" xmlrpc:"storageGroupName,omitempty"` // no documentation yet StorageGroupType *string `json:"storageGroupType,omitempty" xmlrpc:"storageGroupType,omitempty"` }
no documentation yet
type Container_Image_StorageGroupDetails_Drives ¶ added in v1.0.2
type Container_Image_StorageGroupDetails_Drives struct { Entity // no documentation yet Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // no documentation yet DiskSpace *string `json:"diskSpace,omitempty" xmlrpc:"diskSpace,omitempty"` // no documentation yet Units *string `json:"units,omitempty" xmlrpc:"units,omitempty"` }
no documentation yet
type Container_KnowledgeLayer_QuestionAnswer ¶
type Container_KnowledgeLayer_QuestionAnswer struct { Entity // The answer to a question asked on the SoftLayer KnowledgeLayer. Answer *string `json:"answer,omitempty" xmlrpc:"answer,omitempty"` // The link to a question asked on the SoftLayer KnowledgeLayer. Link *string `json:"link,omitempty" xmlrpc:"link,omitempty"` // A question asked on the SoftLayer KnowledgeLayer. Question *string `json:"question,omitempty" xmlrpc:"question,omitempty"` }
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.
type Container_Message ¶
type Container_Message struct { Entity // no documentation yet Message *string `json:"message,omitempty" xmlrpc:"message,omitempty"` // no documentation yet Type *string `json:"type,omitempty" xmlrpc:"type,omitempty"` }
no documentation yet
type Container_Metric_Data_Type ¶
type Container_Metric_Data_Type struct { Entity // no documentation yet KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // no documentation yet SummaryType *string `json:"summaryType,omitempty" xmlrpc:"summaryType,omitempty"` // no documentation yet Unit *string `json:"unit,omitempty" xmlrpc:"unit,omitempty"` }
no documentation yet
type Container_Metric_Tracking_Object_Details ¶
type Container_Metric_Tracking_Object_Details struct { Entity // The name that best describes the metric being collected. MetricName *string `json:"metricName,omitempty" xmlrpc:"metricName,omitempty"` }
SoftLayer_Container_Metric_Tracking_Object_Details This container is a parent class for detailing diverse metrics.
type Container_Metric_Tracking_Object_Summary ¶
type Container_Metric_Tracking_Object_Summary struct { Entity // The name that best describes the metric being collected. MetricName *string `json:"metricName,omitempty" xmlrpc:"metricName,omitempty"` }
SoftLayer_Container_Metric_Tracking_Object_Summary This container is a parent class for summarizing diverse metrics.
type Container_Metric_Tracking_Object_Virtual_Host_Details ¶
type Container_Metric_Tracking_Object_Virtual_Host_Details struct { Container_Metric_Tracking_Object_Details // The day this metric was collected. Day *Time `json:"day,omitempty" xmlrpc:"day,omitempty"` // The maximum number of guests hosted by this platform for the given day. MaxInstances *int `json:"maxInstances,omitempty" xmlrpc:"maxInstances,omitempty"` // The maximum amount of memory utilized by this platform for the given day. MaxMemoryUsage *int `json:"maxMemoryUsage,omitempty" xmlrpc:"maxMemoryUsage,omitempty"` // The mean number of guests hosted by this platform for the given day. MeanInstances *Float64 `json:"meanInstances,omitempty" xmlrpc:"meanInstances,omitempty"` // The mean amount of memory utilized by this platform for the given day. MeanMemoryUsage *Float64 `json:"meanMemoryUsage,omitempty" xmlrpc:"meanMemoryUsage,omitempty"` // The minimum number of guests hosted by this platform for the given day. MinInstances *int `json:"minInstances,omitempty" xmlrpc:"minInstances,omitempty"` // The minimum amount of memory utilized by this platform for the given day. MinMemoryUsage *int `json:"minMemoryUsage,omitempty" xmlrpc:"minMemoryUsage,omitempty"` }
SoftLayer_Container_Metric_Tracking_Object_Virtual_Host_Details This container details a virtual host's metric data.
type Container_Metric_Tracking_Object_Virtual_Host_Summary ¶
type Container_Metric_Tracking_Object_Virtual_Host_Summary struct { Container_Metric_Tracking_Object_Summary // The average amount of memory usage thus far in this billing cycle. AvgMemoryUsageInBillingCycle *int `json:"avgMemoryUsageInBillingCycle,omitempty" xmlrpc:"avgMemoryUsageInBillingCycle,omitempty"` // Current bill cycle end date. CurrentBillCycleEnd *Time `json:"currentBillCycleEnd,omitempty" xmlrpc:"currentBillCycleEnd,omitempty"` // Current bill cycle start date. CurrentBillCycleStart *Time `json:"currentBillCycleStart,omitempty" xmlrpc:"currentBillCycleStart,omitempty"` // The last count of instances this platform was hosting. LastInstanceCount *int `json:"lastInstanceCount,omitempty" xmlrpc:"lastInstanceCount,omitempty"` // The last amount of memory this platform was using. LastMemoryUsageAmount *int `json:"lastMemoryUsageAmount,omitempty" xmlrpc:"lastMemoryUsageAmount,omitempty"` // The last time this virtual host was polled for metrics. LastPollTime *Time `json:"lastPollTime,omitempty" xmlrpc:"lastPollTime,omitempty"` // The max number of instances hosted thus far in this billing cycle. MaxInstanceInBillingCycle *int `json:"maxInstanceInBillingCycle,omitempty" xmlrpc:"maxInstanceInBillingCycle,omitempty"` // Previous bill cycle end date. PreviousBillCycleEnd *Time `json:"previousBillCycleEnd,omitempty" xmlrpc:"previousBillCycleEnd,omitempty"` // Previous bill cycle start date. PreviousBillCycleStart *Time `json:"previousBillCycleStart,omitempty" xmlrpc:"previousBillCycleStart,omitempty"` // This virtual hosting platform name. VirtualPlatformName *string `json:"virtualPlatformName,omitempty" xmlrpc:"virtualPlatformName,omitempty"` }
SoftLayer_Container_Metric_Tracking_Object_Virtual_Host_Summary This container summarizes a virtual host's metric data.
type Container_Monitoring_Alarm_History ¶
type Container_Monitoring_Alarm_History struct { Entity // Account ID that this alarm belongs to AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // DEPRECATED. ID of the monitoring agent that triggered this alarm // Deprecated: This function has been marked as deprecated. AgentId *int `json:"agentId,omitempty" xmlrpc:"agentId,omitempty"` // Alarm ID AlarmId *string `json:"alarmId,omitempty" xmlrpc:"alarmId,omitempty"` // Time that an alarm was closed. ClosedDate *Time `json:"closedDate,omitempty" xmlrpc:"closedDate,omitempty"` // Time that an alarm was triggered CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // Alarm message Message *string `json:"message,omitempty" xmlrpc:"message,omitempty"` // DEPRECATED. Robot ID // Deprecated: This function has been marked as deprecated. RobotId *int `json:"robotId,omitempty" xmlrpc:"robotId,omitempty"` // Severity of an alarm Severity *string `json:"severity,omitempty" xmlrpc:"severity,omitempty"` }
The SoftLayer_Container_Monitoring_Alarm_History data type contains information relating to SoftLayer monitoring alarm history.
type Container_Network_Authentication_Data ¶
type Container_Network_Authentication_Data struct { Entity // The name of a host Host *string `json:"host,omitempty" xmlrpc:"host,omitempty"` // The authentication password Password *string `json:"password,omitempty" xmlrpc:"password,omitempty"` // The port number Port *int `json:"port,omitempty" xmlrpc:"port,omitempty"` // The type of network protocol. This can be ftp, ssh and so on. Type *string `json:"type,omitempty" xmlrpc:"type,omitempty"` // The authentication username Username *string `json:"username,omitempty" xmlrpc:"username,omitempty"` }
This object holds authentication data to a server.
type Container_Network_Bandwidth_Data_Summary ¶
type Container_Network_Bandwidth_Data_Summary struct { Entity // The amount of bandwidth a server has allocated to it in it's current billing period. AllowedUsage *Float64 `json:"allowedUsage,omitempty" xmlrpc:"allowedUsage,omitempty"` // The amount of bandwidth that a server has used within it's current billing period. EstimatedUsage *Float64 `json:"estimatedUsage,omitempty" xmlrpc:"estimatedUsage,omitempty"` // The amount of bandwidth a server is projected to use within its billing period, based on it's current usage. ProjectedUsage *Float64 `json:"projectedUsage,omitempty" xmlrpc:"projectedUsage,omitempty"` // The unit of measurement used in a bandwidth data summary. UsageUnits *string `json:"usageUnits,omitempty" xmlrpc:"usageUnits,omitempty"` }
SoftLayer_Container_Network_Bandwidth_Data_Summary models an interface's overall bandwidth usage during it's current billing cycle.
type Container_Network_Bandwidth_Version1_Usage ¶
type Container_Network_Bandwidth_Version1_Usage struct { Entity // The amount of incoming bandwidth that a server has used within the hour of the recordedDate. IncomingAmount *Float64 `json:"incomingAmount,omitempty" xmlrpc:"incomingAmount,omitempty"` // The amount of outgoing bandwidth that a server has used within the hour of the recordedDate. OutgoingAmount *Float64 `json:"outgoingAmount,omitempty" xmlrpc:"outgoingAmount,omitempty"` // The date and time that the bandwidth was used by a piece of hardware RecordedDate *Time `json:"recordedDate,omitempty" xmlrpc:"recordedDate,omitempty"` }
SoftLayer_Container_Network_Bandwidth_Version1_Usage models an hourly bandwidth record.
type Container_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader ¶ added in v1.0.2
type Container_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader struct { Entity // Specifies the delimiter to be used when indicating multiple values for a header. Valid delimiter is, a <space>, , (comma), ; (semicolon), ,<space> (comma and space), or ;<space> (semicolon and space). Delimiter *string `json:"delimiter,omitempty" xmlrpc:"delimiter,omitempty"` // The description of modify response header. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // 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'] Headers []string `json:"headers,omitempty" xmlrpc:"headers,omitempty"` // The uniqueId of the modify response header to which the existing behavior belongs. ModResHeaderUniqueId *string `json:"modResHeaderUniqueId,omitempty" xmlrpc:"modResHeaderUniqueId,omitempty"` // The path, relative to the domain that is accessed via modify response header. Path *string `json:"path,omitempty" xmlrpc:"path,omitempty"` // 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 `json:"type,omitempty" xmlrpc:"type,omitempty"` // The uniqueId of the mapping to which the existing behavior belongs. UniqueId *string `json:"uniqueId,omitempty" xmlrpc:"uniqueId,omitempty"` }
The SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader data type contains information for specific responses from the modify response header API.
type Container_Network_CdnMarketplace_Configuration_Behavior_TokenAuth ¶ added in v1.0.2
type Container_Network_CdnMarketplace_Configuration_Behavior_TokenAuth struct { Entity // Specifies a single character to separate access control list (ACL) fields. The default value is '!'. AclDelimiter *string `json:"aclDelimiter,omitempty" xmlrpc:"aclDelimiter,omitempty"` // Possible values '0' and '1'. If set to '1', input values are escaped before adding them to the token. Default value is '1'. EscapeTokenInputs *string `json:"escapeTokenInputs,omitempty" xmlrpc:"escapeTokenInputs,omitempty"` // 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'. HmacAlgorithm *string `json:"hmacAlgorithm,omitempty" xmlrpc:"hmacAlgorithm,omitempty"` // 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'. IgnoreQueryString *string `json:"ignoreQueryString,omitempty" xmlrpc:"ignoreQueryString,omitempty"` // The token name. If this value is empty, then it is set to the default value '__token__'. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // The path, relative to the domain that is accessed via token authentication. Path *string `json:"path,omitempty" xmlrpc:"path,omitempty"` // Specifies a single character to separate the individual token fields. The default value is '~'. TokenDelimiter *string `json:"tokenDelimiter,omitempty" xmlrpc:"tokenDelimiter,omitempty"` // 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. TokenKey *string `json:"tokenKey,omitempty" xmlrpc:"tokenKey,omitempty"` // 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. TransitionKey *string `json:"transitionKey,omitempty" xmlrpc:"transitionKey,omitempty"` // The uniqueId of the mapping to which the existing behavior belongs. UniqueId *string `json:"uniqueId,omitempty" xmlrpc:"uniqueId,omitempty"` }
The SoftLayer_Container_Network_CdnMarketplace_Configuration_Behavior_TokenAuth data type contains information for specific responses from the Token Authentication API.
type Container_Network_CdnMarketplace_Configuration_Cache_Purge ¶
type Container_Network_CdnMarketplace_Configuration_Cache_Purge struct { Entity // no documentation yet Date *string `json:"date,omitempty" xmlrpc:"date,omitempty"` // no documentation yet Path *string `json:"path,omitempty" xmlrpc:"path,omitempty"` // no documentation yet Saved *string `json:"saved,omitempty" xmlrpc:"saved,omitempty"` // no documentation yet Status *string `json:"status,omitempty" xmlrpc:"status,omitempty"` }
no documentation yet
type Container_Network_CdnMarketplace_Configuration_Cache_PurgeGroup ¶ added in v1.0.1
type Container_Network_CdnMarketplace_Configuration_Cache_PurgeGroup struct { Entity // Date in which record is created CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // A identifier that is unique to purge group. GroupUniqueId *string `json:"groupUniqueId,omitempty" xmlrpc:"groupUniqueId,omitempty"` // The Unix timestamp of the last purge. LastPurgeDate *Time `json:"lastPurgeDate,omitempty" xmlrpc:"lastPurgeDate,omitempty"` // Purge Group name. The favorite group name must be unique, but non-favorite groups do not have this limitation Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // 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. Option *int `json:"option,omitempty" xmlrpc:"option,omitempty"` // Total number of purge paths. PathCount *int `json:"pathCount,omitempty" xmlrpc:"pathCount,omitempty"` // A collection of purge paths. Paths []string `json:"paths,omitempty" xmlrpc:"paths,omitempty"` // The purge's status when the input option field is 1 or 3. Status can be SUCCESS, FAILED, or IN_PROGRESS. PurgeStatus *string `json:"purgeStatus,omitempty" xmlrpc:"purgeStatus,omitempty"` // Type of the Purge Group, currently SAVED or UNSAVED. Saved *string `json:"saved,omitempty" xmlrpc:"saved,omitempty"` // A identifier that is unique to domain mapping. UniqueId *string `json:"uniqueId,omitempty" xmlrpc:"uniqueId,omitempty"` }
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
type Container_Network_CdnMarketplace_Configuration_Cache_PurgeGroupHistory ¶ added in v1.0.1
type Container_Network_CdnMarketplace_Configuration_Cache_PurgeGroupHistory struct { Entity // Date in which record is created CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // Purge Group name. The favorite group name must be unique, but un-favorite groups do not have this limitation GroupName *string `json:"groupName,omitempty" xmlrpc:"groupName,omitempty"` // Purge group unique ID GroupUniqueId *string `json:"groupUniqueId,omitempty" xmlrpc:"groupUniqueId,omitempty"` // The purge's status. Status can be SUCCESS, FAILED, or IN_PROGRESS. Status *string `json:"status,omitempty" xmlrpc:"status,omitempty"` // Domain mapping unique ID. UniqueId *string `json:"uniqueId,omitempty" xmlrpc:"uniqueId,omitempty"` }
The SoftLayer_Container_Network_CdnMarketplace_Configuration_Cache_PurgeGroupHistory data type contains information for specific responses from the Purge Group API and Purge History API.
type Container_Network_CdnMarketplace_Configuration_Input ¶
type Container_Network_CdnMarketplace_Configuration_Input struct { Entity // no documentation yet BucketName *string `json:"bucketName,omitempty" xmlrpc:"bucketName,omitempty"` // no documentation yet CacheKeyQueryRule *string `json:"cacheKeyQueryRule,omitempty" xmlrpc:"cacheKeyQueryRule,omitempty"` // no documentation yet CertificateType *string `json:"certificateType,omitempty" xmlrpc:"certificateType,omitempty"` // no documentation yet Cname *string `json:"cname,omitempty" xmlrpc:"cname,omitempty"` // no documentation yet Domain *string `json:"domain,omitempty" xmlrpc:"domain,omitempty"` // no documentation yet DynamicContentAcceleration *Container_Network_CdnMarketplace_Configuration_Performance_DynamicContentAcceleration `json:"dynamicContentAcceleration,omitempty" xmlrpc:"dynamicContentAcceleration,omitempty"` // no documentation yet FileExtension *string `json:"fileExtension,omitempty" xmlrpc:"fileExtension,omitempty"` // no documentation yet GeoblockingRule *Network_CdnMarketplace_Configuration_Behavior_Geoblocking `json:"geoblockingRule,omitempty" xmlrpc:"geoblockingRule,omitempty"` // no documentation yet Header *string `json:"header,omitempty" xmlrpc:"header,omitempty"` // no documentation yet HotlinkProtection *Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection `json:"hotlinkProtection,omitempty" xmlrpc:"hotlinkProtection,omitempty"` // no documentation yet HttpPort *int `json:"httpPort,omitempty" xmlrpc:"httpPort,omitempty"` // no documentation yet HttpsPort *int `json:"httpsPort,omitempty" xmlrpc:"httpsPort,omitempty"` // 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. OldPath *string `json:"oldPath,omitempty" xmlrpc:"oldPath,omitempty"` // no documentation yet Origin *string `json:"origin,omitempty" xmlrpc:"origin,omitempty"` // no documentation yet OriginType *string `json:"originType,omitempty" xmlrpc:"originType,omitempty"` // no documentation yet Path *string `json:"path,omitempty" xmlrpc:"path,omitempty"` // no documentation yet PerformanceConfiguration *string `json:"performanceConfiguration,omitempty" xmlrpc:"performanceConfiguration,omitempty"` // no documentation yet Protocol *string `json:"protocol,omitempty" xmlrpc:"protocol,omitempty"` // no documentation yet RespectHeaders *string `json:"respectHeaders,omitempty" xmlrpc:"respectHeaders,omitempty"` // no documentation yet ServeStale *string `json:"serveStale,omitempty" xmlrpc:"serveStale,omitempty"` // no documentation yet Status *string `json:"status,omitempty" xmlrpc:"status,omitempty"` // no documentation yet UniqueId *string `json:"uniqueId,omitempty" xmlrpc:"uniqueId,omitempty"` // no documentation yet VendorName *string `json:"vendorName,omitempty" xmlrpc:"vendorName,omitempty"` }
no documentation yet
type Container_Network_CdnMarketplace_Configuration_Mapping ¶
type Container_Network_CdnMarketplace_Configuration_Mapping struct { Entity // no documentation yet AkamaiCname *string `json:"akamaiCname,omitempty" xmlrpc:"akamaiCname,omitempty"` // no documentation yet BucketName *string `json:"bucketName,omitempty" xmlrpc:"bucketName,omitempty"` // no documentation yet CacheKeyQueryRule *string `json:"cacheKeyQueryRule,omitempty" xmlrpc:"cacheKeyQueryRule,omitempty"` // no documentation yet CertificateType *string `json:"certificateType,omitempty" xmlrpc:"certificateType,omitempty"` // no documentation yet Cname *string `json:"cname,omitempty" xmlrpc:"cname,omitempty"` // no documentation yet CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // no documentation yet Domain *string `json:"domain,omitempty" xmlrpc:"domain,omitempty"` // no documentation yet DynamicContentAcceleration *Container_Network_CdnMarketplace_Configuration_Performance_DynamicContentAcceleration `json:"dynamicContentAcceleration,omitempty" xmlrpc:"dynamicContentAcceleration,omitempty"` // no documentation yet FileExtension *string `json:"fileExtension,omitempty" xmlrpc:"fileExtension,omitempty"` // no documentation yet Header *string `json:"header,omitempty" xmlrpc:"header,omitempty"` // no documentation yet HttpPort *int `json:"httpPort,omitempty" xmlrpc:"httpPort,omitempty"` // no documentation yet HttpsChallengeRedirectUrl *string `json:"httpsChallengeRedirectUrl,omitempty" xmlrpc:"httpsChallengeRedirectUrl,omitempty"` // no documentation yet HttpsChallengeResponse *string `json:"httpsChallengeResponse,omitempty" xmlrpc:"httpsChallengeResponse,omitempty"` // no documentation yet HttpsChallengeUrl *string `json:"httpsChallengeUrl,omitempty" xmlrpc:"httpsChallengeUrl,omitempty"` // no documentation yet HttpsPort *int `json:"httpsPort,omitempty" xmlrpc:"httpsPort,omitempty"` // no documentation yet ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // no documentation yet OriginHost *string `json:"originHost,omitempty" xmlrpc:"originHost,omitempty"` // no documentation yet OriginType *string `json:"originType,omitempty" xmlrpc:"originType,omitempty"` // no documentation yet Path *string `json:"path,omitempty" xmlrpc:"path,omitempty"` // no documentation yet PerformanceConfiguration *string `json:"performanceConfiguration,omitempty" xmlrpc:"performanceConfiguration,omitempty"` // no documentation yet Protocol *string `json:"protocol,omitempty" xmlrpc:"protocol,omitempty"` // no documentation yet RespectHeaders *bool `json:"respectHeaders,omitempty" xmlrpc:"respectHeaders,omitempty"` // no documentation yet ServeStale *bool `json:"serveStale,omitempty" xmlrpc:"serveStale,omitempty"` // no documentation yet Status *string `json:"status,omitempty" xmlrpc:"status,omitempty"` // no documentation yet UniqueId *string `json:"uniqueId,omitempty" xmlrpc:"uniqueId,omitempty"` // no documentation yet VendorName *string `json:"vendorName,omitempty" xmlrpc:"vendorName,omitempty"` }
no documentation yet
type Container_Network_CdnMarketplace_Configuration_Mapping_Path ¶
type Container_Network_CdnMarketplace_Configuration_Mapping_Path struct { Entity // no documentation yet BucketName *string `json:"bucketName,omitempty" xmlrpc:"bucketName,omitempty"` // no documentation yet CacheKeyQueryRule *string `json:"cacheKeyQueryRule,omitempty" xmlrpc:"cacheKeyQueryRule,omitempty"` // no documentation yet DynamicContentAcceleration *Container_Network_CdnMarketplace_Configuration_Performance_DynamicContentAcceleration `json:"dynamicContentAcceleration,omitempty" xmlrpc:"dynamicContentAcceleration,omitempty"` // no documentation yet FileExtension *string `json:"fileExtension,omitempty" xmlrpc:"fileExtension,omitempty"` // no documentation yet Header *string `json:"header,omitempty" xmlrpc:"header,omitempty"` // no documentation yet HttpPort *int `json:"httpPort,omitempty" xmlrpc:"httpPort,omitempty"` // no documentation yet HttpsPort *int `json:"httpsPort,omitempty" xmlrpc:"httpsPort,omitempty"` // no documentation yet MappingUniqueId *string `json:"mappingUniqueId,omitempty" xmlrpc:"mappingUniqueId,omitempty"` // no documentation yet Origin *string `json:"origin,omitempty" xmlrpc:"origin,omitempty"` // no documentation yet OriginType *string `json:"originType,omitempty" xmlrpc:"originType,omitempty"` // no documentation yet Path *string `json:"path,omitempty" xmlrpc:"path,omitempty"` // no documentation yet PerformanceConfiguration *string `json:"performanceConfiguration,omitempty" xmlrpc:"performanceConfiguration,omitempty"` // no documentation yet Status *string `json:"status,omitempty" xmlrpc:"status,omitempty"` }
no documentation yet
type Container_Network_CdnMarketplace_Configuration_Performance_DynamicContentAcceleration ¶
type Container_Network_CdnMarketplace_Configuration_Performance_DynamicContentAcceleration struct { Entity // 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. DetectionPath *string `json:"detectionPath,omitempty" xmlrpc:"detectionPath,omitempty"` // 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. MobileImageCompressionEnabled *bool `json:"mobileImageCompressionEnabled,omitempty" xmlrpc:"mobileImageCompressionEnabled,omitempty"` // Inspects HTML responses and prefetches embedded objects in HTML files. Prefetching works on any page that includes <img>, <script>, or <link> tags that specify relative paths. It also works when the resource hostname matches the request domain in the HTML file, and it is part of a fully qualified URI. When set to true, edge servers prefetch objects with the following file extensions: // // 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. PrefetchEnabled *bool `json:"prefetchEnabled,omitempty" xmlrpc:"prefetchEnabled,omitempty"` }
no documentation yet
type Container_Network_CdnMarketplace_Metrics ¶
type Container_Network_CdnMarketplace_Metrics struct { Entity // no documentation yet Descriptions []string `json:"descriptions,omitempty" xmlrpc:"descriptions,omitempty"` // no documentation yet Names []string `json:"names,omitempty" xmlrpc:"names,omitempty"` // no documentation yet Percentage []string `json:"percentage,omitempty" xmlrpc:"percentage,omitempty"` // no documentation yet Time []int `json:"time,omitempty" xmlrpc:"time,omitempty"` // no documentation yet Totals []string `json:"totals,omitempty" xmlrpc:"totals,omitempty"` // no documentation yet Type *string `json:"type,omitempty" xmlrpc:"type,omitempty"` // no documentation yet Xaxis []string `json:"xaxis,omitempty" xmlrpc:"xaxis,omitempty"` // no documentation yet Yaxis1 []string `json:"yaxis1,omitempty" xmlrpc:"yaxis1,omitempty"` // no documentation yet Yaxis10 []string `json:"yaxis10,omitempty" xmlrpc:"yaxis10,omitempty"` // no documentation yet Yaxis11 []string `json:"yaxis11,omitempty" xmlrpc:"yaxis11,omitempty"` // no documentation yet Yaxis12 []string `json:"yaxis12,omitempty" xmlrpc:"yaxis12,omitempty"` // no documentation yet Yaxis13 []string `json:"yaxis13,omitempty" xmlrpc:"yaxis13,omitempty"` // no documentation yet Yaxis14 []string `json:"yaxis14,omitempty" xmlrpc:"yaxis14,omitempty"` // no documentation yet Yaxis15 []string `json:"yaxis15,omitempty" xmlrpc:"yaxis15,omitempty"` // no documentation yet Yaxis16 []string `json:"yaxis16,omitempty" xmlrpc:"yaxis16,omitempty"` // no documentation yet Yaxis17 []string `json:"yaxis17,omitempty" xmlrpc:"yaxis17,omitempty"` // no documentation yet Yaxis18 []string `json:"yaxis18,omitempty" xmlrpc:"yaxis18,omitempty"` // no documentation yet Yaxis19 []string `json:"yaxis19,omitempty" xmlrpc:"yaxis19,omitempty"` // no documentation yet Yaxis2 []string `json:"yaxis2,omitempty" xmlrpc:"yaxis2,omitempty"` // no documentation yet Yaxis20 []string `json:"yaxis20,omitempty" xmlrpc:"yaxis20,omitempty"` // no documentation yet Yaxis3 []string `json:"yaxis3,omitempty" xmlrpc:"yaxis3,omitempty"` // no documentation yet Yaxis4 []string `json:"yaxis4,omitempty" xmlrpc:"yaxis4,omitempty"` // no documentation yet Yaxis5 []string `json:"yaxis5,omitempty" xmlrpc:"yaxis5,omitempty"` // no documentation yet Yaxis6 []string `json:"yaxis6,omitempty" xmlrpc:"yaxis6,omitempty"` // no documentation yet Yaxis7 []string `json:"yaxis7,omitempty" xmlrpc:"yaxis7,omitempty"` // no documentation yet Yaxis8 []string `json:"yaxis8,omitempty" xmlrpc:"yaxis8,omitempty"` // no documentation yet Yaxis9 []string `json:"yaxis9,omitempty" xmlrpc:"yaxis9,omitempty"` }
no documentation yet
type Container_Network_CdnMarketplace_Vendor ¶
type Container_Network_CdnMarketplace_Vendor struct { Entity // no documentation yet FeatureSummary *string `json:"featureSummary,omitempty" xmlrpc:"featureSummary,omitempty"` // no documentation yet Features *string `json:"features,omitempty" xmlrpc:"features,omitempty"` // no documentation yet Status *string `json:"status,omitempty" xmlrpc:"status,omitempty"` // no documentation yet VendorName *string `json:"vendorName,omitempty" xmlrpc:"vendorName,omitempty"` }
no documentation yet
type Container_Network_Directory_Listing ¶
type Container_Network_Directory_Listing struct { Entity // If the file in a directory listing is a directory itself then fileCount is the number of files within the directory. FileCount *int `json:"fileCount,omitempty" xmlrpc:"fileCount,omitempty"` // The name of a directory or a file within a directory listing. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // 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 `json:"type,omitempty" xmlrpc:"type,omitempty"` }
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.
type Container_Network_LoadBalancer_StatusEntry ¶
type Container_Network_LoadBalancer_StatusEntry struct { Entity // The value of the entry. Content *string `json:"content,omitempty" xmlrpc:"content,omitempty"` // Text description of the status entry Label *string `json:"label,omitempty" xmlrpc:"label,omitempty"` }
The LoadBalancer_StatusEntry object stores information about the current status of a particular load balancer service.
It is a data container that cannot be edited, deleted, or saved.
It is returned exclusively by the getStatus method on the [[SoftLayer_Network_LoadBalancer_Service]] service
type Container_Network_Message_Delivery_Email ¶
type Container_Network_Message_Delivery_Email struct { Entity // no documentation yet Body *string `json:"body,omitempty" xmlrpc:"body,omitempty"` // no documentation yet ContainsHtml *bool `json:"containsHtml,omitempty" xmlrpc:"containsHtml,omitempty"` // no documentation yet From *string `json:"from,omitempty" xmlrpc:"from,omitempty"` // no documentation yet Subject *string `json:"subject,omitempty" xmlrpc:"subject,omitempty"` // no documentation yet To *string `json:"to,omitempty" xmlrpc:"to,omitempty"` }
This datatype is deprecated and will be removed in API version 3.2.
type Container_Network_Message_Delivery_Email_Sendgrid_Account ¶ added in v1.1.2
type Container_Network_Message_Delivery_Email_Sendgrid_Account struct { Entity // no documentation yet Offerings []Container_Network_Message_Delivery_Email_Sendgrid_Account_Offering `json:"offerings,omitempty" xmlrpc:"offerings,omitempty"` // no documentation yet Profile *Container_Network_Message_Delivery_Email_Sendgrid_Account_Profile `json:"profile,omitempty" xmlrpc:"profile,omitempty"` }
no documentation yet
type Container_Network_Message_Delivery_Email_Sendgrid_Account_Offering ¶ added in v1.1.2
type Container_Network_Message_Delivery_Email_Sendgrid_Account_Offering struct { Entity // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // no documentation yet Quantity *int `json:"quantity,omitempty" xmlrpc:"quantity,omitempty"` // no documentation yet Type *string `json:"type,omitempty" xmlrpc:"type,omitempty"` }
no documentation yet
type Container_Network_Message_Delivery_Email_Sendgrid_Account_Overview ¶
type Container_Network_Message_Delivery_Email_Sendgrid_Account_Overview struct { Entity // no documentation yet CreditsAllowed *int `json:"creditsAllowed,omitempty" xmlrpc:"creditsAllowed,omitempty"` // no documentation yet CreditsOverage *int `json:"creditsOverage,omitempty" xmlrpc:"creditsOverage,omitempty"` // no documentation yet CreditsRemain *int `json:"creditsRemain,omitempty" xmlrpc:"creditsRemain,omitempty"` // no documentation yet CreditsUsed *int `json:"creditsUsed,omitempty" xmlrpc:"creditsUsed,omitempty"` // no documentation yet Email *int `json:"email,omitempty" xmlrpc:"email,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet Package *string `json:"package,omitempty" xmlrpc:"package,omitempty"` // no documentation yet Reputation *int `json:"reputation,omitempty" xmlrpc:"reputation,omitempty"` // no documentation yet Requests *int `json:"requests,omitempty" xmlrpc:"requests,omitempty"` }
no documentation yet
type Container_Network_Message_Delivery_Email_Sendgrid_Account_Profile ¶ added in v1.1.2
type Container_Network_Message_Delivery_Email_Sendgrid_Account_Profile struct { Entity // no documentation yet CompanyName *string `json:"companyName,omitempty" xmlrpc:"companyName,omitempty"` // no documentation yet CompanyWebsite *string `json:"companyWebsite,omitempty" xmlrpc:"companyWebsite,omitempty"` // no documentation yet CreatedAt *string `json:"createdAt,omitempty" xmlrpc:"createdAt,omitempty"` // no documentation yet Email *string `json:"email,omitempty" xmlrpc:"email,omitempty"` // no documentation yet FirstName *string `json:"firstName,omitempty" xmlrpc:"firstName,omitempty"` // no documentation yet Id *string `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet LastName *string `json:"lastName,omitempty" xmlrpc:"lastName,omitempty"` // no documentation yet Overage *int `json:"overage,omitempty" xmlrpc:"overage,omitempty"` // no documentation yet Package *string `json:"package,omitempty" xmlrpc:"package,omitempty"` // no documentation yet Remain *int `json:"remain,omitempty" xmlrpc:"remain,omitempty"` // no documentation yet Reputation *int `json:"reputation,omitempty" xmlrpc:"reputation,omitempty"` // no documentation yet Total *int `json:"total,omitempty" xmlrpc:"total,omitempty"` // no documentation yet UpdatedAt *string `json:"updatedAt,omitempty" xmlrpc:"updatedAt,omitempty"` // no documentation yet Used *int `json:"used,omitempty" xmlrpc:"used,omitempty"` }
no documentation yet
type Container_Network_Message_Delivery_Email_Sendgrid_Catalog_Item ¶ added in v1.1.2
type Container_Network_Message_Delivery_Email_Sendgrid_Catalog_Item struct { Entity // no documentation yet Entitlements *Container_Network_Message_Delivery_Email_Sendgrid_Catalog_Item_Entitlements `json:"entitlements,omitempty" xmlrpc:"entitlements,omitempty"` // no documentation yet Offering *Container_Network_Message_Delivery_Email_Sendgrid_Catalog_Item_Offering `json:"offering,omitempty" xmlrpc:"offering,omitempty"` }
no documentation yet
type Container_Network_Message_Delivery_Email_Sendgrid_Catalog_Item_Entitlements ¶ added in v1.1.2
type Container_Network_Message_Delivery_Email_Sendgrid_Catalog_Item_Entitlements struct { Entity // no documentation yet EmailSendsMaxMonthly *int `json:"emailSendsMaxMonthly,omitempty" xmlrpc:"emailSendsMaxMonthly,omitempty"` // no documentation yet IpCount *int `json:"ipCount,omitempty" xmlrpc:"ipCount,omitempty"` // no documentation yet TeammatesMaxTotal *int `json:"teammatesMaxTotal,omitempty" xmlrpc:"teammatesMaxTotal,omitempty"` // no documentation yet UsersMaxTotal *int `json:"usersMaxTotal,omitempty" xmlrpc:"usersMaxTotal,omitempty"` }
no documentation yet
type Container_Network_Message_Delivery_Email_Sendgrid_Catalog_Item_Offering ¶ added in v1.1.2
type Container_Network_Message_Delivery_Email_Sendgrid_Catalog_Item_Offering struct { Entity // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // no documentation yet Quantity *int `json:"quantity,omitempty" xmlrpc:"quantity,omitempty"` // no documentation yet Type *string `json:"type,omitempty" xmlrpc:"type,omitempty"` }
no documentation yet
type Container_Network_Message_Delivery_Email_Sendgrid_Customer_Profile ¶
type Container_Network_Message_Delivery_Email_Sendgrid_Customer_Profile struct { Entity // no documentation yet Address *string `json:"address,omitempty" xmlrpc:"address,omitempty"` // no documentation yet City *string `json:"city,omitempty" xmlrpc:"city,omitempty"` // no documentation yet Country *string `json:"country,omitempty" xmlrpc:"country,omitempty"` // no documentation yet Email *string `json:"email,omitempty" xmlrpc:"email,omitempty"` // no documentation yet FirstName *string `json:"firstName,omitempty" xmlrpc:"firstName,omitempty"` // no documentation yet LastName *string `json:"lastName,omitempty" xmlrpc:"lastName,omitempty"` // no documentation yet Phone *string `json:"phone,omitempty" xmlrpc:"phone,omitempty"` // no documentation yet State *string `json:"state,omitempty" xmlrpc:"state,omitempty"` // no documentation yet Website *string `json:"website,omitempty" xmlrpc:"website,omitempty"` // no documentation yet Zip *string `json:"zip,omitempty" xmlrpc:"zip,omitempty"` }
no documentation yet
type Container_Network_Message_Delivery_Email_Sendgrid_List_Entry ¶
type Container_Network_Message_Delivery_Email_Sendgrid_List_Entry struct { Entity // no documentation yet Created *string `json:"created,omitempty" xmlrpc:"created,omitempty"` // no documentation yet Email *string `json:"email,omitempty" xmlrpc:"email,omitempty"` // no documentation yet Reason *string `json:"reason,omitempty" xmlrpc:"reason,omitempty"` // no documentation yet Status *string `json:"status,omitempty" xmlrpc:"status,omitempty"` }
no documentation yet
type Container_Network_Message_Delivery_Email_Sendgrid_Statistics ¶
type Container_Network_Message_Delivery_Email_Sendgrid_Statistics struct { Entity // no documentation yet Blocks *int `json:"blocks,omitempty" xmlrpc:"blocks,omitempty"` // no documentation yet Bounces *int `json:"bounces,omitempty" xmlrpc:"bounces,omitempty"` // no documentation yet Clicks *int `json:"clicks,omitempty" xmlrpc:"clicks,omitempty"` // no documentation yet Date *string `json:"date,omitempty" xmlrpc:"date,omitempty"` // no documentation yet Delivered *int `json:"delivered,omitempty" xmlrpc:"delivered,omitempty"` // no documentation yet InvalidEmail *int `json:"invalidEmail,omitempty" xmlrpc:"invalidEmail,omitempty"` // no documentation yet Opens *int `json:"opens,omitempty" xmlrpc:"opens,omitempty"` // no documentation yet RepeatBounces *int `json:"repeatBounces,omitempty" xmlrpc:"repeatBounces,omitempty"` // no documentation yet RepeatSpamReports *int `json:"repeatSpamReports,omitempty" xmlrpc:"repeatSpamReports,omitempty"` // no documentation yet RepeatUnsubscribes *int `json:"repeatUnsubscribes,omitempty" xmlrpc:"repeatUnsubscribes,omitempty"` // no documentation yet Requests *int `json:"requests,omitempty" xmlrpc:"requests,omitempty"` // no documentation yet SpamReports *int `json:"spamReports,omitempty" xmlrpc:"spamReports,omitempty"` // no documentation yet UniqueClicks *int `json:"uniqueClicks,omitempty" xmlrpc:"uniqueClicks,omitempty"` // no documentation yet UniqueOpens *int `json:"uniqueOpens,omitempty" xmlrpc:"uniqueOpens,omitempty"` // no documentation yet Unsubscribes *int `json:"unsubscribes,omitempty" xmlrpc:"unsubscribes,omitempty"` }
no documentation yet
type Container_Network_Message_Delivery_Email_Sendgrid_Statistics_Graph ¶
type Container_Network_Message_Delivery_Email_Sendgrid_Statistics_Graph struct { Entity // no documentation yet GraphError *string `json:"graphError,omitempty" xmlrpc:"graphError,omitempty"` // no documentation yet GraphImage *[]byte `json:"graphImage,omitempty" xmlrpc:"graphImage,omitempty"` // no documentation yet GraphTitle *string `json:"graphTitle,omitempty" xmlrpc:"graphTitle,omitempty"` }
no documentation yet
type Container_Network_Message_Delivery_Email_Sendgrid_Statistics_Options ¶
type Container_Network_Message_Delivery_Email_Sendgrid_Statistics_Options struct { Entity // no documentation yet AggregatedBy *bool `json:"aggregatedBy,omitempty" xmlrpc:"aggregatedBy,omitempty"` // no documentation yet AggregatesOnly *bool `json:"aggregatesOnly,omitempty" xmlrpc:"aggregatesOnly,omitempty"` // no documentation yet Category *string `json:"category,omitempty" xmlrpc:"category,omitempty"` // no documentation yet Days *int `json:"days,omitempty" xmlrpc:"days,omitempty"` // no documentation yet EndDate *Time `json:"endDate,omitempty" xmlrpc:"endDate,omitempty"` // no documentation yet SelectedStatistics []string `json:"selectedStatistics,omitempty" xmlrpc:"selectedStatistics,omitempty"` // no documentation yet StartDate *Time `json:"startDate,omitempty" xmlrpc:"startDate,omitempty"` }
no documentation yet
type Container_Network_Port_Statistic ¶
type Container_Network_Port_Statistic struct { Entity // no documentation yet AdministrativeStatus *int `json:"administrativeStatus,omitempty" xmlrpc:"administrativeStatus,omitempty"` // no documentation yet InDiscardPackets *uint `json:"inDiscardPackets,omitempty" xmlrpc:"inDiscardPackets,omitempty"` // no documentation yet InErrorPackets *uint `json:"inErrorPackets,omitempty" xmlrpc:"inErrorPackets,omitempty"` // no documentation yet InOctets *uint `json:"inOctets,omitempty" xmlrpc:"inOctets,omitempty"` // no documentation yet InUnicastPackets *uint `json:"inUnicastPackets,omitempty" xmlrpc:"inUnicastPackets,omitempty"` // no documentation yet MaximumTransmissionUnit *uint `json:"maximumTransmissionUnit,omitempty" xmlrpc:"maximumTransmissionUnit,omitempty"` // no documentation yet OperationalStatus *int `json:"operationalStatus,omitempty" xmlrpc:"operationalStatus,omitempty"` // no documentation yet OutDiscardPackets *uint `json:"outDiscardPackets,omitempty" xmlrpc:"outDiscardPackets,omitempty"` // no documentation yet OutErrorPackets *uint `json:"outErrorPackets,omitempty" xmlrpc:"outErrorPackets,omitempty"` // no documentation yet OutOctets *uint `json:"outOctets,omitempty" xmlrpc:"outOctets,omitempty"` // no documentation yet OutUnicastPackets *uint `json:"outUnicastPackets,omitempty" xmlrpc:"outUnicastPackets,omitempty"` // no documentation yet PortDuplex *uint `json:"portDuplex,omitempty" xmlrpc:"portDuplex,omitempty"` // no documentation yet Speed *uint `json:"speed,omitempty" xmlrpc:"speed,omitempty"` }
no documentation yet
type Container_Network_SecurityGroup_Limit ¶
type Container_Network_SecurityGroup_Limit struct { Entity // A key value describing what type of limit. TypeKey *string `json:"typeKey,omitempty" xmlrpc:"typeKey,omitempty"` // The value of the security group limit. Value *int `json:"value,omitempty" xmlrpc:"value,omitempty"` }
no documentation yet
type Container_Network_Service_Resource_ObjectStorage_ConnectionInformation ¶
type Container_Network_Service_Resource_ObjectStorage_ConnectionInformation struct { Entity // no documentation yet Datacenter *string `json:"datacenter,omitempty" xmlrpc:"datacenter,omitempty"` // no documentation yet DatacenterShortName *string `json:"datacenterShortName,omitempty" xmlrpc:"datacenterShortName,omitempty"` // no documentation yet PrivateEndpoint *string `json:"privateEndpoint,omitempty" xmlrpc:"privateEndpoint,omitempty"` // no documentation yet PublicEndpoint *string `json:"publicEndpoint,omitempty" xmlrpc:"publicEndpoint,omitempty"` }
no documentation yet
type Container_Network_Storage_Backup_Evault_WebCc_Authentication_Details ¶
type Container_Network_Storage_Backup_Evault_WebCc_Authentication_Details struct { Entity // no documentation yet EventValidation *string `json:"eventValidation,omitempty" xmlrpc:"eventValidation,omitempty"` // no documentation yet ViewState *string `json:"viewState,omitempty" xmlrpc:"viewState,omitempty"` // no documentation yet WebCcFormName *string `json:"webCcFormName,omitempty" xmlrpc:"webCcFormName,omitempty"` // no documentation yet WebCcUrl *string `json:"webCcUrl,omitempty" xmlrpc:"webCcUrl,omitempty"` // no documentation yet WebCcUserId *string `json:"webCcUserId,omitempty" xmlrpc:"webCcUserId,omitempty"` // no documentation yet WebCcUserPassword *string `json:"webCcUserPassword,omitempty" xmlrpc:"webCcUserPassword,omitempty"` }
no documentation yet
type Container_Network_Storage_DataCenterLimits_VolumeCountLimitContainer ¶ added in v1.0.1
type Container_Network_Storage_DataCenterLimits_VolumeCountLimitContainer struct { Entity // no documentation yet DatacenterName *string `json:"datacenterName,omitempty" xmlrpc:"datacenterName,omitempty"` // no documentation yet MaximumAvailableCount *int `json:"maximumAvailableCount,omitempty" xmlrpc:"maximumAvailableCount,omitempty"` // no documentation yet ProvisionedCount *int `json:"provisionedCount,omitempty" xmlrpc:"provisionedCount,omitempty"` }
no documentation yet
type Container_Network_Storage_DuplicateConversionStatusInformation ¶ added in v1.0.6
type Container_Network_Storage_DuplicateConversionStatusInformation struct { Entity // This represents the timestamp when current conversion process started. ActiveConversionStartTime *string `json:"activeConversionStartTime,omitempty" xmlrpc:"activeConversionStartTime,omitempty"` // This represents the percentage progress of conversion of a dependent DeDuplicateConversionPercentage *int `json:"deDuplicateConversionPercentage,omitempty" xmlrpc:"deDuplicateConversionPercentage,omitempty"` // This represents the volume username. VolumeUsername *string `json:"volumeUsername,omitempty" xmlrpc:"volumeUsername,omitempty"` }
no documentation yet
type Container_Network_Storage_Evault_Vault_Task ¶
type Container_Network_Storage_Evault_Vault_Task struct { Entity // Unique identifier for the task. Id *uint `json:"id,omitempty" xmlrpc:"id,omitempty"` // The hostname provided at time of agent registration. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // Total compressed bytes used for the task. UsedPoolsize *uint `json:"usedPoolsize,omitempty" xmlrpc:"usedPoolsize,omitempty"` }
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.
type Container_Network_Storage_Evault_WebCc_AgentStatus ¶
type Container_Network_Storage_Evault_WebCc_AgentStatus struct { Entity // Timestamp of last backup performed by the EVault backup agent LastBackup *Time `json:"lastBackup,omitempty" xmlrpc:"lastBackup,omitempty"` // 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)". Status *string `json:"status,omitempty" xmlrpc:"status,omitempty"` }
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.
type Container_Network_Storage_Evault_WebCc_BackupResults ¶
type Container_Network_Storage_Evault_WebCc_BackupResults struct { Entity // Timestamp of begin time BeginTime *Time `json:"beginTime,omitempty" xmlrpc:"beginTime,omitempty"` // Count of backups with conflicts. Conflict *string `json:"conflict,omitempty" xmlrpc:"conflict,omitempty"` // Timestamp of end time EndTime *Time `json:"endTime,omitempty" xmlrpc:"endTime,omitempty"` // Count of failed backups. Failed *string `json:"failed,omitempty" xmlrpc:"failed,omitempty"` // Count of successfull backups. Success *string `json:"success,omitempty" xmlrpc:"success,omitempty"` }
The SoftLayer_Container_Network_Storage_Evault_WebCc_BackupResults will contain the timeframe of backups and the results will also be returned.
type Container_Network_Storage_Evault_WebCc_JobDetails ¶
type Container_Network_Storage_Evault_WebCc_JobDetails struct { Entity // The number of bytes currently used by the backup job. (provided only for backup jobs) BytesUsed *uint `json:"bytesUsed,omitempty" xmlrpc:"bytesUsed,omitempty"` // Description of the backup/restore job Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // hardware id HardwareId *int `json:"hardwareId,omitempty" xmlrpc:"hardwareId,omitempty"` // Date of the last jobrun. LastRunDate *Time `json:"lastRunDate,omitempty" xmlrpc:"lastRunDate,omitempty"` // Name of the backup/restore job Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // Size of backup job when it was first run. (provided only for backup jobs) OriginalSize *uint `json:"originalSize,omitempty" xmlrpc:"originalSize,omitempty"` // Percentage of overall used space allocated by the job. (provided only for backup jobs) PercentageOfTotalUsage *int `json:"percentageOfTotalUsage,omitempty" xmlrpc:"percentageOfTotalUsage,omitempty"` // Result of the latest jobrun. Result *string `json:"result,omitempty" xmlrpc:"result,omitempty"` // virtual guest id VirtualGuestId *int `json:"virtualGuestId,omitempty" xmlrpc:"virtualGuestId,omitempty"` }
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.
type Container_Network_Storage_Host ¶
type Container_Network_Storage_Host struct { Entity // Reference id field for object associated with host. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Type for the object associated with host ObjectType *string `json:"objectType,omitempty" xmlrpc:"objectType,omitempty"` }
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.
type Container_Network_Storage_HostsGatewayInformation ¶ added in v1.0.5
type Container_Network_Storage_HostsGatewayInformation struct { Entity // Reference id field for object associated with host. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet IsBehindGatewayDevice *bool `json:"isBehindGatewayDevice,omitempty" xmlrpc:"isBehindGatewayDevice,omitempty"` // Type for the object associated with host ObjectType *string `json:"objectType,omitempty" xmlrpc:"objectType,omitempty"` }
The SoftLayer_Container_Network_Storage_HostsGatewayInformation will contain the reference id field for the object associated with the host. The host object type will also be returned.
type Container_Network_Storage_Hub_ObjectStorage_Bucket ¶
type Container_Network_Storage_Hub_ObjectStorage_Bucket struct { Entity // no documentation yet BytesUsed *int `json:"bytesUsed,omitempty" xmlrpc:"bytesUsed,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // no documentation yet ObjectCount *int `json:"objectCount,omitempty" xmlrpc:"objectCount,omitempty"` // no documentation yet StorageLocation *string `json:"storageLocation,omitempty" xmlrpc:"storageLocation,omitempty"` }
SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Bucket provides description of a bucket
type Container_Network_Storage_Hub_ObjectStorage_ContentDeliveryUrl ¶
type Container_Network_Storage_Hub_ObjectStorage_ContentDeliveryUrl struct { Entity // no documentation yet Datacenter *string `json:"datacenter,omitempty" xmlrpc:"datacenter,omitempty"` // no documentation yet FlashUrl *string `json:"flashUrl,omitempty" xmlrpc:"flashUrl,omitempty"` // no documentation yet HttpUrl *string `json:"httpUrl,omitempty" xmlrpc:"httpUrl,omitempty"` }
SoftLayer_Container_Network_Storage_Hub_ObjectStorage_ContentDeliveryUrl provides specific details is a container which contains the cdn urls associated with an object storage account
type Container_Network_Storage_Hub_ObjectStorage_Endpoint ¶
type Container_Network_Storage_Hub_ObjectStorage_Endpoint struct { Entity // no documentation yet Legacy *bool `json:"legacy,omitempty" xmlrpc:"legacy,omitempty"` // no documentation yet Location *string `json:"location,omitempty" xmlrpc:"location,omitempty"` // no documentation yet Region *string `json:"region,omitempty" xmlrpc:"region,omitempty"` // no documentation yet Type *string `json:"type,omitempty" xmlrpc:"type,omitempty"` // no documentation yet Url *string `json:"url,omitempty" xmlrpc:"url,omitempty"` }
SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Endpoint provides specific details on available endpoint URLs and locations.
type Container_Network_Storage_Hub_ObjectStorage_File ¶
type Container_Network_Storage_Hub_ObjectStorage_File struct { Container_Utility_File_Entity // no documentation yet Folder *string `json:"folder,omitempty" xmlrpc:"folder,omitempty"` // no documentation yet Hash *string `json:"hash,omitempty" xmlrpc:"hash,omitempty"` }
SoftLayer_Container_Network_Storage_Hub_ObjectStorage_File provides specific details that only apply to files that are sent or received from CloudLayer storage resources.
type Container_Network_Storage_Hub_ObjectStorage_Folder ¶
type Container_Network_Storage_Hub_ObjectStorage_Folder struct { Entity // no documentation yet Bytes *uint `json:"bytes,omitempty" xmlrpc:"bytes,omitempty"` // no documentation yet Count *uint `json:"count,omitempty" xmlrpc:"count,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
SoftLayer_Container_Network_Storage_Hub_Container provides details about containers which store collections of files.
type Container_Network_Storage_Hub_ObjectStorage_Node ¶
type Container_Network_Storage_Hub_ObjectStorage_Node struct { Entity // no documentation yet DeviceName *string `json:"deviceName,omitempty" xmlrpc:"deviceName,omitempty"` // no documentation yet ResourceName *string `json:"resourceName,omitempty" xmlrpc:"resourceName,omitempty"` // no documentation yet UserAuthUrl *string `json:"userAuthUrl,omitempty" xmlrpc:"userAuthUrl,omitempty"` }
SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Node provides detailed information for a particular object storage node
type Container_Network_Storage_Hub_ObjectStorage_Policy ¶
type Container_Network_Storage_Hub_ObjectStorage_Policy struct { Entity // no documentation yet PolicyCode *string `json:"policyCode,omitempty" xmlrpc:"policyCode,omitempty"` }
SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Policy provides specific details on available storage policies.
type Container_Network_Storage_Hub_ObjectStorage_Provision ¶
type Container_Network_Storage_Hub_ObjectStorage_Provision struct { Entity // no documentation yet AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // no documentation yet Provision *string `json:"provision,omitempty" xmlrpc:"provision,omitempty"` // no documentation yet ProvisionCreateDate *Time `json:"provisionCreateDate,omitempty" xmlrpc:"provisionCreateDate,omitempty"` // no documentation yet ProvisionModifyDate *Time `json:"provisionModifyDate,omitempty" xmlrpc:"provisionModifyDate,omitempty"` // no documentation yet ProvisionTime *int `json:"provisionTime,omitempty" xmlrpc:"provisionTime,omitempty"` }
SoftLayer_Container_Network_Storage_Hub_ObjectStorage_Provision provides description of a provision
type Container_Network_Storage_MassDataMigration_Request_Address ¶
type Container_Network_Storage_MassDataMigration_Request_Address struct { Entity // Line 1 of the address - typically the number and street address the MDMS device will be delivered to Address1 *string `json:"address1,omitempty" xmlrpc:"address1,omitempty"` // Line 2 of the address Address2 *string `json:"address2,omitempty" xmlrpc:"address2,omitempty"` // First and last name of the customer on the shipping address AddressAttention *string `json:"addressAttention,omitempty" xmlrpc:"addressAttention,omitempty"` // The datacenter name where the MDMS device will be shipped to AddressNickname *string `json:"addressNickname,omitempty" xmlrpc:"addressNickname,omitempty"` // The shipping address city City *string `json:"city,omitempty" xmlrpc:"city,omitempty"` // Name of the company device is being shipped to CompanyName *string `json:"companyName,omitempty" xmlrpc:"companyName,omitempty"` // The shipping address country Country *string `json:"country,omitempty" xmlrpc:"country,omitempty"` // The shipping address postal code PostalCode *string `json:"postalCode,omitempty" xmlrpc:"postalCode,omitempty"` // The shipping address state State *string `json:"state,omitempty" xmlrpc:"state,omitempty"` }
no documentation yet
type Container_Network_Storage_NetworkConnectionInformation ¶
type Container_Network_Storage_NetworkConnectionInformation struct { Entity // no documentation yet Id *string `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet IpAddress *string `json:"ipAddress,omitempty" xmlrpc:"ipAddress,omitempty"` // no documentation yet StorageType *string `json:"storageType,omitempty" xmlrpc:"storageType,omitempty"` }
no documentation yet
type Container_Network_Storage_VolumeDuplicateParameters ¶
type Container_Network_Storage_VolumeDuplicateParameters struct { Entity // The iopsPerGB of the volume IopsPerGb *Float64 `json:"iopsPerGb,omitempty" xmlrpc:"iopsPerGb,omitempty"` // Returns true if volume can be duplicated; false otherwise IsDuplicatable *bool `json:"isDuplicatable,omitempty" xmlrpc:"isDuplicatable,omitempty"` // This represents the location id LocationId *int `json:"locationId,omitempty" xmlrpc:"locationId,omitempty"` // This represents the location name LocationName *string `json:"locationName,omitempty" xmlrpc:"locationName,omitempty"` // The maximumIopsPerGb allowed for a duplicated volume MaximumIopsPerGb *Float64 `json:"maximumIopsPerGb,omitempty" xmlrpc:"maximumIopsPerGb,omitempty"` // The maximumIopsTier allowed for a duplicated volume MaximumIopsTier *Float64 `json:"maximumIopsTier,omitempty" xmlrpc:"maximumIopsTier,omitempty"` // The maximumVolumeSize allowed for a duplicated volume MaximumVolumeSize *int `json:"maximumVolumeSize,omitempty" xmlrpc:"maximumVolumeSize,omitempty"` // The minimumIopsPerGb allowed for a duplicated volume MinimumIopsPerGb *Float64 `json:"minimumIopsPerGb,omitempty" xmlrpc:"minimumIopsPerGb,omitempty"` // The minimumIopsTier allowed for a duplicated volume MinimumIopsTier *Float64 `json:"minimumIopsTier,omitempty" xmlrpc:"minimumIopsTier,omitempty"` // The minimumVolumeSize allowed for a duplicated volume MinimumVolumeSize *int `json:"minimumVolumeSize,omitempty" xmlrpc:"minimumVolumeSize,omitempty"` // The volume duplicate status description Status *string `json:"status,omitempty" xmlrpc:"status,omitempty"` // This represents the volume username VolumeUsername *string `json:"volumeUsername,omitempty" xmlrpc:"volumeUsername,omitempty"` }
Container for Volume Duplicate Information
type Container_Network_Subnet_IpAddress ¶
type Container_Network_Subnet_IpAddress struct { Entity // The hardware that an IP address is associated with. Hardware *Hardware `json:"hardware,omitempty" xmlrpc:"hardware,omitempty"` // An IP address expressed in dotted-quad notation. IpAddress *string `json:"ipAddress,omitempty" xmlrpc:"ipAddress,omitempty"` // Whether an IP address is its subnet's broadcast address. IsBroadcastAddress *bool `json:"isBroadcastAddress,omitempty" xmlrpc:"isBroadcastAddress,omitempty"` // Whether an IP address is its subnet's gateway address. Gateway addresses exist on SoftLayer's routers and many not be assigned to servers. IsGatewayAddress *bool `json:"isGatewayAddress,omitempty" xmlrpc:"isGatewayAddress,omitempty"` // Whether an IP address is its subnet's network identifier address. IsNetworkAddress *bool `json:"isNetworkAddress,omitempty" xmlrpc:"isNetworkAddress,omitempty"` }
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.
type Container_Network_Subnet_Registration_SubnetReference ¶
type Container_Network_Subnet_Registration_SubnetReference struct { Entity // The ID of the [[SoftLayer_Network_Subnet_Registration]] object. RegistrationId *int `json:"registrationId,omitempty" xmlrpc:"registrationId,omitempty"` // The subnet address in CIDR form. SubnetCidr *string `json:"subnetCidr,omitempty" xmlrpc:"subnetCidr,omitempty"` }
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.
type Container_Network_Subnet_Registration_TransactionDetails ¶
type Container_Network_Subnet_Registration_TransactionDetails struct { Entity // The IDs and Subnets of the [[SoftLayer_Network_Subnet_Registration]] object. SubnetReferences []Container_Network_Subnet_Registration_SubnetReference `json:"subnetReferences,omitempty" xmlrpc:"subnetReferences,omitempty"` // The ID of the Transaction object. TransactionId *int `json:"transactionId,omitempty" xmlrpc:"transactionId,omitempty"` }
SoftLayer_Container_Subnet_Registration_TransactionDetails is provided to return details of a newly created Subnet Registration Transaction.
type Container_Policy_Acceptance ¶
type Container_Policy_Acceptance struct { Entity // Flag to indicate if a policy has been previously accepted. AcceptedFlag *bool `json:"acceptedFlag,omitempty" xmlrpc:"acceptedFlag,omitempty"` // Name of the policy for which we are representing it's acceptance status. PolicyName *string `json:"policyName,omitempty" xmlrpc:"policyName,omitempty"` // ID of the [[SoftLayer_Product_Item_Policy_Assignment]]. ProductPolicyAssignmentId *int `json:"productPolicyAssignmentId,omitempty" xmlrpc:"productPolicyAssignmentId,omitempty"` }
Represents the acceptance status of a Policy.
type Container_Product_Item_Category ¶
type Container_Product_Item_Category struct { Entity // identifier for category. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` }
The SoftLayer_Container_Product_Item_Category data type represents a single product item category.
type Container_Product_Item_Category_Question_Answer ¶
type Container_Product_Item_Category_Question_Answer struct { Entity // The answer to the question. Answer *string `json:"answer,omitempty" xmlrpc:"answer,omitempty"` // The product item category code. CategoryCode *string `json:"categoryCode,omitempty" xmlrpc:"categoryCode,omitempty"` // The product item category id. CategoryId *int `json:"categoryId,omitempty" xmlrpc:"categoryId,omitempty"` // The product item category question id. QuestionId *int `json:"questionId,omitempty" xmlrpc:"questionId,omitempty"` }
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.
type Container_Product_Item_Category_ZeroFee_Count ¶
type Container_Product_Item_Category_ZeroFee_Count struct { Entity // The product item category code. CategoryCode *string `json:"categoryCode,omitempty" xmlrpc:"categoryCode,omitempty"` // The product item category id. CategoryId *int `json:"categoryId,omitempty" xmlrpc:"categoryId,omitempty"` // The product item category name. CategoryName *string `json:"categoryName,omitempty" xmlrpc:"categoryName,omitempty"` // The count of zero fee items for this category. Count *int `json:"count,omitempty" xmlrpc:"count,omitempty"` }
The SoftLayer_Container_Product_Item_Category_ZeroFee_Count data type represents a count of zero fee billing/invoice items.
type Container_Product_Item_Discount_Program ¶
type Container_Product_Item_Discount_Program struct { Entity // 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. ApplicableQuantity *int `json:"applicableQuantity,omitempty" xmlrpc:"applicableQuantity,omitempty"` // The product item that the discount applies to. Item *Product_Item `json:"item,omitempty" xmlrpc:"item,omitempty"` // 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. OneTimeAmount *Float64 `json:"oneTimeAmount,omitempty" xmlrpc:"oneTimeAmount,omitempty"` // 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. OneTimeTax *Float64 `json:"oneTimeTax,omitempty" xmlrpc:"oneTimeTax,omitempty"` // The item prices that contain the amount of the discount in the recurringFee field. There may be one or more prices. Prices []Product_Item_Price `json:"prices,omitempty" xmlrpc:"prices,omitempty"` // 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. ProratedOneTimeAmount *Float64 `json:"proratedOneTimeAmount,omitempty" xmlrpc:"proratedOneTimeAmount,omitempty"` // 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. ProratedOneTimeTax *Float64 `json:"proratedOneTimeTax,omitempty" xmlrpc:"proratedOneTimeTax,omitempty"` // 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. ProratedRecurringAmount *Float64 `json:"proratedRecurringAmount,omitempty" xmlrpc:"proratedRecurringAmount,omitempty"` // 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. ProratedRecurringTax *Float64 `json:"proratedRecurringTax,omitempty" xmlrpc:"proratedRecurringTax,omitempty"` // The sum of the recurring fees of the prices of this container multiplied by the applicable quantity of this container. RecurringAmount *Float64 `json:"recurringAmount,omitempty" xmlrpc:"recurringAmount,omitempty"` // The tax amount on the recurring fees of the prices of this container mulitiplied by the applicable quantity of this container. RecurringTax *Float64 `json:"recurringTax,omitempty" xmlrpc:"recurringTax,omitempty"` }
The SoftLayer_Container_Product_Item_Discount_Program data type represents the information about a discount that is related to a specific product item.
type Container_Product_Order ¶
type Container_Product_Order struct { Entity // Deprecated. // Deprecated: This function has been marked as deprecated. BigDataOrderFlag *bool `json:"bigDataOrderFlag,omitempty" xmlrpc:"bigDataOrderFlag,omitempty"` // Billing Information associated with an order. For existing customers this information is completely ignored. Do not send this information for existing customers. BillingInformation *Container_Product_Order_Billing_Information `json:"billingInformation,omitempty" xmlrpc:"billingInformation,omitempty"` // 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. BillingOrderItemId *int `json:"billingOrderItemId,omitempty" xmlrpc:"billingOrderItemId,omitempty"` // The URL to which PayPal redirects browser after checkout has been canceled before completion of a payment. CancelUrl *string `json:"cancelUrl,omitempty" xmlrpc:"cancelUrl,omitempty"` // Added by softlayer-go. This hints to the API what kind of product order this is. ComplexType *string `json:"complexType,omitempty" xmlrpc:"complexType,omitempty"` // User-specified description to identify a particular order container. This is useful if you have a multi-configuration order (multiple <code>orderContainers</code>) 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. ContainerIdentifier *string `json:"containerIdentifier,omitempty" xmlrpc:"containerIdentifier,omitempty"` // This hash is internally-generated and is used to for tracking order containers. ContainerSplHash *string `json:"containerSplHash,omitempty" xmlrpc:"containerSplHash,omitempty"` // The currency type chosen at checkout. CurrencyShortName *string `json:"currencyShortName,omitempty" xmlrpc:"currencyShortName,omitempty"` // Device Fingerprint Identifier - Optional. DeviceFingerprintId *string `json:"deviceFingerprintId,omitempty" xmlrpc:"deviceFingerprintId,omitempty"` // This has been deprecated. It is the identifier used to track configurations in legacy order forms. // Deprecated: This function has been marked as deprecated. DisplayLayerSessionId *string `json:"displayLayerSessionId,omitempty" xmlrpc:"displayLayerSessionId,omitempty"` // no documentation yet ExtendedHardwareTesting *bool `json:"extendedHardwareTesting,omitempty" xmlrpc:"extendedHardwareTesting,omitempty"` // The [[SoftLayer_Product_Item_Price]] for the Flexible Credit Program discount. The <code>oneTimeFee</code> field contains the calculated discount being applied to the order. FlexibleCreditProgramPrice *Product_Item_Price `json:"flexibleCreditProgramPrice,omitempty" xmlrpc:"flexibleCreditProgramPrice,omitempty"` // This flag indicates that the customer consented to the GDPR terms for the quote. GdprConsentFlag *bool `json:"gdprConsentFlag,omitempty" xmlrpc:"gdprConsentFlag,omitempty"` // 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 <code>hostname</code> and <code>domain</code> 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 <code>virtualGuests</code> property. Hardware []Hardware `json:"hardware,omitempty" xmlrpc:"hardware,omitempty"` // An optional virtual disk image template identifier to be used as an installation base for a computing instance order ImageTemplateGlobalIdentifier *string `json:"imageTemplateGlobalIdentifier,omitempty" xmlrpc:"imageTemplateGlobalIdentifier,omitempty"` // An optional virtual disk image template identifier to be used as an installation base for a computing instance order ImageTemplateId *int `json:"imageTemplateId,omitempty" xmlrpc:"imageTemplateId,omitempty"` // Flag to identify a "managed" order. This value is set internally. IsManagedOrder *int `json:"isManagedOrder,omitempty" xmlrpc:"isManagedOrder,omitempty"` // The collection of [[SoftLayer_Container_Product_Item_Category_Question_Answer]] for any product category that has additional questions requiring user input. ItemCategoryQuestionAnswers []Container_Product_Item_Category_Question_Answer `json:"itemCategoryQuestionAnswers,omitempty" xmlrpc:"itemCategoryQuestionAnswers,omitempty"` // The [[SoftLayer_Location_Region]] keyname or specific [[SoftLayer_Location_Datacenter]] id where the order should be provisioned. If this value is provided and the <code>regionalGroup</code> property is also specified, an exception will be thrown indicating that only 1 is allowed. Location *string `json:"location,omitempty" xmlrpc:"location,omitempty"` // This [[SoftLayer_Location]] object will be determined from the <code>location</code> property and will be returned in the order verification or placement response. Any value specified here will get overwritten by the verification process. LocationObject *Location `json:"locationObject,omitempty" xmlrpc:"locationObject,omitempty"` // A generic message about the order. Does not need to be sent in with any orders. Message *string `json:"message,omitempty" xmlrpc:"message,omitempty"` // 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 <code>orderContainers</code> is populated on the base order container, most of the configuration-specific properties are ignored on the base container. For example, <code>prices</code>, <code>location</code> and <code>packageId</code> will be ignored on the base container, but since the <code>billingInformation</code> 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. OrderContainers []Container_Product_Order `json:"orderContainers,omitempty" xmlrpc:"orderContainers,omitempty"` // This is deprecated and does not do anything. OrderHostnames []string `json:"orderHostnames,omitempty" xmlrpc:"orderHostnames,omitempty"` // 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. OrderVerificationExceptions []Container_Exception `json:"orderVerificationExceptions,omitempty" xmlrpc:"orderVerificationExceptions,omitempty"` // The [[SoftLayer_Product_Package]] id for an order container. This is required to place an order. PackageId *int `json:"packageId,omitempty" xmlrpc:"packageId,omitempty"` // The Payment Type is Optional. If nothing is sent in, then the normal method of payment will be used. For paypal customers, this means a paypalToken will be returned in the receipt. This token is to be used on the paypal website to complete the order. For Credit Card customers, the card on file in our system will be used to make an initial authorization. To force the order to use a payment type, use one of the following: CARD_ON_FILE or PAYPAL PaymentType *string `json:"paymentType,omitempty" xmlrpc:"paymentType,omitempty"` // The post-tax recurring charge for the order. This is the sum of preTaxRecurring + totalRecurringTax. PostTaxRecurring *Float64 `json:"postTaxRecurring,omitempty" xmlrpc:"postTaxRecurring,omitempty"` // 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. PostTaxRecurringHourly *Float64 `json:"postTaxRecurringHourly,omitempty" xmlrpc:"postTaxRecurringHourly,omitempty"` // The post-tax recurring monthly charge for the order. This is the sum of preTaxRecurringMonthly + totalRecurringTax. PostTaxRecurringMonthly *Float64 `json:"postTaxRecurringMonthly,omitempty" xmlrpc:"postTaxRecurringMonthly,omitempty"` // The post-tax setup fees of the order. This is the sum of preTaxSetup + totalSetupTax; PostTaxSetup *Float64 `json:"postTaxSetup,omitempty" xmlrpc:"postTaxSetup,omitempty"` // 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. PreTaxRecurring *Float64 `json:"preTaxRecurring,omitempty" xmlrpc:"preTaxRecurring,omitempty"` // The pre-tax hourly recurring total of the order. If there are only monthly prices on the order, this value will be 0. PreTaxRecurringHourly *Float64 `json:"preTaxRecurringHourly,omitempty" xmlrpc:"preTaxRecurringHourly,omitempty"` // The pre-tax monthly recurring total of the order. If there are only hourly prices on the order, this value will be 0. PreTaxRecurringMonthly *Float64 `json:"preTaxRecurringMonthly,omitempty" xmlrpc:"preTaxRecurringMonthly,omitempty"` // The pre-tax setup fee total of the order. PreTaxSetup *Float64 `json:"preTaxSetup,omitempty" xmlrpc:"preTaxSetup,omitempty"` // 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. PresaleEvent *Sales_Presale_Event `json:"presaleEvent,omitempty" xmlrpc:"presaleEvent,omitempty"` // A preset configuration id for the package. Is required if not submitting any prices. PresetId *int `json:"presetId,omitempty" xmlrpc:"presetId,omitempty"` // 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 <code>id</code> - 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. Prices []Product_Item_Price `json:"prices,omitempty" xmlrpc:"prices,omitempty"` // The id of a [[SoftLayer_Hardware_Component_Partition_Template]]. 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. PrimaryDiskPartitionId *int `json:"primaryDiskPartitionId,omitempty" xmlrpc:"primaryDiskPartitionId,omitempty"` // Priorities to set on replication set servers. Priorities []string `json:"priorities,omitempty" xmlrpc:"priorities,omitempty"` // Deprecated. // Deprecated: This function has been marked as deprecated. PrivateCloudOrderFlag *bool `json:"privateCloudOrderFlag,omitempty" xmlrpc:"privateCloudOrderFlag,omitempty"` // Deprecated. // Deprecated: This function has been marked as deprecated. PrivateCloudOrderType *string `json:"privateCloudOrderType,omitempty" xmlrpc:"privateCloudOrderType,omitempty"` // Optional promotion code for an order. PromotionCode *string `json:"promotionCode,omitempty" xmlrpc:"promotionCode,omitempty"` // Generic properties. Properties []Container_Product_Order_Property `json:"properties,omitempty" xmlrpc:"properties,omitempty"` // 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. ProratedInitialCharge *Float64 `json:"proratedInitialCharge,omitempty" xmlrpc:"proratedInitialCharge,omitempty"` // This is the same as the proratedInitialCharge, except the balance on the account is ignored. This is the prorated total amount of the order. ProratedOrderTotal *Float64 `json:"proratedOrderTotal,omitempty" xmlrpc:"proratedOrderTotal,omitempty"` // The URLs for scripts to execute on their respective servers after they have been provisioned. Provision scripts are not available for Microsoft Windows servers. ProvisionScripts []string `json:"provisionScripts,omitempty" xmlrpc:"provisionScripts,omitempty"` // The quantity of the item being ordered Quantity *int `json:"quantity,omitempty" xmlrpc:"quantity,omitempty"` // A custom name to be assigned to the quote. QuoteName *string `json:"quoteName,omitempty" xmlrpc:"quoteName,omitempty"` // Specifying a regional group name allows you to not worry about placing your server or service at a specific datacenter, but to any datacenter within that regional group. See [[SoftLayer_Location_Group_Regional]] to get a list of available regional group names. // // <code>location</code> and <code>regionalGroup</code> 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 <code>hardware</code> or <code>virtualGuests</code> 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. RegionalGroup *string `json:"regionalGroup,omitempty" xmlrpc:"regionalGroup,omitempty"` // Deprecated. // Deprecated: This function has been marked as deprecated. ResourceGroupId *int `json:"resourceGroupId,omitempty" xmlrpc:"resourceGroupId,omitempty"` // Deprecated. // Deprecated: This function has been marked as deprecated. ResourceGroupName *string `json:"resourceGroupName,omitempty" xmlrpc:"resourceGroupName,omitempty"` // An optional resource group template identifier to be used as a deployment base for a Virtual Server (Private Node) order. ResourceGroupTemplateId *int `json:"resourceGroupTemplateId,omitempty" xmlrpc:"resourceGroupTemplateId,omitempty"` // The URL to which PayPal redirects browser after a payment is completed. ReturnUrl *string `json:"returnUrl,omitempty" xmlrpc:"returnUrl,omitempty"` // This flag indicates that the quote should be sent to the email address associated with the account or order. SendQuoteEmailFlag *bool `json:"sendQuoteEmailFlag,omitempty" xmlrpc:"sendQuoteEmailFlag,omitempty"` // The number of cores for the server being ordered. This value is set internally. ServerCoreCount *int `json:"serverCoreCount,omitempty" xmlrpc:"serverCoreCount,omitempty"` // The token of a requesting service. Do not set. ServiceToken *string `json:"serviceToken,omitempty" xmlrpc:"serviceToken,omitempty"` // An optional computing instance identifier to be used as an installation base for a computing instance order SourceVirtualGuestId *int `json:"sourceVirtualGuestId,omitempty" xmlrpc:"sourceVirtualGuestId,omitempty"` // 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. SshKeys []Container_Product_Order_SshKeys `json:"sshKeys,omitempty" xmlrpc:"sshKeys,omitempty"` // An optional parameter for step-based order processing. StepId *int `json:"stepId,omitempty" xmlrpc:"stepId,omitempty"` // // // For orders that want to add storage groups such as RAID across multiple disks, simply add [[SoftLayer_Container_Product_Order_Storage_Group]] objects to this array. Storage groups will only be used if the 'RAID' disk controller price is selected. Any other disk controller types will ignore the storage groups set here. // // 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. // // StorageGroups []Container_Product_Order_Storage_Group `json:"storageGroups,omitempty" xmlrpc:"storageGroups,omitempty"` // The order container may not contain the final tax rates when it is returned from [[SoftLayer_Product_Order/verifyOrder|verifyOrder]]. This hash will facilitate checking if the tax rates have finished being calculated and retrieving the accurate tax rate values. TaxCacheHash *string `json:"taxCacheHash,omitempty" xmlrpc:"taxCacheHash,omitempty"` // 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|verifyOrder]]. TaxCompletedFlag *bool `json:"taxCompletedFlag,omitempty" xmlrpc:"taxCompletedFlag,omitempty"` // The SoftLayer_Product_Item_Price for the Tech Incubator discount. The oneTimeFee field contain the calculated discount being applied to the order. TechIncubatorItemPrice *Product_Item_Price `json:"techIncubatorItemPrice,omitempty" xmlrpc:"techIncubatorItemPrice,omitempty"` // The total tax portion of the recurring fees. TotalRecurringTax *Float64 `json:"totalRecurringTax,omitempty" xmlrpc:"totalRecurringTax,omitempty"` // The tax amount of the setup fees. TotalSetupTax *Float64 `json:"totalSetupTax,omitempty" xmlrpc:"totalSetupTax,omitempty"` // 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. UsagePrices []Product_Item_Price `json:"usagePrices,omitempty" xmlrpc:"usagePrices,omitempty"` // An optional flag to use hourly pricing instead of standard monthly pricing. UseHourlyPricing *bool `json:"useHourlyPricing,omitempty" xmlrpc:"useHourlyPricing,omitempty"` // For virtual guest (virtual server) orders, this property is required if you did not specify data in the <code>hardware</code> property. This is an array of [[SoftLayer_Virtual_Guest]] objects. The <code>hostname</code> and <code>domain</code> properties are required for each virtual guest object. There is no need to specify data in this property and the <code>hardware</code> property - only one is required for virtual server orders. VirtualGuests []Virtual_Guest `json:"virtualGuests,omitempty" xmlrpc:"virtualGuests,omitempty"` }
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.
type Container_Product_Order_Account_Media_Data_Transfer_Request ¶
type Container_Product_Order_Account_Media_Data_Transfer_Request struct { Container_Product_Order // An instance of [[SoftLayer_Account_Media_Data_Transfer_Request]] Request *Account_Media_Data_Transfer_Request `json:"request,omitempty" xmlrpc:"request,omitempty"` }
This datatype is to be used for data transfer requests.
type Container_Product_Order_Attribute_Address ¶
type Container_Product_Order_Attribute_Address struct { Entity // The physical street address. AddressLine1 *string `json:"addressLine1,omitempty" xmlrpc:"addressLine1,omitempty"` // The second line in the address. Information such as suite number goes here. AddressLine2 *string `json:"addressLine2,omitempty" xmlrpc:"addressLine2,omitempty"` // The city name City *string `json:"city,omitempty" xmlrpc:"city,omitempty"` // The 2-character Country code. (i.e. US) CountryCode *string `json:"countryCode,omitempty" xmlrpc:"countryCode,omitempty"` // State, Region or Province not part of the U.S. or Canada. NonUsState *string `json:"nonUsState,omitempty" xmlrpc:"nonUsState,omitempty"` // The Zip or Postal Code. PostalCode *string `json:"postalCode,omitempty" xmlrpc:"postalCode,omitempty"` // U.S. State, Region or Canadian Province. State *string `json:"state,omitempty" xmlrpc:"state,omitempty"` }
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.
type Container_Product_Order_Attribute_Contact ¶
type Container_Product_Order_Attribute_Contact struct { Entity // The address information of the contact. Address *Container_Product_Order_Attribute_Address `json:"address,omitempty" xmlrpc:"address,omitempty"` // The email address of the contact. EmailAddress *string `json:"emailAddress,omitempty" xmlrpc:"emailAddress,omitempty"` // The fax number associated with a contact. This is an optional value. FaxNumber *string `json:"faxNumber,omitempty" xmlrpc:"faxNumber,omitempty"` // The first name of the contact. FirstName *string `json:"firstName,omitempty" xmlrpc:"firstName,omitempty"` // The last name of the contact. LastName *string `json:"lastName,omitempty" xmlrpc:"lastName,omitempty"` // The organization name of the contact. OrganizationName *string `json:"organizationName,omitempty" xmlrpc:"organizationName,omitempty"` // The phone number associated with a contact. PhoneNumber *string `json:"phoneNumber,omitempty" xmlrpc:"phoneNumber,omitempty"` // The title of the contact. Title *string `json:"title,omitempty" xmlrpc:"title,omitempty"` }
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.
type Container_Product_Order_Attribute_Organization ¶
type Container_Product_Order_Attribute_Organization struct { Entity // The address information of the contact. Address *Container_Product_Order_Attribute_Address `json:"address,omitempty" xmlrpc:"address,omitempty"` // The fax number associated with an organization. This is an optional value. FaxNumber *string `json:"faxNumber,omitempty" xmlrpc:"faxNumber,omitempty"` // The name of an organization. OrganizationName *string `json:"organizationName,omitempty" xmlrpc:"organizationName,omitempty"` // The phone number associated with an organization. PhoneNumber *string `json:"phoneNumber,omitempty" xmlrpc:"phoneNumber,omitempty"` }
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.
type Container_Product_Order_Billing_Information ¶
type Container_Product_Order_Billing_Information struct { Entity // The physical street address. Reserve information such as "apartment #123" or "Suite 2" for line 1. BillingAddressLine1 *string `json:"billingAddressLine1,omitempty" xmlrpc:"billingAddressLine1,omitempty"` // The second line in the address. Information such as suite number goes here. BillingAddressLine2 *string `json:"billingAddressLine2,omitempty" xmlrpc:"billingAddressLine2,omitempty"` // The city in which a customer's account resides. BillingCity *string `json:"billingCity,omitempty" xmlrpc:"billingCity,omitempty"` // The 2-character Country code for an account's address. (i.e. US) BillingCountryCode *string `json:"billingCountryCode,omitempty" xmlrpc:"billingCountryCode,omitempty"` // The email address associated with a customer account. BillingEmail *string `json:"billingEmail,omitempty" xmlrpc:"billingEmail,omitempty"` // the company name for an account. BillingNameCompany *string `json:"billingNameCompany,omitempty" xmlrpc:"billingNameCompany,omitempty"` // The first name of the customer account owner. BillingNameFirst *string `json:"billingNameFirst,omitempty" xmlrpc:"billingNameFirst,omitempty"` // The last name of the customer account owner BillingNameLast *string `json:"billingNameLast,omitempty" xmlrpc:"billingNameLast,omitempty"` // The fax number associated with a customer account. BillingPhoneFax *string `json:"billingPhoneFax,omitempty" xmlrpc:"billingPhoneFax,omitempty"` // The phone number associated with a customer account. BillingPhoneVoice *string `json:"billingPhoneVoice,omitempty" xmlrpc:"billingPhoneVoice,omitempty"` // The Zip or Postal Code for the billing address on an account. BillingPostalCode *string `json:"billingPostalCode,omitempty" xmlrpc:"billingPostalCode,omitempty"` // The State for the account. BillingState *string `json:"billingState,omitempty" xmlrpc:"billingState,omitempty"` // Total height of browser screen in pixels. BrowserScreenHeight *string `json:"browserScreenHeight,omitempty" xmlrpc:"browserScreenHeight,omitempty"` // Total width of browser screen in pixels. BrowserScreenWidth *string `json:"browserScreenWidth,omitempty" xmlrpc:"browserScreenWidth,omitempty"` // The credit card number to use. CardAccountNumber *string `json:"cardAccountNumber,omitempty" xmlrpc:"cardAccountNumber,omitempty"` // The payment card expiration month CardExpirationMonth *int `json:"cardExpirationMonth,omitempty" xmlrpc:"cardExpirationMonth,omitempty"` // The payment card expiration year CardExpirationYear *int `json:"cardExpirationYear,omitempty" xmlrpc:"cardExpirationYear,omitempty"` // The Card Verification Value Code (CVV) number CreditCardVerificationNumber *string `json:"creditCardVerificationNumber,omitempty" xmlrpc:"creditCardVerificationNumber,omitempty"` // 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. EuSupported *bool `json:"euSupported,omitempty" xmlrpc:"euSupported,omitempty"` // If true, order is being placed by a business. IsBusinessFlag *bool `json:"isBusinessFlag,omitempty" xmlrpc:"isBusinessFlag,omitempty"` // 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. PayerAuthenticationEnrollmentReferenceId *string `json:"payerAuthenticationEnrollmentReferenceId,omitempty" xmlrpc:"payerAuthenticationEnrollmentReferenceId,omitempty"` // The URL where the issuing bank will redirect. PayerAuthenticationEnrollmentReturnUrl *string `json:"payerAuthenticationEnrollmentReturnUrl,omitempty" xmlrpc:"payerAuthenticationEnrollmentReturnUrl,omitempty"` // "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. PayerAuthenticationWebToken *string `json:"payerAuthenticationWebToken,omitempty" xmlrpc:"payerAuthenticationWebToken,omitempty"` // Tax exempt status. 1 = exempt (not taxable), 0 = not exempt (taxable) TaxExempt *int `json:"taxExempt,omitempty" xmlrpc:"taxExempt,omitempty"` // The VAT ID entered at checkout VatId *string `json:"vatId,omitempty" xmlrpc:"vatId,omitempty"` }
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.
type Container_Product_Order_Gateway_Appliance_Cluster ¶
type Container_Product_Order_Gateway_Appliance_Cluster struct { Container_Product_Order // Used to identify which items on an order belong in the same cluster. ClusterIdentifier *string `json:"clusterIdentifier,omitempty" xmlrpc:"clusterIdentifier,omitempty"` // Indicates what type of cluster order is being placed (HA, Provision). ClusterOrderType *string `json:"clusterOrderType,omitempty" xmlrpc:"clusterOrderType,omitempty"` }
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.
type Container_Product_Order_Gateway_Appliance_Upgrade ¶ added in v1.0.1
type Container_Product_Order_Gateway_Appliance_Upgrade struct { Container_Product_Order // Identifier for the [[SoftLayer_Network_Gateway (type)|network gateway]] being upgraded. GatewayId *int `json:"gatewayId,omitempty" xmlrpc:"gatewayId,omitempty"` }
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 (type)|network gateway]].
type Container_Product_Order_Hardware_Security_Module ¶
type Container_Product_Order_Hardware_Security_Module struct {
Container_Product_Order_Hardware_Server
}
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to place a hardware security module order with SoftLayer.
type Container_Product_Order_Hardware_Server ¶
type Container_Product_Order_Hardware_Server struct { Container_Product_Order // Used to identify which category should be used for the boot disk. BootCategoryCode *string `json:"bootCategoryCode,omitempty" xmlrpc:"bootCategoryCode,omitempty"` // Used to identify which items on an order belong in the same cluster. ClusterIdentifier *string `json:"clusterIdentifier,omitempty" xmlrpc:"clusterIdentifier,omitempty"` // Indicates what type of cluster order is being placed (HA, Provision). ClusterOrderType *string `json:"clusterOrderType,omitempty" xmlrpc:"clusterOrderType,omitempty"` // Used to identify which gateway is being upgraded to HA. ClusterResourceId *int `json:"clusterResourceId,omitempty" xmlrpc:"clusterResourceId,omitempty"` // 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 <strong>is not removable</strong> 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. DriveDestructionDisks []string `json:"driveDestructionDisks,omitempty" xmlrpc:"driveDestructionDisks,omitempty"` // Id used with the monitoring package. (Deprecated) // Deprecated: This function has been marked as deprecated. MonitoringAgentConfigurationTemplateGroupId *int `json:"monitoringAgentConfigurationTemplateGroupId,omitempty" xmlrpc:"monitoringAgentConfigurationTemplateGroupId,omitempty"` // When ordering Virtual Server (Private Node), this variable specifies the role of the server configuration. (Deprecated) PrivateCloudServerRole *string `json:"privateCloudServerRole,omitempty" xmlrpc:"privateCloudServerRole,omitempty"` // Used to identify which device the new server should be attached to. RequiredUpstreamDeviceId *int `json:"requiredUpstreamDeviceId,omitempty" xmlrpc:"requiredUpstreamDeviceId,omitempty"` // tags (used in MongoDB deployments). (Deprecated) Tags []Container_Product_Order_Property `json:"tags,omitempty" xmlrpc:"tags,omitempty"` }
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.
type Container_Product_Order_Hardware_Server_Colocation ¶
type Container_Product_Order_Hardware_Server_Colocation struct {
Container_Product_Order_Hardware_Server
}
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to place an order with SoftLayer.
type Container_Product_Order_Hardware_Server_Gateway_Appliance ¶
type Container_Product_Order_Hardware_Server_Gateway_Appliance struct {
Container_Product_Order_Hardware_Server
}
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to place a Gateway Appliance order.
type Container_Product_Order_Hardware_Server_Upgrade ¶
type Container_Product_Order_Hardware_Server_Upgrade struct {
Container_Product_Order_Hardware_Server
}
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to place a hardware upgrade.
type Container_Product_Order_Hardware_Server_Upgrade_MigrateToReserved ¶ added in v1.0.4
type Container_Product_Order_Hardware_Server_Upgrade_MigrateToReserved struct { Container_Product_Order_Hardware_Server_Upgrade // no documentation yet TermLength *int `json:"termLength,omitempty" xmlrpc:"termLength,omitempty"` // no documentation yet TermStartDate *Time `json:"termStartDate,omitempty" xmlrpc:"termStartDate,omitempty"` }
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.
type Container_Product_Order_Hardware_Server_Vpc ¶
type Container_Product_Order_Hardware_Server_Vpc struct { Container_Product_Order_Hardware_Server // no documentation yet Crn *string `json:"crn,omitempty" xmlrpc:"crn,omitempty"` // no documentation yet InstanceProfile *string `json:"instanceProfile,omitempty" xmlrpc:"instanceProfile,omitempty"` // no documentation yet IpAllocations []Container_Product_Order_Vpc_IpAllocation `json:"ipAllocations,omitempty" xmlrpc:"ipAllocations,omitempty"` // no documentation yet ResourceGroup *string `json:"resourceGroup,omitempty" xmlrpc:"resourceGroup,omitempty"` // no documentation yet ServerId *string `json:"serverId,omitempty" xmlrpc:"serverId,omitempty"` // no documentation yet ServicePortInterfaceId *string `json:"servicePortInterfaceId,omitempty" xmlrpc:"servicePortInterfaceId,omitempty"` // no documentation yet ServicePortIpAllocationId *string `json:"servicePortIpAllocationId,omitempty" xmlrpc:"servicePortIpAllocationId,omitempty"` // no documentation yet ServicePortVpcId *string `json:"servicePortVpcId,omitempty" xmlrpc:"servicePortVpcId,omitempty"` // no documentation yet Subnets []Container_Product_Order_Vpc_Subnet `json:"subnets,omitempty" xmlrpc:"subnets,omitempty"` // no documentation yet Zone *string `json:"zone,omitempty" xmlrpc:"zone,omitempty"` }
no documentation yet
type Container_Product_Order_Monitoring_Package ¶
type Container_Product_Order_Monitoring_Package struct { Container_Product_Order // no documentation yet // Deprecated: This function has been marked as deprecated. ServerType *string `json:"serverType,omitempty" xmlrpc:"serverType,omitempty"` }
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.
type Container_Product_Order_MultiConfiguration ¶
type Container_Product_Order_MultiConfiguration struct {
Container_Product_Order
}
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.
type Container_Product_Order_MultiConfiguration_Tornado ¶
type Container_Product_Order_MultiConfiguration_Tornado struct {
Container_Product_Order_MultiConfiguration
}
no documentation yet
type Container_Product_Order_Network ¶
type Container_Product_Order_Network struct { Entity // The [[SoftLayer_Network]] object. Network *Network `json:"network,omitempty" xmlrpc:"network,omitempty"` // The list of public [[SoftLayer_Container_Product_Order_Network_Vlan|vlans]] available for ordering. Each VLAN will have list of public subnets that are accessible to the VLAN. PublicVlans []Container_Product_Order `json:"publicVlans,omitempty" xmlrpc:"publicVlans,omitempty"` // The list of private [[SoftLayer_Container_Product_Order_Network_Subnet|subnets]] available for ordering with a description of their available IP space. Subnets []Container_Product_Order `json:"subnets,omitempty" xmlrpc:"subnets,omitempty"` }
(DEPRECATED) This type contains the structure of network-related objects that may be specified when ordering services.
type Container_Product_Order_Network_Application_Delivery_Controller ¶
type Container_Product_Order_Network_Application_Delivery_Controller struct { Container_Product_Order // An optional [[SoftLayer_Network_Application_Delivery_Controller]] identifier that is used for upgrading an existing application delivery controller. ApplicationDeliveryControllerId *int `json:"applicationDeliveryControllerId,omitempty" xmlrpc:"applicationDeliveryControllerId,omitempty"` }
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.
type Container_Product_Order_Network_Interconnect ¶
type Container_Product_Order_Network_Interconnect struct { Container_Product_Order // The BGP ASN. BgpAsn *string `json:"bgpAsn,omitempty" xmlrpc:"bgpAsn,omitempty"` // The [[SoftLayer_Network_Interconnect]] for this order, ID must be provided. InterconnectId *int `json:"interconnectId,omitempty" xmlrpc:"interconnectId,omitempty"` // The [[SoftLayer_Network_DirectLink_Location]] for this order, ID must be provided. InterconnectLocation *Network_DirectLink_Location `json:"interconnectLocation,omitempty" xmlrpc:"interconnectLocation,omitempty"` // The [[SoftLayer_Network_Interconnect_Tenant]] 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. InterconnectTenant *Network_Interconnect_Tenant `json:"interconnectTenant,omitempty" xmlrpc:"interconnectTenant,omitempty"` // Optional IP address for this link. IpAddressRange *string `json:"ipAddressRange,omitempty" xmlrpc:"ipAddressRange,omitempty"` // A name to identify this Direct Link resource. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // Optional network identifier for this link. NetworkIdentifier *string `json:"networkIdentifier,omitempty" xmlrpc:"networkIdentifier,omitempty"` }
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder when purchasing a Network Interconnect.
type Container_Product_Order_Network_Interconnect_Upgrade ¶
type Container_Product_Order_Network_Interconnect_Upgrade struct {
Container_Product_Order_Network_Interconnect
}
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.
type Container_Product_Order_Network_LoadBalancer ¶
type Container_Product_Order_Network_LoadBalancer struct {
Container_Product_Order
}
This is the default container type for network load balancer orders.
type Container_Product_Order_Network_LoadBalancer_AsAService ¶
type Container_Product_Order_Network_LoadBalancer_AsAService struct { Container_Product_Order // A description of this Load Balancer. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // The [[SoftLayer_Network_LBaaS_LoadBalancerHealthMonitorConfiguration]]s for this Load Balancer. HealthMonitorConfigurations []Network_LBaaS_LoadBalancerHealthMonitorConfiguration `json:"healthMonitorConfigurations,omitempty" xmlrpc:"healthMonitorConfigurations,omitempty"` // Specify whether this load balancer is a public or internal facing load balancer. If this value is omitted, the value will default to true. IsPublic *bool `json:"isPublic,omitempty" xmlrpc:"isPublic,omitempty"` // A name to identify this Load Balancer. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // The [[SoftLayer_Network_LBaaS_LoadBalancerProtocolConfiguration]]s for this Load Balancer. ProtocolConfigurations []Network_LBaaS_LoadBalancerProtocolConfiguration `json:"protocolConfigurations,omitempty" xmlrpc:"protocolConfigurations,omitempty"` // 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. PublicSubnets []Network_Subnet `json:"publicSubnets,omitempty" xmlrpc:"publicSubnets,omitempty"` // The [[SoftLayer_Network_LBaaS_LoadBalancerServerInstanceInfo]]s for this Load Balancer. ServerInstancesInformation []Network_LBaaS_LoadBalancerServerInstanceInfo `json:"serverInstancesInformation,omitempty" xmlrpc:"serverInstancesInformation,omitempty"` // The [[SoftLayer_Network_Subnet]]s where this Load Balancer will be provisioned. Subnets []Network_Subnet `json:"subnets,omitempty" xmlrpc:"subnets,omitempty"` // 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 *int `json:"type,omitempty" xmlrpc:"type,omitempty"` // Specify if this load balancer uses system IP pool (true, default) or customer's (null|false) public subnet to allocate IP addresses. UseSystemPublicIpPool *bool `json:"useSystemPublicIpPool,omitempty" xmlrpc:"useSystemPublicIpPool,omitempty"` }
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.
type Container_Product_Order_Network_Message_Delivery ¶
type Container_Product_Order_Network_Message_Delivery struct { Container_Product_Order // This property has been deprecated and should no longer be used. // // The account password for SendGrid enrollment. // Deprecated: This function has been marked as deprecated. AccountPassword *string `json:"accountPassword,omitempty" xmlrpc:"accountPassword,omitempty"` // This property has been deprecated and should no longer be used. // // The username for SendGrid enrollment. // Deprecated: This function has been marked as deprecated. AccountUsername *string `json:"accountUsername,omitempty" xmlrpc:"accountUsername,omitempty"` // The email address for SendGrid enrollment. EmailAddress *string `json:"emailAddress,omitempty" xmlrpc:"emailAddress,omitempty"` }
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.
type Container_Product_Order_Network_Message_Delivery_Upgrade ¶ added in v1.1.2
type Container_Product_Order_Network_Message_Delivery_Upgrade struct { Container_Product_Order_Network_Message_Delivery // The ID of the [[SoftLayer_Network_Message_Delivery]] being upgraded. MessageDeliveryId *int `json:"messageDeliveryId,omitempty" xmlrpc:"messageDeliveryId,omitempty"` }
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to place an upgrade order for network message delivery.
type Container_Product_Order_Network_PerformanceStorage ¶
type Container_Product_Order_Network_PerformanceStorage struct {
Container_Product_Order
}
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.
type Container_Product_Order_Network_PerformanceStorage_Iscsi ¶
type Container_Product_Order_Network_PerformanceStorage_Iscsi struct { Container_Product_Order_Network_PerformanceStorage // 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. OsFormatType *Network_Storage_Iscsi_OS_Type `json:"osFormatType,omitempty" xmlrpc:"osFormatType,omitempty"` }
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
type Container_Product_Order_Network_PerformanceStorage_Nfs ¶
type Container_Product_Order_Network_PerformanceStorage_Nfs struct {
Container_Product_Order_Network_PerformanceStorage
}
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
type Container_Product_Order_Network_Protection_Firewall ¶
type Container_Product_Order_Network_Protection_Firewall struct {
Container_Product_Order
}
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to place a hardware firewall order with SoftLayer.
type Container_Product_Order_Network_Protection_Firewall_Dedicated ¶
type Container_Product_Order_Network_Protection_Firewall_Dedicated struct { Container_Product_Order // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // no documentation yet RouterId *int `json:"routerId,omitempty" xmlrpc:"routerId,omitempty"` // generic properties. Vlan *Network_Vlan `json:"vlan,omitempty" xmlrpc:"vlan,omitempty"` // generic properties. VlanId *int `json:"vlanId,omitempty" xmlrpc:"vlanId,omitempty"` }
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.
type Container_Product_Order_Network_Protection_Firewall_Dedicated_Upgrade ¶
type Container_Product_Order_Network_Protection_Firewall_Dedicated_Upgrade struct { Container_Product_Order_Network_Protection_Firewall_Dedicated // no documentation yet FirewallId *int `json:"firewallId,omitempty" xmlrpc:"firewallId,omitempty"` }
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.
type Container_Product_Order_Network_Storage_AsAService ¶
type Container_Product_Order_Network_Storage_AsAService struct { Container_Product_Order // 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. DedicatedCluster *Network_Storage_DedicatedCluster `json:"dedicatedCluster,omitempty" xmlrpc:"dedicatedCluster,omitempty"` // This must be populated only for duplicating a specific snapshot for volume duplicating. It represents the identifier of the origin [[SoftLayer_Network_Storage_Snapshot]] DuplicateOriginSnapshotId *int `json:"duplicateOriginSnapshotId,omitempty" xmlrpc:"duplicateOriginSnapshotId,omitempty"` // This must be populated only for duplicate volume ordering. It represents the identifier of the origin [[SoftLayer_Network_Storage]]. DuplicateOriginVolumeId *int `json:"duplicateOriginVolumeId,omitempty" xmlrpc:"duplicateOriginVolumeId,omitempty"` // When ordering performance by IOPS, populate this property with how many. Iops *int `json:"iops,omitempty" xmlrpc:"iops,omitempty"` // 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. IsDependentDuplicateFlag *bool `json:"isDependentDuplicateFlag,omitempty" xmlrpc:"isDependentDuplicateFlag,omitempty"` // This must be populated only for replicant volume ordering. It represents the identifier of the origin [[SoftLayer_Network_Storage]]. OriginVolumeId *int `json:"originVolumeId,omitempty" xmlrpc:"originVolumeId,omitempty"` // 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. OriginVolumeScheduleId *int `json:"originVolumeScheduleId,omitempty" xmlrpc:"originVolumeScheduleId,omitempty"` // 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. OsFormatType *Network_Storage_Iscsi_OS_Type `json:"osFormatType,omitempty" xmlrpc:"osFormatType,omitempty"` // Volume size in GB's. VolumeSize *int `json:"volumeSize,omitempty" xmlrpc:"volumeSize,omitempty"` }
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.
type Container_Product_Order_Network_Storage_AsAService_Upgrade ¶
type Container_Product_Order_Network_Storage_AsAService_Upgrade struct { Container_Product_Order_Network_Storage_AsAService // The [[SoftLayer_Network_Storage]] being upgraded. Only it's ID is required. Volume *Network_Storage `json:"volume,omitempty" xmlrpc:"volume,omitempty"` }
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.
type Container_Product_Order_Network_Storage_Backup_Evault_Plugin ¶
type Container_Product_Order_Network_Storage_Backup_Evault_Plugin struct {
Container_Product_Order
}
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to place an order for additional Evault plugins.
type Container_Product_Order_Network_Storage_Backup_Evault_Vault ¶
type Container_Product_Order_Network_Storage_Backup_Evault_Vault struct {
Container_Product_Order
}
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to place an Evault order with SoftLayer.
type Container_Product_Order_Network_Storage_Enterprise ¶
type Container_Product_Order_Network_Storage_Enterprise struct { Container_Product_Order // This must be populated only for replicant volume ordering. It represents the identifier of the origin [[SoftLayer_Network_Storage]]. OriginVolumeId *int `json:"originVolumeId,omitempty" xmlrpc:"originVolumeId,omitempty"` // 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. OriginVolumeScheduleId *int `json:"originVolumeScheduleId,omitempty" xmlrpc:"originVolumeScheduleId,omitempty"` // 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. OsFormatType *Network_Storage_Iscsi_OS_Type `json:"osFormatType,omitempty" xmlrpc:"osFormatType,omitempty"` }
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
type Container_Product_Order_Network_Storage_Enterprise_SnapshotSpace ¶
type Container_Product_Order_Network_Storage_Enterprise_SnapshotSpace struct { Container_Product_Order // The [[SoftLayer_Network_Storage]] id for which snapshot space is being ordered for. VolumeId *int `json:"volumeId,omitempty" xmlrpc:"volumeId,omitempty"` }
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.
type Container_Product_Order_Network_Storage_Enterprise_SnapshotSpace_Upgrade ¶
type Container_Product_Order_Network_Storage_Enterprise_SnapshotSpace_Upgrade struct {
Container_Product_Order_Network_Storage_Enterprise_SnapshotSpace
}
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to place an upgrade order for Enterprise Storage Snapshot Space.
type Container_Product_Order_Network_Storage_Hub ¶
type Container_Product_Order_Network_Storage_Hub struct {
Container_Product_Order
}
This datatype is to be used for object storage orders.
type Container_Product_Order_Network_Storage_Hub_Datacenter ¶
type Container_Product_Order_Network_Storage_Hub_Datacenter struct { Entity // The datacenter location where object storage is available. Location *Location `json:"location,omitempty" xmlrpc:"location,omitempty"` // The collection of active usage rate item prices. UsageRatePrices []Product_Item_Price `json:"usageRatePrices,omitempty" xmlrpc:"usageRatePrices,omitempty"` }
This class is used to contain a datacenter location and its associated active usage rate prices for object storage ordering.
type Container_Product_Order_Network_Storage_Iscsi ¶
type Container_Product_Order_Network_Storage_Iscsi struct {
Container_Product_Order
}
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to place an ISCSI order with SoftLayer.
type Container_Product_Order_Network_Storage_MassDataMigration_Request ¶
type Container_Product_Order_Network_Storage_MassDataMigration_Request struct { Container_Product_Order // Line 1 of the address - typically the number and street address the MDMS device will be delivered to Address1 *string `json:"address1,omitempty" xmlrpc:"address1,omitempty"` // Line 2 of the address Address2 *string `json:"address2,omitempty" xmlrpc:"address2,omitempty"` // First and last name of the customer on the shipping address AddressAttention *string `json:"addressAttention,omitempty" xmlrpc:"addressAttention,omitempty"` // The datacenter name where the MDMS device will be shipped to AddressNickname *string `json:"addressNickname,omitempty" xmlrpc:"addressNickname,omitempty"` // The shipping address city City *string `json:"city,omitempty" xmlrpc:"city,omitempty"` // Name of the company device is being shipped to CompanyName *string `json:"companyName,omitempty" xmlrpc:"companyName,omitempty"` // Cloud Object Storage Account ID for the data offload destination CosAccountId *string `json:"cosAccountId,omitempty" xmlrpc:"cosAccountId,omitempty"` // Cloud Object Storage Bucket for the data offload destination CosBucketName *string `json:"cosBucketName,omitempty" xmlrpc:"cosBucketName,omitempty"` // The shipping address country Country *string `json:"country,omitempty" xmlrpc:"country,omitempty"` // Default Gateway used for preconfiguring the Eth1 port on the MDMS device to access the user interface Eth1DefaultGateway *string `json:"eth1DefaultGateway,omitempty" xmlrpc:"eth1DefaultGateway,omitempty"` // Netmask used for preconfiguring the Eth1 port on the MDMS device to access the user interface Eth1Netmask *string `json:"eth1Netmask,omitempty" xmlrpc:"eth1Netmask,omitempty"` // Static IP Address used for preconfiguring the Eth1 port on the MDMS device to access the user interface Eth1StaticIp *string `json:"eth1StaticIp,omitempty" xmlrpc:"eth1StaticIp,omitempty"` // Netmask used for preconfiguring the Eth3 port on the MDMS device to enable data transfer Eth3Netmask *string `json:"eth3Netmask,omitempty" xmlrpc:"eth3Netmask,omitempty"` // Static IP Address used for preconfiguring the Eth3 port on the MDMS device to enable data transfer Eth3StaticIp *string `json:"eth3StaticIp,omitempty" xmlrpc:"eth3StaticIp,omitempty"` // The e-mails of the MDMS key contacts KeyContactEmails []string `json:"keyContactEmails,omitempty" xmlrpc:"keyContactEmails,omitempty"` // The names of the MDMS key contacts KeyContactNames []string `json:"keyContactNames,omitempty" xmlrpc:"keyContactNames,omitempty"` // The phone numbers of the MDMS key contacts KeyContactPhoneNumbers []string `json:"keyContactPhoneNumbers,omitempty" xmlrpc:"keyContactPhoneNumbers,omitempty"` // The roles of the MDMS key contacts KeyContactRoles []string `json:"keyContactRoles,omitempty" xmlrpc:"keyContactRoles,omitempty"` // The shipping address postal code PostalCode *string `json:"postalCode,omitempty" xmlrpc:"postalCode,omitempty"` // Name of the Mass Data Migration Service job request RequestName *string `json:"requestName,omitempty" xmlrpc:"requestName,omitempty"` // Shipping address and information where device will be shipped to ShippingAddress *Container_Network_Storage_MassDataMigration_Request_Address `json:"shippingAddress,omitempty" xmlrpc:"shippingAddress,omitempty"` // The shipping address state State *string `json:"state,omitempty" xmlrpc:"state,omitempty"` }
This datatype is to be used for mass data migration requests.
type Container_Product_Order_Network_Storage_Modification ¶
type Container_Product_Order_Network_Storage_Modification struct { Container_Product_Order // The id of the StorageLayer account to modify. VolumeId *int `json:"volumeId,omitempty" xmlrpc:"volumeId,omitempty"` }
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.
NOTE: When upgrading CloudLayer storage service from a metered plan (pay as you go) to a non-metered plan, make sure the chosen plan's storage allotment has enough space to cover the current usage. If the chosen plan's usage allotment is less than the CloudLayer storage's usage the order will be rejected.
type Container_Product_Order_Network_Storage_Nas ¶
type Container_Product_Order_Network_Storage_Nas struct {
Container_Product_Order
}
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder when placing network attached storage orders.
type Container_Product_Order_Network_Storage_Object ¶
type Container_Product_Order_Network_Storage_Object struct {
Container_Product_Order
}
This datatype is to be used for ordering object storage products using the object_storage [[SoftLayer_Product_Item_Category|category]]. For object storage products using hub [[SoftLayer_Product_Item_Category|category]] use the [[SoftLayer_Container_Product_Order_Network_Storage_Hub]] order container.
type Container_Product_Order_Network_Storage_ObjectStorage_LocationGroup ¶
type Container_Product_Order_Network_Storage_ObjectStorage_LocationGroup struct { Entity // The datacenter location where object storage is available. ClusterGeolocationType *string `json:"clusterGeolocationType,omitempty" xmlrpc:"clusterGeolocationType,omitempty"` // The datacenter location where object storage is available. LocationGroup *Location_Group `json:"locationGroup,omitempty" xmlrpc:"locationGroup,omitempty"` // The collection of active usage rate item prices. UsageRatePrices []Product_Item_Price `json:"usageRatePrices,omitempty" xmlrpc:"usageRatePrices,omitempty"` }
This class is used to contain a location group and its associated active usage rate prices for object storage ordering.
type Container_Product_Order_Network_Subnet ¶
type Container_Product_Order_Network_Subnet struct { Container_Product_Order // The description which includes the network identifier, Classless Inter-Domain Routing prefix and the available slot count. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // The [[SoftLayer_Network_Subnet_IpAddress]] id. EndPointIpAddressId *int `json:"endPointIpAddressId,omitempty" xmlrpc:"endPointIpAddressId,omitempty"` // The [[SoftLayer_Network_Vlan]] id. EndPointVlanId *int `json:"endPointVlanId,omitempty" xmlrpc:"endPointVlanId,omitempty"` // The [[SoftLayer_Network_Subnet]] id. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // This is the hostname for the router associated with the [[SoftLayer_Network_Subnet|subnet]]. This is a readonly property. RouterHostname *string `json:"routerHostname,omitempty" xmlrpc:"routerHostname,omitempty"` }
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.
type Container_Product_Order_Network_Tunnel_Ipsec ¶
type Container_Product_Order_Network_Tunnel_Ipsec struct {
Container_Product_Order
}
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to place a network ipsec vpn order with SoftLayer.
type Container_Product_Order_Network_Vlan ¶
type Container_Product_Order_Network_Vlan struct { Container_Product_Order // The description which includes the primary router's hostname plus the vlan number. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // The datacenter portion of the hostname. HostnameDatacenter *string `json:"hostnameDatacenter,omitempty" xmlrpc:"hostnameDatacenter,omitempty"` // The router portion of the hostname. HostnameRouter *string `json:"hostnameRouter,omitempty" xmlrpc:"hostnameRouter,omitempty"` // The [[SoftLayer_Network_Vlan]] id. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The optional name for this VLAN Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // The router object on which the new VLAN should be created. Router *Hardware `json:"router,omitempty" xmlrpc:"router,omitempty"` // The ID of the [[SoftLayer_Hardware_Router]] object on which the new VLAN should be created. RouterId *int `json:"routerId,omitempty" xmlrpc:"routerId,omitempty"` // The collection of subnets associated with this vlan. Subnets []Container_Product_Order `json:"subnets,omitempty" xmlrpc:"subnets,omitempty"` // The vlan number. VlanNumber *int `json:"vlanNumber,omitempty" xmlrpc:"vlanNumber,omitempty"` }
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.
type Container_Product_Order_Network_Vlans ¶
type Container_Product_Order_Network_Vlans struct { Entity // The collection of private vlans available during ordering. PrivateVlans []Container_Product_Order `json:"privateVlans,omitempty" xmlrpc:"privateVlans,omitempty"` // The collection of public vlans available during ordering. PublicVlans []Container_Product_Order `json:"publicVlans,omitempty" xmlrpc:"publicVlans,omitempty"` }
This class contains the collections of public and private VLANs that are available during the ordering process.
type Container_Product_Order_NewCustomerSetup ¶
type Container_Product_Order_NewCustomerSetup struct { Container_Product_Order // no documentation yet // Deprecated: This function has been marked as deprecated. AuthorizationToken *string `json:"authorizationToken,omitempty" xmlrpc:"authorizationToken,omitempty"` // no documentation yet ExternalAccountId *string `json:"externalAccountId,omitempty" xmlrpc:"externalAccountId,omitempty"` // no documentation yet ExternalServiceProviderKey *string `json:"externalServiceProviderKey,omitempty" xmlrpc:"externalServiceProviderKey,omitempty"` }
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.
type Container_Product_Order_Private_Cloud ¶
type Container_Product_Order_Private_Cloud struct {
Container_Product_Order
}
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to place an order for Private Cloud.
type Container_Product_Order_Property ¶
type Container_Product_Order_Property struct { Entity // The property name Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // The property value Value *string `json:"value,omitempty" xmlrpc:"value,omitempty"` }
This is used for storing various items about the order. Currently used for storing additional raid information when ordering servers. This is optional
type Container_Product_Order_Receipt ¶
type Container_Product_Order_Receipt struct { Entity // This URL refers to the location where you will visit to complete the payment authorization for an external service, such as PayPal. This property is associated with <code>externalPaymentToken</code> and will only be populated when purchasing products with an external service. // // 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. ExternalPaymentCheckoutUrl *string `json:"externalPaymentCheckoutUrl,omitempty" xmlrpc:"externalPaymentCheckoutUrl,omitempty"` // This token refers to the identifier for the external payment authorization. This token is associated with the <code>externalPaymentCheckoutUrl</code> and is only populated when purchasing products with an external service like PayPal. ExternalPaymentToken *string `json:"externalPaymentToken,omitempty" xmlrpc:"externalPaymentToken,omitempty"` // The date when SoftLayer received the order. OrderDate *Time `json:"orderDate,omitempty" xmlrpc:"orderDate,omitempty"` // 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. OrderDetails *Container_Product_Order `json:"orderDetails,omitempty" xmlrpc:"orderDetails,omitempty"` // SoftLayer's unique identifier for the order. OrderId *int `json:"orderId,omitempty" xmlrpc:"orderId,omitempty"` // Deprecation notice: use <code>externalPaymentCheckoutUrl</code> instead of this property. // // This URL refers to the location where you will visit to complete the payment authorization for PayPal. This property is associated with <code>paypalToken</code> and will only be populated when purchasing products with PayPal. // // 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. PaypalCheckoutUrl *string `json:"paypalCheckoutUrl,omitempty" xmlrpc:"paypalCheckoutUrl,omitempty"` // Deprecation notice: use <code>externalPaymentToken</code> instead of this property. // // This token refers to the identifier provided when payment is processed via PayPal. This token is associated with the <code>paypalCheckoutUrl</code>. PaypalToken *string `json:"paypalToken,omitempty" xmlrpc:"paypalToken,omitempty"` // This is a copy of the order that was successfully placed (SoftLayer_Billing_Order). This will only return when an order is processed successfully. PlacedOrder *Billing_Order `json:"placedOrder,omitempty" xmlrpc:"placedOrder,omitempty"` // 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. Quote *Billing_Order_Quote `json:"quote,omitempty" xmlrpc:"quote,omitempty"` }
When an order is placed (SoftLayer_Product_Order::placeOrder), a receipt is returned when the order is created successfully. The information in the receipt helps explain information about the order. It's order ID, and all the data within the order as well.
For PayPal Orders, an URL is also returned to the user so that the user can complete the transaction. Users paying with PayPal must continue on to this URL, login and pay. When doing this, PayPal will redirect the user back to a SoftLayer page which will then "finalize" the authorization process. From here, Sales will verify the order by contacting the user in some way, unless sales has already spoken to the user about approving the order.
For users paying with a credit card, a receipt means the order has gone to sales and is awaiting approval.
type Container_Product_Order_Security_Certificate ¶
type Container_Product_Order_Security_Certificate struct { Container_Product_Order // 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. AdministrativeContact *Container_Product_Order_Attribute_Contact `json:"administrativeContact,omitempty" xmlrpc:"administrativeContact,omitempty"` // 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. BillingContact *Container_Product_Order_Attribute_Contact `json:"billingContact,omitempty" xmlrpc:"billingContact,omitempty"` // 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. CertificateSigningRequest *string `json:"certificateSigningRequest,omitempty" xmlrpc:"certificateSigningRequest,omitempty"` // The email address that can approve a secure certificate order. OrderApproverEmailAddress *string `json:"orderApproverEmailAddress,omitempty" xmlrpc:"orderApproverEmailAddress,omitempty"` // The organization information associated with a SSL certificate. OrganizationInformation *Container_Product_Order_Attribute_Organization `json:"organizationInformation,omitempty" xmlrpc:"organizationInformation,omitempty"` // Indicates if it is an renewal order of an existing SSL certificate. RenewalFlag *bool `json:"renewalFlag,omitempty" xmlrpc:"renewalFlag,omitempty"` // (DEPRECATED) Do not set this property, as it will always be set to 1. // Deprecated: This function has been marked as deprecated. ServerCount *int `json:"serverCount,omitempty" xmlrpc:"serverCount,omitempty"` // The server type. This is the name from a [[SoftLayer_Security_Certificate_Request_ServerType]] object. ServerType *string `json:"serverType,omitempty" xmlrpc:"serverType,omitempty"` // The technical contact associated with a SSL certificate. If the address is not provided the organization information address will be used. TechnicalContact *Container_Product_Order_Attribute_Contact `json:"technicalContact,omitempty" xmlrpc:"technicalContact,omitempty"` // (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. ValidityMonths *int `json:"validityMonths,omitempty" xmlrpc:"validityMonths,omitempty"` }
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.
type Container_Product_Order_Service ¶
type Container_Product_Order_Service struct {
Container_Product_Order
}
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder.
type Container_Product_Order_Service_External ¶
type Container_Product_Order_Service_External struct { Container_Product_Order // 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 <code>hostname</code> and <code>domain</code> 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 <code>virtualGuests</code> property. ExternalResources []Service_External_Resource `json:"externalResources,omitempty" xmlrpc:"externalResources,omitempty"` }
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder.
type Container_Product_Order_Software_Component_Virtual ¶
type Container_Product_Order_Software_Component_Virtual struct { Container_Product_Order // array of ip address ids for which a license should be allocated for. EndPointIpAddressIds []int `json:"endPointIpAddressIds,omitempty" xmlrpc:"endPointIpAddressIds,omitempty"` }
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.
type Container_Product_Order_Software_License ¶
type Container_Product_Order_Software_License struct {
Container_Product_Order
}
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to place a hardware security module order with SoftLayer.
type Container_Product_Order_SshKeys ¶
type Container_Product_Order_SshKeys struct { Entity // An array of SoftLayer_Security_Ssh_Key IDs to assign to a server. SshKeyIds []int `json:"sshKeyIds,omitempty" xmlrpc:"sshKeyIds,omitempty"` }
This object holds all of the ssh key ids that will allow authentication to a single server.
type Container_Product_Order_Storage_Group ¶
type Container_Product_Order_Storage_Group struct { Entity // Size of the array in gigabytes. Must be within limitations of the smallest drive assigned to the storage group and the storage group type. ArraySize *Float64 `json:"arraySize,omitempty" xmlrpc:"arraySize,omitempty"` // The array type id from a [[SoftLayer_Configuration_Storage_Group_Array_Type]] object. ArrayTypeId *int `json:"arrayTypeId,omitempty" xmlrpc:"arrayTypeId,omitempty"` // Defines the disk controller to put the storage group and the hard drives on. // // This must match a disk controller price on the order. The disk controller index is 0-indexed. 'disk_controller' = 0 'disk_controller1' = 1 'disk_controller2' = 2 DiskControllerIndex *int `json:"diskControllerIndex,omitempty" xmlrpc:"diskControllerIndex,omitempty"` // String array of category codes for drives to use in the storage group as an alternative to their index positions. // // This must be specified if ordering a storage group with PCIe drives. HardDriveCategoryCodes []string `json:"hardDriveCategoryCodes,omitempty" xmlrpc:"hardDriveCategoryCodes,omitempty"` // Integer array of drive indexes to use in the storage group. HardDrives []int `json:"hardDrives,omitempty" xmlrpc:"hardDrives,omitempty"` // 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 HotSpareDrives []int `json:"hotSpareDrives,omitempty" xmlrpc:"hotSpareDrives,omitempty"` // << EOT LvmFlag *bool `json:"lvmFlag,omitempty" xmlrpc:"lvmFlag,omitempty"` // 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. PartitionTemplateId *int `json:"partitionTemplateId,omitempty" xmlrpc:"partitionTemplateId,omitempty"` // Defines the partitions for the storage group. // // If this storage group is not a secondary storage group, then this will not be used. Partitions []Container_Product_Order_Storage_Group_Partition `json:"partitions,omitempty" xmlrpc:"partitions,omitempty"` }
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.
type Container_Product_Order_Storage_Group_Partition ¶
type Container_Product_Order_Storage_Group_Partition struct { Entity // Is this a grow partition IsGrow *bool `json:"isGrow,omitempty" xmlrpc:"isGrow,omitempty"` // The name of this partition Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // The size of this partition Size *Float64 `json:"size,omitempty" xmlrpc:"size,omitempty"` }
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.
type Container_Product_Order_Support ¶
type Container_Product_Order_Support struct {
Container_Product_Order
}
When ordering paid support this datatype needs to be populated and sent to SoftLayer_Product_Order::placeOrder.
type Container_Product_Order_User_Customer_External_Binding ¶
type Container_Product_Order_User_Customer_External_Binding struct { Container_Product_Order // The external id that access to external authentication is being purchased for. ExternalId *string `json:"externalId,omitempty" xmlrpc:"externalId,omitempty"` // The SoftLayer [[SoftLayer_User_Customer|user]] identifier that an external binding is being purchased for. UserId *int `json:"userId,omitempty" xmlrpc:"userId,omitempty"` // The [[SoftLayer_User_Customer_External_Binding_Vendor|vendor]] identifier for the external binding being purchased. VendorId *int `json:"vendorId,omitempty" xmlrpc:"vendorId,omitempty"` }
This container type is used for placing orders for external authentication, such as phone-based authentication.
type Container_Product_Order_Virtual_DedicatedHost ¶
type Container_Product_Order_Virtual_DedicatedHost struct {
Container_Product_Order
}
This is the default container type for Dedicated Virtual Host orders.
type Container_Product_Order_Virtual_Disk_Image ¶
type Container_Product_Order_Virtual_Disk_Image struct { Container_Product_Order // Label for the portable storage volume. DiskDescription *string `json:"diskDescription,omitempty" xmlrpc:"diskDescription,omitempty"` }
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.
type Container_Product_Order_Virtual_Guest ¶
type Container_Product_Order_Virtual_Guest struct { Container_Product_Order_Hardware_Server // The mode used to boot the [[SoftLayer_Virtual_Guest]]. Supported values are 'PV' and 'HVM'. BootMode *string `json:"bootMode,omitempty" xmlrpc:"bootMode,omitempty"` // Identifier of the [[SoftLayer_Virtual_Disk_Image]] to boot from. BootableDiskId *int `json:"bootableDiskId,omitempty" xmlrpc:"bootableDiskId,omitempty"` // Identifier of [[SoftLayer_Virtual_DedicatedHost]] to order HostId *int `json:"hostId,omitempty" xmlrpc:"hostId,omitempty"` // Identifier of [[SoftLayer_Virtual_ReservedCapacityGroup]] to order ReservedCapacityId *int `json:"reservedCapacityId,omitempty" xmlrpc:"reservedCapacityId,omitempty"` }
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.
type Container_Product_Order_Virtual_Guest_Upgrade ¶
type Container_Product_Order_Virtual_Guest_Upgrade struct {
Container_Product_Order_Virtual_Guest
}
This is the datatype that needs to be populated and sent to SoftLayer_Product_Order::placeOrder. This datatype has everything required to place an order with SoftLayer.
type Container_Product_Order_Virtual_Guest_Vpc ¶
type Container_Product_Order_Virtual_Guest_Vpc struct { Container_Product_Order_Virtual_Guest // no documentation yet AdditionalNetworkInterfaces []Container_Product_Order_Virtual_Guest_Vpc_NetworkInterface `json:"additionalNetworkInterfaces,omitempty" xmlrpc:"additionalNetworkInterfaces,omitempty"` // no documentation yet Crn *string `json:"crn,omitempty" xmlrpc:"crn,omitempty"` // no documentation yet InstanceProfile *string `json:"instanceProfile,omitempty" xmlrpc:"instanceProfile,omitempty"` // no documentation yet IpAllocations []Container_Product_Order_Vpc_IpAllocation `json:"ipAllocations,omitempty" xmlrpc:"ipAllocations,omitempty"` // no documentation yet OverlayNetworkFlag *bool `json:"overlayNetworkFlag,omitempty" xmlrpc:"overlayNetworkFlag,omitempty"` // no documentation yet ResourceGroup *string `json:"resourceGroup,omitempty" xmlrpc:"resourceGroup,omitempty"` // no documentation yet ServerId *string `json:"serverId,omitempty" xmlrpc:"serverId,omitempty"` // no documentation yet ServicePortCidr *string `json:"servicePortCidr,omitempty" xmlrpc:"servicePortCidr,omitempty"` // no documentation yet ServicePortDns []string `json:"servicePortDns,omitempty" xmlrpc:"servicePortDns,omitempty"` // no documentation yet ServicePortGateway *string `json:"servicePortGateway,omitempty" xmlrpc:"servicePortGateway,omitempty"` // no documentation yet ServicePortInterfaceId *string `json:"servicePortInterfaceId,omitempty" xmlrpc:"servicePortInterfaceId,omitempty"` // no documentation yet ServicePortIpAddress *string `json:"servicePortIpAddress,omitempty" xmlrpc:"servicePortIpAddress,omitempty"` // no documentation yet ServicePortIpAllocationId *string `json:"servicePortIpAllocationId,omitempty" xmlrpc:"servicePortIpAllocationId,omitempty"` // no documentation yet ServicePortVpcId *string `json:"servicePortVpcId,omitempty" xmlrpc:"servicePortVpcId,omitempty"` // no documentation yet StorageVolumes []Container_Product_Order_Virtual_Guest_Vpc_StorageVolume `json:"storageVolumes,omitempty" xmlrpc:"storageVolumes,omitempty"` // no documentation yet Subnets []Container_Product_Order_Vpc_Subnet `json:"subnets,omitempty" xmlrpc:"subnets,omitempty"` // no documentation yet Zone *string `json:"zone,omitempty" xmlrpc:"zone,omitempty"` }
no documentation yet
type Container_Product_Order_Virtual_Guest_Vpc_NetworkInterface ¶
type Container_Product_Order_Virtual_Guest_Vpc_NetworkInterface struct { Entity // no documentation yet Cidr *string `json:"cidr,omitempty" xmlrpc:"cidr,omitempty"` // no documentation yet Dns []string `json:"dns,omitempty" xmlrpc:"dns,omitempty"` // no documentation yet Gateway *string `json:"gateway,omitempty" xmlrpc:"gateway,omitempty"` // no documentation yet InterfaceId *string `json:"interfaceId,omitempty" xmlrpc:"interfaceId,omitempty"` // no documentation yet IpAddress *string `json:"ipAddress,omitempty" xmlrpc:"ipAddress,omitempty"` // no documentation yet IpAllocationId *string `json:"ipAllocationId,omitempty" xmlrpc:"ipAllocationId,omitempty"` // no documentation yet SecurityGroupIds []int `json:"securityGroupIds,omitempty" xmlrpc:"securityGroupIds,omitempty"` // no documentation yet SubnetId *string `json:"subnetId,omitempty" xmlrpc:"subnetId,omitempty"` // no documentation yet VpcId *string `json:"vpcId,omitempty" xmlrpc:"vpcId,omitempty"` }
no documentation yet
type Container_Product_Order_Virtual_Guest_Vpc_StorageVolume ¶
type Container_Product_Order_Virtual_Guest_Vpc_StorageVolume struct { Entity // no documentation yet AttachmentName *string `json:"attachmentName,omitempty" xmlrpc:"attachmentName,omitempty"` // no documentation yet Capacity *int `json:"capacity,omitempty" xmlrpc:"capacity,omitempty"` // no documentation yet DeleteOnReclaim *bool `json:"deleteOnReclaim,omitempty" xmlrpc:"deleteOnReclaim,omitempty"` // no documentation yet Id *string `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet Index *int `json:"index,omitempty" xmlrpc:"index,omitempty"` // no documentation yet Iops *int `json:"iops,omitempty" xmlrpc:"iops,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // no documentation yet Profile *string `json:"profile,omitempty" xmlrpc:"profile,omitempty"` // no documentation yet ResourceGroup *string `json:"resourceGroup,omitempty" xmlrpc:"resourceGroup,omitempty"` // no documentation yet RootKeyCrn *string `json:"rootKeyCrn,omitempty" xmlrpc:"rootKeyCrn,omitempty"` }
no documentation yet
type Container_Product_Order_Virtual_Guest_Vpc_Upgrade ¶
type Container_Product_Order_Virtual_Guest_Vpc_Upgrade struct {
Container_Product_Order_Virtual_Guest_Vpc
}
no documentation yet
type Container_Product_Order_Virtual_ReservedCapacity ¶
type Container_Product_Order_Virtual_ReservedCapacity struct { Container_Product_Order // Identifier of [[SoftLayer_Hardware_Router]] on which the capacity will be BackendRouterId *int `json:"backendRouterId,omitempty" xmlrpc:"backendRouterId,omitempty"` // Name for the [[SoftLayer_Virtual_ReservedCapacityGroup]] being ordered. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
This is the default container type for Reserved Capacity orders.
type Container_Product_Order_Vpc_IpAllocation ¶
type Container_Product_Order_Vpc_IpAllocation struct { Entity // no documentation yet Id *string `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet Ip *string `json:"ip,omitempty" xmlrpc:"ip,omitempty"` }
no documentation yet
type Container_Product_Order_Vpc_Subnet ¶
type Container_Product_Order_Vpc_Subnet struct { Entity // no documentation yet Cidr *string `json:"cidr,omitempty" xmlrpc:"cidr,omitempty"` // no documentation yet Dns *string `json:"dns,omitempty" xmlrpc:"dns,omitempty"` // no documentation yet Gateway *string `json:"gateway,omitempty" xmlrpc:"gateway,omitempty"` // no documentation yet Id *string `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet Vlan *int `json:"vlan,omitempty" xmlrpc:"vlan,omitempty"` }
no documentation yet
type Container_Product_Promotion ¶
type Container_Product_Promotion struct { Entity // no documentation yet Code *string `json:"code,omitempty" xmlrpc:"code,omitempty"` // no documentation yet ExpirationDate *Time `json:"expirationDate,omitempty" xmlrpc:"expirationDate,omitempty"` // no documentation yet Locations []Location `json:"locations,omitempty" xmlrpc:"locations,omitempty"` // no documentation yet RequirementGroups []Container_Product_Promotion_RequirementGroup `json:"requirementGroups,omitempty" xmlrpc:"requirementGroups,omitempty"` }
The SoftLayer_Container_Product_Promotion data type contains information about a promotion and its requirements.
type Container_Product_Promotion_RequirementGroup ¶
type Container_Product_Promotion_RequirementGroup struct { Entity // The category options to choose from for this requirement group Categories []Product_Item_Category `json:"categories,omitempty" xmlrpc:"categories,omitempty"` // The preset options to choose from for this requirement group Presets []Product_Package_Preset `json:"presets,omitempty" xmlrpc:"presets,omitempty"` // The price options to choose from for this requirement group Prices []Product_Item_Price `json:"prices,omitempty" xmlrpc:"prices,omitempty"` }
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.
type Container_Provisioning_Maintenance_Window ¶
type Container_Provisioning_Maintenance_Window struct { Entity // Maintenance classifications. ClassificationIds []Provisioning_Maintenance_Classification `json:"classificationIds,omitempty" xmlrpc:"classificationIds,omitempty"` // Maintenance classifications. ItemCategoryIds []Product_Item_Category `json:"itemCategoryIds,omitempty" xmlrpc:"itemCategoryIds,omitempty"` // The maintenance window id MaintenanceWindowId *int `json:"maintenanceWindowId,omitempty" xmlrpc:"maintenanceWindowId,omitempty"` // Maintenance window ticket id TicketId *int `json:"ticketId,omitempty" xmlrpc:"ticketId,omitempty"` // Maintenance window date WindowMaintenanceDate *Time `json:"windowMaintenanceDate,omitempty" xmlrpc:"windowMaintenanceDate,omitempty"` }
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.
type Container_Referral_Partner_Commission ¶
type Container_Referral_Partner_Commission struct { Entity // no documentation yet CommissionAmount *Float64 `json:"commissionAmount,omitempty" xmlrpc:"commissionAmount,omitempty"` // no documentation yet CommissionRate *Float64 `json:"commissionRate,omitempty" xmlrpc:"commissionRate,omitempty"` // no documentation yet CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // no documentation yet ReferralAccountId *int `json:"referralAccountId,omitempty" xmlrpc:"referralAccountId,omitempty"` // no documentation yet ReferralCompanyName *string `json:"referralCompanyName,omitempty" xmlrpc:"referralCompanyName,omitempty"` // no documentation yet ReferralPartnerAccountId *int `json:"referralPartnerAccountId,omitempty" xmlrpc:"referralPartnerAccountId,omitempty"` // no documentation yet ReferralRevenue *Float64 `json:"referralRevenue,omitempty" xmlrpc:"referralRevenue,omitempty"` }
no documentation yet
type Container_Referral_Partner_Payment_Option ¶
type Container_Referral_Partner_Payment_Option struct { Entity // no documentation yet AccountNumber *string `json:"accountNumber,omitempty" xmlrpc:"accountNumber,omitempty"` // no documentation yet AccountType *string `json:"accountType,omitempty" xmlrpc:"accountType,omitempty"` // no documentation yet Address1 *string `json:"address1,omitempty" xmlrpc:"address1,omitempty"` // no documentation yet Address2 *string `json:"address2,omitempty" xmlrpc:"address2,omitempty"` // no documentation yet BankTransitNumber *string `json:"bankTransitNumber,omitempty" xmlrpc:"bankTransitNumber,omitempty"` // no documentation yet City *string `json:"city,omitempty" xmlrpc:"city,omitempty"` // no documentation yet CompanyName *string `json:"companyName,omitempty" xmlrpc:"companyName,omitempty"` // no documentation yet Country *string `json:"country,omitempty" xmlrpc:"country,omitempty"` // no documentation yet FederalTaxId *string `json:"federalTaxId,omitempty" xmlrpc:"federalTaxId,omitempty"` // no documentation yet FirstName *string `json:"firstName,omitempty" xmlrpc:"firstName,omitempty"` // no documentation yet LastName *string `json:"lastName,omitempty" xmlrpc:"lastName,omitempty"` // no documentation yet PaymentType *string `json:"paymentType,omitempty" xmlrpc:"paymentType,omitempty"` // no documentation yet PaypalEmail *string `json:"paypalEmail,omitempty" xmlrpc:"paypalEmail,omitempty"` // no documentation yet PhoneNumber *string `json:"phoneNumber,omitempty" xmlrpc:"phoneNumber,omitempty"` // no documentation yet PostalCode *string `json:"postalCode,omitempty" xmlrpc:"postalCode,omitempty"` // no documentation yet State *string `json:"state,omitempty" xmlrpc:"state,omitempty"` }
no documentation yet
type Container_Referral_Partner_Prospect ¶
type Container_Referral_Partner_Prospect struct { Entity // no documentation yet Address1 *string `json:"address1,omitempty" xmlrpc:"address1,omitempty"` // no documentation yet Address2 *string `json:"address2,omitempty" xmlrpc:"address2,omitempty"` // no documentation yet City *string `json:"city,omitempty" xmlrpc:"city,omitempty"` // no documentation yet CompanyName *string `json:"companyName,omitempty" xmlrpc:"companyName,omitempty"` // no documentation yet Country *string `json:"country,omitempty" xmlrpc:"country,omitempty"` // no documentation yet Email *string `json:"email,omitempty" xmlrpc:"email,omitempty"` // no documentation yet FirstName *string `json:"firstName,omitempty" xmlrpc:"firstName,omitempty"` // no documentation yet LastName *string `json:"lastName,omitempty" xmlrpc:"lastName,omitempty"` // no documentation yet OfficePhone *string `json:"officePhone,omitempty" xmlrpc:"officePhone,omitempty"` // no documentation yet PostalCode *string `json:"postalCode,omitempty" xmlrpc:"postalCode,omitempty"` // no documentation yet Questions []string `json:"questions,omitempty" xmlrpc:"questions,omitempty"` // no documentation yet Responses []Survey_Response `json:"responses,omitempty" xmlrpc:"responses,omitempty"` // no documentation yet State *string `json:"state,omitempty" xmlrpc:"state,omitempty"` // no documentation yet SurveyId *string `json:"surveyId,omitempty" xmlrpc:"surveyId,omitempty"` }
no documentation yet
type Container_RemoteManagement_Graphs_SensorSpeed ¶
type Container_RemoteManagement_Graphs_SensorSpeed struct { Entity // The graph to display the server's fan speed. Graph *[]byte `json:"graph,omitempty" xmlrpc:"graph,omitempty"` // A title that may be used to display for the graph. Title *string `json:"title,omitempty" xmlrpc:"title,omitempty"` }
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.
type Container_RemoteManagement_Graphs_SensorTemperature ¶
type Container_RemoteManagement_Graphs_SensorTemperature struct { Entity // The graph to display the server's cpu(s) and system temperatures. Graph *[]byte `json:"graph,omitempty" xmlrpc:"graph,omitempty"` // A title that may be used to display for the graph. Title *string `json:"title,omitempty" xmlrpc:"title,omitempty"` }
The SoftLayer_Container_RemoteManagement_Graphs_SensorTemperature contains graphs to display the cpu(s) and system temperatures retrieved from the management card using thermometer graphs.
type Container_RemoteManagement_PmInfo ¶
type Container_RemoteManagement_PmInfo struct { Entity // PmInfo ID PmInfoId *string `json:"pmInfoId,omitempty" xmlrpc:"pmInfoId,omitempty"` // PmInfo Reading PmInfoReading *string `json:"pmInfoReading,omitempty" xmlrpc:"pmInfoReading,omitempty"` }
The SoftLayer_Container_RemoteManagement_PmInfo contains pminfo information retrieved from a server's remote management card.
type Container_RemoteManagement_SensorReading ¶
type Container_RemoteManagement_SensorReading struct { Entity // Lower Non-Recoverable threshold LowerCritical *string `json:"lowerCritical,omitempty" xmlrpc:"lowerCritical,omitempty"` // Lower Non-Critical threshold LowerNonCritical *string `json:"lowerNonCritical,omitempty" xmlrpc:"lowerNonCritical,omitempty"` // Lower Non-Recoverable threshold LowerNonRecoverable *string `json:"lowerNonRecoverable,omitempty" xmlrpc:"lowerNonRecoverable,omitempty"` // Sensor ID SensorId *string `json:"sensorId,omitempty" xmlrpc:"sensorId,omitempty"` // Sensor Reading SensorReading *string `json:"sensorReading,omitempty" xmlrpc:"sensorReading,omitempty"` // Sensor Units SensorUnits *string `json:"sensorUnits,omitempty" xmlrpc:"sensorUnits,omitempty"` // Sensor Status Status *string `json:"status,omitempty" xmlrpc:"status,omitempty"` // Upper Critical threshold UpperCritical *string `json:"upperCritical,omitempty" xmlrpc:"upperCritical,omitempty"` // Upper Non-Critical threshold UpperNonCritical *string `json:"upperNonCritical,omitempty" xmlrpc:"upperNonCritical,omitempty"` // Upper Non-Recoverable threshold UpperNonRecoverable *string `json:"upperNonRecoverable,omitempty" xmlrpc:"upperNonRecoverable,omitempty"` }
The SoftLayer_Container_RemoteManagement_SensorReadings contains sensor information retrieved from a server's remote management card.
type Container_RemoteManagement_SensorReadingsWithGraphs ¶
type Container_RemoteManagement_SensorReadingsWithGraphs struct { Entity // The raw data returned from the server's remote management card. RawData []Container_RemoteManagement_SensorReading `json:"rawData,omitempty" xmlrpc:"rawData,omitempty"` // The graph(s) to display the server's fan speeds. SpeedGraphs []Container_RemoteManagement_Graphs_SensorSpeed `json:"speedGraphs,omitempty" xmlrpc:"speedGraphs,omitempty"` // The graph(s) to display the server's cpu(s) and system temperatures. TemperatureGraphs []Container_RemoteManagement_Graphs_SensorTemperature `json:"temperatureGraphs,omitempty" xmlrpc:"temperatureGraphs,omitempty"` }
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.
type Container_Resource_Metadata_ServiceResource ¶
type Container_Resource_Metadata_ServiceResource struct { Entity // The backend IP address for this resource BackendIpAddress *string `json:"backendIpAddress,omitempty" xmlrpc:"backendIpAddress,omitempty"` // The type for this resource Type *Network_Service_Resource_Type `json:"type,omitempty" xmlrpc:"type,omitempty"` }
The metadata service resource container is used to store information about a single service resource.
type Container_Search_ObjectType ¶
type Container_Search_ObjectType struct { Entity // Name of object type. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // A collection of [[SoftLayer_Container_Search_ObjectType_Property|object properties]]. Properties []Container_Search_ObjectType_Property `json:"properties,omitempty" xmlrpc:"properties,omitempty"` }
This data type is a container that stores information about a single indexed object type. Object type information can be used for discovery of searchable data and for creation or validation of object index search strings. Each of these containers holds a collection of <b>[[SoftLayer_Container_Search_ObjectType_Property (type)|SoftLayer_Container_Search_ObjectType_Property]]</b> objects, specifying which object properties are exposed for the current user. Refer to the the documentation for the <b>[[SoftLayer_Search/search|search()]]</b> method for information on using object types in search strings.
type Container_Search_ObjectType_Property ¶
type Container_Search_ObjectType_Property struct { Entity // Name of property. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // Indicates if this property can be sorted. SortableFlag *bool `json:"sortableFlag,omitempty" xmlrpc:"sortableFlag,omitempty"` // Property data type. Valid values include 'boolean', 'integer', 'date', 'string' or 'text'. Type *string `json:"type,omitempty" xmlrpc:"type,omitempty"` }
This data type is a container that stores information about a single property of a searchable object type. Each <b>[[SoftLayer_Container_Search_ObjectType (type)|SoftLayer_Container_Search_ObjectType]]</b> object holds a collection of these properties. Property information can be used for discovery of searchable data and for the creation or validation of object index search strings. Note that properties are only understood by the <b>[[SoftLayer_Search/advancedSearch|advancedSearch()]]</b> method. Refer to the <b>advancedSearch()</b> method for information on using properties in search strings.
type Container_Search_Result ¶
type Container_Search_Result struct { Entity // An array of terms that were matched in the resource object. MatchedTerms []string `json:"matchedTerms,omitempty" xmlrpc:"matchedTerms,omitempty"` // The score ratio of the result for relevance to the search criteria. RelevanceScore *Float64 `json:"relevanceScore,omitempty" xmlrpc:"relevanceScore,omitempty"` // A search results resource object that matched search criteria. Resource interface{} `json:"resource,omitempty" xmlrpc:"resource,omitempty"` // The type of the resource object that matched search criteria. ResourceType *string `json:"resourceType,omitempty" xmlrpc:"resourceType,omitempty"` }
The SoftLayer_Container_Search_Result data type represents a result row from an execution of Search service.
func (*Container_Search_Result) UnmarshalJSON ¶ added in v1.0.5
func (result *Container_Search_Result) UnmarshalJSON(data []byte) error
type Container_Software_Component_HostIps_Policy ¶
type Container_Software_Component_HostIps_Policy struct { Entity // The value of a host ips category. Policy *string `json:"policy,omitempty" xmlrpc:"policy,omitempty"` // The category title of a host ips policy. PolicyTitle *string `json:"policyTitle,omitempty" xmlrpc:"policyTitle,omitempty"` }
The SoftLayer_Container_Software_Component_HostIps_Policy container holds the title and value of a current host ips policy.
type Container_Tax_Cache ¶
type Container_Tax_Cache struct { Entity // The percentage of the final total that should be tax. EffectiveTaxRate *Float64 `json:"effectiveTaxRate,omitempty" xmlrpc:"effectiveTaxRate,omitempty"` // no documentation yet FailureMessage *string `json:"failureMessage,omitempty" xmlrpc:"failureMessage,omitempty"` // The container that holds the four actual tax rates, one for each fee type. Items []Container_Tax_Cache_Item `json:"items,omitempty" xmlrpc:"items,omitempty"` // The status of the tax request. This should be PENDING, FAILED, or COMPLETED. Status *string `json:"status,omitempty" xmlrpc:"status,omitempty"` // The final amount of tax for the order. TotalTaxAmount *Float64 `json:"totalTaxAmount,omitempty" xmlrpc:"totalTaxAmount,omitempty"` }
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.
type Container_Tax_Cache_Item ¶
type Container_Tax_Cache_Item struct { Entity // The category code for the referenced product. CategoryCode *string `json:"categoryCode,omitempty" xmlrpc:"categoryCode,omitempty"` // This hash will match to the hash on an order container. ContainerHash *string `json:"containerHash,omitempty" xmlrpc:"containerHash,omitempty"` // The reference to the price for this order item. ItemPriceId *int `json:"itemPriceId,omitempty" xmlrpc:"itemPriceId,omitempty"` // This is the container containing the individual tax rates. TaxRates *Container_Tax_Rates `json:"taxRates,omitempty" xmlrpc:"taxRates,omitempty"` }
This represents one order item in a tax calculation.
type Container_Tax_Rates ¶
type Container_Tax_Rates struct { Entity // The tax rate associated with the labor fee. LaborTaxRate *Float64 `json:"laborTaxRate,omitempty" xmlrpc:"laborTaxRate,omitempty"` // A reference to a location. LocationId *Float64 `json:"locationId,omitempty" xmlrpc:"locationId,omitempty"` // The tax rate associated with the one-time fee. OneTimeTaxRate *Float64 `json:"oneTimeTaxRate,omitempty" xmlrpc:"oneTimeTaxRate,omitempty"` // The tax rate associated with the recurring fee. RecurringTaxRate *Float64 `json:"recurringTaxRate,omitempty" xmlrpc:"recurringTaxRate,omitempty"` // The tax rate associated with the setup fee. SetupTaxRate *Float64 `json:"setupTaxRate,omitempty" xmlrpc:"setupTaxRate,omitempty"` }
This contains the four tax rates, one for each fee type.
type Container_Ticket_GraphInputs ¶
type Container_Ticket_GraphInputs struct { Entity // This is a unix timestamp that represents the stop date/time for a graph. EndDate *Time `json:"endDate,omitempty" xmlrpc:"endDate,omitempty"` // The front-end or back-end network uplink interface associated with this server. NetworkInterfaceId *int `json:"networkInterfaceId,omitempty" xmlrpc:"networkInterfaceId,omitempty"` // * Pod *int `json:"pod,omitempty" xmlrpc:"pod,omitempty"` // This is a human readable name for the server or rack being graphed. ServerName *string `json:"serverName,omitempty" xmlrpc:"serverName,omitempty"` // This is a unix timestamp that represents the begin date/time for a graph. StartDate *Time `json:"startDate,omitempty" xmlrpc:"startDate,omitempty"` }
SoftLayer_Container_Ticket_GraphInputs models a single inbound object for a given ticket graph.
type Container_Ticket_GraphOutputs ¶
type Container_Ticket_GraphOutputs struct { Entity // The raw PNG binary data to be displayed once the graph is drawn. GraphImage *[]byte `json:"graphImage,omitempty" xmlrpc:"graphImage,omitempty"` // The title that ended up being displayed as part of the graph image. GraphTitle *string `json:"graphTitle,omitempty" xmlrpc:"graphTitle,omitempty"` // The maximum date included in this graph. MaxEndDate *Time `json:"maxEndDate,omitempty" xmlrpc:"maxEndDate,omitempty"` // The minimum date included in this graph. MinStartDate *Time `json:"minStartDate,omitempty" xmlrpc:"minStartDate,omitempty"` }
SoftLayer_Container_Ticket_GraphOutputs models a single outbound object for a given bandwidth graph.
type Container_Ticket_Priority ¶
type Container_Ticket_Priority struct { Entity // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // no documentation yet Value *int `json:"value,omitempty" xmlrpc:"value,omitempty"` }
no documentation yet
type Container_Ticket_Survey_Preference ¶
type Container_Ticket_Survey_Preference struct { Entity // no documentation yet Applicable *bool `json:"applicable,omitempty" xmlrpc:"applicable,omitempty"` // no documentation yet OptedOut *bool `json:"optedOut,omitempty" xmlrpc:"optedOut,omitempty"` // no documentation yet OptedOutDate *Time `json:"optedOutDate,omitempty" xmlrpc:"optedOutDate,omitempty"` }
no documentation yet
type Container_User_Authentication_Token ¶
type Container_User_Authentication_Token struct { Entity // hash that gets populated for user authentication Hash *string `json:"hash,omitempty" xmlrpc:"hash,omitempty"` // the user authenticated object User *User_Customer `json:"user,omitempty" xmlrpc:"user,omitempty"` // the id of the user to authenticate UserId *int `json:"userId,omitempty" xmlrpc:"userId,omitempty"` }
Container class used to hold user authentication token
type Container_User_Customer_External_Binding ¶
type Container_User_Customer_External_Binding struct { Entity // The unique token that is created by an external authentication request. AuthenticationToken *string `json:"authenticationToken,omitempty" xmlrpc:"authenticationToken,omitempty"` // Added by softlayer-go. This hints to the API what kind of binding this is. ComplexType *string `json:"complexType,omitempty" xmlrpc:"complexType,omitempty"` // The OpenID Connect access token which provides access to a resource by the OpenID Connect provider. OpenIdConnectAccessToken *string `json:"openIdConnectAccessToken,omitempty" xmlrpc:"openIdConnectAccessToken,omitempty"` // The account to login to, if not provided a default will be used. OpenIdConnectAccountId *int `json:"openIdConnectAccountId,omitempty" xmlrpc:"openIdConnectAccountId,omitempty"` // The OpenID Connect provider type, as a string. OpenIdConnectProvider *string `json:"openIdConnectProvider,omitempty" xmlrpc:"openIdConnectProvider,omitempty"` // Your SoftLayer customer portal user's portal password. Password *string `json:"password,omitempty" xmlrpc:"password,omitempty"` // A second security code that is only required if your credential has become unsynchronized. SecondSecurityCode *string `json:"secondSecurityCode,omitempty" xmlrpc:"secondSecurityCode,omitempty"` // The security code used to validate a VeriSign credential. SecurityCode *string `json:"securityCode,omitempty" xmlrpc:"securityCode,omitempty"` // The answer to your security question. SecurityQuestionAnswer *string `json:"securityQuestionAnswer,omitempty" xmlrpc:"securityQuestionAnswer,omitempty"` // 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. SecurityQuestionId *int `json:"securityQuestionId,omitempty" xmlrpc:"securityQuestionId,omitempty"` // The username you wish to authenticate to the SoftLayer customer portal with. Username *string `json:"username,omitempty" xmlrpc:"username,omitempty"` // The name of the vendor that will be used for external authentication Vendor *string `json:"vendor,omitempty" xmlrpc:"vendor,omitempty"` }
Container classed used to hold external authentication information
type Container_User_Customer_External_Binding_Totp ¶
type Container_User_Customer_External_Binding_Totp struct { Container_User_Customer_External_Binding // The security code used to validate a Totp credential. SecurityCode *string `json:"securityCode,omitempty" xmlrpc:"securityCode,omitempty"` }
Container classed used to hold portal token
type Container_User_Customer_External_Binding_Vendor ¶
type Container_User_Customer_External_Binding_Vendor struct { Entity // The keyname used to identify an external authentication vendor. KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // The name of an external authentication vendor. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
Container classed used to hold details about an external authentication vendor.
type Container_User_Customer_External_Binding_Verisign ¶
type Container_User_Customer_External_Binding_Verisign struct { Container_User_Customer_External_Binding // A second security code that is only required if your credential has become unsynchronized. SecondSecurityCode *string `json:"secondSecurityCode,omitempty" xmlrpc:"secondSecurityCode,omitempty"` // The security code used to validate a VeriSign credential. SecurityCode *string `json:"securityCode,omitempty" xmlrpc:"securityCode,omitempty"` }
Container classed used to hold portal token
type Container_User_Customer_OpenIdConnect_LoginAccountInfo ¶
type Container_User_Customer_OpenIdConnect_LoginAccountInfo struct { Entity // The customer account's internal identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The company name associated with an account. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
no documentation yet
type Container_User_Customer_OpenIdConnect_MigrationState ¶
type Container_User_Customer_OpenIdConnect_MigrationState struct { Entity // The number of days remaining in the grace period for this user's account to DaysToGracePeriodEnd *int `json:"daysToGracePeriodEnd,omitempty" xmlrpc:"daysToGracePeriodEnd,omitempty"` // Flag for whether the email address inside this SoftLayer_User_Customer object EmailAlreadyUsedForInvitationToAccount *bool `json:"emailAlreadyUsedForInvitationToAccount,omitempty" xmlrpc:"emailAlreadyUsedForInvitationToAccount,omitempty"` // Flag for whether the email address inside this SoftLayer_User_Customer object EmailAlreadyUsedForLinkToAccount *bool `json:"emailAlreadyUsedForLinkToAccount,omitempty" xmlrpc:"emailAlreadyUsedForLinkToAccount,omitempty"` // The IBMid email address where an invitation was sent. ExistingInvitationOpenIdConnectName *string `json:"existingInvitationOpenIdConnectName,omitempty" xmlrpc:"existingInvitationOpenIdConnectName,omitempty"` // Flag for whether the account is OpenIdConnect authenticated or not. IsAccountOpenIdConnectAuthenticated *bool `json:"isAccountOpenIdConnectAuthenticated,omitempty" xmlrpc:"isAccountOpenIdConnectAuthenticated,omitempty"` }
no documentation yet
type Container_User_Customer_PasswordSet ¶
type Container_User_Customer_PasswordSet struct { Entity // Id of SoftLayer_User_Security_Question. AnsweredSecurityQuestionId *int `json:"answeredSecurityQuestionId,omitempty" xmlrpc:"answeredSecurityQuestionId,omitempty"` // The authentication methods required. AuthenticationMethods []int `json:"authenticationMethods,omitempty" xmlrpc:"authenticationMethods,omitempty"` // The number of digits required. DigitCountRequirement *int `json:"digitCountRequirement,omitempty" xmlrpc:"digitCountRequirement,omitempty"` // The password key provided to user in the password set url link sent via email. Key *string `json:"key,omitempty" xmlrpc:"key,omitempty"` // The number of lowercase letters required. LowercaseCountRequirement *int `json:"lowercaseCountRequirement,omitempty" xmlrpc:"lowercaseCountRequirement,omitempty"` // The maximum password length requirement. MaximumPasswordLengthRequirement *int `json:"maximumPasswordLengthRequirement,omitempty" xmlrpc:"maximumPasswordLengthRequirement,omitempty"` // The minimum password length requirement. MinimumPasswordLengthRequirement *int `json:"minimumPasswordLengthRequirement,omitempty" xmlrpc:"minimumPasswordLengthRequirement,omitempty"` // The user's new password. Password *string `json:"password,omitempty" xmlrpc:"password,omitempty"` // Answer to security question provided by the user. SecurityAnswer *string `json:"securityAnswer,omitempty" xmlrpc:"securityAnswer,omitempty"` // Array of SoftLayer_User_Security_Question. SecurityQuestions []User_Security_Question `json:"securityQuestions,omitempty" xmlrpc:"securityQuestions,omitempty"` // The number of special characters required. SpecialCharacterCountRequirement *int `json:"specialCharacterCountRequirement,omitempty" xmlrpc:"specialCharacterCountRequirement,omitempty"` // List of the allowed special characters. SpecialCharactersAllowed *string `json:"specialCharactersAllowed,omitempty" xmlrpc:"specialCharactersAllowed,omitempty"` // The number of uppercase letters required. UppercaseCountRequirement *int `json:"uppercaseCountRequirement,omitempty" xmlrpc:"uppercaseCountRequirement,omitempty"` // The id of the user to authenticate. UserId *int `json:"userId,omitempty" xmlrpc:"userId,omitempty"` }
Container for holding information necessary for the setting and resetting of customer passwords
type Container_User_Customer_Portal_MobileToken ¶
type Container_User_Customer_Portal_MobileToken struct { Container_User_Customer_Portal_Token // True if this user login required an external binding. HasExternalBinding *bool `json:"hasExternalBinding,omitempty" xmlrpc:"hasExternalBinding,omitempty"` }
Container classed used to hold mobile portal token
type Container_User_Customer_Portal_Token ¶
type Container_User_Customer_Portal_Token struct { Entity // hash of logged in user session id Hash *string `json:"hash,omitempty" xmlrpc:"hash,omitempty"` // the logged in user data User *User_Customer `json:"user,omitempty" xmlrpc:"user,omitempty"` // the id of the logged in user UserId *int `json:"userId,omitempty" xmlrpc:"userId,omitempty"` }
Container classed used to hold portal token
type Container_User_Customer_Profile_Event_HyperWarp_ProfileChange ¶
type Container_User_Customer_Profile_Event_HyperWarp_ProfileChange struct { Entity // no documentation yet Account_id *string `json:"account_id,omitempty" xmlrpc:"account_id,omitempty"` // no documentation yet Context *Container_User_Customer_Profile_Event_HyperWarp_ProfileChange_Context `json:"context,omitempty" xmlrpc:"context,omitempty"` // no documentation yet Event_id *string `json:"event_id,omitempty" xmlrpc:"event_id,omitempty"` // no documentation yet Event_properties *Container_User_Customer_Profile_Event_HyperWarp_ProfileChange_EventProperties `json:"event_properties,omitempty" xmlrpc:"event_properties,omitempty"` // no documentation yet Event_type *string `json:"event_type,omitempty" xmlrpc:"event_type,omitempty"` // no documentation yet Publisher *string `json:"publisher,omitempty" xmlrpc:"publisher,omitempty"` // no documentation yet Timestamp *string `json:"timestamp,omitempty" xmlrpc:"timestamp,omitempty"` // no documentation yet Version *string `json:"version,omitempty" xmlrpc:"version,omitempty"` }
no documentation yet
type Container_User_Customer_Profile_Event_HyperWarp_ProfileChange_Context ¶
type Container_User_Customer_Profile_Event_HyperWarp_ProfileChange_Context struct { Entity // no documentation yet Previous_values *Container_User_Customer_Profile_Event_HyperWarp_ProfileChange_EventProperties `json:"previous_values,omitempty" xmlrpc:"previous_values,omitempty"` }
no documentation yet
type Container_User_Customer_Profile_Event_HyperWarp_ProfileChange_EventProperties ¶
type Container_User_Customer_Profile_Event_HyperWarp_ProfileChange_EventProperties struct { Entity // no documentation yet Allowed_ip_addresses *string `json:"allowed_ip_addresses,omitempty" xmlrpc:"allowed_ip_addresses,omitempty"` // no documentation yet Altphonenumber *string `json:"altphonenumber,omitempty" xmlrpc:"altphonenumber,omitempty"` // no documentation yet Email *string `json:"email,omitempty" xmlrpc:"email,omitempty"` // no documentation yet Firstname *string `json:"firstname,omitempty" xmlrpc:"firstname,omitempty"` // no documentation yet Iam_id *string `json:"iam_id,omitempty" xmlrpc:"iam_id,omitempty"` // no documentation yet Language *string `json:"language,omitempty" xmlrpc:"language,omitempty"` // no documentation yet Lastname *string `json:"lastname,omitempty" xmlrpc:"lastname,omitempty"` // no documentation yet Notification_language *string `json:"notification_language,omitempty" xmlrpc:"notification_language,omitempty"` // no documentation yet Origin *string `json:"origin,omitempty" xmlrpc:"origin,omitempty"` // no documentation yet Phonenumber *string `json:"phonenumber,omitempty" xmlrpc:"phonenumber,omitempty"` // no documentation yet Photo *string `json:"photo,omitempty" xmlrpc:"photo,omitempty"` // no documentation yet Realm *string `json:"realm,omitempty" xmlrpc:"realm,omitempty"` // no documentation yet Self_manage *bool `json:"self_manage,omitempty" xmlrpc:"self_manage,omitempty"` // no documentation yet State *string `json:"state,omitempty" xmlrpc:"state,omitempty"` // no documentation yet Substate *string `json:"substate,omitempty" xmlrpc:"substate,omitempty"` // no documentation yet User_id *string `json:"user_id,omitempty" xmlrpc:"user_id,omitempty"` }
no documentation yet
type Container_User_Employee_External_Binding_Verisign ¶
type Container_User_Employee_External_Binding_Verisign struct {
Entity
}
Container classed used to hold portal token
type Container_Utility_File_Attachment ¶
type Container_Utility_File_Attachment struct { Entity // The contents of a file that is uploaded to the SoftLayer API. Data *[]byte `json:"data,omitempty" xmlrpc:"data,omitempty"` // The name of a file that is uploaded to the SoftLayer API. Filename *string `json:"filename,omitempty" xmlrpc:"filename,omitempty"` }
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.
type Container_Utility_File_Entity ¶
type Container_Utility_File_Entity struct { Entity // A file entity's raw content. Content *[]byte `json:"content,omitempty" xmlrpc:"content,omitempty"` // A file entity's MIME content type. ContentType *string `json:"contentType,omitempty" xmlrpc:"contentType,omitempty"` // The date a file entity was created. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // 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. DeleteDate *Time `json:"deleteDate,omitempty" xmlrpc:"deleteDate,omitempty"` // Unique identifier for the file. This can be either a number or guid. Id *string `json:"id,omitempty" xmlrpc:"id,omitempty"` IsShared *int `json:"isShared,omitempty" xmlrpc:"isShared,omitempty"` // The date a file entity was last changed. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // A file entity's name. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // 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. Owner *string `json:"owner,omitempty" xmlrpc:"owner,omitempty"` // The size of a file entity in bytes. Size *uint `json:"size,omitempty" xmlrpc:"size,omitempty"` // A CloudLayer storage file entity's type. Types can include "file", "folder", "dir", and "project". Type *string `json:"type,omitempty" xmlrpc:"type,omitempty"` // The latest revision of a file on a CloudLayer storage volume. This number increments each time a new revision of the file is uploaded. Version *int `json:"version,omitempty" xmlrpc:"version,omitempty"` }
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.
type Container_Utility_Message ¶
type Container_Utility_Message struct { Entity // no documentation yet CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet Message *string `json:"message,omitempty" xmlrpc:"message,omitempty"` // no documentation yet ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // no documentation yet Summary *string `json:"summary,omitempty" xmlrpc:"summary,omitempty"` }
no documentation yet
type Container_Utility_Microsoft_Windows_UpdateServices_Status ¶
type Container_Utility_Microsoft_Windows_UpdateServices_Status struct { Entity // The last time a server rebooted due to a Windows Update. LastRebootDate *Time `json:"lastRebootDate,omitempty" xmlrpc:"lastRebootDate,omitempty"` // The last time that SoftLayer's local WSUS server received a status update from a customer server. LastStatusDate *Time `json:"lastStatusDate,omitempty" xmlrpc:"lastStatusDate,omitempty"` // The last time a server synchronized with SoftLayer's local WSUS server. LastSyncDate *Time `json:"lastSyncDate,omitempty" xmlrpc:"lastSyncDate,omitempty"` // This is the private IP address for this server. PrivateIPAddress *string `json:"privateIPAddress,omitempty" xmlrpc:"privateIPAddress,omitempty"` // The status message returned from a server's last synchronization with SoftLayer's local WSUS server. SyncStatus *string `json:"syncStatus,omitempty" xmlrpc:"syncStatus,omitempty"` // A server's update status, as retrieved form SoftLayer's local WSUS server. UpdateStatus *string `json:"updateStatus,omitempty" xmlrpc:"updateStatus,omitempty"` }
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.
type Container_Utility_Microsoft_Windows_UpdateServices_UpdateItem ¶
type Container_Utility_Microsoft_Windows_UpdateServices_UpdateItem struct { Entity // A short description of a Microsoft Windows Update. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // Flag indicating that this patch failed to properly install Failed *bool `json:"failed,omitempty" xmlrpc:"failed,omitempty"` // A Windows Update's knowledge base article number. Every Windows Update can be referenced on the Microsoft Help and Support site at the URL <nowiki>http://support.microsoft.com/kb/<article number></nowiki>. KbArticleNumber *int `json:"kbArticleNumber,omitempty" xmlrpc:"kbArticleNumber,omitempty"` // Flag indicating that the update is entirely optionals Optional *bool `json:"optional,omitempty" xmlrpc:"optional,omitempty"` // Flag indicating that a reboot is needed for this update to be fully applied RequiresReboot *bool `json:"requiresReboot,omitempty" xmlrpc:"requiresReboot,omitempty"` }
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.
type Container_Utility_Network_Firewall_Rule_Attribute ¶
type Container_Utility_Network_Firewall_Rule_Attribute struct { Entity // The valid actions for use with rules. Actions []string `json:"actions,omitempty" xmlrpc:"actions,omitempty"` // Maximum allowed number of rules. MaximumRuleCount *int `json:"maximumRuleCount,omitempty" xmlrpc:"maximumRuleCount,omitempty"` // The valid protocols for use with rules. Protocols []string `json:"protocols,omitempty" xmlrpc:"protocols,omitempty"` // The valid source ip subnet masks for use with rules. SourceIpSubnetMasks []Container_Utility_Network_Subnet_Mask_Generic_Detail `json:"sourceIpSubnetMasks,omitempty" xmlrpc:"sourceIpSubnetMasks,omitempty"` }
The SoftLayer_Container_Utility_Network_Firewall_Rule_Attribute data type contains information relating to a single firewall rule.
type Container_Utility_Network_Subnet_Mask_Generic_Detail ¶
type Container_Utility_Network_Subnet_Mask_Generic_Detail struct { Entity // The subnet cidr prefix. Cidr *string `json:"cidr,omitempty" xmlrpc:"cidr,omitempty"` // The subnet mask description. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // The subnet mask. Mask *string `json:"mask,omitempty" xmlrpc:"mask,omitempty"` }
The SoftLayer_Container_Utility_Network_Subnet_Mask_Generic_Detail data type contains information relating to a subnet mask and details associated with that object.
type Container_Virtual_ConsoleData ¶ added in v1.0.4
type Container_Virtual_ConsoleData struct { Entity // The websocket host address used to access the console WebsocketHost *string `json:"websocketHost,omitempty" xmlrpc:"websocketHost,omitempty"` // The path to the websocket WebsocketPath *string `json:"websocketPath,omitempty" xmlrpc:"websocketPath,omitempty"` // The websocket port used to access the console WebsocketPort *string `json:"websocketPort,omitempty" xmlrpc:"websocketPort,omitempty"` // The token used to authenticate with the console websocket WebsocketToken *string `json:"websocketToken,omitempty" xmlrpc:"websocketToken,omitempty"` }
The SoftLayer_Container_Virtual_ConsoleData data type contains information used to access a VSIs console
type Container_Virtual_DedicatedHost_AllocationStatus ¶
type Container_Virtual_DedicatedHost_AllocationStatus struct { Entity // Number of allocated CPU cores on the specified dedicated host. CpuAllocated *int `json:"cpuAllocated,omitempty" xmlrpc:"cpuAllocated,omitempty"` // Number of available CPU cores on the specified dedicated host. CpuAvailable *int `json:"cpuAvailable,omitempty" xmlrpc:"cpuAvailable,omitempty"` // Total number of CPU cores on the dedicated host. CpuCount *int `json:"cpuCount,omitempty" xmlrpc:"cpuCount,omitempty"` // Amount of allocated disk space on the specified dedicated host. DiskAllocated *int `json:"diskAllocated,omitempty" xmlrpc:"diskAllocated,omitempty"` // Amount of available disk space on the specified dedicated host. DiskAvailable *int `json:"diskAvailable,omitempty" xmlrpc:"diskAvailable,omitempty"` // Total amount of disk capacity on the dedicated host. DiskCapacity *int `json:"diskCapacity,omitempty" xmlrpc:"diskCapacity,omitempty"` // Number of allocated guests on the specified dedicated host. GuestCount *int `json:"guestCount,omitempty" xmlrpc:"guestCount,omitempty"` // Amount of allocated memory on the specified dedicated host. MemoryAllocated *int `json:"memoryAllocated,omitempty" xmlrpc:"memoryAllocated,omitempty"` // Amount of available memory on the specified dedicated host. MemoryAvailable *int `json:"memoryAvailable,omitempty" xmlrpc:"memoryAvailable,omitempty"` // Total amount of memory capacity on the dedicated host. MemoryCapacity *int `json:"memoryCapacity,omitempty" xmlrpc:"memoryCapacity,omitempty"` }
This data type represents the structure to hold the allocation properties of a [[SoftLayer_Virtual_DedicatedHost]].
type Container_Virtual_DedicatedHost_Pci_Device_AllocationStatus ¶
type Container_Virtual_DedicatedHost_Pci_Device_AllocationStatus struct { Entity // The number of PCI devices on the host. DeviceCount *int `json:"deviceCount,omitempty" xmlrpc:"deviceCount,omitempty"` // The name of the PCI devices on the host. DeviceName *string `json:"deviceName,omitempty" xmlrpc:"deviceName,omitempty"` // The number of PCI devices currently allocated to guests. DevicesAllocated *int `json:"devicesAllocated,omitempty" xmlrpc:"devicesAllocated,omitempty"` // The number of PCI devices available for allocation. DevicesAvailable *int `json:"devicesAvailable,omitempty" xmlrpc:"devicesAvailable,omitempty"` // The generic component model ID of the PCI device. HardwareComponentModelGenericId *int `json:"hardwareComponentModelGenericId,omitempty" xmlrpc:"hardwareComponentModelGenericId,omitempty"` // The ID of the host that the dedicated host is on. HostId *int `json:"hostId,omitempty" xmlrpc:"hostId,omitempty"` }
This data type represents PCI device allocation properties of a [[SoftLayer_Virtual_DedicatedHost]].
type Container_Virtual_Guest_Block_Device_Template_Configuration ¶
type Container_Virtual_Guest_Block_Device_Template_Configuration struct { Entity // // Optional virtualization boot mode parameter, if set, can mark a template to boot specifically into PV or HVM. BootMode *string `json:"bootMode,omitempty" xmlrpc:"bootMode,omitempty"` // // Specifies if image is using a customer's software license. Byol *bool `json:"byol,omitempty" xmlrpc:"byol,omitempty"` // // Specifies if image requires cloud-init. CloudInit *bool `json:"cloudInit,omitempty" xmlrpc:"cloudInit,omitempty"` // // CRN to customer root key CrkCrn *string `json:"crkCrn,omitempty" xmlrpc:"crkCrn,omitempty"` // // For future use; not currently defined. EnvironmentType []string `json:"environmentType,omitempty" xmlrpc:"environmentType,omitempty"` // // IBM Cloud HMAC Access Key IbmAccessKey *string `json:"ibmAccessKey,omitempty" xmlrpc:"ibmAccessKey,omitempty"` // // IBM Cloud (Bluemix) API Key IbmApiKey *string `json:"ibmApiKey,omitempty" xmlrpc:"ibmApiKey,omitempty"` // // IBM HMAC Secret Key IbmSecretKey *string `json:"ibmSecretKey,omitempty" xmlrpc:"ibmSecretKey,omitempty"` // // Specifies if image is encrypted or not. IsEncrypted *bool `json:"isEncrypted,omitempty" xmlrpc:"isEncrypted,omitempty"` // The group name to be applied to the imported template Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // The note to be applied to the imported template Note *string `json:"note,omitempty" xmlrpc:"note,omitempty"` // // The referenceCode of the operating system software description for the imported VHD OperatingSystemReferenceCode *string `json:"operatingSystemReferenceCode,omitempty" xmlrpc:"operatingSystemReferenceCode,omitempty"` // // Name of the IBM Key Protect Key Name. Required if using an encrypted image. RootKeyId *string `json:"rootKeyId,omitempty" xmlrpc:"rootKeyId,omitempty"` // // Optional Collection of modes that this template supports booting into. SupportedBootModes []string `json:"supportedBootModes,omitempty" xmlrpc:"supportedBootModes,omitempty"` // // The URI for an object storage object (.vhd/.iso file) // <code>swift://<ObjectStorageAccountName>@<clusterName>/<containerName>/<fileName.(vhd|iso)></code> Uri *string `json:"uri,omitempty" xmlrpc:"uri,omitempty"` // // Wrapped Decryption Key provided by IBM Key Protect WrappedDek *string `json:"wrappedDek,omitempty" xmlrpc:"wrappedDek,omitempty"` }
The SoftLayer_Container_Virtual_Guest_Block_Device_Template_Configuration data type contains information relating to a template's external location for importing and exporting
type Container_Virtual_Guest_Block_Device_Template_Group_RiasAccount ¶ added in v1.0.2
type Container_Virtual_Guest_Block_Device_Template_Group_RiasAccount struct { Entity // no documentation yet AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // no documentation yet MasterUserId *int `json:"masterUserId,omitempty" xmlrpc:"masterUserId,omitempty"` // no documentation yet Token *string `json:"token,omitempty" xmlrpc:"token,omitempty"` }
no documentation yet
type Container_Virtual_Guest_Configuration ¶
type Container_Virtual_Guest_Configuration struct { Entity // // <div style="width: 200%"> // Available block device options. // // // A computing instance will have at least one block device represented by a <code>device</code> number of <code>'0'</code>. // // // The <code>blockDevices.device</code> value in the template represents which device the option is for. // The <code>blockDevices.diskImage.capacity</code> value in the template represents the size, in gigabytes, of the disk. // The <code>localDiskFlag</code> value in the template represents whether the option is a local or SAN based disk. // // // Note: The block device number <code>'1'</code> is reserved for the SWAP disk attached to the computing instance. // </div> BlockDevices []Container_Virtual_Guest_Configuration_Option `json:"blockDevices,omitempty" xmlrpc:"blockDevices,omitempty"` // // <div style="width: 200%"> // Available datacenter options. // // // The <code>datacenter.name</code> value in the template represents which datacenter the computing instance will be provisioned in. // </div> Datacenters []Container_Virtual_Guest_Configuration_Option `json:"datacenters,omitempty" xmlrpc:"datacenters,omitempty"` // // <div style="width: 200%"> // // // Available flavor options. // // // The <code>supplementalCreateObjectOptions.flavorKeyName</code> value in the template is an identifier for a particular core, ram, and primary disk configuration. // // // When providing a <code>supplementalCreateObjectOptions.flavorKeyName</code> option the core, ram, and primary disk options are not needed. If those options are provided they are validated against the flavor. // </div> Flavors []Container_Virtual_Guest_Configuration_Option `json:"flavors,omitempty" xmlrpc:"flavors,omitempty"` // // <div style="width: 200%"> // Available memory options. // // // The <code>maxMemory</code> value in the template represents the amount of memory, in megabytes, allocated to the computing instance. // </div> Memory []Container_Virtual_Guest_Configuration_Option `json:"memory,omitempty" xmlrpc:"memory,omitempty"` // // <div style="width: 200%"> // Available network component options. // // // The <code>networkComponent.maxSpeed</code> value in the template represents the link speed, in megabits per second, of the network connections for a computing instance. // </div> NetworkComponents []Container_Virtual_Guest_Configuration_Option `json:"networkComponents,omitempty" xmlrpc:"networkComponents,omitempty"` // // <div style="width: 200%"> // Available operating system options. // // // The <code>operatingSystemReferenceCode</code> value in the template is an identifier for a particular operating system. When provided exactly as shown in the template, that operating system will be used. // // // 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 OS is 32 or 64bit. // // // When providing an <code>operatingSystemReferenceCode</code> while ordering a computing instance the only token required to match exactly is the product. The version token may be given as 'LATEST', else it will require an exact match as well. When the bits token is not provided, 64 bits will be assumed. // // // Providing the value of 'LATEST' for a version will select the latest release of that product for the operating system. As this may change over time, you should be sure that the release version is irrelevant for your applications. // // // 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 not represented in a reference code. // // // <b>Notice</b> - Some operating systems are charged based on the value specified in <code>startCpus</code>. The price which is used can be determined by calling [[SoftLayer_Virtual_Guest/generateOrderTemplate|generateOrderTemplate]] with your desired device specifications. // </div> OperatingSystems []Container_Virtual_Guest_Configuration_Option `json:"operatingSystems,omitempty" xmlrpc:"operatingSystems,omitempty"` // // <div style="width: 200%"> // Available processor options. // // // The <code>startCpus</code> value in the template represents the number of cores allocated to the computing instance. // The <code>dedicatedAccountHostOnlyFlag</code> value in the template represents whether the instance will run on hosts with instances belonging to other accounts. // </div> Processors []Container_Virtual_Guest_Configuration_Option `json:"processors,omitempty" xmlrpc:"processors,omitempty"` }
The guest configuration container is used to provide configuration options for creating computing instances.
Each configuration option will include both an <code>itemPrice</code> and a <code>template</code>.
The <code>itemPrice</code> value will provide hourly and monthly costs (if either are applicable), and a description of the option.
The <code>template</code> will provide a fragment of the request with the properties and values that must be sent when creating a computing instance with the option.
The [[SoftLayer_Virtual_Guest/getCreateObjectOptions|getCreateObjectOptions]] method returns this data structure.
<style type="text/css">#properties .views-field-body p { margin-top: 1.5em; };</style>
type Container_Virtual_Guest_Configuration_Option ¶
type Container_Virtual_Guest_Configuration_Option struct { Entity // // Provides a description of a pre-defined configuration with monthly and hourly costs. Flavor *Product_Package_Preset `json:"flavor,omitempty" xmlrpc:"flavor,omitempty"` // // Provides hourly and monthly costs (if either are applicable), and a description of the option. ItemPrice *Product_Item_Price `json:"itemPrice,omitempty" xmlrpc:"itemPrice,omitempty"` // // Provides a fragment of the request with the properties and values that must be sent when creating a computing instance with the option. Template *Virtual_Guest `json:"template,omitempty" xmlrpc:"template,omitempty"` }
An option found within a [[SoftLayer_Container_Virtual_Guest_Configuration (type)]] structure.
type Container_Virtual_Guest_PendingMaintenanceAction ¶
type Container_Virtual_Guest_PendingMaintenanceAction struct { Entity // The ID of the associated action. ActionId *int `json:"actionId,omitempty" xmlrpc:"actionId,omitempty"` // The datetime at which this action will be initiated regardless of customer action (if it has not already been completed). DueDate *Time `json:"dueDate,omitempty" xmlrpc:"dueDate,omitempty"` // User-friendly status. // // The <code>Completed</code> status means that it is done, no further action is required. The <code>Scheduled</code> status means that the action is pending and will start on the <code>dueDate</code> if no customer action is taken before such time. The <code>In Progress</code> status means the action is currently being executed. Status *string `json:"status,omitempty" xmlrpc:"status,omitempty"` // The ticket associated with this maintenance action. Ticket *Ticket `json:"ticket,omitempty" xmlrpc:"ticket,omitempty"` // The Title for the associated action. Title *string `json:"title,omitempty" xmlrpc:"title,omitempty"` // The Trigger Explanation for the associated action. TriggerExplanation *string `json:"triggerExplanation,omitempty" xmlrpc:"triggerExplanation,omitempty"` }
The SoftLayer_Container_Virtual_Guest_PendingMaintenanceAction data type contains information relating to a SoftLayer_Virtual_Guest's pending maintenance actions.
type Device_Status ¶ added in v1.0.4
type Device_Status struct { Entity // The device status's associated unique ID. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The device status's unique string identifier. KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // The name of the status. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
SoftLayer_Device_Status is used to indicate the current status of a device
type Dns_Domain ¶
type Dns_Domain struct { Entity // The SoftLayer customer account that owns a domain. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // A domain record's internal identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A flag indicating that the dns domain record is a managed resource. ManagedResourceFlag *bool `json:"managedResourceFlag,omitempty" xmlrpc:"managedResourceFlag,omitempty"` // A domain's name including top-level domain, for example "example.com". Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // 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. ResourceRecordCount *uint `json:"resourceRecordCount,omitempty" xmlrpc:"resourceRecordCount,omitempty"` // The individual records contained within a domain record. These include but are not limited to A, AAAA, MX, CTYPE, SPF and TXT records. ResourceRecords []Dns_Domain_ResourceRecord `json:"resourceRecords" xmlrpc:"resourceRecords"` // The secondary DNS record that defines this domain as being managed through zone transfers. Secondary *Dns_Secondary `json:"secondary,omitempty" xmlrpc:"secondary,omitempty"` // 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. Serial *int `json:"serial,omitempty" xmlrpc:"serial,omitempty"` // 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. SoaResourceRecord *Dns_Domain_ResourceRecord_SoaType `json:"soaResourceRecord,omitempty" xmlrpc:"soaResourceRecord,omitempty"` // The date that this domain record was last updated. UpdateDate *Time `json:"updateDate,omitempty" xmlrpc:"updateDate,omitempty"` }
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 (type)|SoftLayer_Dns_Domain_ResourceRecord]] records.
type Dns_Domain_Forward ¶
type Dns_Domain_Forward struct {
Dns_Domain
}
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 (type)|SoftLayer_Dns_Domain_ResourceRecord]] records.
type Dns_Domain_ResourceRecord ¶
type Dns_Domain_ResourceRecord struct { Entity // 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. Data *string `json:"data,omitempty" xmlrpc:"data,omitempty"` // The domain that a resource record belongs to. Domain *Dns_Domain `json:"domain,omitempty" xmlrpc:"domain,omitempty"` // An identifier belonging to the domain that a resource record is associated with. DomainId *int `json:"domainId,omitempty" xmlrpc:"domainId,omitempty"` // The amount of time in seconds that a secondary name server (or servers) will hold a zone before it is no longer considered authoritative. Expire *int `json:"expire,omitempty" xmlrpc:"expire,omitempty"` // The host defined by a resource record. A value of "@" denotes a wildcard. Host *string `json:"host,omitempty" xmlrpc:"host,omitempty"` // A domain resource record's internal identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Whether the address associated with a PTR record is the gateway address of a subnet. IsGatewayAddress *bool `json:"isGatewayAddress,omitempty" xmlrpc:"isGatewayAddress,omitempty"` // 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. Minimum *int `json:"minimum,omitempty" xmlrpc:"minimum,omitempty"` // 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. MxPriority *int `json:"mxPriority,omitempty" xmlrpc:"mxPriority,omitempty"` // The TCP or UDP port on which the service is to be found. Port *int `json:"port,omitempty" xmlrpc:"port,omitempty"` // The priority of the target host, lower value means more preferred. Priority *int `json:"priority,omitempty" xmlrpc:"priority,omitempty"` // The protocol of the desired service; this is usually either TCP or UDP. Protocol *string `json:"protocol,omitempty" xmlrpc:"protocol,omitempty"` // 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. Refresh *int `json:"refresh,omitempty" xmlrpc:"refresh,omitempty"` // 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.". ResponsiblePerson *string `json:"responsiblePerson,omitempty" xmlrpc:"responsiblePerson,omitempty"` // 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. Retry *int `json:"retry,omitempty" xmlrpc:"retry,omitempty"` // The symbolic name of the desired service Service *string `json:"service,omitempty" xmlrpc:"service,omitempty"` // 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. Ttl *int `json:"ttl,omitempty" xmlrpc:"ttl,omitempty"` // 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 `json:"type,omitempty" xmlrpc:"type,omitempty"` // A relative weight for records with the same priority. Weight *int `json:"weight,omitempty" xmlrpc:"weight,omitempty"` }
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|address]] records * ”'"aaaa"”' for [[SoftLayer_Dns_Domain_ResourceRecord_AaaaType|address]] records * ”'"cname"”' for [[SoftLayer_Dns_Domain_ResourceRecord_CnameType|canonical name]] records * ”'"mx"”' for [[SoftLayer_Dns_Domain_ResourceRecord_MxType|mail exchanger]] records * ”'"ns"”' for [[SoftLayer_Dns_Domain_ResourceRecord_NsType|name server]] records * ”'"ptr"”' for [[SoftLayer_Dns_Domain_ResourceRecord_PtrType|pointer]] records in reverse domains * ”'"soa"”' for a domain's [[SoftLayer_Dns_Domain_ResourceRecord_SoaType|start of authority]] record * ”'"spf"”' for [[SoftLayer_Dns_Domain_ResourceRecord_SpfType|sender policy framework]] records * ”'"srv"”' for [[SoftLayer_Dns_Domain_ResourceRecord_SrvType|service]] records * ”'"txt"”' for [[SoftLayer_Dns_Domain_ResourceRecord_TxtType|text]] records
As ”SoftLayer_Dns_Domain_ResourceRecord” objects are created and loaded, the API verifies the ”type” property and casts the object as the appropriate type.
type Dns_Domain_ResourceRecord_AType ¶
type Dns_Domain_ResourceRecord_AType struct {
Dns_Domain_ResourceRecord
}
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".
type Dns_Domain_ResourceRecord_AaaaType ¶
type Dns_Domain_ResourceRecord_AaaaType struct {
Dns_Domain_ResourceRecord
}
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".
type Dns_Domain_ResourceRecord_CnameType ¶
type Dns_Domain_ResourceRecord_CnameType struct {
Dns_Domain_ResourceRecord
}
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.
type Dns_Domain_ResourceRecord_MxType ¶
type Dns_Domain_ResourceRecord_MxType struct {
Dns_Domain_ResourceRecord
}
SoftLayer_Dns_Domain_ResourceRecord_MxType is a SoftLayer_Dns_Domain_ResourceRecord object whose ”type” property is set to "mx" and used to describe MX resource records. MX records control which hosts are responsible as mail exchangers for a domain. For instance, in the domain example.org, an MX record whose host is "@" and data is "mail" says that the host "mail.example.org" is responsible for handling mail for example.org. That means mail sent to users @example.org are delivered to mail.example.org.
Domains can have more than one MX record if it uses more than one server to send mail through. Multiple MX records are denoted by their priority, defined by the mxPriority property.
MX records must be defined for hosts with accompanying A or AAAA resource records. They may not point mail towards a host defined by a CNAME record.
type Dns_Domain_ResourceRecord_NsType ¶
type Dns_Domain_ResourceRecord_NsType struct {
Dns_Domain_ResourceRecord
}
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.
type Dns_Domain_ResourceRecord_PtrType ¶
type Dns_Domain_ResourceRecord_PtrType struct { Dns_Domain_ResourceRecord // Whether the address associated with a PTR record is the gateway address of a subnet. IsGatewayAddress *bool `json:"isGatewayAddress,omitempty" xmlrpc:"isGatewayAddress,omitempty"` }
SoftLayer_Dns_Domain_ResourceRecord_PtrType is a SoftLayer_Dns_Domain_ResourceRecord object whose ”type” property is set to "ptr" and defines a reverse DNS PTR record on the SoftLayer name servers.
The format for a reverse DNS PTR record varies based on whether it is for an IPv4 or IPv6 address.
For an IPv4 address the ”host” property for every PTR record is the last octet of the IP address that the PTR record belongs to, while the ”data” property is the canonical name of the host that the reverse lookup resolves to. Every PTR record belongs to a domain on the SoftLayer name servers named by the first three octets of an IP address in reverse order followed by ".in-addr.arpa".
For instance, if the reverse DNS record for 10.0.0.1 is "host.example.org" then it's corresponding SoftLayer_Dns_Domain_ResourceRecord_PtrType host is "1", while it's data property equals "host.example.org". The full name of the reverse record for host.example.org including the domain name is "1.0.0.10.in-addr.arpa".
For an IPv6 address the ”host” property for every PTR record is the last four octets of the IP address that the PTR record belongs to. The last four octets need to be in reversed order and each digit separated by a period. The ”data” property is the canonical name of the host that the reverse lookup resolves to. Every PTR record belongs to a domain on the SoftLayer name servers named by the first four octets of an IP address in reverse order, split up by digit with a period, and followed by ".ip6.arpa".
For instance, if the reverse DNS record for fe80:0000:0000:0000:0000:0000:0a00:0001 is "host.example.org" then it's corresponding SoftLayer_Dns_Domain_ResourceRecord_PtrType host is "1.0.0.0.0.0.a.0.0.0.0.0.0.0.0.0", while it's data property equals "host.example.org". The full name of the reverse record for host.example.org including the domain name is "1.0.0.0.0.0.a.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.0.8.e.f.ip6.arpa".
PTR record host names may not be changed by [[SoftLayer_Dns_Domain_ResourceRecord::editObject]] or [[SoftLayer_Dns_Domain_ResourceRecord::editObjects]].
type Dns_Domain_ResourceRecord_SoaType ¶
type Dns_Domain_ResourceRecord_SoaType struct {
Dns_Domain_ResourceRecord
}
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.
type Dns_Domain_ResourceRecord_SpfType ¶
type Dns_Domain_ResourceRecord_SpfType struct {
Dns_Domain_ResourceRecord_TxtType
}
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.
type Dns_Domain_ResourceRecord_SrvType ¶
type Dns_Domain_ResourceRecord_SrvType struct { Dns_Domain_ResourceRecord // The TCP or UDP port on which the service is to be found. Port *int `json:"port,omitempty" xmlrpc:"port,omitempty"` // The priority of the target host, lower value means more preferred. Priority *int `json:"priority,omitempty" xmlrpc:"priority,omitempty"` // The protocol of the desired service; this is usually either TCP or UDP. Protocol *string `json:"protocol,omitempty" xmlrpc:"protocol,omitempty"` // The symbolic name of the desired service Service *string `json:"service,omitempty" xmlrpc:"service,omitempty"` // A relative weight for records with the same priority. Weight *int `json:"weight,omitempty" xmlrpc:"weight,omitempty"` }
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.
type Dns_Domain_ResourceRecord_TxtType ¶
type Dns_Domain_ResourceRecord_TxtType struct {
Dns_Domain_ResourceRecord
}
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.
type Dns_Domain_Reverse ¶
type Dns_Domain_Reverse struct { Dns_Domain // Network address the domain is associated with. NetworkAddress *string `json:"networkAddress,omitempty" xmlrpc:"networkAddress,omitempty"` }
The SoftLayer_Dns_Domain_Reverse data type represents a reverse IP address record.
type Dns_Domain_Reverse_Version4 ¶
type Dns_Domain_Reverse_Version4 struct {
Dns_Domain_Reverse
}
The SoftLayer_Dns_Domain_Reverse_Version4 data type represents a reverse IPv4 address record.
type Dns_Domain_Reverse_Version6 ¶
type Dns_Domain_Reverse_Version6 struct {
Dns_Domain_Reverse
}
The SoftLayer_Dns_Domain_Reverse_Version6 data type represents a reverse IPv6 address record.
type Dns_Message ¶
type Dns_Message struct { Entity // The date the message was created. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // The domain that is associated with a message. Domain *Dns_Domain `json:"domain,omitempty" xmlrpc:"domain,omitempty"` // The internal identifier for a DNS message. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The message text. Message *string `json:"message,omitempty" xmlrpc:"message,omitempty"` // The priority level for a DNS message. The possible levels are 'notice' and 'error'. Priority *string `json:"priority,omitempty" xmlrpc:"priority,omitempty"` // The resource record that is associated with a message. ResourceRecord *Dns_Domain_ResourceRecord `json:"resourceRecord,omitempty" xmlrpc:"resourceRecord,omitempty"` // The secondary DNS record that a message belongs to. Secondary *Dns_Secondary `json:"secondary,omitempty" xmlrpc:"secondary,omitempty"` }
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.
type Dns_Secondary ¶
type Dns_Secondary struct { Entity // The SoftLayer account that owns a secondary DNS record. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // The date a secondary DNS record was created. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // The domain record created by zone transfer from a secondary DNS record. Domain *Dns_Domain `json:"domain,omitempty" xmlrpc:"domain,omitempty"` // A count of the error messages created during secondary DNS record transfer. ErrorMessageCount *uint `json:"errorMessageCount,omitempty" xmlrpc:"errorMessageCount,omitempty"` // The error messages created during secondary DNS record transfer. ErrorMessages []Dns_Message `json:"errorMessages,omitempty" xmlrpc:"errorMessages,omitempty"` // The internal identifier for a secondary DNS record. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The date when the most recent secondary DNS zone transfer took place. LastUpdate *Time `json:"lastUpdate,omitempty" xmlrpc:"lastUpdate,omitempty"` // The IP address of the master name server where a secondary DNS zone is transferred from. MasterIpAddress *string `json:"masterIpAddress,omitempty" xmlrpc:"masterIpAddress,omitempty"` // The current status of the secondary DNS zone. Status *Dns_Status `json:"status,omitempty" xmlrpc:"status,omitempty"` // The current status of a secondary DNS record. The status may be one of the following: // :*”'0”': Disabled // :*”'1”': Active // :*”'2”': Transfer Now // :*”'3”': An error occurred that prevented the zone transfer from being completed. StatusId *int `json:"statusId,omitempty" xmlrpc:"statusId,omitempty"` // The textual representation of a secondary DNS zone's status. StatusText *string `json:"statusText,omitempty" xmlrpc:"statusText,omitempty"` // How often a secondary DNS zone should be transferred in minutes. TransferFrequency *int `json:"transferFrequency,omitempty" xmlrpc:"transferFrequency,omitempty"` // The name of the zone that is transferred. ZoneName *string `json:"zoneName,omitempty" xmlrpc:"zoneName,omitempty"` }
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.
type Dns_Status ¶
type Dns_Status struct { Entity // Internal identifier of a DNS status Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Monitoring DNS status name Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
The SoftLayer_Dns_Status data type contains information for a DNS status
type Email_Subscription ¶
type Email_Subscription struct { Entity // Brief description of the purpose of the email. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // no documentation yet Enabled *bool `json:"enabled,omitempty" xmlrpc:"enabled,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Email template name. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
no documentation yet
type Email_Subscription_Group ¶
type Email_Subscription_Group struct { Entity // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Email subscription group name. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // A count of all email subscriptions associated with this group. SubscriptionCount *uint `json:"subscriptionCount,omitempty" xmlrpc:"subscriptionCount,omitempty"` // All email subscriptions associated with this group. Subscriptions []Email_Subscription `json:"subscriptions,omitempty" xmlrpc:"subscriptions,omitempty"` }
no documentation yet
type Email_Subscription_Suppression_User ¶
type Email_Subscription_Suppression_User struct { Entity // no documentation yet Subscription *Email_Subscription `json:"subscription,omitempty" xmlrpc:"subscription,omitempty"` }
no documentation yet
type Event_Log ¶
type Event_Log struct { Entity // Account id with which the event is associated AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // Event creation date in millisecond precision EventCreateDate *Time `json:"eventCreateDate,omitempty" xmlrpc:"eventCreateDate,omitempty"` // Event name such as "reboot", "cancel", "update host" and so on. EventName *string `json:"eventName,omitempty" xmlrpc:"eventName,omitempty"` // The remote IP Address that made the request IpAddress *string `json:"ipAddress,omitempty" xmlrpc:"ipAddress,omitempty"` // Label or description of the event object Label *string `json:"label,omitempty" xmlrpc:"label,omitempty"` // Meta data for an event in JSON string MetaData *string `json:"metaData,omitempty" xmlrpc:"metaData,omitempty"` // Event object id ObjectId *int `json:"objectId,omitempty" xmlrpc:"objectId,omitempty"` // Event object name such as "server", "dns" and so on. ObjectName *string `json:"objectName,omitempty" xmlrpc:"objectName,omitempty"` // OpenIdConnectUserName of the customer who initiated the event OpenIdConnectUserName *string `json:"openIdConnectUserName,omitempty" xmlrpc:"openIdConnectUserName,omitempty"` // A resource object that is associated with the event Resource interface{} `json:"resource,omitempty" xmlrpc:"resource,omitempty"` // A unique trace id. Multiple event can be grouped by a trace id. TraceId *string `json:"traceId,omitempty" xmlrpc:"traceId,omitempty"` // no documentation yet User *User_Customer `json:"user,omitempty" xmlrpc:"user,omitempty"` // Id of customer who initiated the event UserId *int `json:"userId,omitempty" xmlrpc:"userId,omitempty"` // Type of user that triggered the event. User type can be CUSTOMER, EMPLOYEE or SYSTEM. UserType *string `json:"userType,omitempty" xmlrpc:"userType,omitempty"` // Customer username who initiated the event Username *string `json:"username,omitempty" xmlrpc:"username,omitempty"` }
The SoftLayer_Event_Log data type contains an event detail occurred upon various SoftLayer resources.
type Exception_Brand_Creation ¶
type Exception_Brand_Creation struct { Entity // no documentation yet Message *string `json:"message,omitempty" xmlrpc:"message,omitempty"` // no documentation yet Type *string `json:"type,omitempty" xmlrpc:"type,omitempty"` }
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.
type Exception_Hardware_Component_Locator_ComponentLocatorException ¶
type Exception_Hardware_Component_Locator_ComponentLocatorException struct {
Entity
}
This exception is thrown if the component locator client cannot find or communicate with the component locator service.
type Exception_Hardware_Component_Locator_InvalidGenericComponentArgument ¶
type Exception_Hardware_Component_Locator_InvalidGenericComponentArgument struct {
Entity
}
This exception is thrown if the argument is of incorrect type.
type FlexibleCredit_Affiliate ¶
type FlexibleCredit_Affiliate struct { Entity // Flexible Credit Program the affiliate belongs to. FlexibleCreditProgram *FlexibleCredit_Program `json:"flexibleCreditProgram,omitempty" xmlrpc:"flexibleCreditProgram,omitempty"` // Primary ID for the affiliate Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Name of this affiliate Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
no documentation yet
type FlexibleCredit_Company_Type ¶
type FlexibleCredit_Company_Type struct { Entity // Description of the company type Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // Primary ID for the company type Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` }
no documentation yet
type FlexibleCredit_Enrollment ¶
type FlexibleCredit_Enrollment struct { Entity // Account the enrollment belongs to Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // Account ID associated with this enrollment AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // Affiliate associated with the account enrollment Affiliate *FlexibleCredit_Affiliate `json:"affiliate,omitempty" xmlrpc:"affiliate,omitempty"` // ID of the corresponding Flexible Credit Program Affiliate AffiliateId *int `json:"affiliateId,omitempty" xmlrpc:"affiliateId,omitempty"` // Indicates signing of Flexible Credit agreement (independent from MSA) AgreementCompleteFlag *int `json:"agreementCompleteFlag,omitempty" xmlrpc:"agreementCompleteFlag,omitempty"` // How much lifetime credit from this enrollment is available for use by the customer, refreshed every 5 minutes. ApproximateAvailableLifetimeCredit *Float64 `json:"approximateAvailableLifetimeCredit,omitempty" xmlrpc:"approximateAvailableLifetimeCredit,omitempty"` // Brief description of the company CompanyDescription *string `json:"companyDescription,omitempty" xmlrpc:"companyDescription,omitempty"` // Category which best describes the company CompanyType *FlexibleCredit_Company_Type `json:"companyType,omitempty" xmlrpc:"companyType,omitempty"` // ID of the Flexible Credit Program Company classification for this enrollment CompanyTypeId *int `json:"companyTypeId,omitempty" xmlrpc:"companyTypeId,omitempty"` // Date when participation in the Flexible Credit program began EnrollmentDate *Time `json:"enrollmentDate,omitempty" xmlrpc:"enrollmentDate,omitempty"` // Discount program the enrollment belongs to FlexibleCreditProgram *FlexibleCredit_Program `json:"flexibleCreditProgram,omitempty" xmlrpc:"flexibleCreditProgram,omitempty"` // Date Flexible Credit Program benefits end. GraduationDate *Time `json:"graduationDate,omitempty" xmlrpc:"graduationDate,omitempty"` // Flag indicating whether an enrollment is active (true) or inactive (false) IsActiveFlag *bool `json:"isActiveFlag,omitempty" xmlrpc:"isActiveFlag,omitempty"` // Amount of monthly credit (USD) given to the account MonthlyCreditAmount *Float64 `json:"monthlyCreditAmount,omitempty" xmlrpc:"monthlyCreditAmount,omitempty"` // Employee overseeing the enrollment Representative *User_Employee `json:"representative,omitempty" xmlrpc:"representative,omitempty"` // ID of the employee representing this account. RepresentativeEmployeeId *int `json:"representativeEmployeeId,omitempty" xmlrpc:"representativeEmployeeId,omitempty"` }
no documentation yet
type FlexibleCredit_Program ¶
type FlexibleCredit_Program struct { Entity // Primary ID of the Flexible Credit Program Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Unique name for the Flexible Credit Program KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // Name of the Flexible Credit Program. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // no documentation yet PlatformPromotionCode *string `json:"platformPromotionCode,omitempty" xmlrpc:"platformPromotionCode,omitempty"` }
no documentation yet
type Float64 ¶
type Float64 float64
FIXME: Need to have special unmarshaling of some values defined as float type in the metadata that actually come down as strings in the api. e.g. SoftLayer_Product_Item.capacity Float64 is a float type that deals with some of the oddities when unmarshalling from the SLAPI
Code borrowed from https://github.com/sudorandom/softlayer-go/blob/master/slapi/types/float.go
func (*Float64) UnmarshalJSON ¶
UnmarshalJSON statisied the json.Unmarshaler interface
type Hardware ¶
type Hardware struct { Entity // The account associated with a piece of hardware. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // A hardware's associated [[SoftLayer_Account|account]] id. AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // A count of a piece of hardware's active physical components. ActiveComponentCount *uint `json:"activeComponentCount,omitempty" xmlrpc:"activeComponentCount,omitempty"` // A piece of hardware's active physical components. ActiveComponents []Hardware_Component `json:"activeComponents,omitempty" xmlrpc:"activeComponents,omitempty"` // A piece of hardware's active network monitoring incidents. ActiveNetworkMonitorIncident []Network_Monitor_Version1_Incident `json:"activeNetworkMonitorIncident,omitempty" xmlrpc:"activeNetworkMonitorIncident,omitempty"` // A count of a piece of hardware's active network monitoring incidents. ActiveNetworkMonitorIncidentCount *uint `json:"activeNetworkMonitorIncidentCount,omitempty" xmlrpc:"activeNetworkMonitorIncidentCount,omitempty"` // A count of AllPowerComponentCount *uint `json:"allPowerComponentCount,omitempty" xmlrpc:"allPowerComponentCount,omitempty"` // no documentation yet AllPowerComponents []Hardware_Power_Component `json:"allPowerComponents,omitempty" xmlrpc:"allPowerComponents,omitempty"` // The SoftLayer_Network_Storage_Allowed_Host information to connect this server to Network Storage volumes that require access control lists. AllowedHost *Network_Storage_Allowed_Host `json:"allowedHost,omitempty" xmlrpc:"allowedHost,omitempty"` // The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to. AllowedNetworkStorage []Network_Storage `json:"allowedNetworkStorage,omitempty" xmlrpc:"allowedNetworkStorage,omitempty"` // A count of the SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to. AllowedNetworkStorageCount *uint `json:"allowedNetworkStorageCount,omitempty" xmlrpc:"allowedNetworkStorageCount,omitempty"` // A count of the SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to. AllowedNetworkStorageReplicaCount *uint `json:"allowedNetworkStorageReplicaCount,omitempty" xmlrpc:"allowedNetworkStorageReplicaCount,omitempty"` // The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to. AllowedNetworkStorageReplicas []Network_Storage `json:"allowedNetworkStorageReplicas,omitempty" xmlrpc:"allowedNetworkStorageReplicas,omitempty"` // Information regarding an antivirus/spyware software component object. AntivirusSpywareSoftwareComponent *Software_Component `json:"antivirusSpywareSoftwareComponent,omitempty" xmlrpc:"antivirusSpywareSoftwareComponent,omitempty"` // A count of information regarding a piece of hardware's specific attributes. AttributeCount *uint `json:"attributeCount,omitempty" xmlrpc:"attributeCount,omitempty"` // Information regarding a piece of hardware's specific attributes. Attributes []Hardware_Attribute `json:"attributes,omitempty" xmlrpc:"attributes,omitempty"` // The average daily public bandwidth usage for the current billing cycle. AverageDailyPublicBandwidthUsage *Float64 `json:"averageDailyPublicBandwidthUsage,omitempty" xmlrpc:"averageDailyPublicBandwidthUsage,omitempty"` // A count of a piece of hardware's back-end or private network components. BackendNetworkComponentCount *uint `json:"backendNetworkComponentCount,omitempty" xmlrpc:"backendNetworkComponentCount,omitempty"` // A piece of hardware's back-end or private network components. BackendNetworkComponents []Network_Component `json:"backendNetworkComponents,omitempty" xmlrpc:"backendNetworkComponents,omitempty"` // A count of a hardware's backend or private router. BackendRouterCount *uint `json:"backendRouterCount,omitempty" xmlrpc:"backendRouterCount,omitempty"` // A hardware's backend or private router. BackendRouters []Hardware `json:"backendRouters,omitempty" xmlrpc:"backendRouters,omitempty"` // A hardware's allotted bandwidth (measured in GB). BandwidthAllocation *Float64 `json:"bandwidthAllocation,omitempty" xmlrpc:"bandwidthAllocation,omitempty"` // A hardware's allotted detail record. Allotment details link bandwidth allocation with allotments. BandwidthAllotmentDetail *Network_Bandwidth_Version1_Allotment_Detail `json:"bandwidthAllotmentDetail,omitempty" xmlrpc:"bandwidthAllotmentDetail,omitempty"` // When true, this flag specifies that a hardware is Bare Metal Server. Bare Metal Servers are physical bare metal servers that are billed with the same options as Virtual Servers, with monthly and hourly rates. Bare Metal instances are ordered based on processor core count and ram amount. BareMetalInstanceFlag *int `json:"bareMetalInstanceFlag,omitempty" xmlrpc:"bareMetalInstanceFlag,omitempty"` // A count of information regarding a piece of hardware's benchmark certifications. BenchmarkCertificationCount *uint `json:"benchmarkCertificationCount,omitempty" xmlrpc:"benchmarkCertificationCount,omitempty"` // Information regarding a piece of hardware's benchmark certifications. BenchmarkCertifications []Hardware_Benchmark_Certification `json:"benchmarkCertifications,omitempty" xmlrpc:"benchmarkCertifications,omitempty"` // Information regarding the billing item for a server. BillingItem *Billing_Item_Hardware `json:"billingItem,omitempty" xmlrpc:"billingItem,omitempty"` // A flag indicating that a billing item exists. BillingItemFlag *bool `json:"billingItemFlag,omitempty" xmlrpc:"billingItemFlag,omitempty"` // Determines whether the hardware is ineligible for cancellation because it is disconnected. BlockCancelBecauseDisconnectedFlag *bool `json:"blockCancelBecauseDisconnectedFlag,omitempty" xmlrpc:"blockCancelBecauseDisconnectedFlag,omitempty"` // Status indicating whether or not a piece of hardware has business continuance insurance. BusinessContinuanceInsuranceFlag *bool `json:"businessContinuanceInsuranceFlag,omitempty" xmlrpc:"businessContinuanceInsuranceFlag,omitempty"` // Child hardware. ChildrenHardware []Hardware `json:"childrenHardware,omitempty" xmlrpc:"childrenHardware,omitempty"` // A count of child hardware. ChildrenHardwareCount *uint `json:"childrenHardwareCount,omitempty" xmlrpc:"childrenHardwareCount,omitempty"` // A count of a piece of hardware's components. ComponentCount *uint `json:"componentCount,omitempty" xmlrpc:"componentCount,omitempty"` // A piece of hardware's components. Components []Hardware_Component `json:"components,omitempty" xmlrpc:"components,omitempty"` // A continuous data protection/server backup software component object. ContinuousDataProtectionSoftwareComponent *Software_Component `json:"continuousDataProtectionSoftwareComponent,omitempty" xmlrpc:"continuousDataProtectionSoftwareComponent,omitempty"` // The current billable public outbound bandwidth for this hardware for the current billing cycle. CurrentBillableBandwidthUsage *Float64 `json:"currentBillableBandwidthUsage,omitempty" xmlrpc:"currentBillableBandwidthUsage,omitempty"` // Information regarding the datacenter in which a piece of hardware resides. Datacenter *Location `json:"datacenter,omitempty" xmlrpc:"datacenter,omitempty"` // The name of the datacenter in which a piece of hardware resides. DatacenterName *string `json:"datacenterName,omitempty" xmlrpc:"datacenterName,omitempty"` // Number of day(s) a server have been in spare pool. DaysInSparePool *int `json:"daysInSparePool,omitempty" xmlrpc:"daysInSparePool,omitempty"` // A piece of hardware's local network domain name. Domain *string `json:"domain,omitempty" xmlrpc:"domain,omitempty"` // All hardware that has uplink network connections to a piece of hardware. DownlinkHardware []Hardware `json:"downlinkHardware,omitempty" xmlrpc:"downlinkHardware,omitempty"` // A count of all hardware that has uplink network connections to a piece of hardware. DownlinkHardwareCount *uint `json:"downlinkHardwareCount,omitempty" xmlrpc:"downlinkHardwareCount,omitempty"` // All hardware that has uplink network connections to a piece of hardware. DownlinkNetworkHardware []Hardware `json:"downlinkNetworkHardware,omitempty" xmlrpc:"downlinkNetworkHardware,omitempty"` // A count of all hardware that has uplink network connections to a piece of hardware. DownlinkNetworkHardwareCount *uint `json:"downlinkNetworkHardwareCount,omitempty" xmlrpc:"downlinkNetworkHardwareCount,omitempty"` // A count of information regarding all servers attached to a piece of network hardware. DownlinkServerCount *uint `json:"downlinkServerCount,omitempty" xmlrpc:"downlinkServerCount,omitempty"` // Information regarding all servers attached to a piece of network hardware. DownlinkServers []Hardware `json:"downlinkServers,omitempty" xmlrpc:"downlinkServers,omitempty"` // A count of information regarding all virtual guests attached to a piece of network hardware. DownlinkVirtualGuestCount *uint `json:"downlinkVirtualGuestCount,omitempty" xmlrpc:"downlinkVirtualGuestCount,omitempty"` // Information regarding all virtual guests attached to a piece of network hardware. DownlinkVirtualGuests []Virtual_Guest `json:"downlinkVirtualGuests,omitempty" xmlrpc:"downlinkVirtualGuests,omitempty"` // A count of all hardware downstream from a network device. DownstreamHardwareBindingCount *uint `json:"downstreamHardwareBindingCount,omitempty" xmlrpc:"downstreamHardwareBindingCount,omitempty"` // All hardware downstream from a network device. DownstreamHardwareBindings []Network_Component_Uplink_Hardware `json:"downstreamHardwareBindings,omitempty" xmlrpc:"downstreamHardwareBindings,omitempty"` // All network hardware downstream from the selected piece of hardware. DownstreamNetworkHardware []Hardware `json:"downstreamNetworkHardware,omitempty" xmlrpc:"downstreamNetworkHardware,omitempty"` // A count of all network hardware downstream from the selected piece of hardware. DownstreamNetworkHardwareCount *uint `json:"downstreamNetworkHardwareCount,omitempty" xmlrpc:"downstreamNetworkHardwareCount,omitempty"` // A count of all network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. [DEPRECATED] DownstreamNetworkHardwareWithIncidentCount *uint `json:"downstreamNetworkHardwareWithIncidentCount,omitempty" xmlrpc:"downstreamNetworkHardwareWithIncidentCount,omitempty"` // All network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. [DEPRECATED] // Deprecated: This function has been marked as deprecated. DownstreamNetworkHardwareWithIncidents []Hardware `json:"downstreamNetworkHardwareWithIncidents,omitempty" xmlrpc:"downstreamNetworkHardwareWithIncidents,omitempty"` // A count of information regarding all servers attached downstream to a piece of network hardware. DownstreamServerCount *uint `json:"downstreamServerCount,omitempty" xmlrpc:"downstreamServerCount,omitempty"` // Information regarding all servers attached downstream to a piece of network hardware. DownstreamServers []Hardware `json:"downstreamServers,omitempty" xmlrpc:"downstreamServers,omitempty"` // A count of information regarding all virtual guests attached to a piece of network hardware. DownstreamVirtualGuestCount *uint `json:"downstreamVirtualGuestCount,omitempty" xmlrpc:"downstreamVirtualGuestCount,omitempty"` // Information regarding all virtual guests attached to a piece of network hardware. DownstreamVirtualGuests []Virtual_Guest `json:"downstreamVirtualGuests,omitempty" xmlrpc:"downstreamVirtualGuests,omitempty"` // A count of the drive controllers contained within a piece of hardware. DriveControllerCount *uint `json:"driveControllerCount,omitempty" xmlrpc:"driveControllerCount,omitempty"` // The drive controllers contained within a piece of hardware. DriveControllers []Hardware_Component `json:"driveControllers,omitempty" xmlrpc:"driveControllers,omitempty"` // Information regarding a piece of hardware's associated EVault network storage service account. EvaultNetworkStorage []Network_Storage `json:"evaultNetworkStorage,omitempty" xmlrpc:"evaultNetworkStorage,omitempty"` // A count of information regarding a piece of hardware's associated EVault network storage service account. EvaultNetworkStorageCount *uint `json:"evaultNetworkStorageCount,omitempty" xmlrpc:"evaultNetworkStorageCount,omitempty"` // Information regarding a piece of hardware's firewall services. FirewallServiceComponent *Network_Component_Firewall `json:"firewallServiceComponent,omitempty" xmlrpc:"firewallServiceComponent,omitempty"` // Defines the fixed components in a fixed configuration bare metal server. FixedConfigurationPreset *Product_Package_Preset `json:"fixedConfigurationPreset,omitempty" xmlrpc:"fixedConfigurationPreset,omitempty"` // A count of a piece of hardware's front-end or public network components. FrontendNetworkComponentCount *uint `json:"frontendNetworkComponentCount,omitempty" xmlrpc:"frontendNetworkComponentCount,omitempty"` // A piece of hardware's front-end or public network components. FrontendNetworkComponents []Network_Component `json:"frontendNetworkComponents,omitempty" xmlrpc:"frontendNetworkComponents,omitempty"` // A count of a hardware's frontend or public router. FrontendRouterCount *uint `json:"frontendRouterCount,omitempty" xmlrpc:"frontendRouterCount,omitempty"` // A hardware's frontend or public router. FrontendRouters []Hardware `json:"frontendRouters,omitempty" xmlrpc:"frontendRouters,omitempty"` // 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. FullyQualifiedDomainName *string `json:"fullyQualifiedDomainName,omitempty" xmlrpc:"fullyQualifiedDomainName,omitempty"` // Information regarding the future billing item for a server. FutureBillingItem *Billing_Item_Hardware `json:"futureBillingItem,omitempty" xmlrpc:"futureBillingItem,omitempty"` // A hardware's universally unique identifier. GlobalIdentifier *string `json:"globalIdentifier,omitempty" xmlrpc:"globalIdentifier,omitempty"` // A count of the hard drives contained within a piece of hardware. HardDriveCount *uint `json:"hardDriveCount,omitempty" xmlrpc:"hardDriveCount,omitempty"` // The hard drives contained within a piece of hardware. HardDrives []Hardware_Component `json:"hardDrives,omitempty" xmlrpc:"hardDrives,omitempty"` // The chassis that a piece of hardware is housed in. HardwareChassis *Hardware_Chassis `json:"hardwareChassis,omitempty" xmlrpc:"hardwareChassis,omitempty"` // A hardware's function. HardwareFunction *Hardware_Function `json:"hardwareFunction,omitempty" xmlrpc:"hardwareFunction,omitempty"` // A hardware's function. HardwareFunctionDescription *string `json:"hardwareFunctionDescription,omitempty" xmlrpc:"hardwareFunctionDescription,omitempty"` // A hardware's power/transaction state. HardwareState *Hardware_State `json:"hardwareState,omitempty" xmlrpc:"hardwareState,omitempty"` // A hardware's status. HardwareStatus *Hardware_Status `json:"hardwareStatus,omitempty" xmlrpc:"hardwareStatus,omitempty"` // A number reflecting the state of a hardware HardwareStatusId *int `json:"hardwareStatusId,omitempty" xmlrpc:"hardwareStatusId,omitempty"` // Determine in hardware object has TPM enabled. HasTrustedPlatformModuleBillingItemFlag *bool `json:"hasTrustedPlatformModuleBillingItemFlag,omitempty" xmlrpc:"hasTrustedPlatformModuleBillingItemFlag,omitempty"` // Information regarding a host IPS software component object. HostIpsSoftwareComponent *Software_Component `json:"hostIpsSoftwareComponent,omitempty" xmlrpc:"hostIpsSoftwareComponent,omitempty"` // A hardware's hostname Hostname *string `json:"hostname,omitempty" xmlrpc:"hostname,omitempty"` // A server's hourly billing status. HourlyBillingFlag *bool `json:"hourlyBillingFlag,omitempty" xmlrpc:"hourlyBillingFlag,omitempty"` // A hardware's internal identification number Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The sum of all the inbound network traffic data for the last 30 days. InboundBandwidthUsage *Float64 `json:"inboundBandwidthUsage,omitempty" xmlrpc:"inboundBandwidthUsage,omitempty"` // The total public inbound bandwidth for this hardware for the current billing cycle. InboundPublicBandwidthUsage *Float64 `json:"inboundPublicBandwidthUsage,omitempty" xmlrpc:"inboundPublicBandwidthUsage,omitempty"` // Whether or not this hardware object is eligible to change to term billing. IsBillingTermChangeAvailableFlag *bool `json:"isBillingTermChangeAvailableFlag,omitempty" xmlrpc:"isBillingTermChangeAvailableFlag,omitempty"` // Determine if hardware object has the IBM_CLOUD_READY_NODE_CERTIFIED attribute. IsCloudReadyNodeCertified *bool `json:"isCloudReadyNodeCertified,omitempty" xmlrpc:"isCloudReadyNodeCertified,omitempty"` // Information regarding the last transaction a server performed. LastTransaction *Provisioning_Version1_Transaction `json:"lastTransaction,omitempty" xmlrpc:"lastTransaction,omitempty"` // A piece of hardware's latest network monitoring incident. LatestNetworkMonitorIncident *Network_Monitor_Version1_Incident `json:"latestNetworkMonitorIncident,omitempty" xmlrpc:"latestNetworkMonitorIncident,omitempty"` // Where a piece of hardware is located within SoftLayer's location hierarchy. Location *Location `json:"location,omitempty" xmlrpc:"location,omitempty"` // no documentation yet LocationPathString *string `json:"locationPathString,omitempty" xmlrpc:"locationPathString,omitempty"` // Information regarding a lockbox account associated with a server. LockboxNetworkStorage *Network_Storage `json:"lockboxNetworkStorage,omitempty" xmlrpc:"lockboxNetworkStorage,omitempty"` // A flag indicating that the hardware is a managed resource. ManagedResourceFlag *bool `json:"managedResourceFlag,omitempty" xmlrpc:"managedResourceFlag,omitempty"` // A hardware's serial number that is supplied by the manufacturer. ManufacturerSerialNumber *string `json:"manufacturerSerialNumber,omitempty" xmlrpc:"manufacturerSerialNumber,omitempty"` // Information regarding a piece of hardware's memory. Memory []Hardware_Component `json:"memory,omitempty" xmlrpc:"memory,omitempty"` // The amount of memory a piece of hardware has, measured in gigabytes. MemoryCapacity *uint `json:"memoryCapacity,omitempty" xmlrpc:"memoryCapacity,omitempty"` // A count of information regarding a piece of hardware's memory. MemoryCount *uint `json:"memoryCount,omitempty" xmlrpc:"memoryCount,omitempty"` // A piece of hardware's metric tracking object. MetricTrackingObject *Metric_Tracking_Object `json:"metricTrackingObject,omitempty" xmlrpc:"metricTrackingObject,omitempty"` // A count of ModuleCount *uint `json:"moduleCount,omitempty" xmlrpc:"moduleCount,omitempty"` // no documentation yet Modules []Hardware_Component `json:"modules,omitempty" xmlrpc:"modules,omitempty"` // no documentation yet MonitoringRobot *Monitoring_Robot `json:"monitoringRobot,omitempty" xmlrpc:"monitoringRobot,omitempty"` // Information regarding a piece of hardware's network monitoring services. MonitoringServiceComponent *Network_Monitor_Version1_Query_Host_Stratum `json:"monitoringServiceComponent,omitempty" xmlrpc:"monitoringServiceComponent,omitempty"` // no documentation yet MonitoringServiceEligibilityFlag *bool `json:"monitoringServiceEligibilityFlag,omitempty" xmlrpc:"monitoringServiceEligibilityFlag,omitempty"` // Information regarding a piece of hardware's motherboard. Motherboard *Hardware_Component `json:"motherboard,omitempty" xmlrpc:"motherboard,omitempty"` // A count of information regarding a piece of hardware's network cards. NetworkCardCount *uint `json:"networkCardCount,omitempty" xmlrpc:"networkCardCount,omitempty"` // Information regarding a piece of hardware's network cards. NetworkCards []Hardware_Component `json:"networkCards,omitempty" xmlrpc:"networkCards,omitempty"` // A count of returns a hardware's network components. NetworkComponentCount *uint `json:"networkComponentCount,omitempty" xmlrpc:"networkComponentCount,omitempty"` // Returns a hardware's network components. NetworkComponents []Network_Component `json:"networkComponents,omitempty" xmlrpc:"networkComponents,omitempty"` // The gateway member if this device is part of a network gateway. NetworkGatewayMember *Network_Gateway_Member `json:"networkGatewayMember,omitempty" xmlrpc:"networkGatewayMember,omitempty"` // Whether or not this device is part of a network gateway. NetworkGatewayMemberFlag *bool `json:"networkGatewayMemberFlag,omitempty" xmlrpc:"networkGatewayMemberFlag,omitempty"` // A piece of hardware's network management IP address. NetworkManagementIpAddress *string `json:"networkManagementIpAddress,omitempty" xmlrpc:"networkManagementIpAddress,omitempty"` // All servers with failed monitoring that are attached downstream to a piece of hardware. NetworkMonitorAttachedDownHardware []Hardware `json:"networkMonitorAttachedDownHardware,omitempty" xmlrpc:"networkMonitorAttachedDownHardware,omitempty"` // A count of all servers with failed monitoring that are attached downstream to a piece of hardware. NetworkMonitorAttachedDownHardwareCount *uint `json:"networkMonitorAttachedDownHardwareCount,omitempty" xmlrpc:"networkMonitorAttachedDownHardwareCount,omitempty"` // A count of virtual guests that are attached downstream to a hardware that have failed monitoring NetworkMonitorAttachedDownVirtualGuestCount *uint `json:"networkMonitorAttachedDownVirtualGuestCount,omitempty" xmlrpc:"networkMonitorAttachedDownVirtualGuestCount,omitempty"` // Virtual guests that are attached downstream to a hardware that have failed monitoring NetworkMonitorAttachedDownVirtualGuests []Virtual_Guest `json:"networkMonitorAttachedDownVirtualGuests,omitempty" xmlrpc:"networkMonitorAttachedDownVirtualGuests,omitempty"` // A count of information regarding a piece of hardware's network monitors. NetworkMonitorCount *uint `json:"networkMonitorCount,omitempty" xmlrpc:"networkMonitorCount,omitempty"` // A count of the status of all of a piece of hardware's network monitoring incidents. NetworkMonitorIncidentCount *uint `json:"networkMonitorIncidentCount,omitempty" xmlrpc:"networkMonitorIncidentCount,omitempty"` // The status of all of a piece of hardware's network monitoring incidents. NetworkMonitorIncidents []Network_Monitor_Version1_Incident `json:"networkMonitorIncidents,omitempty" xmlrpc:"networkMonitorIncidents,omitempty"` // Information regarding a piece of hardware's network monitors. NetworkMonitors []Network_Monitor_Version1_Query_Host `json:"networkMonitors,omitempty" xmlrpc:"networkMonitors,omitempty"` // The value of a hardware's network status attribute. [DEPRECATED] // Deprecated: This function has been marked as deprecated. NetworkStatus *string `json:"networkStatus,omitempty" xmlrpc:"networkStatus,omitempty"` // The hardware's related network status attribute. [DEPRECATED] // Deprecated: This function has been marked as deprecated. NetworkStatusAttribute *Hardware_Attribute `json:"networkStatusAttribute,omitempty" xmlrpc:"networkStatusAttribute,omitempty"` // Information regarding a piece of hardware's associated network storage service account. NetworkStorage []Network_Storage `json:"networkStorage,omitempty" xmlrpc:"networkStorage,omitempty"` // A count of information regarding a piece of hardware's associated network storage service account. NetworkStorageCount *uint `json:"networkStorageCount,omitempty" xmlrpc:"networkStorageCount,omitempty"` // A count of the network virtual LANs (VLANs) associated with a piece of hardware's network components. NetworkVlanCount *uint `json:"networkVlanCount,omitempty" xmlrpc:"networkVlanCount,omitempty"` // The network virtual LANs (VLANs) associated with a piece of hardware's network components. NetworkVlans []Network_Vlan `json:"networkVlans,omitempty" xmlrpc:"networkVlans,omitempty"` // A hardware's allotted bandwidth for the next billing cycle (measured in GB). NextBillingCycleBandwidthAllocation *Float64 `json:"nextBillingCycleBandwidthAllocation,omitempty" xmlrpc:"nextBillingCycleBandwidthAllocation,omitempty"` // A small note about a piece of hardware to use at your discretion. Notes *string `json:"notes,omitempty" xmlrpc:"notes,omitempty"` // no documentation yet NotesHistory []Hardware_Note `json:"notesHistory,omitempty" xmlrpc:"notesHistory,omitempty"` // A count of NotesHistoryCount *uint `json:"notesHistoryCount,omitempty" xmlrpc:"notesHistoryCount,omitempty"` // The amount of non-volatile memory a piece of hardware has, measured in gigabytes. NvRamCapacity *uint `json:"nvRamCapacity,omitempty" xmlrpc:"nvRamCapacity,omitempty"` // A count of NvRamComponentModelCount *uint `json:"nvRamComponentModelCount,omitempty" xmlrpc:"nvRamComponentModelCount,omitempty"` // no documentation yet NvRamComponentModels []Hardware_Component_Model `json:"nvRamComponentModels,omitempty" xmlrpc:"nvRamComponentModels,omitempty"` // Information regarding a piece of hardware's operating system. OperatingSystem *Software_Component_OperatingSystem `json:"operatingSystem,omitempty" xmlrpc:"operatingSystem,omitempty"` // A hardware's operating system software description. OperatingSystemReferenceCode *string `json:"operatingSystemReferenceCode,omitempty" xmlrpc:"operatingSystemReferenceCode,omitempty"` // The sum of all the outbound network traffic data for the last 30 days. OutboundBandwidthUsage *Float64 `json:"outboundBandwidthUsage,omitempty" xmlrpc:"outboundBandwidthUsage,omitempty"` // The total public outbound bandwidth for this hardware for the current billing cycle. OutboundPublicBandwidthUsage *Float64 `json:"outboundPublicBandwidthUsage,omitempty" xmlrpc:"outboundPublicBandwidthUsage,omitempty"` // Blade Bay ParentBay *Hardware_Blade `json:"parentBay,omitempty" xmlrpc:"parentBay,omitempty"` // Parent Hardware. ParentHardware *Hardware `json:"parentHardware,omitempty" xmlrpc:"parentHardware,omitempty"` // Information regarding the Point of Presence (PoP) location in which a piece of hardware resides. PointOfPresenceLocation *Location `json:"pointOfPresenceLocation,omitempty" xmlrpc:"pointOfPresenceLocation,omitempty"` // URI of the script to be downloaded and executed after installation is complete. PostInstallScriptUri *string `json:"postInstallScriptUri,omitempty" xmlrpc:"postInstallScriptUri,omitempty"` // A count of the power components for a hardware object. PowerComponentCount *uint `json:"powerComponentCount,omitempty" xmlrpc:"powerComponentCount,omitempty"` // The power components for a hardware object. PowerComponents []Hardware_Power_Component `json:"powerComponents,omitempty" xmlrpc:"powerComponents,omitempty"` // Information regarding a piece of hardware's power supply. PowerSupply []Hardware_Component `json:"powerSupply,omitempty" xmlrpc:"powerSupply,omitempty"` // A count of information regarding a piece of hardware's power supply. PowerSupplyCount *uint `json:"powerSupplyCount,omitempty" xmlrpc:"powerSupplyCount,omitempty"` // The hardware's primary private IP address. PrimaryBackendIpAddress *string `json:"primaryBackendIpAddress,omitempty" xmlrpc:"primaryBackendIpAddress,omitempty"` // Information regarding the hardware's primary back-end network component. PrimaryBackendNetworkComponent *Network_Component `json:"primaryBackendNetworkComponent,omitempty" xmlrpc:"primaryBackendNetworkComponent,omitempty"` // The hardware's primary public IP address. PrimaryIpAddress *string `json:"primaryIpAddress,omitempty" xmlrpc:"primaryIpAddress,omitempty"` // Information regarding the hardware's primary public network component. PrimaryNetworkComponent *Network_Component `json:"primaryNetworkComponent,omitempty" xmlrpc:"primaryNetworkComponent,omitempty"` // Whether the hardware only has access to the private network. PrivateNetworkOnlyFlag *bool `json:"privateNetworkOnlyFlag,omitempty" xmlrpc:"privateNetworkOnlyFlag,omitempty"` // The total number of processor cores, summed from all processors that are attached to a piece of hardware ProcessorCoreAmount *uint `json:"processorCoreAmount,omitempty" xmlrpc:"processorCoreAmount,omitempty"` // A count of information regarding a piece of hardware's processors. ProcessorCount *uint `json:"processorCount,omitempty" xmlrpc:"processorCount,omitempty"` // The total number of physical processor cores, summed from all processors that are attached to a piece of hardware ProcessorPhysicalCoreAmount *uint `json:"processorPhysicalCoreAmount,omitempty" xmlrpc:"processorPhysicalCoreAmount,omitempty"` // Information regarding a piece of hardware's processors. Processors []Hardware_Component `json:"processors,omitempty" xmlrpc:"processors,omitempty"` // no documentation yet ProvisionDate *Time `json:"provisionDate,omitempty" xmlrpc:"provisionDate,omitempty"` // no documentation yet Rack *Location `json:"rack,omitempty" xmlrpc:"rack,omitempty"` // A count of the RAID controllers contained within a piece of hardware. RaidControllerCount *uint `json:"raidControllerCount,omitempty" xmlrpc:"raidControllerCount,omitempty"` // The RAID controllers contained within a piece of hardware. RaidControllers []Hardware_Component `json:"raidControllers,omitempty" xmlrpc:"raidControllers,omitempty"` // A count of recent events that impact this hardware. RecentEventCount *uint `json:"recentEventCount,omitempty" xmlrpc:"recentEventCount,omitempty"` // Recent events that impact this hardware. RecentEvents []Notification_Occurrence_Event `json:"recentEvents,omitempty" xmlrpc:"recentEvents,omitempty"` // A count of user credentials to issue commands and/or interact with the server's remote management card. RemoteManagementAccountCount *uint `json:"remoteManagementAccountCount,omitempty" xmlrpc:"remoteManagementAccountCount,omitempty"` // User credentials to issue commands and/or interact with the server's remote management card. RemoteManagementAccounts []Hardware_Component_RemoteManagement_User `json:"remoteManagementAccounts,omitempty" xmlrpc:"remoteManagementAccounts,omitempty"` // A hardware's associated remote management component. This is normally IPMI. RemoteManagementComponent *Network_Component `json:"remoteManagementComponent,omitempty" xmlrpc:"remoteManagementComponent,omitempty"` // A count of ResourceConfigurationCount *uint `json:"resourceConfigurationCount,omitempty" xmlrpc:"resourceConfigurationCount,omitempty"` // no documentation yet ResourceConfigurations []Hardware_Resource_Configuration `json:"resourceConfigurations,omitempty" xmlrpc:"resourceConfigurations,omitempty"` // A count of the resource groups in which this hardware is a member. ResourceGroupCount *uint `json:"resourceGroupCount,omitempty" xmlrpc:"resourceGroupCount,omitempty"` // A count of ResourceGroupMemberReferenceCount *uint `json:"resourceGroupMemberReferenceCount,omitempty" xmlrpc:"resourceGroupMemberReferenceCount,omitempty"` // no documentation yet ResourceGroupMemberReferences []Resource_Group_Member `json:"resourceGroupMemberReferences,omitempty" xmlrpc:"resourceGroupMemberReferences,omitempty"` // A count of ResourceGroupRoleCount *uint `json:"resourceGroupRoleCount,omitempty" xmlrpc:"resourceGroupRoleCount,omitempty"` // no documentation yet ResourceGroupRoles []Resource_Group_Role `json:"resourceGroupRoles,omitempty" xmlrpc:"resourceGroupRoles,omitempty"` // The resource groups in which this hardware is a member. ResourceGroups []Resource_Group `json:"resourceGroups,omitempty" xmlrpc:"resourceGroups,omitempty"` // A count of a hardware's routers. RouterCount *uint `json:"routerCount,omitempty" xmlrpc:"routerCount,omitempty"` // A hardware's routers. Routers []Hardware `json:"routers,omitempty" xmlrpc:"routers,omitempty"` // A count of information regarding a piece of hardware's vulnerability scan requests. SecurityScanRequestCount *uint `json:"securityScanRequestCount,omitempty" xmlrpc:"securityScanRequestCount,omitempty"` // Information regarding a piece of hardware's vulnerability scan requests. SecurityScanRequests []Network_Security_Scanner_Request `json:"securityScanRequests,omitempty" xmlrpc:"securityScanRequests,omitempty"` // A hardware's serial number that is supplied by SoftLayer. SerialNumber *string `json:"serialNumber,omitempty" xmlrpc:"serialNumber,omitempty"` // Information regarding the server room in which the hardware is located. ServerRoom *Location `json:"serverRoom,omitempty" xmlrpc:"serverRoom,omitempty"` // Information regarding the piece of hardware's service provider. ServiceProvider *Service_Provider `json:"serviceProvider,omitempty" xmlrpc:"serviceProvider,omitempty"` // no documentation yet ServiceProviderId *int `json:"serviceProviderId,omitempty" xmlrpc:"serviceProviderId,omitempty"` // A hardware's internal identification number at its service provider ServiceProviderResourceId *int `json:"serviceProviderResourceId,omitempty" xmlrpc:"serviceProviderResourceId,omitempty"` // A count of information regarding a piece of hardware's installed software. SoftwareComponentCount *uint `json:"softwareComponentCount,omitempty" xmlrpc:"softwareComponentCount,omitempty"` // Information regarding a piece of hardware's installed software. SoftwareComponents []Software_Component `json:"softwareComponents,omitempty" xmlrpc:"softwareComponents,omitempty"` // Information regarding the billing item for a spare pool server. SparePoolBillingItem *Billing_Item_Hardware `json:"sparePoolBillingItem,omitempty" xmlrpc:"sparePoolBillingItem,omitempty"` // A count of sSH keys to be installed on the server during provisioning or an OS reload. SshKeyCount *uint `json:"sshKeyCount,omitempty" xmlrpc:"sshKeyCount,omitempty"` // SSH keys to be installed on the server during provisioning or an OS reload. SshKeys []Security_Ssh_Key `json:"sshKeys,omitempty" xmlrpc:"sshKeys,omitempty"` // A count of StorageGroupCount *uint `json:"storageGroupCount,omitempty" xmlrpc:"storageGroupCount,omitempty"` // no documentation yet StorageGroups []Configuration_Storage_Group `json:"storageGroups,omitempty" xmlrpc:"storageGroups,omitempty"` // A count of a piece of hardware's private storage network components. [Deprecated] StorageNetworkComponentCount *uint `json:"storageNetworkComponentCount,omitempty" xmlrpc:"storageNetworkComponentCount,omitempty"` // A piece of hardware's private storage network components. [Deprecated] // Deprecated: This function has been marked as deprecated. StorageNetworkComponents []Network_Component `json:"storageNetworkComponents,omitempty" xmlrpc:"storageNetworkComponents,omitempty"` // A count of TagReferenceCount *uint `json:"tagReferenceCount,omitempty" xmlrpc:"tagReferenceCount,omitempty"` // no documentation yet TagReferences []Tag_Reference `json:"tagReferences,omitempty" xmlrpc:"tagReferences,omitempty"` // no documentation yet TopLevelLocation *Location `json:"topLevelLocation,omitempty" xmlrpc:"topLevelLocation,omitempty"` // An account's associated upgrade request object, if any. UpgradeRequest *Product_Upgrade_Request `json:"upgradeRequest,omitempty" xmlrpc:"upgradeRequest,omitempty"` // A count of a piece of hardware's active upgradeable physical components. UpgradeableActiveComponentCount *uint `json:"upgradeableActiveComponentCount,omitempty" xmlrpc:"upgradeableActiveComponentCount,omitempty"` // A piece of hardware's active upgradeable physical components. UpgradeableActiveComponents []Hardware_Component `json:"upgradeableActiveComponents,omitempty" xmlrpc:"upgradeableActiveComponents,omitempty"` // The network device connected to a piece of hardware. UplinkHardware *Hardware `json:"uplinkHardware,omitempty" xmlrpc:"uplinkHardware,omitempty"` // A count of information regarding the network component that is one level higher than a piece of hardware on the network infrastructure. UplinkNetworkComponentCount *uint `json:"uplinkNetworkComponentCount,omitempty" xmlrpc:"uplinkNetworkComponentCount,omitempty"` // Information regarding the network component that is one level higher than a piece of hardware on the network infrastructure. UplinkNetworkComponents []Network_Component `json:"uplinkNetworkComponents,omitempty" xmlrpc:"uplinkNetworkComponents,omitempty"` // An array containing a single string of custom user data for a hardware order. Max size is 16 kb. UserData []Hardware_Attribute `json:"userData,omitempty" xmlrpc:"userData,omitempty"` // A count of an array containing a single string of custom user data for a hardware order. Max size is 16 kb. UserDataCount *uint `json:"userDataCount,omitempty" xmlrpc:"userDataCount,omitempty"` // Information regarding the virtual chassis for a piece of hardware. VirtualChassis *Hardware_Group `json:"virtualChassis,omitempty" xmlrpc:"virtualChassis,omitempty"` // A count of information regarding the virtual chassis siblings for a piece of hardware. VirtualChassisSiblingCount *uint `json:"virtualChassisSiblingCount,omitempty" xmlrpc:"virtualChassisSiblingCount,omitempty"` // Information regarding the virtual chassis siblings for a piece of hardware. VirtualChassisSiblings []Hardware `json:"virtualChassisSiblings,omitempty" xmlrpc:"virtualChassisSiblings,omitempty"` // A piece of hardware's virtual host record. VirtualHost *Virtual_Host `json:"virtualHost,omitempty" xmlrpc:"virtualHost,omitempty"` // A count of information regarding a piece of hardware's virtual software licenses. VirtualLicenseCount *uint `json:"virtualLicenseCount,omitempty" xmlrpc:"virtualLicenseCount,omitempty"` // Information regarding a piece of hardware's virtual software licenses. VirtualLicenses []Software_VirtualLicense `json:"virtualLicenses,omitempty" xmlrpc:"virtualLicenses,omitempty"` // Information regarding the bandwidth allotment to which a piece of hardware belongs. VirtualRack *Network_Bandwidth_Version1_Allotment `json:"virtualRack,omitempty" xmlrpc:"virtualRack,omitempty"` // The name of the bandwidth allotment belonging to a piece of hardware. VirtualRackId *int `json:"virtualRackId,omitempty" xmlrpc:"virtualRackId,omitempty"` // The name of the bandwidth allotment belonging to a piece of hardware. VirtualRackName *string `json:"virtualRackName,omitempty" xmlrpc:"virtualRackName,omitempty"` // A piece of hardware's virtualization platform software. VirtualizationPlatform *Software_Component `json:"virtualizationPlatform,omitempty" xmlrpc:"virtualizationPlatform,omitempty"` }
The SoftLayer_Hardware data type contains general information relating to a single SoftLayer hardware.
type Hardware_Attribute ¶
type Hardware_Attribute struct { Entity // The type of hardware attribute that this represents. HardwareAttributeType *Hardware_Attribute_Type `json:"hardwareAttributeType,omitempty" xmlrpc:"hardwareAttributeType,omitempty"` // The unique identifier of a hardware attribute's type. HardwareAttributeTypeId *int `json:"hardwareAttributeTypeId,omitempty" xmlrpc:"hardwareAttributeTypeId,omitempty"` // A hardware attribute's unique identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A hardware attribute's value. Value *string `json:"value,omitempty" xmlrpc:"value,omitempty"` }
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.
type Hardware_Attribute_Type ¶
type Hardware_Attribute_Type struct { Entity // The attribute type key name or code. Keyname *string `json:"keyname,omitempty" xmlrpc:"keyname,omitempty"` // The attribute type name. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
Retrieve attributes associated with a hardware object.
type Hardware_Attribute_UserData ¶
type Hardware_Attribute_UserData struct {
Hardware_Attribute
}
no documentation yet
type Hardware_Benchmark_Certification ¶
type Hardware_Benchmark_Certification struct { Entity // Information regarding a benchmark certification result's associated SoftLayer customer account. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // The internal identifier of the SoftLayer customer account associated with a benchmark certification result. AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // The date that a benchmark certification result was generated. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // Information regarding the piece of hardware on which a benchmark certification test was performed. Hardware *Hardware `json:"hardware,omitempty" xmlrpc:"hardware,omitempty"` // A benchmark certification results's associated hardware's internal identification number. HardwareId *int `json:"hardwareId,omitempty" xmlrpc:"hardwareId,omitempty"` }
The SoftLayer_Hardware_Benchmark_Certification data type contains general information relating to a single SoftLayer hardware benchmark certification document.
type Hardware_Blade ¶
type Hardware_Blade struct { Entity // no documentation yet CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // no documentation yet Disabled *int `json:"disabled,omitempty" xmlrpc:"disabled,omitempty"` // no documentation yet HardwareChild *Hardware `json:"hardwareChild,omitempty" xmlrpc:"hardwareChild,omitempty"` // no documentation yet HardwareChildId *int `json:"hardwareChildId,omitempty" xmlrpc:"hardwareChildId,omitempty"` // no documentation yet HardwareParent *Hardware `json:"hardwareParent,omitempty" xmlrpc:"hardwareParent,omitempty"` // no documentation yet HardwareParentId *int `json:"hardwareParentId,omitempty" xmlrpc:"hardwareParentId,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // The name of this blade as referenced by the operating system. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
no documentation yet
type Hardware_Chassis ¶
type Hardware_Chassis struct { Entity // no documentation yet BackplaneCapacity *string `json:"backplaneCapacity,omitempty" xmlrpc:"backplaneCapacity,omitempty"` // no documentation yet BayCapacity *string `json:"bayCapacity,omitempty" xmlrpc:"bayCapacity,omitempty"` // no documentation yet DriveCapacity *string `json:"driveCapacity,omitempty" xmlrpc:"driveCapacity,omitempty"` // no documentation yet DriveControllerCapacity *string `json:"driveControllerCapacity,omitempty" xmlrpc:"driveControllerCapacity,omitempty"` // A hardware form factor internal identifier. FormFactorId *int `json:"formFactorId,omitempty" xmlrpc:"formFactorId,omitempty"` // no documentation yet GpuCapacity *string `json:"gpuCapacity,omitempty" xmlrpc:"gpuCapacity,omitempty"` // A hardware's function. HardwareFunction *Hardware_Function `json:"hardwareFunction,omitempty" xmlrpc:"hardwareFunction,omitempty"` // A hardware chassis' internal identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A hardware chassis' manufacturer. Manufacturer *string `json:"manufacturer,omitempty" xmlrpc:"manufacturer,omitempty"` // no documentation yet ModuleCapacity *string `json:"moduleCapacity,omitempty" xmlrpc:"moduleCapacity,omitempty"` // A hardware chassis' name. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // no documentation yet PowerCapacity *string `json:"powerCapacity,omitempty" xmlrpc:"powerCapacity,omitempty"` // no documentation yet StorageShelfNode *string `json:"storageShelfNode,omitempty" xmlrpc:"storageShelfNode,omitempty"` // no documentation yet U2Capacity *string `json:"u2Capacity,omitempty" xmlrpc:"u2Capacity,omitempty"` // The physical size of a hardware chassis. Currently this relates to the 'U' size of a chassis buy default. UnitSize *int `json:"unitSize,omitempty" xmlrpc:"unitSize,omitempty"` // A hardware chassis' revision number. Version *string `json:"version,omitempty" xmlrpc:"version,omitempty"` }
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.
type Hardware_Component ¶
type Hardware_Component struct { Entity // A component's capacity. Capacity *Float64 `json:"capacity,omitempty" xmlrpc:"capacity,omitempty"` // A components sub components. Devices that are usually integrated or in some way attached to a component. Children []Hardware_Component `json:"children,omitempty" xmlrpc:"children,omitempty"` // A count of a components sub components. Devices that are usually integrated or in some way attached to a component. ChildrenCount *uint `json:"childrenCount,omitempty" xmlrpc:"childrenCount,omitempty"` // A component's Revision. ComponentRevision *string `json:"componentRevision,omitempty" xmlrpc:"componentRevision,omitempty"` // A count of DownlinkHardwareComponentCount *uint `json:"downlinkHardwareComponentCount,omitempty" xmlrpc:"downlinkHardwareComponentCount,omitempty"` // no documentation yet DownlinkHardwareComponents []Hardware_Component `json:"downlinkHardwareComponents,omitempty" xmlrpc:"downlinkHardwareComponents,omitempty"` // The hardware object that this component belongs to. Hardware *Hardware `json:"hardware,omitempty" xmlrpc:"hardware,omitempty"` // The general group of component models. HardwareComponentModel *Hardware_Component_Model `json:"hardwareComponentModel,omitempty" xmlrpc:"hardwareComponentModel,omitempty"` // The internal identifier of a hardware component's component model. HardwareComponentModelId *int `json:"hardwareComponentModelId,omitempty" xmlrpc:"hardwareComponentModelId,omitempty"` // A components type. HardwareComponentType *Hardware_Component_Type `json:"hardwareComponentType,omitempty" xmlrpc:"hardwareComponentType,omitempty"` // The internal identifier of the hardware that a hardware component resides inside. HardwareId *int `json:"hardwareId,omitempty" xmlrpc:"hardwareId,omitempty"` // no documentation yet HasUpgradeableFirmware *bool `json:"hasUpgradeableFirmware,omitempty" xmlrpc:"hasUpgradeableFirmware,omitempty"` // A hardware component's internal identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet IsChildModule *bool `json:"isChildModule,omitempty" xmlrpc:"isChildModule,omitempty"` // A count of returns the associated logic volume storage groups for the hardware component. LogicalVolumeStorageGroupCount *uint `json:"logicalVolumeStorageGroupCount,omitempty" xmlrpc:"logicalVolumeStorageGroupCount,omitempty"` // Returns the associated logic volume storage groups for the hardware component. LogicalVolumeStorageGroups []Configuration_Storage_Group `json:"logicalVolumeStorageGroups,omitempty" xmlrpc:"logicalVolumeStorageGroups,omitempty"` // A component's M.2 SATA capacity. M2SataSlotCapacity *string `json:"m2SataSlotCapacity,omitempty" xmlrpc:"m2SataSlotCapacity,omitempty"` // The date that a hardware component was last modified. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // A count of the module's hardware components ModuleComponentCount *uint `json:"moduleComponentCount,omitempty" xmlrpc:"moduleComponentCount,omitempty"` // The module's hardware components ModuleComponents []Hardware_Component `json:"moduleComponents,omitempty" xmlrpc:"moduleComponents,omitempty"` // A count of ModuleCount *uint `json:"moduleCount,omitempty" xmlrpc:"moduleCount,omitempty"` // A count of the module's hardware components ModuleHardwareComponentCount *uint `json:"moduleHardwareComponentCount,omitempty" xmlrpc:"moduleHardwareComponentCount,omitempty"` // The module's hardware components ModuleHardwareComponents []Hardware_Component `json:"moduleHardwareComponents,omitempty" xmlrpc:"moduleHardwareComponents,omitempty"` // A count of the module's network components ModuleNetworkComponentCount *uint `json:"moduleNetworkComponentCount,omitempty" xmlrpc:"moduleNetworkComponentCount,omitempty"` // The module's network components ModuleNetworkComponents []Hardware_Component `json:"moduleNetworkComponents,omitempty" xmlrpc:"moduleNetworkComponents,omitempty"` // no documentation yet Modules []Hardware_Component `json:"modules,omitempty" xmlrpc:"modules,omitempty"` // The name of this component as referenced by the operating system. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // A count of the components local ethernet and remote management interfaces NetworkComponentCount *uint `json:"networkComponentCount,omitempty" xmlrpc:"networkComponentCount,omitempty"` // The components local ethernet and remote management interfaces NetworkComponents []Network_Component `json:"networkComponents,omitempty" xmlrpc:"networkComponents,omitempty"` // The account this component belongs to. Owner *Account `json:"owner,omitempty" xmlrpc:"owner,omitempty"` // A components parent. Devices that are usually integrated or in some way attached to a component. Parent *Hardware_Component `json:"parent,omitempty" xmlrpc:"parent,omitempty"` // no documentation yet ParentModule *Hardware_Component `json:"parentModule,omitempty" xmlrpc:"parentModule,omitempty"` // no documentation yet PrefixAttribute *Hardware_Component_Model_Generic_Attribute `json:"prefixAttribute,omitempty" xmlrpc:"prefixAttribute,omitempty"` // A RAID controllers RAID mode. RaidMode *string `json:"raidMode,omitempty" xmlrpc:"raidMode,omitempty"` // The component revision designation. Revision *Hardware_Component_Revision `json:"revision,omitempty" xmlrpc:"revision,omitempty"` // The component serial number. SerialNumber *string `json:"serialNumber,omitempty" xmlrpc:"serialNumber,omitempty"` // no documentation yet ServiceProvider *Service_Provider `json:"serviceProvider,omitempty" xmlrpc:"serviceProvider,omitempty"` // A hardware's internal identification number at its service provider ServiceProviderId *int `json:"serviceProviderId,omitempty" xmlrpc:"serviceProviderId,omitempty"` // A count of UplinkHardwareComponentCount *uint `json:"uplinkHardwareComponentCount,omitempty" xmlrpc:"uplinkHardwareComponentCount,omitempty"` // no documentation yet UplinkHardwareComponents []Hardware_Component `json:"uplinkHardwareComponents,omitempty" xmlrpc:"uplinkHardwareComponents,omitempty"` }
The SoftLayer_Hardware_Component data type abstracts information related to a hardware component.
type Hardware_Component_Attribute ¶
type Hardware_Component_Attribute struct { Entity // A hardware component attribute's associated [[SoftLayer_Hardware_Component|Hardware Component]]. HardwareComponent *Hardware_Component `json:"hardwareComponent,omitempty" xmlrpc:"hardwareComponent,omitempty"` // A hardware component attribute's associated [[SoftLayer_Hardware_Component_Attribute_Type|type]]. HardwareComponentAttributeType *Hardware_Component_Attribute_Type `json:"hardwareComponentAttributeType,omitempty" xmlrpc:"hardwareComponentAttributeType,omitempty"` // A hardware component attribute's associated [[SoftLayer_Hardware_Component_Attribute_Type|type]] Id. HardwareComponentAttributeTypeId *int `json:"hardwareComponentAttributeTypeId,omitempty" xmlrpc:"hardwareComponentAttributeTypeId,omitempty"` // A hardware component attribute's associated [[SoftLayer_Hardware_Component|hardware component]] Id. HardwareComponentId *int `json:"hardwareComponentId,omitempty" xmlrpc:"hardwareComponentId,omitempty"` // A hardware component attribute's value. A value can have many different values depending on the attributes [[SoftLayer_Hardware_Component_Attribute_Type|type]]. Value *string `json:"value,omitempty" xmlrpc:"value,omitempty"` }
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.
type Hardware_Component_Attribute_Type ¶
type Hardware_Component_Attribute_Type struct { Entity // The description for the date that a hardware component attribute type's [[SoftLayer_Hardware_Component_Attribute|Attribute]] contains. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // A hardware component attribute type's Id. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A hardware component attribute type's unique name. KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // A hardware component attribute type's name. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
The SoftLayer_Hardware_Component_Attribute_Type data type contains general information for the type of an attribute for a hardware component.
type Hardware_Component_DriveController ¶
type Hardware_Component_DriveController struct {
Hardware_Component
}
The SoftLayer_Hardware_Component_DriveController data type abstracts information related to a drive controller.
type Hardware_Component_Firmware ¶
type Hardware_Component_Firmware struct { Entity // A count of AttributeCount *uint `json:"attributeCount,omitempty" xmlrpc:"attributeCount,omitempty"` // no documentation yet Attributes []Hardware_Component_Firmware_Attribute `json:"attributes,omitempty" xmlrpc:"attributes,omitempty"` // no documentation yet BuildDate *Time `json:"buildDate,omitempty" xmlrpc:"buildDate,omitempty"` // no documentation yet CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // The Hardware Component Model this Firmware applies to. HardwareComponentModel *Hardware_Component_Model `json:"hardwareComponentModel,omitempty" xmlrpc:"hardwareComponentModel,omitempty"` // no documentation yet HardwareComponentModelId *int `json:"hardwareComponentModelId,omitempty" xmlrpc:"hardwareComponentModelId,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet IsQualified *int `json:"isQualified,omitempty" xmlrpc:"isQualified,omitempty"` // no documentation yet QualificationType *Hardware_Component_Firmware_QualificationTypes `json:"qualificationType,omitempty" xmlrpc:"qualificationType,omitempty"` // no documentation yet ReleaseNotes *string `json:"releaseNotes,omitempty" xmlrpc:"releaseNotes,omitempty"` // A count of all revisions of this firmware. RevisionCount *uint `json:"revisionCount,omitempty" xmlrpc:"revisionCount,omitempty"` // All revisions of this firmware. Revisions []Hardware_Component_Revision `json:"revisions,omitempty" xmlrpc:"revisions,omitempty"` // no documentation yet Severity *int `json:"severity,omitempty" xmlrpc:"severity,omitempty"` // no documentation yet Version *string `json:"version,omitempty" xmlrpc:"version,omitempty"` }
no documentation yet
type Hardware_Component_Firmware_Attribute ¶
type Hardware_Component_Firmware_Attribute struct { Entity // A hardware component firmware attribute's associated [[SoftLayer_Hardware_Component_Firmware|firmware]]. Firmware *Hardware_Component_Firmware `json:"firmware,omitempty" xmlrpc:"firmware,omitempty"` // A hardware component firmware attribute's firmware Id. FirmwareId *int `json:"firmwareId,omitempty" xmlrpc:"firmwareId,omitempty"` // A hardware component firmware attribute's Id. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A hardware component firmware attribute's associated [[SoftLayer_Hardware_Component_Firmware_Attribute_Type|type]]. Type *Hardware_Component_Firmware_Attribute_Type `json:"type,omitempty" xmlrpc:"type,omitempty"` // A hardware component firmware attribute's type Id. TypeId *int `json:"typeId,omitempty" xmlrpc:"typeId,omitempty"` // A hardware component firmware attribute's value. Value *string `json:"value,omitempty" xmlrpc:"value,omitempty"` }
The SoftLayer_Hardware_Component_Firmware_Attribute data type contains general information for a hardware model's firmware.
type Hardware_Component_Firmware_Attribute_Type ¶
type Hardware_Component_Firmware_Attribute_Type struct { Entity // The description for the date that a hardware component attribute type's [[SoftLayer_Hardware_Component_Attribute|Attribute]] contains. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // A hardware component firmware attribute type's Id. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A hardware component firmware attribute type's unique name. KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // A hardware component firmware attribute type's name. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
The SoftLayer_Hardware_Component_Firmware_Attribute_Type data type defines attribute types for a hardware component model's firmware.
type Hardware_Component_Firmware_QualificationTypes ¶
type Hardware_Component_Firmware_QualificationTypes struct { Entity // A description about the qualificationType. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // The Id of the qualificationType. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // KeyName representation for the qualificationType. KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // The qualificationType name. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
The SoftLayer_Hardware_Component_Firmware_QualificationTypes data type describes the current qualification status for a particular firmware.
type Hardware_Component_HardDrive ¶
type Hardware_Component_HardDrive struct { Hardware_Component // A count of the attached component partitions. PartitionCount *uint `json:"partitionCount,omitempty" xmlrpc:"partitionCount,omitempty"` // The attached component partitions. Partitions []Hardware_Component_Partition `json:"partitions,omitempty" xmlrpc:"partitions,omitempty"` // A hard drives physical security ID. Psid *string `json:"psid,omitempty" xmlrpc:"psid,omitempty"` }
The SoftLayer_Hardware_Component_HardDrive data type abstracts information related to a hard drive.
type Hardware_Component_Locator ¶
type Hardware_Component_Locator struct {
Entity
}
no documentation yet
type Hardware_Component_Locator_Result ¶
type Hardware_Component_Locator_Result struct { Entity // array of datacenter names where generic component model is available Datacenters []string `json:"datacenters,omitempty" xmlrpc:"datacenters,omitempty"` // generic component model id GenericComponentModelId *int `json:"genericComponentModelId,omitempty" xmlrpc:"genericComponentModelId,omitempty"` // Id of SoftLayer_Product_Package_Server ServerPackageId *int `json:"serverPackageId,omitempty" xmlrpc:"serverPackageId,omitempty"` }
This object holds a generic component model id and the list of datacenter names where it is available.
type Hardware_Component_Model ¶
type Hardware_Component_Model struct { Entity // no documentation yet ArchitectureType *Hardware_Component_Model_Architecture_Type `json:"architectureType,omitempty" xmlrpc:"architectureType,omitempty"` // no documentation yet ArchitectureTypeId *string `json:"architectureTypeId,omitempty" xmlrpc:"architectureTypeId,omitempty"` // A count of AttributeCount *uint `json:"attributeCount,omitempty" xmlrpc:"attributeCount,omitempty"` // no documentation yet Attributes []Hardware_Component_Model_Attribute `json:"attributes,omitempty" xmlrpc:"attributes,omitempty"` // 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. Capacity *Float64 `json:"capacity,omitempty" xmlrpc:"capacity,omitempty"` // A count of CompatibleArrayTypeCount *uint `json:"compatibleArrayTypeCount,omitempty" xmlrpc:"compatibleArrayTypeCount,omitempty"` // no documentation yet CompatibleArrayTypes []Configuration_Storage_Group_Array_Type `json:"compatibleArrayTypes,omitempty" xmlrpc:"compatibleArrayTypes,omitempty"` // A count of all the component models that are compatible with a hardware component model. CompatibleChildComponentModelCount *uint `json:"compatibleChildComponentModelCount,omitempty" xmlrpc:"compatibleChildComponentModelCount,omitempty"` // All the component models that are compatible with a hardware component model. CompatibleChildComponentModels []Hardware_Component_Model `json:"compatibleChildComponentModels,omitempty" xmlrpc:"compatibleChildComponentModels,omitempty"` // A count of all the component models that a hardware component model is compatible with. CompatibleParentComponentModelCount *uint `json:"compatibleParentComponentModelCount,omitempty" xmlrpc:"compatibleParentComponentModelCount,omitempty"` // All the component models that a hardware component model is compatible with. CompatibleParentComponentModels []Hardware_Component_Model `json:"compatibleParentComponentModels,omitempty" xmlrpc:"compatibleParentComponentModels,omitempty"` // A colon delimited list of hardware component model attributes. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // A count of FirmwareCount *uint `json:"firmwareCount,omitempty" xmlrpc:"firmwareCount,omitempty"` // no documentation yet FirmwareQuantity *uint `json:"firmwareQuantity,omitempty" xmlrpc:"firmwareQuantity,omitempty"` // no documentation yet Firmwares []Hardware_Component_Firmware `json:"firmwares,omitempty" xmlrpc:"firmwares,omitempty"` // A hardware component model's physical components in inventory. HardwareComponents []Hardware_Component `json:"hardwareComponents,omitempty" xmlrpc:"hardwareComponents,omitempty"` // The non-vendor specific generic component model for a hardware component model. HardwareGenericComponentModel *Hardware_Component_Model_Generic `json:"hardwareGenericComponentModel,omitempty" xmlrpc:"hardwareGenericComponentModel,omitempty"` // The internal identifier of the generic component model for a component model. HardwareGenericComponentModelId *int `json:"hardwareGenericComponentModelId,omitempty" xmlrpc:"hardwareGenericComponentModelId,omitempty"` // A hardware component model's internal identifier number. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet InfinibandCompatibleAttribute *Hardware_Component_Model_Attribute `json:"infinibandCompatibleAttribute,omitempty" xmlrpc:"infinibandCompatibleAttribute,omitempty"` // no documentation yet IsFlexSkuCompatible *bool `json:"isFlexSkuCompatible,omitempty" xmlrpc:"isFlexSkuCompatible,omitempty"` // no documentation yet IsInfinibandCompatible *bool `json:"isInfinibandCompatible,omitempty" xmlrpc:"isInfinibandCompatible,omitempty"` // no documentation yet LongDescription *string `json:"longDescription,omitempty" xmlrpc:"longDescription,omitempty"` // A hardware component model's manufacturer. Manufacturer *string `json:"manufacturer,omitempty" xmlrpc:"manufacturer,omitempty"` // The model name of a hardware component model. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // A count of QualifiedFirmwareCount *uint `json:"qualifiedFirmwareCount,omitempty" xmlrpc:"qualifiedFirmwareCount,omitempty"` // no documentation yet QualifiedFirmwares []Hardware_Component_Firmware `json:"qualifiedFirmwares,omitempty" xmlrpc:"qualifiedFirmwares,omitempty"` // A motherboard's average reboot time. RebootTime *Hardware_Component_Motherboard_Reboot_Time `json:"rebootTime,omitempty" xmlrpc:"rebootTime,omitempty"` // A hardware component model's type. Type *string `json:"type,omitempty" xmlrpc:"type,omitempty"` // A count of the types of attributes that are allowed for a given hardware component model. ValidAttributeTypeCount *uint `json:"validAttributeTypeCount,omitempty" xmlrpc:"validAttributeTypeCount,omitempty"` // The types of attributes that are allowed for a given hardware component model. ValidAttributeTypes []Hardware_Component_Model_Attribute_Type `json:"validAttributeTypes,omitempty" xmlrpc:"validAttributeTypes,omitempty"` // The model number or model description of a hardware component model. Version *string `json:"version,omitempty" xmlrpc:"version,omitempty"` // A count of VmwareQualifiedFirmwareCount *uint `json:"vmwareQualifiedFirmwareCount,omitempty" xmlrpc:"vmwareQualifiedFirmwareCount,omitempty"` // no documentation yet VmwareQualifiedFirmwares []Hardware_Component_Firmware `json:"vmwareQualifiedFirmwares,omitempty" xmlrpc:"vmwareQualifiedFirmwares,omitempty"` }
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.
type Hardware_Component_Model_Architecture_Type ¶
type Hardware_Component_Model_Architecture_Type struct { Entity // no documentation yet Children []Hardware_Component_Model_Architecture_Type `json:"children,omitempty" xmlrpc:"children,omitempty"` // A count of ChildrenCount *uint `json:"childrenCount,omitempty" xmlrpc:"childrenCount,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // no documentation yet Parent *Hardware_Component_Model_Architecture_Type `json:"parent,omitempty" xmlrpc:"parent,omitempty"` // no documentation yet ParentId *string `json:"parentId,omitempty" xmlrpc:"parentId,omitempty"` }
no documentation yet
type Hardware_Component_Model_Attribute ¶
type Hardware_Component_Model_Attribute struct { Entity // A hardware component model attribute's associated [[SoftLayer_Hardware_Component_Model_Attribute_Type|type]] Id. AttributeTypeId *int `json:"attributeTypeId,omitempty" xmlrpc:"attributeTypeId,omitempty"` // no documentation yet HardwareComponent *Hardware_Component_Model `json:"hardwareComponent,omitempty" xmlrpc:"hardwareComponent,omitempty"` // no documentation yet HardwareComponentAttributeType *Hardware_Component_Model_Attribute_Type `json:"hardwareComponentAttributeType,omitempty" xmlrpc:"hardwareComponentAttributeType,omitempty"` // A hardware component model attribute's associated [[SoftLayer_Hardware_Component_Model|hardware component model]] Id. HardwareComponentModelId *int `json:"hardwareComponentModelId,omitempty" xmlrpc:"hardwareComponentModelId,omitempty"` // 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]]. Value *string `json:"value,omitempty" xmlrpc:"value,omitempty"` }
The SoftLayer_Hardware_Component__Model_Attribute data type contains general information relating to a single hardware setting or attribute for a component model.
type Hardware_Component_Model_Attribute_Type ¶
type Hardware_Component_Model_Attribute_Type struct { Entity // The description for the data that a hardware component model type's [[SoftLayer_Hardware_Component_Model_Attribute|Attribute]] contains. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // A hardware component model attribute type's Id. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A hardware component model attribute type's unique name. KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // A hardware component model attribute type's name. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // A count of ValidComponentTypeCount *uint `json:"validComponentTypeCount,omitempty" xmlrpc:"validComponentTypeCount,omitempty"` // no documentation yet ValidComponentTypes []Hardware_Component_Type `json:"validComponentTypes,omitempty" xmlrpc:"validComponentTypes,omitempty"` }
The SoftLayer_Hardware_Component_Model_Attribute_Type data type contains general information for the type of an attribute for a hardware component model.
type Hardware_Component_Model_Generic ¶
type Hardware_Component_Model_Generic struct { Entity // 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. Capacity *Float64 `json:"capacity,omitempty" xmlrpc:"capacity,omitempty"` // A brief description for a generic component model that typically defines it's function. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // A count of a generic component model's hardware component model. HardwareComponentModelCount *uint `json:"hardwareComponentModelCount,omitempty" xmlrpc:"hardwareComponentModelCount,omitempty"` // A generic component model's hardware component model. HardwareComponentModels []Hardware_Component_Model `json:"hardwareComponentModels,omitempty" xmlrpc:"hardwareComponentModels,omitempty"` // A generic component model's type. HardwareComponentType *Hardware_Component_Type `json:"hardwareComponentType,omitempty" xmlrpc:"hardwareComponentType,omitempty"` // The internal identifier of the component type for a generic component model. HardwareComponentTypeId *int `json:"hardwareComponentTypeId,omitempty" xmlrpc:"hardwareComponentTypeId,omitempty"` // A generic component model's internal identification number. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A list of features that a generic component model can provide. MarketingFeatures *Hardware_Component_Model_Generic_MarketingFeature `json:"marketingFeatures,omitempty" xmlrpc:"marketingFeatures,omitempty"` // The unit of measurement for the capacity of a generic component model. Units *string `json:"units,omitempty" xmlrpc:"units,omitempty"` // 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. UpgradePriority *int `json:"upgradePriority,omitempty" xmlrpc:"upgradePriority,omitempty"` }
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.
type Hardware_Component_Model_Generic_Attribute ¶
type Hardware_Component_Model_Generic_Attribute struct { Entity // An attributes generic component model. HardwareGenericComponentModel *Hardware_Component_Model_Generic `json:"hardwareGenericComponentModel,omitempty" xmlrpc:"hardwareGenericComponentModel,omitempty"` // A generic component model attribute's value. Value *string `json:"value,omitempty" xmlrpc:"value,omitempty"` }
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.
type Hardware_Component_Model_Generic_MarketingFeature ¶
type Hardware_Component_Model_Generic_MarketingFeature struct { Entity // An html formatted list of all features. Features *string `json:"features,omitempty" xmlrpc:"features,omitempty"` // The generic component model for a list of advertising or marketing features HardwareGenericComponentModel *Hardware_Component_Model_Generic `json:"hardwareGenericComponentModel,omitempty" xmlrpc:"hardwareGenericComponentModel,omitempty"` // A hardware component's upgrade price. Price *string `json:"price,omitempty" xmlrpc:"price,omitempty"` }
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.
type Hardware_Component_Motherboard ¶
type Hardware_Component_Motherboard struct {
Hardware_Component
}
The SoftLayer_Hardware_Component_DriveController data type abstracts information related to a motherboard.
type Hardware_Component_Motherboard_Reboot_Time ¶
type Hardware_Component_Motherboard_Reboot_Time struct { Entity // Motherboard's specifications (manufacturer, version, etc....) HardwareComponentModel *Hardware_Component_Model `json:"hardwareComponentModel,omitempty" xmlrpc:"hardwareComponentModel,omitempty"` // Average reboot time in seconds for the motherboard when raid is installed. WithRaid *int `json:"withRaid,omitempty" xmlrpc:"withRaid,omitempty"` // Average reboot time in seconds for the motherboard when NO raid is installed. WithoutRaid *int `json:"withoutRaid,omitempty" xmlrpc:"withoutRaid,omitempty"` }
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.
type Hardware_Component_NetworkCard ¶
type Hardware_Component_NetworkCard struct {
Hardware_Component
}
The SoftLayer_Hardware_Component_NetworkCard data type abstracts information related to a network card.
type Hardware_Component_PSID_Xref ¶ added in v1.0.2
type Hardware_Component_PSID_Xref struct { Entity // The hardware component the PSID belongs to. Component *Hardware_Component `json:"component,omitempty" xmlrpc:"component,omitempty"` // no documentation yet ComponentId *int `json:"componentId,omitempty" xmlrpc:"componentId,omitempty"` // no documentation yet Psid *string `json:"psid,omitempty" xmlrpc:"psid,omitempty"` }
The SoftLayer_Hardware_Component_PSID_Xref data type holds physical security ID information for hard drives
type Hardware_Component_Partition ¶
type Hardware_Component_Partition struct { Entity // A hardware component partition's order in the [[SoftLayer_Hardware_Server]]. DiskNumber *int `json:"diskNumber,omitempty" xmlrpc:"diskNumber,omitempty"` // A flag indicating if a partition is the grow partition. The grow partition will grow to fill all remaining space on a disk. There can only be one. Grow *int `json:"grow,omitempty" xmlrpc:"grow,omitempty"` // A hardware component partitions's associated [[SoftLayer_Hardware_Component|Hardware Component]]. Likely to be a [[SoftLayer_Hardware_Component_HardDrive|Hard Drive]] HardwareComponent *Hardware_Component `json:"hardwareComponent,omitempty" xmlrpc:"hardwareComponent,omitempty"` // A hardware component partition's associated [[SoftLayer_Hardware_Component|hardware component]] Id. HardwareComponentId *int `json:"hardwareComponentId,omitempty" xmlrpc:"hardwareComponentId,omitempty"` // A hardware component partition's minimum size(GB). MinimumSize *Float64 `json:"minimumSize,omitempty" xmlrpc:"minimumSize,omitempty"` // A hardware component partition's name. On a server with windows this may be 'C' and on Linux this may be '/var' Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
The SoftLayer_Hardware_Component_Partition data type contains general information relating to a single hard drive partition.
type Hardware_Component_Partition_OperatingSystem ¶
type Hardware_Component_Partition_OperatingSystem struct { Entity // A partition template operating system's description. Typically the title of the Operating System. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // A partition template operating system's id. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Information about the kinds of partition templates assigned to this operating system. Notes *string `json:"notes,omitempty" xmlrpc:"notes,omitempty"` // A count of information regarding an operating system's [[SoftLayer_Hardware_Component_Partition_Template|Partition Templates]]. PartitionTemplateCount *uint `json:"partitionTemplateCount,omitempty" xmlrpc:"partitionTemplateCount,omitempty"` // Information regarding an operating system's [[SoftLayer_Hardware_Component_Partition_Template|Partition Templates]]. PartitionTemplates []Hardware_Component_Partition_Template `json:"partitionTemplates,omitempty" xmlrpc:"partitionTemplates,omitempty"` }
The SoftLayer_Hardware_Component_Partition_OperatingSystem data type contains general information relating to a single SoftLayer Operating System Partition Template.
type Hardware_Component_Partition_Template ¶
type Hardware_Component_Partition_Template struct { Entity // A partition template's associated [[SoftLayer_Account|Account]]. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // A partition template's owner. The [[SoftLayer_Account|Account]] that a template was created by. AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // An individual partition for a partition template. This is identical to 'partitionTemplatePartition' except this will sort unix partitions. Data []Hardware_Component_Partition_Template_Partition `json:"data,omitempty" xmlrpc:"data,omitempty"` // A count of an individual partition for a partition template. This is identical to 'partitionTemplatePartition' except this will sort unix partitions. DataCount *uint `json:"dataCount,omitempty" xmlrpc:"dataCount,omitempty"` // A partition template's description. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // no documentation yet ExpireDate *string `json:"expireDate,omitempty" xmlrpc:"expireDate,omitempty"` // A partition template's id. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A partition template's associated [[SoftLayer_Hardware_Component_Partition_OperatingSystem|Operating System]]. PartitionOperatingSystem *Hardware_Component_Partition_OperatingSystem `json:"partitionOperatingSystem,omitempty" xmlrpc:"partitionOperatingSystem,omitempty"` // A partition template's associated [[SoftLayer_Hardware_Component_Partition_OperatingSystem|Operating System]] Id. PartitionOperatingSystemId *int `json:"partitionOperatingSystemId,omitempty" xmlrpc:"partitionOperatingSystemId,omitempty"` // An individual partition for a partition template. PartitionTemplatePartition []Hardware_Component_Partition_Template_Partition `json:"partitionTemplatePartition,omitempty" xmlrpc:"partitionTemplatePartition,omitempty"` // A count of an individual partition for a partition template. PartitionTemplatePartitionCount *uint `json:"partitionTemplatePartitionCount,omitempty" xmlrpc:"partitionTemplatePartitionCount,omitempty"` // A partition template's status code. ACTIVE ,INACTIVE. StatusCode *string `json:"statusCode,omitempty" xmlrpc:"statusCode,omitempty"` // A partition template's Type. SYSTEM - template generated by softlayer. CUSTOM - templates generated by SoftLayer customers. TemplateType *string `json:"templateType,omitempty" xmlrpc:"templateType,omitempty"` }
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.
type Hardware_Component_Partition_Template_Partition ¶
type Hardware_Component_Partition_Template_Partition struct { Entity // The filesystem type of a partition FilesystemType *Configuration_Storage_Filesystem_Type `json:"filesystemType,omitempty" xmlrpc:"filesystemType,omitempty"` // A partition's id. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // 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. IsGrow *bool `json:"isGrow,omitempty" xmlrpc:"isGrow,omitempty"` // A partition's default name. PartitionName *string `json:"partitionName,omitempty" xmlrpc:"partitionName,omitempty"` // A partition's default size. PartitionSize *Float64 `json:"partitionSize,omitempty" xmlrpc:"partitionSize,omitempty"` // A partition's [[SoftLayer_Hardware_Component_Partition_Template|Partition Template]]. PartitionTemplate *Hardware_Component_Partition_Template `json:"partitionTemplate,omitempty" xmlrpc:"partitionTemplate,omitempty"` // A partition's associated [[SoftLayer_Hardware_Component_Partition_Template|Partition Template]] Id. PartitionTemplateId *int `json:"partitionTemplateId,omitempty" xmlrpc:"partitionTemplateId,omitempty"` // The volume the partition will be put on VolumeNumber *int `json:"volumeNumber,omitempty" xmlrpc:"volumeNumber,omitempty"` }
The SoftLayer_Hardware_Component_Partition_Template_Partition data type contains general information relating to a single SoftLayer Template Partition.
type Hardware_Component_Processor ¶
type Hardware_Component_Processor struct {
Hardware_Component
}
The SoftLayer_Hardware_Component_Processor data type abstracts information related to a processor.
type Hardware_Component_Ram ¶
type Hardware_Component_Ram struct {
Hardware_Component
}
The SoftLayer_Hardware_Component_Ram data type abstracts information related to RAM.
type Hardware_Component_RemoteManagement ¶
type Hardware_Component_RemoteManagement struct { Hardware_Component // A network component data type. NetworkComponent *Network_Component `json:"networkComponent,omitempty" xmlrpc:"networkComponent,omitempty"` }
This class adds functionality to the base SoftLayer_Hardware class for web servers (all server hardware)
type Hardware_Component_RemoteManagement_Command ¶
type Hardware_Component_RemoteManagement_Command struct { Entity // The name of the remote management command. KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // A count of all requests issued for the remote management command. RequestCount *uint `json:"requestCount,omitempty" xmlrpc:"requestCount,omitempty"` // All requests issued for the remote management command. Requests []Hardware_Component_RemoteManagement_Command_Request `json:"requests,omitempty" xmlrpc:"requests,omitempty"` }
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.
type Hardware_Component_RemoteManagement_Command_Request ¶
type Hardware_Component_RemoteManagement_Command_Request struct { Entity // The timestamp the remote management command was issued. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // The id of the hardware to perform the remote management or powerstrip command on. Hardware *Hardware `json:"hardware,omitempty" xmlrpc:"hardware,omitempty"` // The hardware id the command was issued for. HardwareId *int `json:"hardwareId,omitempty" xmlrpc:"hardwareId,omitempty"` // The timestamp recorded when the remote management command returned a status of the command issued. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // A hardware's network components. Network components are hardware components such as IPMI cards or Ethernet cards. NetworkComponent *Network_Component `json:"networkComponent,omitempty" xmlrpc:"networkComponent,omitempty"` // Execution status of the remote management command. True is successful. False is failure. Processed *bool `json:"processed,omitempty" xmlrpc:"processed,omitempty"` // The remote management command issued. RemoteManagementCommand *Hardware_Component_RemoteManagement_Command `json:"remoteManagementCommand,omitempty" xmlrpc:"remoteManagementCommand,omitempty"` // Information regarding the user who issued the remote management command. User *User_Customer `json:"user,omitempty" xmlrpc:"user,omitempty"` }
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.
type Hardware_Component_RemoteManagement_User ¶
type Hardware_Component_RemoteManagement_User struct { Entity // no documentation yet Hardware *Hardware `json:"hardware,omitempty" xmlrpc:"hardware,omitempty"` // no documentation yet NetworkComponent *Network_Component `json:"networkComponent,omitempty" xmlrpc:"networkComponent,omitempty"` // The password used for this remote management command. Password *string `json:"password,omitempty" xmlrpc:"password,omitempty"` // The username used for this remote management command. Username *string `json:"username,omitempty" xmlrpc:"username,omitempty"` }
The credentials used for remote management such as username, password, etc...
type Hardware_Component_Revision ¶
type Hardware_Component_Revision struct { Entity // The firmware build date BiosDate *Time `json:"biosDate,omitempty" xmlrpc:"biosDate,omitempty"` // The Firmware installed on this record's Hardware Component. Firmware *Hardware_Component_Firmware `json:"firmware,omitempty" xmlrpc:"firmware,omitempty"` // no documentation yet FirmwareVersionId *int `json:"firmwareVersionId,omitempty" xmlrpc:"firmwareVersionId,omitempty"` // The Hardware Component this revision record applies to. HardwareComponent *Hardware_Component `json:"hardwareComponent,omitempty" xmlrpc:"hardwareComponent,omitempty"` // no documentation yet HardwareComponentId *int `json:"hardwareComponentId,omitempty" xmlrpc:"hardwareComponentId,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The firmware revision Revision *string `json:"revision,omitempty" xmlrpc:"revision,omitempty"` }
no documentation yet
type Hardware_Component_SecurityDevice ¶
type Hardware_Component_SecurityDevice struct {
Hardware_Component
}
The SoftLayer_Hardware_Component_SecurityDevice is used to determine the security devices attached to the hardware component.
type Hardware_Component_SecurityDevice_Infineon ¶
type Hardware_Component_SecurityDevice_Infineon struct {
Hardware_Component_SecurityDevice
}
The SoftLayer_Hardware_Component_SecurityDevice_Infineon is used to determine the Infineon security device attached to the hardware component.
type Hardware_Component_Type ¶
type Hardware_Component_Type struct { Entity // A count of the generic component model description for this component type object. HardwareGenericComponentModelCount *uint `json:"hardwareGenericComponentModelCount,omitempty" xmlrpc:"hardwareGenericComponentModelCount,omitempty"` // The generic component model description for this component type object. HardwareGenericComponentModels []Hardware_Component_Model_Generic `json:"hardwareGenericComponentModels,omitempty" xmlrpc:"hardwareGenericComponentModels,omitempty"` // The ID associated with this component type. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The hardware component type key name or code. KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // The type associated with this component type. Type *string `json:"type,omitempty" xmlrpc:"type,omitempty"` // The parent generic component model object for this generic component model object. TypeParent *Hardware_Component_Type `json:"typeParent,omitempty" xmlrpc:"typeParent,omitempty"` // The parent id associated with this component type. TypeParentId *int `json:"typeParentId,omitempty" xmlrpc:"typeParentId,omitempty"` }
The SoftLayer_Hardware_Component_Type data type provides details on the type of component requested
type Hardware_Firewall ¶
type Hardware_Firewall struct { Hardware_Switch // The firewall's primary public IP address. PrimaryIpAddress *string `json:"primaryIpAddress,omitempty" xmlrpc:"primaryIpAddress,omitempty"` // A count of a list of users that have access to this hardware firewall. UserCount *uint `json:"userCount,omitempty" xmlrpc:"userCount,omitempty"` // A list of users that have access to this hardware firewall. Users []User_Customer `json:"users,omitempty" xmlrpc:"users,omitempty"` }
The SoftLayer_Hardware_Firewall data type contains general information relating to a single SoftLayer firewall.
type Hardware_Function ¶
type Hardware_Function struct { Entity // The code associated with this hardware function. Code *string `json:"code,omitempty" xmlrpc:"code,omitempty"` // The description for a hardware function. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // The id associated with a hardware function. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` }
The SoftLayer_Hardware_Function data type contains a generic object type for a piece of hardware, like switch, firewall, server, etc..
type Hardware_Group ¶
type Hardware_Group struct { Entity // no documentation yet Domain *string `json:"domain,omitempty" xmlrpc:"domain,omitempty"` // A count of all servers attached to a network hardware. DownlinkServerCount *uint `json:"downlinkServerCount,omitempty" xmlrpc:"downlinkServerCount,omitempty"` // All servers attached to a network hardware. DownlinkServers []Hardware `json:"downlinkServers,omitempty" xmlrpc:"downlinkServers,omitempty"` // A count of all virtual guests attached to a network hardware. DownlinkVirtualGuestCount *uint `json:"downlinkVirtualGuestCount,omitempty" xmlrpc:"downlinkVirtualGuestCount,omitempty"` // All virtual guests attached to a network hardware. DownlinkVirtualGuests []Virtual_Guest `json:"downlinkVirtualGuests,omitempty" xmlrpc:"downlinkVirtualGuests,omitempty"` // All network hardware downstream from this hardware. DownstreamNetworkHardware []Hardware `json:"downstreamNetworkHardware,omitempty" xmlrpc:"downstreamNetworkHardware,omitempty"` // A count of all network hardware downstream from this hardware. DownstreamNetworkHardwareCount *uint `json:"downstreamNetworkHardwareCount,omitempty" xmlrpc:"downstreamNetworkHardwareCount,omitempty"` // A count of all network hardware with monitoring warnings or errors downstream from this hardware. [DEPRECATED] DownstreamNetworkHardwareWithIncidentCount *uint `json:"downstreamNetworkHardwareWithIncidentCount,omitempty" xmlrpc:"downstreamNetworkHardwareWithIncidentCount,omitempty"` // All network hardware with monitoring warnings or errors downstream from this hardware. [DEPRECATED] // Deprecated: This function has been marked as deprecated. DownstreamNetworkHardwareWithIncidents []Hardware `json:"downstreamNetworkHardwareWithIncidents,omitempty" xmlrpc:"downstreamNetworkHardwareWithIncidents,omitempty"` // The chassis that a piece of hardware is housed in. HardwareChassis *Hardware_Chassis `json:"hardwareChassis,omitempty" xmlrpc:"hardwareChassis,omitempty"` // no documentation yet Hostname *string `json:"hostname,omitempty" xmlrpc:"hostname,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // All servers attached downstream to a hardware that have failed monitoring NetworkMonitorAttachedDownHardware []Hardware `json:"networkMonitorAttachedDownHardware,omitempty" xmlrpc:"networkMonitorAttachedDownHardware,omitempty"` // A count of all servers attached downstream to a hardware that have failed monitoring NetworkMonitorAttachedDownHardwareCount *uint `json:"networkMonitorAttachedDownHardwareCount,omitempty" xmlrpc:"networkMonitorAttachedDownHardwareCount,omitempty"` // A count of virtual guests that are attached downstream to a hardware that have failed monitoring NetworkMonitorAttachedDownVirtualGuestCount *uint `json:"networkMonitorAttachedDownVirtualGuestCount,omitempty" xmlrpc:"networkMonitorAttachedDownVirtualGuestCount,omitempty"` // Virtual guests that are attached downstream to a hardware that have failed monitoring NetworkMonitorAttachedDownVirtualGuests []Virtual_Guest `json:"networkMonitorAttachedDownVirtualGuests,omitempty" xmlrpc:"networkMonitorAttachedDownVirtualGuests,omitempty"` // The value of a hardware's network status attribute. [DEPRECATED] // Deprecated: This function has been marked as deprecated. NetworkStatus *string `json:"networkStatus,omitempty" xmlrpc:"networkStatus,omitempty"` }
no documentation yet
type Hardware_LoadBalancer ¶
type Hardware_LoadBalancer struct { Hardware // no documentation yet ModelFamily *string `json:"modelFamily,omitempty" xmlrpc:"modelFamily,omitempty"` // A count of a list of users that have access to this hardware load balancer. UserCount *uint `json:"userCount,omitempty" xmlrpc:"userCount,omitempty"` // A list of users that have access to this hardware load balancer. Users []User_Customer `json:"users,omitempty" xmlrpc:"users,omitempty"` }
no documentation yet
type Hardware_Note ¶
type Hardware_Note struct { Entity // no documentation yet CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // no documentation yet Employee *User_Employee `json:"employee,omitempty" xmlrpc:"employee,omitempty"` // no documentation yet Hardware *Hardware `json:"hardware,omitempty" xmlrpc:"hardware,omitempty"` // no documentation yet HardwareId *int `json:"hardwareId,omitempty" xmlrpc:"hardwareId,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // no documentation yet Note *string `json:"note,omitempty" xmlrpc:"note,omitempty"` // no documentation yet Type *Hardware_Note_Type `json:"type,omitempty" xmlrpc:"type,omitempty"` // no documentation yet TypeId *int `json:"typeId,omitempty" xmlrpc:"typeId,omitempty"` // no documentation yet User *User_Customer `json:"user,omitempty" xmlrpc:"user,omitempty"` // no documentation yet UserRecordId *int `json:"userRecordId,omitempty" xmlrpc:"userRecordId,omitempty"` }
no documentation yet
type Hardware_Note_Type ¶
type Hardware_Note_Type struct { Entity // no documentation yet KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` }
no documentation yet
type Hardware_Power_Component ¶
type Hardware_Power_Component struct { Entity // no documentation yet Hardware *Hardware `json:"hardware,omitempty" xmlrpc:"hardware,omitempty"` // no documentation yet HardwareId *int `json:"hardwareId,omitempty" xmlrpc:"hardwareId,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` }
no documentation yet
type Hardware_Resource_Configuration ¶
type Hardware_Resource_Configuration struct { Entity // no documentation yet ConfigurationTypeId *int `json:"configurationTypeId,omitempty" xmlrpc:"configurationTypeId,omitempty"` // no documentation yet Hardware *Hardware `json:"hardware,omitempty" xmlrpc:"hardware,omitempty"` // no documentation yet HardwareId *int `json:"hardwareId,omitempty" xmlrpc:"hardwareId,omitempty"` // no documentation yet Properties []Hardware_Resource_Configuration_Property `json:"properties,omitempty" xmlrpc:"properties,omitempty"` // A count of PropertyCount *uint `json:"propertyCount,omitempty" xmlrpc:"propertyCount,omitempty"` // no documentation yet Type *Hardware_Resource_Configuration_Type `json:"type,omitempty" xmlrpc:"type,omitempty"` }
no documentation yet
type Hardware_Resource_Configuration_Property ¶
type Hardware_Resource_Configuration_Property struct { Entity // no documentation yet Configuration *Hardware_Resource_Configuration `json:"configuration,omitempty" xmlrpc:"configuration,omitempty"` // no documentation yet ConfigurationId *int `json:"configurationId,omitempty" xmlrpc:"configurationId,omitempty"` // no documentation yet ConfigurationPropertyTypeId *int `json:"configurationPropertyTypeId,omitempty" xmlrpc:"configurationPropertyTypeId,omitempty"` // no documentation yet Type *Hardware_Resource_Configuration_Property_Type `json:"type,omitempty" xmlrpc:"type,omitempty"` // no documentation yet Value *string `json:"value,omitempty" xmlrpc:"value,omitempty"` }
no documentation yet
type Hardware_Resource_Configuration_Property_Type ¶
type Hardware_Resource_Configuration_Property_Type struct { Entity // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // no documentation yet Properties []Hardware_Resource_Configuration_Property `json:"properties,omitempty" xmlrpc:"properties,omitempty"` // A count of PropertyCount *uint `json:"propertyCount,omitempty" xmlrpc:"propertyCount,omitempty"` // no documentation yet Unit *string `json:"unit,omitempty" xmlrpc:"unit,omitempty"` }
no documentation yet
type Hardware_Resource_Configuration_Type ¶
type Hardware_Resource_Configuration_Type struct { Entity // no documentation yet KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
no documentation yet
type Hardware_Router ¶
type Hardware_Router struct { Hardware_Switch // A count of associated subnets for a router object. BoundSubnetCount *uint `json:"boundSubnetCount,omitempty" xmlrpc:"boundSubnetCount,omitempty"` // Associated subnets for a router object. BoundSubnets []Network_Subnet `json:"boundSubnets,omitempty" xmlrpc:"boundSubnets,omitempty"` // A flag indicating that a VLAN on the router can be assigned to a host that has local disk functionality. LocalDiskStorageCapabilityFlag *bool `json:"localDiskStorageCapabilityFlag,omitempty" xmlrpc:"localDiskStorageCapabilityFlag,omitempty"` // A flag indicating that a VLAN on the router can be assigned to a host that has SAN disk functionality. SanStorageCapabilityFlag *bool `json:"sanStorageCapabilityFlag,omitempty" xmlrpc:"sanStorageCapabilityFlag,omitempty"` }
The SoftLayer_Hardware_Router data type contains general information relating to a single SoftLayer router.
type Hardware_Router_Backend ¶
type Hardware_Router_Backend struct {
Hardware_Router
}
The SoftLayer_Hardware_Router_Backend data type contains general information relating to a single SoftLayer router item for hardware.
type Hardware_Router_Frontend ¶
type Hardware_Router_Frontend struct {
Hardware_Router
}
The SoftLayer_Hardware_Router_Frontend data type contains general information relating to a single SoftLayer router item for hardware.
type Hardware_SecurityModule ¶
type Hardware_SecurityModule struct {
Hardware_Server
}
no documentation yet
type Hardware_SecurityModule750 ¶
type Hardware_SecurityModule750 struct {
Hardware_SecurityModule
}
no documentation yet
type Hardware_Server ¶
type Hardware_Server struct { Hardware // The billing item for a server's attached network firewall. ActiveNetworkFirewallBillingItem *Billing_Item `json:"activeNetworkFirewallBillingItem,omitempty" xmlrpc:"activeNetworkFirewallBillingItem,omitempty"` // A count of ActiveTicketCount *uint `json:"activeTicketCount,omitempty" xmlrpc:"activeTicketCount,omitempty"` // no documentation yet ActiveTickets []Ticket `json:"activeTickets,omitempty" xmlrpc:"activeTickets,omitempty"` // Transaction currently running for server. ActiveTransaction *Provisioning_Version1_Transaction `json:"activeTransaction,omitempty" xmlrpc:"activeTransaction,omitempty"` // A count of any active transaction(s) that are currently running for the server (example: os reload). ActiveTransactionCount *uint `json:"activeTransactionCount,omitempty" xmlrpc:"activeTransactionCount,omitempty"` // Any active transaction(s) that are currently running for the server (example: os reload). ActiveTransactions []Provisioning_Version1_Transaction `json:"activeTransactions,omitempty" xmlrpc:"activeTransactions,omitempty"` // An object that stores the maximum level for the monitoring query types and response types. AvailableMonitoring []Network_Monitor_Version1_Query_Host_Stratum `json:"availableMonitoring,omitempty" xmlrpc:"availableMonitoring,omitempty"` // A count of an object that stores the maximum level for the monitoring query types and response types. AvailableMonitoringCount *uint `json:"availableMonitoringCount,omitempty" xmlrpc:"availableMonitoringCount,omitempty"` // The average daily total bandwidth usage for the current billing cycle. AverageDailyBandwidthUsage *Float64 `json:"averageDailyBandwidthUsage,omitempty" xmlrpc:"averageDailyBandwidthUsage,omitempty"` // The average daily private bandwidth usage for the current billing cycle. AverageDailyPrivateBandwidthUsage *Float64 `json:"averageDailyPrivateBandwidthUsage,omitempty" xmlrpc:"averageDailyPrivateBandwidthUsage,omitempty"` // The raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to. BillingCycleBandwidthUsage []Network_Bandwidth_Usage `json:"billingCycleBandwidthUsage,omitempty" xmlrpc:"billingCycleBandwidthUsage,omitempty"` // 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. BillingCycleBandwidthUsageCount *uint `json:"billingCycleBandwidthUsageCount,omitempty" xmlrpc:"billingCycleBandwidthUsageCount,omitempty"` // The raw private bandwidth usage data for the current billing cycle. BillingCyclePrivateBandwidthUsage *Network_Bandwidth_Usage `json:"billingCyclePrivateBandwidthUsage,omitempty" xmlrpc:"billingCyclePrivateBandwidthUsage,omitempty"` // The raw public bandwidth usage data for the current billing cycle. BillingCyclePublicBandwidthUsage *Network_Bandwidth_Usage `json:"billingCyclePublicBandwidthUsage,omitempty" xmlrpc:"billingCyclePublicBandwidthUsage,omitempty"` // Determine if BIOS password should be left as null. BiosPasswordNullFlag *bool `json:"biosPasswordNullFlag,omitempty" xmlrpc:"biosPasswordNullFlag,omitempty"` // Determine if the server is able to be image captured. If unable to image capture a reason will be provided. CaptureEnabledFlag *Container_Hardware_CaptureEnabled `json:"captureEnabledFlag,omitempty" xmlrpc:"captureEnabledFlag,omitempty"` // no documentation yet ContainsSolidStateDrivesFlag *bool `json:"containsSolidStateDrivesFlag,omitempty" xmlrpc:"containsSolidStateDrivesFlag,omitempty"` // A server's control panel. ControlPanel *Software_Component_ControlPanel `json:"controlPanel,omitempty" xmlrpc:"controlPanel,omitempty"` // The total cost of a server, measured in US Dollars ($USD). Cost *Float64 `json:"cost,omitempty" xmlrpc:"cost,omitempty"` // An object that provides commonly used bandwidth summary components for the current billing cycle. CurrentBandwidthSummary *Metric_Tracking_Object_Bandwidth_Summary `json:"currentBandwidthSummary,omitempty" xmlrpc:"currentBandwidthSummary,omitempty"` // Indicates if a server has a Customer Installed OS CustomerInstalledOperatingSystemFlag *bool `json:"customerInstalledOperatingSystemFlag,omitempty" xmlrpc:"customerInstalledOperatingSystemFlag,omitempty"` // Indicates if a server is a customer owned device. CustomerOwnedFlag *bool `json:"customerOwnedFlag,omitempty" xmlrpc:"customerOwnedFlag,omitempty"` // Determine if hardware has Single Root IO VIrtualization (SR-IOV) billing item. HasSingleRootVirtualizationBillingItemFlag *bool `json:"hasSingleRootVirtualizationBillingItemFlag,omitempty" xmlrpc:"hasSingleRootVirtualizationBillingItemFlag,omitempty"` // The total private inbound bandwidth for this hardware for the current billing cycle. InboundPrivateBandwidthUsage *Float64 `json:"inboundPrivateBandwidthUsage,omitempty" xmlrpc:"inboundPrivateBandwidthUsage,omitempty"` // Determine if remote management has been disabled due to port speed. IsIpmiDisabled *bool `json:"isIpmiDisabled,omitempty" xmlrpc:"isIpmiDisabled,omitempty"` // A server that has nfs only drive. IsNfsOnly *string `json:"isNfsOnly,omitempty" xmlrpc:"isNfsOnly,omitempty"` // Determine if hardware object has the QE_INTERNAL_SERVER attribute. IsQeInternalServer *bool `json:"isQeInternalServer,omitempty" xmlrpc:"isQeInternalServer,omitempty"` // Determine if hardware object is a Virtual Private Cloud node. IsVirtualPrivateCloudNode *bool `json:"isVirtualPrivateCloudNode,omitempty" xmlrpc:"isVirtualPrivateCloudNode,omitempty"` // The last transaction that a server's operating system was loaded. LastOperatingSystemReload *Provisioning_Version1_Transaction `json:"lastOperatingSystemReload,omitempty" xmlrpc:"lastOperatingSystemReload,omitempty"` // A count of returns a list of logical volumes on the physical machine. LogicalVolumeStorageGroupCount *uint `json:"logicalVolumeStorageGroupCount,omitempty" xmlrpc:"logicalVolumeStorageGroupCount,omitempty"` // Returns a list of logical volumes on the physical machine. LogicalVolumeStorageGroups []Configuration_Storage_Group `json:"logicalVolumeStorageGroups,omitempty" xmlrpc:"logicalVolumeStorageGroups,omitempty"` // The metric tracking object id for this server. MetricTrackingObjectId *int `json:"metricTrackingObjectId,omitempty" xmlrpc:"metricTrackingObjectId,omitempty"` // 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 MonitoringUserNotification []User_Customer_Notification_Hardware `json:"monitoringUserNotification,omitempty" xmlrpc:"monitoringUserNotification,omitempty"` // 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 MonitoringUserNotificationCount *uint `json:"monitoringUserNotificationCount,omitempty" xmlrpc:"monitoringUserNotificationCount,omitempty"` // An open ticket requesting cancellation of this server, if one exists. OpenCancellationTicket *Ticket `json:"openCancellationTicket,omitempty" xmlrpc:"openCancellationTicket,omitempty"` // The total private outbound bandwidth for this hardware for the current billing cycle. OutboundPrivateBandwidthUsage *Float64 `json:"outboundPrivateBandwidthUsage,omitempty" xmlrpc:"outboundPrivateBandwidthUsage,omitempty"` // Whether the bandwidth usage for this hardware for the current billing cycle exceeds the allocation. OverBandwidthAllocationFlag *int `json:"overBandwidthAllocationFlag,omitempty" xmlrpc:"overBandwidthAllocationFlag,omitempty"` // A count of PartitionCount *uint `json:"partitionCount,omitempty" xmlrpc:"partitionCount,omitempty"` // no documentation yet Partitions []Hardware_Server_Partition `json:"partitions,omitempty" xmlrpc:"partitions,omitempty"` // A count of a collection of backendNetwork components PrivateBackendNetworkComponentCount *uint `json:"privateBackendNetworkComponentCount,omitempty" xmlrpc:"privateBackendNetworkComponentCount,omitempty"` // A collection of backendNetwork components PrivateBackendNetworkComponents []Network_Component `json:"privateBackendNetworkComponents,omitempty" xmlrpc:"privateBackendNetworkComponents,omitempty"` // A server's primary private IP address. PrivateIpAddress *string `json:"privateIpAddress,omitempty" xmlrpc:"privateIpAddress,omitempty"` // Whether the bandwidth usage for this hardware for the current billing cycle is projected to exceed the allocation. ProjectedOverBandwidthAllocationFlag *int `json:"projectedOverBandwidthAllocationFlag,omitempty" xmlrpc:"projectedOverBandwidthAllocationFlag,omitempty"` // The projected public outbound bandwidth for this hardware for the current billing cycle. ProjectedPublicBandwidthUsage *Float64 `json:"projectedPublicBandwidthUsage,omitempty" xmlrpc:"projectedPublicBandwidthUsage,omitempty"` // Determine if hardware object is vSan Ready Node. ReadyNodeFlag *bool `json:"readyNodeFlag,omitempty" xmlrpc:"readyNodeFlag,omitempty"` // A count of the last five commands issued to the server's remote management card. RecentRemoteManagementCommandCount *uint `json:"recentRemoteManagementCommandCount,omitempty" xmlrpc:"recentRemoteManagementCommandCount,omitempty"` // The last five commands issued to the server's remote management card. RecentRemoteManagementCommands []Hardware_Component_RemoteManagement_Command_Request `json:"recentRemoteManagementCommands,omitempty" xmlrpc:"recentRemoteManagementCommands,omitempty"` // no documentation yet RegionalInternetRegistry *Network_Regional_Internet_Registry `json:"regionalInternetRegistry,omitempty" xmlrpc:"regionalInternetRegistry,omitempty"` // A server's remote management card. RemoteManagement *Hardware_Component_RemoteManagement `json:"remoteManagement,omitempty" xmlrpc:"remoteManagement,omitempty"` // A count of user(s) who have access to issue commands and/or interact with the server's remote management card. RemoteManagementUserCount *uint `json:"remoteManagementUserCount,omitempty" xmlrpc:"remoteManagementUserCount,omitempty"` // User(s) who have access to issue commands and/or interact with the server's remote management card. RemoteManagementUsers []Hardware_Component_RemoteManagement_User `json:"remoteManagementUsers,omitempty" xmlrpc:"remoteManagementUsers,omitempty"` // Determine if hardware object has Software Guard Extension (SGX) enabled. SoftwareGuardExtensionEnabled *bool `json:"softwareGuardExtensionEnabled,omitempty" xmlrpc:"softwareGuardExtensionEnabled,omitempty"` // A server's remote management card used for statistics. StatisticsRemoteManagement *Hardware_Component_RemoteManagement `json:"statisticsRemoteManagement,omitempty" xmlrpc:"statisticsRemoteManagement,omitempty"` // Whether to use UEFI boot instead of BIOS. UefiBootFlag *bool `json:"uefiBootFlag,omitempty" xmlrpc:"uefiBootFlag,omitempty"` // A count of a list of users that have access to this computing instance. UserCount *uint `json:"userCount,omitempty" xmlrpc:"userCount,omitempty"` // A list of users that have access to this computing instance. Users []User_Customer `json:"users,omitempty" xmlrpc:"users,omitempty"` // A count of [DEPRECATED] A hardware server's virtual servers. VirtualGuestCount *uint `json:"virtualGuestCount,omitempty" xmlrpc:"virtualGuestCount,omitempty"` // [DEPRECATED] A hardware server's virtual servers. // Deprecated: This function has been marked as deprecated. VirtualGuests []Virtual_Guest `json:"virtualGuests,omitempty" xmlrpc:"virtualGuests,omitempty"` }
The SoftLayer_Hardware_Server data type contains general information relating to a single SoftLayer server.
type Hardware_Server_Partition ¶ added in v1.0.3
type Hardware_Server_Partition struct { Entity // no documentation yet Hardware *Hardware `json:"hardware,omitempty" xmlrpc:"hardware,omitempty"` // no documentation yet HardwareId *int `json:"hardwareId,omitempty" xmlrpc:"hardwareId,omitempty"` // no documentation yet Hostname *string `json:"hostname,omitempty" xmlrpc:"hostname,omitempty"` // no documentation yet MacAddress *string `json:"macAddress,omitempty" xmlrpc:"macAddress,omitempty"` // A count of NetworkComponentAttributeCount *uint `json:"networkComponentAttributeCount,omitempty" xmlrpc:"networkComponentAttributeCount,omitempty"` // no documentation yet NetworkComponentAttributes []Hardware_Server_Partition_Network_Attribute `json:"networkComponentAttributes,omitempty" xmlrpc:"networkComponentAttributes,omitempty"` }
no documentation yet
type Hardware_Server_Partition_Network_Attribute ¶ added in v1.0.3
type Hardware_Server_Partition_Network_Attribute struct { Entity // no documentation yet IpAddress *string `json:"ipAddress,omitempty" xmlrpc:"ipAddress,omitempty"` // no documentation yet MacAddress *string `json:"macAddress,omitempty" xmlrpc:"macAddress,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // no documentation yet PartitionId *int `json:"partitionId,omitempty" xmlrpc:"partitionId,omitempty"` }
no documentation yet
type Hardware_State ¶ added in v1.0.4
type Hardware_State struct { Entity // no documentation yet DeviceStatus *Device_Status `json:"deviceStatus,omitempty" xmlrpc:"deviceStatus,omitempty"` // The id of the device status of the assigned hardware. DeviceStatusId *int `json:"deviceStatusId,omitempty" xmlrpc:"deviceStatusId,omitempty"` // The hardware this state is assigned to. HardwareId *int `json:"hardwareId,omitempty" xmlrpc:"hardwareId,omitempty"` // A hardware state's unique identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet TransitioningStatus *Device_Status `json:"transitioningStatus,omitempty" xmlrpc:"transitioningStatus,omitempty"` }
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).
type Hardware_Status ¶
type Hardware_Status struct { Entity // A hardware status' internal identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A hardware's status code. See the SoftLayer_Hardware_Status Overview for ”status”' possible values. Status *string `json:"status,omitempty" xmlrpc:"status,omitempty"` }
SoftLayer_Hardware_Status models the inventory state of any piece of hardware in SoftLayer's inventory. Most of these statuses are used by SoftLayer while a server is not provisioned or undergoing provisioning. SoftLayer uses the following status codes:
*”'ACTIVE”': This server is active and in use. *”'DEPLOY”': Used during server provisioning. *”'DEPLOY2”': Used during server provisioning. *”'MACWAIT”': Used during server provisioning. *”'RECLAIM”': This server has been reclaimed by SoftLayer and is awaiting de-provisioning.
Servers in production and in use should stay in the ACTIVE state. If a server's status ever reads anything else then please contact SoftLayer support.
type Hardware_Switch ¶
type Hardware_Switch struct {
Hardware
}
The SoftLayer_Hardware_Switch object extends the base functionality of the SoftLayer_Hardware service.
type Layout_Container ¶
type Layout_Container struct { Entity // The internal identifier of a layout container Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The unique key name of the layout container, used primarily for programmatic purposes Keyname *string `json:"keyname,omitempty" xmlrpc:"keyname,omitempty"` // The type of the layout container object LayoutContainerType *Layout_Container_Type `json:"layoutContainerType,omitempty" xmlrpc:"layoutContainerType,omitempty"` // The internal identifier of the related [[SoftLayer_Layout_Container_Type]] LayoutContainerTypeId *int `json:"layoutContainerTypeId,omitempty" xmlrpc:"layoutContainerTypeId,omitempty"` // A count of the layout items assigned to this layout container LayoutItemCount *uint `json:"layoutItemCount,omitempty" xmlrpc:"layoutItemCount,omitempty"` // The layout items assigned to this layout container LayoutItems []Layout_Item `json:"layoutItems,omitempty" xmlrpc:"layoutItems,omitempty"` // The friendly name of the layout container Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
The SoftLayer_Layout_Container contains definitions for default page layouts
type Layout_Container_Type ¶
type Layout_Container_Type struct { Entity // The internal identifier of the container type Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The unique key name of the container type, used primarily for programmatic purposes Keyname *string `json:"keyname,omitempty" xmlrpc:"keyname,omitempty"` // The friendly name of the container type Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
The SoftLayer_Layout_Container_Type contains definitions for container types
type Layout_Item ¶
type Layout_Item struct { Entity // The internal identifier of a layout item Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The unique key name of the layout item, used primarily for programmatic purposes Keyname *string `json:"keyname,omitempty" xmlrpc:"keyname,omitempty"` // A count of the layout preferences assigned to this layout item LayoutItemPreferenceCount *uint `json:"layoutItemPreferenceCount,omitempty" xmlrpc:"layoutItemPreferenceCount,omitempty"` // The layout preferences assigned to this layout item LayoutItemPreferences []Layout_Preference `json:"layoutItemPreferences,omitempty" xmlrpc:"layoutItemPreferences,omitempty"` // The type of the layout item object LayoutItemType *Layout_Item_Type `json:"layoutItemType,omitempty" xmlrpc:"layoutItemType,omitempty"` // The internal identifier of the related [[SoftLayer_Layout_Item_Type]] LayoutItemTypeId *int `json:"layoutItemTypeId,omitempty" xmlrpc:"layoutItemTypeId,omitempty"` // The friendly name of the layout item Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
The SoftLayer_Layout_Item contains definitions for default layout items
type Layout_Item_Type ¶
type Layout_Item_Type struct { Entity // The internal identifier of the item type Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The unique key name of the item type, used primarily for programmatic purposes Keyname *string `json:"keyname,omitempty" xmlrpc:"keyname,omitempty"` // The friendly name of the item type Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
The SoftLayer_Layout_Item_Type contains definitions for item types
type Layout_Preference ¶
type Layout_Preference struct { Entity // The internal identifier of a layout preference Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The type of the preference object LayoutPreferenceType *Layout_Preference_Type `json:"layoutPreferenceType,omitempty" xmlrpc:"layoutPreferenceType,omitempty"` // The internal identifier of the related [[SoftLayer_Layout_Preference_Type]] LayoutPreferenceTypeId *int `json:"layoutPreferenceTypeId,omitempty" xmlrpc:"layoutPreferenceTypeId,omitempty"` // The default value of the preference Value *string `json:"value,omitempty" xmlrpc:"value,omitempty"` }
The SoftLayer_Layout_Preference contains definitions for default layout item preferences
type Layout_Preference_Type ¶
type Layout_Preference_Type struct { Entity // The internal identifier of the item type Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The unique key name of the item type, used primarily for programmatic purposes Keyname *string `json:"keyname,omitempty" xmlrpc:"keyname,omitempty"` // The friendly name of the item type Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // A regular expression used to validate the related [[SoftLayer_Layout_Preference]] ValueExpression *string `json:"valueExpression,omitempty" xmlrpc:"valueExpression,omitempty"` }
The SoftLayer_Layout_Preference_Type contains definitions for preference types
type Layout_Profile ¶
type Layout_Profile struct { Entity // Active status of the layout profile ActiveFlag *int `json:"activeFlag,omitempty" xmlrpc:"activeFlag,omitempty"` // Timestamp of when the layout profile was created CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // The internal identifier of a layout profile Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A count of LayoutContainerCount *uint `json:"layoutContainerCount,omitempty" xmlrpc:"layoutContainerCount,omitempty"` // no documentation yet LayoutContainers []Layout_Container `json:"layoutContainers,omitempty" xmlrpc:"layoutContainers,omitempty"` // A count of LayoutPreferenceCount *uint `json:"layoutPreferenceCount,omitempty" xmlrpc:"layoutPreferenceCount,omitempty"` // no documentation yet LayoutPreferences []Layout_Profile_Preference `json:"layoutPreferences,omitempty" xmlrpc:"layoutPreferences,omitempty"` // Timestamp of when the layout profile was last updated ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // The friendly name of the layout profile Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // The [[SoftLayer_User_Customer]] owning this layout profile UserRecordId *int `json:"userRecordId,omitempty" xmlrpc:"userRecordId,omitempty"` }
The SoftLayer_Layout_Profile contains the definition of the layout profile
type Layout_Profile_Containers ¶
type Layout_Profile_Containers struct { Entity // Timestamp of when the reference was created CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // The internal identifier of the container reference Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The id of the referenced [[SoftLayer_Layout_Container]] LayoutContainerId *int `json:"layoutContainerId,omitempty" xmlrpc:"layoutContainerId,omitempty"` // The container to be contained LayoutContainerType *Layout_Container `json:"layoutContainerType,omitempty" xmlrpc:"layoutContainerType,omitempty"` // The profile containing this container LayoutProfile *Layout_Profile `json:"layoutProfile,omitempty" xmlrpc:"layoutProfile,omitempty"` // The id of the referenced [[SoftLayer_Layout_Profile]] LayoutProfileId *int `json:"layoutProfileId,omitempty" xmlrpc:"layoutProfileId,omitempty"` // Timestamp of when the reference was last updated ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` }
no documentation yet
type Layout_Profile_Customer ¶
type Layout_Profile_Customer struct { Layout_Profile // no documentation yet UserRecord *User_Customer `json:"userRecord,omitempty" xmlrpc:"userRecord,omitempty"` }
no documentation yet
type Layout_Profile_Preference ¶
type Layout_Profile_Preference struct { Entity // Timestamp of when the preference was created CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // Indicates whether this is a default value or not DefaultValueFlag *int `json:"defaultValueFlag,omitempty" xmlrpc:"defaultValueFlag,omitempty"` // no documentation yet LayoutContainer *Layout_Container `json:"layoutContainer,omitempty" xmlrpc:"layoutContainer,omitempty"` // The id of the related [[SoftLayer_Layout_Container]] LayoutContainerId *int `json:"layoutContainerId,omitempty" xmlrpc:"layoutContainerId,omitempty"` // no documentation yet LayoutItem *Layout_Item `json:"layoutItem,omitempty" xmlrpc:"layoutItem,omitempty"` // The id of the related [[SoftLayer_Layout_Item]] LayoutItemId *int `json:"layoutItemId,omitempty" xmlrpc:"layoutItemId,omitempty"` // no documentation yet LayoutPreference *Layout_Preference `json:"layoutPreference,omitempty" xmlrpc:"layoutPreference,omitempty"` // The internal identifier of the overridden [[SoftLayer_Layout_Preference]] LayoutPreferenceId *int `json:"layoutPreferenceId,omitempty" xmlrpc:"layoutPreferenceId,omitempty"` // no documentation yet LayoutProfile *Layout_Profile `json:"layoutProfile,omitempty" xmlrpc:"layoutProfile,omitempty"` // The internal identifier of the related [[SoftLayer_Layout_Profile]] LayoutProfileId *int `json:"layoutProfileId,omitempty" xmlrpc:"layoutProfileId,omitempty"` // Timestamp of when the preference was last updated ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // The value overriding the default value Value *string `json:"value,omitempty" xmlrpc:"value,omitempty"` }
The SoftLayer_Layout_Profile_Preference contains definitions for layout preferences
type Legal_RegulatedWorkload ¶
type Legal_RegulatedWorkload struct { Entity // no documentation yet Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // no documentation yet AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // no documentation yet EnabledFlag *bool `json:"enabledFlag,omitempty" xmlrpc:"enabledFlag,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet Type *Legal_RegulatedWorkload_Type `json:"type,omitempty" xmlrpc:"type,omitempty"` // no documentation yet WorkloadTypeId *int `json:"workloadTypeId,omitempty" xmlrpc:"workloadTypeId,omitempty"` }
no documentation yet
type Legal_RegulatedWorkload_Type ¶
type Legal_RegulatedWorkload_Type struct { Entity // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
no documentation yet
type Locale ¶
type Locale struct { Entity // no documentation yet FriendlyName *string `json:"friendlyName,omitempty" xmlrpc:"friendlyName,omitempty"` // Internal identification number of a locale Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet LanguageTag *string `json:"languageTag,omitempty" xmlrpc:"languageTag,omitempty"` // Locale name Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
no documentation yet
type Locale_Country ¶
type Locale_Country struct { Entity // Binary flag denoting if this country is part of the European Union IsEuropeanUnionFlag *int `json:"isEuropeanUnionFlag,omitempty" xmlrpc:"isEuropeanUnionFlag,omitempty"` // no documentation yet IsoCodeAlphaThree *string `json:"isoCodeAlphaThree,omitempty" xmlrpc:"isoCodeAlphaThree,omitempty"` // no documentation yet LongName *string `json:"longName,omitempty" xmlrpc:"longName,omitempty"` // no documentation yet PostalCodeFormat *string `json:"postalCodeFormat,omitempty" xmlrpc:"postalCodeFormat,omitempty"` // no documentation yet PostalCodeRequiredFlag *int `json:"postalCodeRequiredFlag,omitempty" xmlrpc:"postalCodeRequiredFlag,omitempty"` // no documentation yet ShortName *string `json:"shortName,omitempty" xmlrpc:"shortName,omitempty"` // A count of states that belong to this country. StateCount *uint `json:"stateCount,omitempty" xmlrpc:"stateCount,omitempty"` // States that belong to this country. States []Locale_StateProvince `json:"states,omitempty" xmlrpc:"states,omitempty"` // no documentation yet VatIdRegex *string `json:"vatIdRegex,omitempty" xmlrpc:"vatIdRegex,omitempty"` // no documentation yet VatIdRequiredFlag *bool `json:"vatIdRequiredFlag,omitempty" xmlrpc:"vatIdRequiredFlag,omitempty"` }
no documentation yet
type Locale_StateProvince ¶
type Locale_StateProvince struct { Entity // no documentation yet LongName *string `json:"longName,omitempty" xmlrpc:"longName,omitempty"` // no documentation yet ShortName *string `json:"shortName,omitempty" xmlrpc:"shortName,omitempty"` }
This object represents a state or province for a country.
type Locale_Timezone ¶
type Locale_Timezone struct { Entity // A timezone's identifying number. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A timezone's long name. For example, "(GMT-06:00) America/Dallas - CST". LongName *string `json:"longName,omitempty" xmlrpc:"longName,omitempty"` // A timezone's name. For example, "America/Dallas". Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // A timezone's offset based on the GMT standard. For example, Central Standard Time's offset is "-0600" from GMT=0000. Offset *string `json:"offset,omitempty" xmlrpc:"offset,omitempty"` // A timezone's common abbreviation. For example, Central Standard Time's abbreviation is "CST". ShortName *string `json:"shortName,omitempty" xmlrpc:"shortName,omitempty"` }
Each User is assigned a timezone allowing for a precise local timestamp.
type Location ¶
type Location struct { Entity // A count of ActivePresaleEventCount *uint `json:"activePresaleEventCount,omitempty" xmlrpc:"activePresaleEventCount,omitempty"` // no documentation yet ActivePresaleEvents []Sales_Presale_Event `json:"activePresaleEvents,omitempty" xmlrpc:"activePresaleEvents,omitempty"` // A flag indicating whether or not the datacenter/location is BNPP compliant. BnppCompliantFlag *bool `json:"bnppCompliantFlag,omitempty" xmlrpc:"bnppCompliantFlag,omitempty"` // A flag indicating whether or not the datacenter/location is EU compliant. EuCompliantFlag *bool `json:"euCompliantFlag,omitempty" xmlrpc:"euCompliantFlag,omitempty"` // A count of a location can be a member of 1 or more groups. This will show which groups to which a location belongs. GroupCount *uint `json:"groupCount,omitempty" xmlrpc:"groupCount,omitempty"` // A location can be a member of 1 or more groups. This will show which groups to which a location belongs. Groups []Location_Group `json:"groups,omitempty" xmlrpc:"groups,omitempty"` // A count of HardwareFirewallCount *uint `json:"hardwareFirewallCount,omitempty" xmlrpc:"hardwareFirewallCount,omitempty"` // no documentation yet HardwareFirewalls []Hardware `json:"hardwareFirewalls,omitempty" xmlrpc:"hardwareFirewalls,omitempty"` // The unique identifier of a specific location. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A location's physical address. LocationAddress *Account_Address `json:"locationAddress,omitempty" xmlrpc:"locationAddress,omitempty"` // A count of a location's physical addresses. LocationAddressCount *uint `json:"locationAddressCount,omitempty" xmlrpc:"locationAddressCount,omitempty"` // A location's physical addresses. LocationAddresses []Account_Address `json:"locationAddresses,omitempty" xmlrpc:"locationAddresses,omitempty"` // A location's Dedicated Rack member LocationReservationMember *Location_Reservation_Rack_Member `json:"locationReservationMember,omitempty" xmlrpc:"locationReservationMember,omitempty"` // The current locations status. LocationStatus *Location_Status `json:"locationStatus,omitempty" xmlrpc:"locationStatus,omitempty"` // A longer location description. LongName *string `json:"longName,omitempty" xmlrpc:"longName,omitempty"` // A short location description. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // no documentation yet NetworkConfigurationAttribute *Hardware_Attribute `json:"networkConfigurationAttribute,omitempty" xmlrpc:"networkConfigurationAttribute,omitempty"` // The total number of users online using SoftLayer's SSL VPN service for a location. OnlineSslVpnUserCount *int `json:"onlineSslVpnUserCount,omitempty" xmlrpc:"onlineSslVpnUserCount,omitempty"` // no documentation yet PathString *string `json:"pathString,omitempty" xmlrpc:"pathString,omitempty"` // 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. PriceGroupCount *uint `json:"priceGroupCount,omitempty" xmlrpc:"priceGroupCount,omitempty"` // A location can be a member of 1 or more Price Groups. This will show which groups to which a location belongs. PriceGroups []Location_Group `json:"priceGroups,omitempty" xmlrpc:"priceGroups,omitempty"` // A count of a location can be a member of 1 or more regions. This will show which regions to which a location belongs. RegionCount *uint `json:"regionCount,omitempty" xmlrpc:"regionCount,omitempty"` // A location can be a member of 1 or more regions. This will show which regions to which a location belongs. Regions []Location_Region `json:"regions,omitempty" xmlrpc:"regions,omitempty"` // no documentation yet StatusId *int `json:"statusId,omitempty" xmlrpc:"statusId,omitempty"` // no documentation yet Timezone *Locale_Timezone `json:"timezone,omitempty" xmlrpc:"timezone,omitempty"` // A location can be a member of 1 Bandwidth Pooling Group. This will show which group to which a location belongs. VdrGroup *Location_Group_Location_CrossReference `json:"vdrGroup,omitempty" xmlrpc:"vdrGroup,omitempty"` }
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.
type Location_Datacenter ¶
type Location_Datacenter struct { Location // A count of ActiveItemPresaleEventCount *uint `json:"activeItemPresaleEventCount,omitempty" xmlrpc:"activeItemPresaleEventCount,omitempty"` // no documentation yet ActiveItemPresaleEvents []Sales_Presale_Event `json:"activeItemPresaleEvents,omitempty" xmlrpc:"activeItemPresaleEvents,omitempty"` // A count of BackendHardwareRouterCount *uint `json:"backendHardwareRouterCount,omitempty" xmlrpc:"backendHardwareRouterCount,omitempty"` // no documentation yet BackendHardwareRouters []Hardware `json:"backendHardwareRouters,omitempty" xmlrpc:"backendHardwareRouters,omitempty"` // A count of subnets which are directly bound to one or more routers in a given datacenter, and currently allow routing. BoundSubnetCount *uint `json:"boundSubnetCount,omitempty" xmlrpc:"boundSubnetCount,omitempty"` // Subnets which are directly bound to one or more routers in a given datacenter, and currently allow routing. BoundSubnets []Network_Subnet `json:"boundSubnets,omitempty" xmlrpc:"boundSubnets,omitempty"` // 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. BrandCountryRestrictionCount *uint `json:"brandCountryRestrictionCount,omitempty" xmlrpc:"brandCountryRestrictionCount,omitempty"` // 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. BrandCountryRestrictions []Brand_Restriction_Location_CustomerCountry `json:"brandCountryRestrictions,omitempty" xmlrpc:"brandCountryRestrictions,omitempty"` // A count of FrontendHardwareRouterCount *uint `json:"frontendHardwareRouterCount,omitempty" xmlrpc:"frontendHardwareRouterCount,omitempty"` // no documentation yet FrontendHardwareRouters []Hardware `json:"frontendHardwareRouters,omitempty" xmlrpc:"frontendHardwareRouters,omitempty"` // A count of HardwareRouterCount *uint `json:"hardwareRouterCount,omitempty" xmlrpc:"hardwareRouterCount,omitempty"` // no documentation yet HardwareRouters []Hardware `json:"hardwareRouters,omitempty" xmlrpc:"hardwareRouters,omitempty"` // A count of PresaleEventCount *uint `json:"presaleEventCount,omitempty" xmlrpc:"presaleEventCount,omitempty"` // no documentation yet PresaleEvents []Sales_Presale_Event `json:"presaleEvents,omitempty" xmlrpc:"presaleEvents,omitempty"` // The regional group this datacenter belongs to. RegionalGroup *Location_Group_Regional `json:"regionalGroup,omitempty" xmlrpc:"regionalGroup,omitempty"` // no documentation yet RegionalInternetRegistry *Network_Regional_Internet_Registry `json:"regionalInternetRegistry,omitempty" xmlrpc:"regionalInternetRegistry,omitempty"` // A count of retrieve all subnets that are eligible to be routed; those which the account has permission to associate with a vlan. RoutableBoundSubnetCount *uint `json:"routableBoundSubnetCount,omitempty" xmlrpc:"routableBoundSubnetCount,omitempty"` // Retrieve all subnets that are eligible to be routed; those which the account has permission to associate with a vlan. RoutableBoundSubnets []Network_Subnet `json:"routableBoundSubnets,omitempty" xmlrpc:"routableBoundSubnets,omitempty"` }
SoftLayer_Location_Datacenter extends the [[SoftLayer_Location]] data type to include datacenter-specific properties.
type Location_Group ¶
type Location_Group struct { Entity // no documentation yet Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A count of the locations in a group. LocationCount *uint `json:"locationCount,omitempty" xmlrpc:"locationCount,omitempty"` // The type for this location group. LocationGroupType *Location_Group_Type `json:"locationGroupType,omitempty" xmlrpc:"locationGroupType,omitempty"` // no documentation yet LocationGroupTypeId *int `json:"locationGroupTypeId,omitempty" xmlrpc:"locationGroupTypeId,omitempty"` // The locations in a group. Locations []Location `json:"locations,omitempty" xmlrpc:"locations,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // no documentation yet SecurityLevelId *int `json:"securityLevelId,omitempty" xmlrpc:"securityLevelId,omitempty"` }
no documentation yet
type Location_Group_Location_CrossReference ¶
type Location_Group_Location_CrossReference struct { Entity // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet Location *Location `json:"location,omitempty" xmlrpc:"location,omitempty"` // no documentation yet LocationGroup *Location_Group `json:"locationGroup,omitempty" xmlrpc:"locationGroup,omitempty"` // no documentation yet LocationGroupId *int `json:"locationGroupId,omitempty" xmlrpc:"locationGroupId,omitempty"` // no documentation yet LocationId *int `json:"locationId,omitempty" xmlrpc:"locationId,omitempty"` // If set, this is the priority of this cross reference record in the group. Priority *int `json:"priority,omitempty" xmlrpc:"priority,omitempty"` }
no documentation yet
type Location_Group_Pricing ¶
type Location_Group_Pricing struct { Location_Group // 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. PriceCount *uint `json:"priceCount,omitempty" xmlrpc:"priceCount,omitempty"` // 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. Prices []Product_Item_Price `json:"prices,omitempty" xmlrpc:"prices,omitempty"` }
no documentation yet
type Location_Group_Regional ¶
type Location_Group_Regional struct { Location_Group // A count of the datacenters in a group. DatacenterCount *uint `json:"datacenterCount,omitempty" xmlrpc:"datacenterCount,omitempty"` // The datacenters in a group. Datacenters []Location `json:"datacenters,omitempty" xmlrpc:"datacenters,omitempty"` // The preferred datacenters of a group. PreferredDatacenter *Location_Datacenter `json:"preferredDatacenter,omitempty" xmlrpc:"preferredDatacenter,omitempty"` }
no documentation yet
type Location_Group_Type ¶
type Location_Group_Type struct { Entity // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
no documentation yet
type Location_Inventory_Room ¶
type Location_Inventory_Room struct {
Location
}
SoftLayer_Location_Inventory_Room extends the [[SoftLayer_Location]] data type to include inventory room-specific properties.
type Location_Network_Operations_Center ¶
type Location_Network_Operations_Center struct {
Location
}
SoftLayer_Location_Network_Operations_Center extends the [[SoftLayer_Location]] data type to include network operation center-specific properties.
type Location_Office ¶
type Location_Office struct {
Location
}
SoftLayer_Location_Office extends the [[SoftLayer_Location]] data type to include office-specific properties.
type Location_Rack ¶
type Location_Rack struct {
Location
}
SoftLayer_Location_Rack extends the [[SoftLayer_Location]] data type to include rack-specific properties.
type Location_Region ¶
type Location_Region struct { Entity // A short description of a region's name. This description is seen on the order forms. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // A unique key name for a region. Provided for easy debugging. This is to be sent in with an order. Keyname *string `json:"keyname,omitempty" xmlrpc:"keyname,omitempty"` // 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') Location *Location_Region_Location `json:"location,omitempty" xmlrpc:"location,omitempty"` // A count of the locations (like datacenters or PoPs) in this region. LocationCount *uint `json:"locationCount,omitempty" xmlrpc:"locationCount,omitempty"` // The locations (like datacenters or PoPs) in this region. Locations []Location_Region_Location `json:"locations,omitempty" xmlrpc:"locations,omitempty"` // An integer representing the order in which this element is displayed. SortOrder *int `json:"sortOrder,omitempty" xmlrpc:"sortOrder,omitempty"` }
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.
type Location_Region_Location ¶
type Location_Region_Location struct { Entity // The SoftLayer_Location tied to a region's location. This provides more information about the location, including specific datacenter information. Location *Location `json:"location,omitempty" xmlrpc:"location,omitempty"` // no documentation yet LocationId *int `json:"locationId,omitempty" xmlrpc:"locationId,omitempty"` // 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.' LocationPackageDetailCount *uint `json:"locationPackageDetailCount,omitempty" xmlrpc:"locationPackageDetailCount,omitempty"` // 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.' LocationPackageDetails []Product_Package_Locations `json:"locationPackageDetails,omitempty" xmlrpc:"locationPackageDetails,omitempty"` // The region to which this location belongs. Region *Location_Region `json:"region,omitempty" xmlrpc:"region,omitempty"` }
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.
type Location_Reservation ¶
type Location_Reservation struct { Entity // The account that a billing item belongs to. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // The bandwidth allotment that the reservation belongs to. Allotment *Network_Bandwidth_Version1_Allotment `json:"allotment,omitempty" xmlrpc:"allotment,omitempty"` // no documentation yet AllotmentId *int `json:"allotmentId,omitempty" xmlrpc:"allotmentId,omitempty"` // The bandwidth allotment that the reservation belongs to. BillingItem *Billing_Item `json:"billingItem,omitempty" xmlrpc:"billingItem,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The datacenter location that the reservation belongs to. Location *Location `json:"location,omitempty" xmlrpc:"location,omitempty"` // no documentation yet LocationId *int `json:"locationId,omitempty" xmlrpc:"locationId,omitempty"` // Rack information for the reservation LocationReservationRack *Location_Reservation_Rack `json:"locationReservationRack,omitempty" xmlrpc:"locationReservationRack,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // no documentation yet Notes *string `json:"notes,omitempty" xmlrpc:"notes,omitempty"` }
no documentation yet
type Location_Reservation_Rack ¶
type Location_Reservation_Rack struct { Entity // The bandwidth allotment that the reservation belongs to. Allotment *Network_Bandwidth_Version1_Allotment `json:"allotment,omitempty" xmlrpc:"allotment,omitempty"` // Members of the rack. Children []Location_Reservation_Rack_Member `json:"children,omitempty" xmlrpc:"children,omitempty"` // A count of members of the rack. ChildrenCount *uint `json:"childrenCount,omitempty" xmlrpc:"childrenCount,omitempty"` // no documentation yet Location *Location `json:"location,omitempty" xmlrpc:"location,omitempty"` // no documentation yet LocationId *int `json:"locationId,omitempty" xmlrpc:"locationId,omitempty"` // no documentation yet LocationReservation *Location_Reservation `json:"locationReservation,omitempty" xmlrpc:"locationReservation,omitempty"` // no documentation yet LocationReservationId *int `json:"locationReservationId,omitempty" xmlrpc:"locationReservationId,omitempty"` // no documentation yet NetworkConnectionCapacity *int `json:"networkConnectionCapacity,omitempty" xmlrpc:"networkConnectionCapacity,omitempty"` // no documentation yet NetworkConnectionReservation *int `json:"networkConnectionReservation,omitempty" xmlrpc:"networkConnectionReservation,omitempty"` // no documentation yet PowerConnectionCapacity *int `json:"powerConnectionCapacity,omitempty" xmlrpc:"powerConnectionCapacity,omitempty"` // no documentation yet PowerConnectionReservation *int `json:"powerConnectionReservation,omitempty" xmlrpc:"powerConnectionReservation,omitempty"` // no documentation yet SlotCapacity *int `json:"slotCapacity,omitempty" xmlrpc:"slotCapacity,omitempty"` // no documentation yet SlotReservation *int `json:"slotReservation,omitempty" xmlrpc:"slotReservation,omitempty"` }
no documentation yet
type Location_Reservation_Rack_Member ¶
type Location_Reservation_Rack_Member struct { Entity // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Location relation for the rack member Location *Location `json:"location,omitempty" xmlrpc:"location,omitempty"` // no documentation yet LocationId *int `json:"locationId,omitempty" xmlrpc:"locationId,omitempty"` // no documentation yet LocationReservationRack *Location_Reservation_Rack `json:"locationReservationRack,omitempty" xmlrpc:"locationReservationRack,omitempty"` }
no documentation yet
type Location_Root ¶
type Location_Root struct {
Location
}
SoftLayer_Location_Root extends the [[SoftLayer_Location]] data type to include root-specific properties.
type Location_Server_Room ¶
type Location_Server_Room struct {
Location
}
SoftLayer_Location_Server_Room extends the [[SoftLayer_Location]] data type to include server room-specific properties.
type Location_Slot ¶
type Location_Slot struct {
Location
}
SoftLayer_Location_Slot extends the [[SoftLayer_Location]] data type to include slot-specific properties.
type Location_Status ¶
type Location_Status struct { Entity // A locations status's internal identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A Location's status code. See the SoftLayer_Locaiton_Status Overview for ”status”' possible values. Status *string `json:"status,omitempty" xmlrpc:"status,omitempty"` }
SoftLayer_Location_Status models the state of any location. SoftLayer uses the following status codes:
*”'ACTIVE”': The location is currently active and available for public usage. *”'PLANNED”': Used when a location is planned but not yet active. *”'RETIRED”': Used when a location has been retired and no longer active.
Locations in use should stay in the ACTIVE state. If a locations status ever reads anything else and contains active hardware then please contact SoftLayer support.
type Location_Storage_Room ¶
type Location_Storage_Room struct {
Location
}
SoftLayer_Location_Storage_Room extends the [[SoftLayer_Location]] data type to include storage room-specific properties.
type Marketplace_EmailDistribution ¶
type Marketplace_EmailDistribution struct { Entity // no documentation yet Email *string `json:"email,omitempty" xmlrpc:"email,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` }
no documentation yet
type Marketplace_Partner ¶
type Marketplace_Partner struct { Entity // no documentation yet AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // no documentation yet AttachedFiles []Marketplace_Partner_Attachment `json:"attachedFiles,omitempty" xmlrpc:"attachedFiles,omitempty"` // A count of AttachmentCount *uint `json:"attachmentCount,omitempty" xmlrpc:"attachmentCount,omitempty"` // no documentation yet Attachments []Marketplace_Partner_Attachment `json:"attachments,omitempty" xmlrpc:"attachments,omitempty"` // no documentation yet CompanyDescription *string `json:"companyDescription,omitempty" xmlrpc:"companyDescription,omitempty"` // no documentation yet CompanyName *string `json:"companyName,omitempty" xmlrpc:"companyName,omitempty"` // no documentation yet HeadlineDescription *string `json:"headlineDescription,omitempty" xmlrpc:"headlineDescription,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet LinkFreeTrial *string `json:"linkFreeTrial,omitempty" xmlrpc:"linkFreeTrial,omitempty"` // no documentation yet LinkOrderPage *string `json:"linkOrderPage,omitempty" xmlrpc:"linkOrderPage,omitempty"` // no documentation yet LinkWebsite *string `json:"linkWebsite,omitempty" xmlrpc:"linkWebsite,omitempty"` // no documentation yet LogoMedium *Marketplace_Partner_Attachment `json:"logoMedium,omitempty" xmlrpc:"logoMedium,omitempty"` // no documentation yet LogoMediumTemp *Marketplace_Partner_Attachment `json:"logoMediumTemp,omitempty" xmlrpc:"logoMediumTemp,omitempty"` // no documentation yet LogoSmall *Marketplace_Partner_Attachment `json:"logoSmall,omitempty" xmlrpc:"logoSmall,omitempty"` // no documentation yet LogoSmallTemp *Marketplace_Partner_Attachment `json:"logoSmallTemp,omitempty" xmlrpc:"logoSmallTemp,omitempty"` // no documentation yet MetaDescription *string `json:"metaDescription,omitempty" xmlrpc:"metaDescription,omitempty"` // no documentation yet MetaKeywords *string `json:"metaKeywords,omitempty" xmlrpc:"metaKeywords,omitempty"` // no documentation yet ProductBenefits *string `json:"productBenefits,omitempty" xmlrpc:"productBenefits,omitempty"` // no documentation yet ProductCategoryId *int `json:"productCategoryId,omitempty" xmlrpc:"productCategoryId,omitempty"` // no documentation yet ProductDescriptionLong *string `json:"productDescriptionLong,omitempty" xmlrpc:"productDescriptionLong,omitempty"` // no documentation yet ProductDescriptionShort *string `json:"productDescriptionShort,omitempty" xmlrpc:"productDescriptionShort,omitempty"` // no documentation yet ProductFeatures *string `json:"productFeatures,omitempty" xmlrpc:"productFeatures,omitempty"` // no documentation yet ProductName *string `json:"productName,omitempty" xmlrpc:"productName,omitempty"` // no documentation yet ProductTitle *string `json:"productTitle,omitempty" xmlrpc:"productTitle,omitempty"` // no documentation yet UrlIdentifier *string `json:"urlIdentifier,omitempty" xmlrpc:"urlIdentifier,omitempty"` }
no documentation yet
type Marketplace_Partner_Attachment ¶
type Marketplace_Partner_Attachment struct { Entity // no documentation yet AttachmentType *Marketplace_Partner_Attachment_Type `json:"attachmentType,omitempty" xmlrpc:"attachmentType,omitempty"` // no documentation yet AttachmentTypeId *int `json:"attachmentTypeId,omitempty" xmlrpc:"attachmentTypeId,omitempty"` // no documentation yet BaseName *string `json:"baseName,omitempty" xmlrpc:"baseName,omitempty"` // no documentation yet DisplayName *string `json:"displayName,omitempty" xmlrpc:"displayName,omitempty"` // no documentation yet FileName *string `json:"fileName,omitempty" xmlrpc:"fileName,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet MarketplacePartnerId *int `json:"marketplacePartnerId,omitempty" xmlrpc:"marketplacePartnerId,omitempty"` // no documentation yet SaveAsName *string `json:"saveAsName,omitempty" xmlrpc:"saveAsName,omitempty"` }
no documentation yet
type Marketplace_Partner_Attachment_Type ¶
type Marketplace_Partner_Attachment_Type struct { Entity // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // no documentation yet Type *string `json:"type,omitempty" xmlrpc:"type,omitempty"` }
no documentation yet
type Marketplace_Partner_File ¶
type Marketplace_Partner_File struct { Entity // no documentation yet Attributes *Marketplace_Partner_File_Attributes `json:"attributes,omitempty" xmlrpc:"attributes,omitempty"` // no documentation yet Contents *[]byte `json:"contents,omitempty" xmlrpc:"contents,omitempty"` }
no documentation yet
type Marketplace_Partner_File_Attributes ¶
type Marketplace_Partner_File_Attributes struct { Entity // no documentation yet Bits *int `json:"bits,omitempty" xmlrpc:"bits,omitempty"` // no documentation yet Channels *int `json:"channels,omitempty" xmlrpc:"channels,omitempty"` // no documentation yet Height *int `json:"height,omitempty" xmlrpc:"height,omitempty"` // no documentation yet HtmlAttributes *string `json:"htmlAttributes,omitempty" xmlrpc:"htmlAttributes,omitempty"` // no documentation yet ImageType *int `json:"imageType,omitempty" xmlrpc:"imageType,omitempty"` // no documentation yet IsImage *bool `json:"isImage,omitempty" xmlrpc:"isImage,omitempty"` // no documentation yet MimeType *string `json:"mimeType,omitempty" xmlrpc:"mimeType,omitempty"` // no documentation yet Width *int `json:"width,omitempty" xmlrpc:"width,omitempty"` }
no documentation yet
type McAfee_Epolicy_Orchestrator_Version36_Agent_Details ¶
type McAfee_Epolicy_Orchestrator_Version36_Agent_Details struct { Entity // Version number of the anti-virus scan agent. AgentVersion *string `json:"agentVersion,omitempty" xmlrpc:"agentVersion,omitempty"` // The current anti-virus policy of an agent. CurrentPolicy *McAfee_Epolicy_Orchestrator_Version36_Agent_Parent_Details `json:"currentPolicy,omitempty" xmlrpc:"currentPolicy,omitempty"` // The date of the last time the anti-virus agent checked in. LastUpdate *string `json:"lastUpdate,omitempty" xmlrpc:"lastUpdate,omitempty"` }
The McAfee_Epolicy_Orchestrator_Version36_Agent_Details data type represents a virus scan agent and contains details about its version.
type McAfee_Epolicy_Orchestrator_Version36_Agent_Parent_Details ¶
type McAfee_Epolicy_Orchestrator_Version36_Agent_Parent_Details struct { Entity // The current anti-virus policy of an agent. CurrentPolicy *McAfee_Epolicy_Orchestrator_Version36_Agent_Parent_Details `json:"currentPolicy,omitempty" xmlrpc:"currentPolicy,omitempty"` // The name of a policy. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
The McAfee_Epolicy_Orchestrator_Version36_Agent_Parent_Details data type contains the name of an anti-virus policy.
type McAfee_Epolicy_Orchestrator_Version36_Antivirus_Event ¶
type McAfee_Epolicy_Orchestrator_Version36_Antivirus_Event struct { Entity // The date when an anti-virus event occurs. EventLocalDateTime *Time `json:"eventLocalDateTime,omitempty" xmlrpc:"eventLocalDateTime,omitempty"` // Name of the file found to be infected. Filename *string `json:"filename,omitempty" xmlrpc:"filename,omitempty"` // The action taken when a virus is detected. VirusActionTaken *McAfee_Epolicy_Orchestrator_Version36_Antivirus_Event_Filter_Description `json:"virusActionTaken,omitempty" xmlrpc:"virusActionTaken,omitempty"` // The name of a virus that is found. VirusName *string `json:"virusName,omitempty" xmlrpc:"virusName,omitempty"` // The type of virus that is found. VirusType *string `json:"virusType,omitempty" xmlrpc:"virusType,omitempty"` }
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.
type McAfee_Epolicy_Orchestrator_Version36_Antivirus_Event_AccessProtection ¶
type McAfee_Epolicy_Orchestrator_Version36_Antivirus_Event_AccessProtection struct { Entity // The date that an access protection event occurs. EventLocalDateTime *Time `json:"eventLocalDateTime,omitempty" xmlrpc:"eventLocalDateTime,omitempty"` // The name of the file that was protected from access. Filename *string `json:"filename,omitempty" xmlrpc:"filename,omitempty"` // The name of the process that was protected from access. ProcessName *string `json:"processName,omitempty" xmlrpc:"processName,omitempty"` // The name of the rule that triggered an access protection event. RuleName *string `json:"ruleName,omitempty" xmlrpc:"ruleName,omitempty"` // The IP address that caused an access protection event. Source *string `json:"source,omitempty" xmlrpc:"source,omitempty"` }
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.
type McAfee_Epolicy_Orchestrator_Version36_Antivirus_Event_Filter_Description ¶
type McAfee_Epolicy_Orchestrator_Version36_Antivirus_Event_Filter_Description struct { Entity // The name of the rule that triggered an anti-virus event. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
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.
type McAfee_Epolicy_Orchestrator_Version36_Hips_Version6_BlockedApplicationEvent ¶
type McAfee_Epolicy_Orchestrator_Version36_Hips_Version6_BlockedApplicationEvent struct { Entity // A brief description of the application that is blocked. ApplicationDescription *string `json:"applicationDescription,omitempty" xmlrpc:"applicationDescription,omitempty"` // The time that an application is blocked. IncidentTime *Time `json:"incidentTime,omitempty" xmlrpc:"incidentTime,omitempty"` // The name of a process that is blocked. ProcessName *string `json:"processName,omitempty" xmlrpc:"processName,omitempty"` }
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.
type McAfee_Epolicy_Orchestrator_Version36_Hips_Version6_Event_Signature ¶
type McAfee_Epolicy_Orchestrator_Version36_Hips_Version6_Event_Signature struct { Entity // The name of a rule that triggered an IPS event. SignatureName *string `json:"signatureName,omitempty" xmlrpc:"signatureName,omitempty"` }
The McAfee_Epolicy_Orchestrator_Version36_Hips_Version6_Event_Signature data type contains the signature name of a rule that generated an IPS event.
type McAfee_Epolicy_Orchestrator_Version36_Hips_Version6_IPSEvent ¶
type McAfee_Epolicy_Orchestrator_Version36_Hips_Version6_IPSEvent struct { Entity // The time when an IPS event occurred. IncidentTime *Time `json:"incidentTime,omitempty" xmlrpc:"incidentTime,omitempty"` // Name of the process that generated an IPS event. ProcessName *string `json:"processName,omitempty" xmlrpc:"processName,omitempty"` // The action taken because of an IPS event. ReactionText *string `json:"reactionText,omitempty" xmlrpc:"reactionText,omitempty"` // The IP address that generated an IPS event. RemoteIpAddress *string `json:"remoteIpAddress,omitempty" xmlrpc:"remoteIpAddress,omitempty"` // The severity level for an IPS event. SeverityText *string `json:"severityText,omitempty" xmlrpc:"severityText,omitempty"` // The signature that generated an IPS event. Signature *McAfee_Epolicy_Orchestrator_Version36_Hips_Version6_Event_Signature `json:"signature,omitempty" xmlrpc:"signature,omitempty"` }
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.
type McAfee_Epolicy_Orchestrator_Version36_Hips_Version7_BlockedApplicationEvent ¶
type McAfee_Epolicy_Orchestrator_Version36_Hips_Version7_BlockedApplicationEvent struct { Entity // A brief description of the application that is blocked. ApplicationDescription *string `json:"applicationDescription,omitempty" xmlrpc:"applicationDescription,omitempty"` // The time that an application is blocked. IncidentTime *Time `json:"incidentTime,omitempty" xmlrpc:"incidentTime,omitempty"` // The name of a process that is blocked. ProcessName *string `json:"processName,omitempty" xmlrpc:"processName,omitempty"` }
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.
type McAfee_Epolicy_Orchestrator_Version36_Hips_Version7_Event_Signature ¶
type McAfee_Epolicy_Orchestrator_Version36_Hips_Version7_Event_Signature struct { Entity // The name of a rule that triggered an IPS event. SignatureName *string `json:"signatureName,omitempty" xmlrpc:"signatureName,omitempty"` }
The McAfee_Epolicy_Orchestrator_Version36_Hips_Version7_Event_Signature data type contains the signature name of a rule that generated an IPS event.
type McAfee_Epolicy_Orchestrator_Version36_Hips_Version7_IPSEvent ¶
type McAfee_Epolicy_Orchestrator_Version36_Hips_Version7_IPSEvent struct { Entity // The time when an IPS event occurred. IncidentTime *Time `json:"incidentTime,omitempty" xmlrpc:"incidentTime,omitempty"` // Name of the process that generated an IPS event. ProcessName *string `json:"processName,omitempty" xmlrpc:"processName,omitempty"` // The action taken because of an IPS event. ReactionText *string `json:"reactionText,omitempty" xmlrpc:"reactionText,omitempty"` // The IP address that generated an IPS event. RemoteIpAddress *string `json:"remoteIpAddress,omitempty" xmlrpc:"remoteIpAddress,omitempty"` // The severity level for an IPS event. SeverityText *string `json:"severityText,omitempty" xmlrpc:"severityText,omitempty"` // The signature that generated an IPS event. Signature *McAfee_Epolicy_Orchestrator_Version36_Hips_Version7_Event_Signature `json:"signature,omitempty" xmlrpc:"signature,omitempty"` }
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.
type McAfee_Epolicy_Orchestrator_Version36_Policy_Object ¶
type McAfee_Epolicy_Orchestrator_Version36_Policy_Object struct { Entity // The name of a policy. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
The McAfee_Epolicy_Orchestrator_Version36_Policy_Object data type contains the name of a policy that may be assigned to a server.
type McAfee_Epolicy_Orchestrator_Version36_Product_Properties ¶
type McAfee_Epolicy_Orchestrator_Version36_Product_Properties struct { Entity // The virus definition file version. DatVersion *string `json:"datVersion,omitempty" xmlrpc:"datVersion,omitempty"` }
The McAfee_Epolicy_Orchestrator_Version36_Product_Properties data type contains the virus definition file version.
type McAfee_Epolicy_Orchestrator_Version45_Agent_Details ¶
type McAfee_Epolicy_Orchestrator_Version45_Agent_Details struct { Entity // Version number of the anti-virus scan agent. AgentVersion *string `json:"agentVersion,omitempty" xmlrpc:"agentVersion,omitempty"` // The date of the last time the anti-virus agent checked in. LastUpdate *Time `json:"lastUpdate,omitempty" xmlrpc:"lastUpdate,omitempty"` }
The McAfee_Epolicy_Orchestrator_Version45_Agent_Details data type represents a virus scan agent and contains details about its version.
type McAfee_Epolicy_Orchestrator_Version45_Agent_Parent_Details ¶
type McAfee_Epolicy_Orchestrator_Version45_Agent_Parent_Details struct { Entity // Additional information about an agent. AgentDetails *McAfee_Epolicy_Orchestrator_Version45_Agent_Details `json:"agentDetails,omitempty" xmlrpc:"agentDetails,omitempty"` // The name of a policy. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // The current anti-virus policy of an agent. Policies []McAfee_Epolicy_Orchestrator_Version45_Agent_Parent_Details `json:"policies,omitempty" xmlrpc:"policies,omitempty"` // A count of the current anti-virus policy of an agent. PolicyCount *uint `json:"policyCount,omitempty" xmlrpc:"policyCount,omitempty"` }
The McAfee_Epolicy_Orchestrator_Version45_Agent_Parent_Details data type contains the name of an anti-virus policy.
type McAfee_Epolicy_Orchestrator_Version45_Event ¶
type McAfee_Epolicy_Orchestrator_Version45_Event struct { Entity // Additional information about an agent. AgentDetails *McAfee_Epolicy_Orchestrator_Version45_Agent_Details `json:"agentDetails,omitempty" xmlrpc:"agentDetails,omitempty"` // The time that an event was detected. DetectedUtc *Time `json:"detectedUtc,omitempty" xmlrpc:"detectedUtc,omitempty"` // The IP address of the source that generated an event. SourceIpv4 *string `json:"sourceIpv4,omitempty" xmlrpc:"sourceIpv4,omitempty"` // The name of the process that generated an event. SourceProcessName *string `json:"sourceProcessName,omitempty" xmlrpc:"sourceProcessName,omitempty"` // The name of the file that was the target of the event. TargetFilename *string `json:"targetFilename,omitempty" xmlrpc:"targetFilename,omitempty"` // The action taken regarding a threat. ThreatActionTaken *string `json:"threatActionTaken,omitempty" xmlrpc:"threatActionTaken,omitempty"` // The name of the threat. ThreatName *string `json:"threatName,omitempty" xmlrpc:"threatName,omitempty"` // The textual representation of the severity level. ThreatSeverityLabel *string `json:"threatSeverityLabel,omitempty" xmlrpc:"threatSeverityLabel,omitempty"` // The type of threat. ThreatType *string `json:"threatType,omitempty" xmlrpc:"threatType,omitempty"` // The action taken when a virus is detected. VirusActionTaken *McAfee_Epolicy_Orchestrator_Version45_Event_Filter_Description `json:"virusActionTaken,omitempty" xmlrpc:"virusActionTaken,omitempty"` }
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.
type McAfee_Epolicy_Orchestrator_Version45_Event_Filter_Description ¶
type McAfee_Epolicy_Orchestrator_Version45_Event_Filter_Description struct { Entity // The name of the rule that triggered an event. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
The McAfee_Epolicy_Orchestrator_Version45_Event_Filter_Description data type contains the name of the rule that was triggered by an event.
type McAfee_Epolicy_Orchestrator_Version45_Event_Version7 ¶
type McAfee_Epolicy_Orchestrator_Version45_Event_Version7 struct { McAfee_Epolicy_Orchestrator_Version45_Event // The signature information for an event. Signature *McAfee_Epolicy_Orchestrator_Version45_Hips_Event_Signature_Version7 `json:"signature,omitempty" xmlrpc:"signature,omitempty"` }
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.
type McAfee_Epolicy_Orchestrator_Version45_Event_Version8 ¶
type McAfee_Epolicy_Orchestrator_Version45_Event_Version8 struct { McAfee_Epolicy_Orchestrator_Version45_Event // The signature information for an event. Signature *McAfee_Epolicy_Orchestrator_Version45_Hips_Event_Signature_Version8 `json:"signature,omitempty" xmlrpc:"signature,omitempty"` }
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.
type McAfee_Epolicy_Orchestrator_Version45_Hips_Event_Signature_Version7 ¶
type McAfee_Epolicy_Orchestrator_Version45_Hips_Event_Signature_Version7 struct { Entity // The name of a rule that triggered an IPS event. SignatureName *string `json:"signatureName,omitempty" xmlrpc:"signatureName,omitempty"` }
The McAfee_Epolicy_Orchestrator_Version45_Hips_Event_Signature_Version7 data type contains the signature name of a rule that generated an IPS event.
type McAfee_Epolicy_Orchestrator_Version45_Hips_Event_Signature_Version8 ¶
type McAfee_Epolicy_Orchestrator_Version45_Hips_Event_Signature_Version8 struct { Entity // The name of a rule that triggered an IPS event. SignatureName *string `json:"signatureName,omitempty" xmlrpc:"signatureName,omitempty"` }
The McAfee_Epolicy_Orchestrator_Version45_Hips_Event_Signature_Version8 data type contains the signature name of a rule that generated an IPS event.
type McAfee_Epolicy_Orchestrator_Version45_Policy_Object ¶
type McAfee_Epolicy_Orchestrator_Version45_Policy_Object struct { Entity // The name of a policy. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
The McAfee_Epolicy_Orchestrator_Version45_Policy_Object data type contains the name of a policy that may be assigned to a server.
type McAfee_Epolicy_Orchestrator_Version45_Product_Properties ¶
type McAfee_Epolicy_Orchestrator_Version45_Product_Properties struct { Entity // The virus definition file version. DatVersion *string `json:"datVersion,omitempty" xmlrpc:"datVersion,omitempty"` }
The McAfee_Epolicy_Orchestrator_Version45_Product_Properties data type contains the virus definition file version.
type McAfee_Epolicy_Orchestrator_Version51_Agent_Details ¶ added in v1.0.1
type McAfee_Epolicy_Orchestrator_Version51_Agent_Details struct { Entity // Version number of the anti-virus scan agent. AgentVersion *string `json:"agentVersion,omitempty" xmlrpc:"agentVersion,omitempty"` // The date of the last time the anti-virus agent checked in. LastUpdate *Time `json:"lastUpdate,omitempty" xmlrpc:"lastUpdate,omitempty"` }
The McAfee_Epolicy_Orchestrator_Version51_Agent_Details data type represents a virus scan agent and contains details about its version.
type McAfee_Epolicy_Orchestrator_Version51_Policy_Object ¶ added in v1.0.1
type McAfee_Epolicy_Orchestrator_Version51_Policy_Object struct { Entity // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
The McAfee_Epolicy_Orchestrator_Version51_Policy_Object data type represents a virus scan agent and contains details about its version.
type McAfee_Epolicy_Orchestrator_Version51_Product_Properties ¶ added in v1.0.1
type McAfee_Epolicy_Orchestrator_Version51_Product_Properties struct { Entity // no documentation yet DatVersion *string `json:"datVersion,omitempty" xmlrpc:"datVersion,omitempty"` }
The McAfee_Epolicy_Orchestrator_Version51_Product_Properties data type represents the version of the virus data file
type Metric_Tracking_Object ¶
type Metric_Tracking_Object struct { Entity // The data recorded by a tracking object. Data []Metric_Tracking_Object_Data `json:"data,omitempty" xmlrpc:"data,omitempty"` // A tracking object's internal identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Tracking object label Label *string `json:"label,omitempty" xmlrpc:"label,omitempty"` // The identifier of the existing resource this object is attempting to track. ResourceTableId *int `json:"resourceTableId,omitempty" xmlrpc:"resourceTableId,omitempty"` // The date this tracker began tracking this particular resource. StartDate *Time `json:"startDate,omitempty" xmlrpc:"startDate,omitempty"` // The type of data that a tracking object polls. Type *Metric_Tracking_Object_Type `json:"type,omitempty" xmlrpc:"type,omitempty"` }
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.
type Metric_Tracking_Object_Abstract ¶
type Metric_Tracking_Object_Abstract struct {
Metric_Tracking_Object
}
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.
type Metric_Tracking_Object_Bandwidth_Summary ¶
type Metric_Tracking_Object_Bandwidth_Summary struct { Entity // This is the amount of bandwidth (measured in gigabytes) allocated for this tracking object. AllocationAmount *Float64 `json:"allocationAmount,omitempty" xmlrpc:"allocationAmount,omitempty"` // no documentation yet AllocationId *int `json:"allocationId,omitempty" xmlrpc:"allocationId,omitempty"` // The amount of outbound bandwidth (measured in gigabytes) currently used this billing period. Same as $outboundBandwidthAmount. Aliased for backward compatability. AmountOut *Float64 `json:"amountOut,omitempty" xmlrpc:"amountOut,omitempty"` // The daily average amount of outbound bandwidth usage. AverageDailyUsage *Float64 `json:"averageDailyUsage,omitempty" xmlrpc:"averageDailyUsage,omitempty"` // A flag that tells whether or not this tracking object's bandwidth usage is already over the allocation. 1 means yes, 0 means no. CurrentlyOverAllocationFlag *int `json:"currentlyOverAllocationFlag,omitempty" xmlrpc:"currentlyOverAllocationFlag,omitempty"` // The metric tracking id for this resource. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The amount of inbound bandwidth (measured in gigabytes) currently used this billing period InboundBandwidthAmount *Float64 `json:"inboundBandwidthAmount,omitempty" xmlrpc:"inboundBandwidthAmount,omitempty"` // The amount of outbound bandwidth (measured in gigabytes) currently used this billing period OutboundBandwidthAmount *Float64 `json:"outboundBandwidthAmount,omitempty" xmlrpc:"outboundBandwidthAmount,omitempty"` // The amount of bandwidth (measured in gigabytes) of projected usage, using a basic average calculation of daily usage. ProjectedBandwidthUsage *Float64 `json:"projectedBandwidthUsage,omitempty" xmlrpc:"projectedBandwidthUsage,omitempty"` // 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. ProjectedOverAllocationFlag *int `json:"projectedOverAllocationFlag,omitempty" xmlrpc:"projectedOverAllocationFlag,omitempty"` }
This data type provides commonly used bandwidth summary components for the current billing cycle.
type Metric_Tracking_Object_Data ¶
type Metric_Tracking_Object_Data struct { Entity // The value stored for a data record. Counter *Float64 `json:"counter,omitempty" xmlrpc:"counter,omitempty"` // The time a data record was stored. DateTime *Time `json:"dateTime,omitempty" xmlrpc:"dateTime,omitempty"` // The type of data held in a record. Type *string `json:"type,omitempty" xmlrpc:"type,omitempty"` }
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.
type Metric_Tracking_Object_HardwareServer ¶
type Metric_Tracking_Object_HardwareServer struct { Metric_Tracking_Object_Abstract // The raw bandwidth usage data for the current billing cycle. One object is returned for each network this server is attached to. BillingCycleBandwidthUsage []Network_Bandwidth_Usage `json:"billingCycleBandwidthUsage,omitempty" xmlrpc:"billingCycleBandwidthUsage,omitempty"` // 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. BillingCycleBandwidthUsageCount *uint `json:"billingCycleBandwidthUsageCount,omitempty" xmlrpc:"billingCycleBandwidthUsageCount,omitempty"` // The raw bandwidth usage data for the current billing cycle. One object is returned for each network this server is attached to. BillingCyclePrivateBandwidthUsage []Network_Bandwidth_Usage `json:"billingCyclePrivateBandwidthUsage,omitempty" xmlrpc:"billingCyclePrivateBandwidthUsage,omitempty"` // 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. BillingCyclePrivateBandwidthUsageCount *uint `json:"billingCyclePrivateBandwidthUsageCount,omitempty" xmlrpc:"billingCyclePrivateBandwidthUsageCount,omitempty"` // The total private inbound bandwidth for this item's resource for the current billing cycle. BillingCyclePrivateUsageIn *Float64 `json:"billingCyclePrivateUsageIn,omitempty" xmlrpc:"billingCyclePrivateUsageIn,omitempty"` // The total private outbound bandwidth for this item's resource for the current billing cycle. BillingCyclePrivateUsageOut *Float64 `json:"billingCyclePrivateUsageOut,omitempty" xmlrpc:"billingCyclePrivateUsageOut,omitempty"` // The total private bandwidth for this item's resource for the current billing cycle. BillingCyclePrivateUsageTotal *uint `json:"billingCyclePrivateUsageTotal,omitempty" xmlrpc:"billingCyclePrivateUsageTotal,omitempty"` // The raw public bandwidth usage data for the current billing cycle. One object is returned for each network this server is attached to. BillingCyclePublicBandwidthUsage *Network_Bandwidth_Usage `json:"billingCyclePublicBandwidthUsage,omitempty" xmlrpc:"billingCyclePublicBandwidthUsage,omitempty"` // The total public inbound bandwidth for this item's resource for the current billing cycle. BillingCyclePublicUsageIn *Float64 `json:"billingCyclePublicUsageIn,omitempty" xmlrpc:"billingCyclePublicUsageIn,omitempty"` // The total public outbound bandwidth for this item's resource for the current billing cycle. BillingCyclePublicUsageOut *Float64 `json:"billingCyclePublicUsageOut,omitempty" xmlrpc:"billingCyclePublicUsageOut,omitempty"` // The total public bandwidth for this item's resource for the current billing cycle. BillingCyclePublicUsageTotal *uint `json:"billingCyclePublicUsageTotal,omitempty" xmlrpc:"billingCyclePublicUsageTotal,omitempty"` // The server that this tracking object tracks. Resource *Hardware_Server `json:"resource,omitempty" xmlrpc:"resource,omitempty"` }
SoftLayer_Metric_Tracking_Object_HardwareServer models tracking objects specific to physical hardware and the data that are recorded by those servers.
type Metric_Tracking_Object_Type ¶
type Metric_Tracking_Object_Type struct { Entity // Description A tracking object type's key name. This is a shorter description of what kind of data a tracking object group is polling. Keyname *string `json:"keyname,omitempty" xmlrpc:"keyname,omitempty"` // Description A tracking object type's name. This describes what kind of data a tracking object group is polling. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
SoftLayer [[SoftLayer_Metric_Tracking_Object|tracking objects]] 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.
type Metric_Tracking_Object_VirtualDedicatedRack ¶
type Metric_Tracking_Object_VirtualDedicatedRack struct { Metric_Tracking_Object_Abstract // The raw bandwidth usage data for the current billing cycle. One object is returned for each network this server is attached to. BillingCycleBandwidthUsage []Network_Bandwidth_Usage `json:"billingCycleBandwidthUsage,omitempty" xmlrpc:"billingCycleBandwidthUsage,omitempty"` // 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. BillingCycleBandwidthUsageCount *uint `json:"billingCycleBandwidthUsageCount,omitempty" xmlrpc:"billingCycleBandwidthUsageCount,omitempty"` // The raw bandwidth usage data for the current billing cycle. One object is returned for each network this server is attached to. BillingCyclePrivateBandwidthUsage []Network_Bandwidth_Usage `json:"billingCyclePrivateBandwidthUsage,omitempty" xmlrpc:"billingCyclePrivateBandwidthUsage,omitempty"` // 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. BillingCyclePrivateBandwidthUsageCount *uint `json:"billingCyclePrivateBandwidthUsageCount,omitempty" xmlrpc:"billingCyclePrivateBandwidthUsageCount,omitempty"` // The total private inbound bandwidth for this item's resource for the current billing cycle. BillingCyclePrivateUsageIn *Float64 `json:"billingCyclePrivateUsageIn,omitempty" xmlrpc:"billingCyclePrivateUsageIn,omitempty"` // The total private outbound bandwidth for this item's resource for the current billing cycle. BillingCyclePrivateUsageOut *Float64 `json:"billingCyclePrivateUsageOut,omitempty" xmlrpc:"billingCyclePrivateUsageOut,omitempty"` // The total private bandwidth for this item's resource for the current billing cycle. BillingCyclePrivateUsageTotal *uint `json:"billingCyclePrivateUsageTotal,omitempty" xmlrpc:"billingCyclePrivateUsageTotal,omitempty"` // The raw bandwidth usage data for the current billing cycle. One object is returned for each network this server is attached to. BillingCyclePublicBandwidthUsage *Network_Bandwidth_Usage `json:"billingCyclePublicBandwidthUsage,omitempty" xmlrpc:"billingCyclePublicBandwidthUsage,omitempty"` // The total public inbound bandwidth for this item's resource for the current billing cycle. BillingCyclePublicUsageIn *Float64 `json:"billingCyclePublicUsageIn,omitempty" xmlrpc:"billingCyclePublicUsageIn,omitempty"` // The total public outbound bandwidth for this item's resource for the current billing cycle. BillingCyclePublicUsageOut *Float64 `json:"billingCyclePublicUsageOut,omitempty" xmlrpc:"billingCyclePublicUsageOut,omitempty"` // The total public bandwidth for this item's resource for the current billing cycle. BillingCyclePublicUsageTotal *uint `json:"billingCyclePublicUsageTotal,omitempty" xmlrpc:"billingCyclePublicUsageTotal,omitempty"` // The virtual rack that this tracking object tracks. Resource *Network_Bandwidth_Version1_Allotment `json:"resource,omitempty" xmlrpc:"resource,omitempty"` }
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.
type Metric_Tracking_Object_Virtual_Storage_Repository ¶
type Metric_Tracking_Object_Virtual_Storage_Repository struct { Metric_Tracking_Object_Abstract // The virtual storage repository that this tracking object tracks. Resource *Virtual_Storage_Repository `json:"resource,omitempty" xmlrpc:"resource,omitempty"` }
no documentation yet
type Monitoring_Robot ¶
type Monitoring_Robot struct { Entity // DEPRECATED. Internal identifier of a SoftLayer account that this robot belongs to // Deprecated: This function has been marked as deprecated. AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // DEPRECATED. Internal identifier of a monitoring robot // Deprecated: This function has been marked as deprecated. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // DEPRECATED. Robot name // Deprecated: This function has been marked as deprecated. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // DEPRECATED. Internal identifier of a monitoring robot status // Deprecated: This function has been marked as deprecated. StatusId *int `json:"statusId,omitempty" xmlrpc:"statusId,omitempty"` }
DEPRECATED. The SoftLayer_Monitoring_Robot data type contains general information relating to a monitoring robot.
type Monitoring_Robot_Status ¶
type Monitoring_Robot_Status struct { Entity // DEPRECATED. Monitoring robot status description // Deprecated: This function has been marked as deprecated. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // DEPRECATED. Internal identifier of a monitoring robot status // Deprecated: This function has been marked as deprecated. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // DEPRECATED. Monitoring robot status name // Deprecated: This function has been marked as deprecated. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
DEPRECATED. Your monitoring robot will be in "Active" status under normal circumstances. If you perform an OS reload, your robot will be in "Reclaim" status until it's reloaded on your server or virtual server.
Advanced monitoring system requires "Nimsoft Monitoring (Advanced)" service running and TCP ports 48000 - 48020 to be open on your server or virtual server. Monitoring agents cannot be managed nor can the usage data be updated if these ports are closed. Your monitoring robot will be in "Limited Connectivity" status if our monitoring management system cannot communicate with your system.
See [[SoftLayer_Monitoring_Robot::resetStatus|resetStatus]] service for more details.
type Network_Application_Delivery_Controller ¶
type Network_Application_Delivery_Controller struct { Entity // The SoftLayer customer account that owns an application delivery controller record. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // The unique identifier of the SoftLayer customer account that owns an application delivery controller record AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // The average daily public bandwidth usage for the current billing cycle. AverageDailyPublicBandwidthUsage *Float64 `json:"averageDailyPublicBandwidthUsage,omitempty" xmlrpc:"averageDailyPublicBandwidthUsage,omitempty"` // The billing item for a Application Delivery Controller. BillingItem *Billing_Item_Network_Application_Delivery_Controller `json:"billingItem,omitempty" xmlrpc:"billingItem,omitempty"` // Previous configurations for an Application Delivery Controller. ConfigurationHistory []Network_Application_Delivery_Controller_Configuration_History `json:"configurationHistory,omitempty" xmlrpc:"configurationHistory,omitempty"` // A count of previous configurations for an Application Delivery Controller. ConfigurationHistoryCount *uint `json:"configurationHistoryCount,omitempty" xmlrpc:"configurationHistoryCount,omitempty"` // The date that an application delivery controller record was created CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // The datacenter that the application delivery controller resides in. Datacenter *Location `json:"datacenter,omitempty" xmlrpc:"datacenter,omitempty"` // A brief description of an application delivery controller record. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // An application delivery controller's unique identifier Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The total public inbound bandwidth for the current billing cycle. InboundPublicBandwidthUsage *Float64 `json:"inboundPublicBandwidthUsage,omitempty" xmlrpc:"inboundPublicBandwidthUsage,omitempty"` // The date in which the license for this application delivery controller will expire. LicenseExpirationDate *Time `json:"licenseExpirationDate,omitempty" xmlrpc:"licenseExpirationDate,omitempty"` // A count of the virtual IP address records that belong to an application delivery controller based load balancer. LoadBalancerCount *uint `json:"loadBalancerCount,omitempty" xmlrpc:"loadBalancerCount,omitempty"` // The virtual IP address records that belong to an application delivery controller based load balancer. LoadBalancers []Network_LoadBalancer_VirtualIpAddress `json:"loadBalancers,omitempty" xmlrpc:"loadBalancers,omitempty"` // A flag indicating that this Application Delivery Controller is a managed resource. ManagedResourceFlag *bool `json:"managedResourceFlag,omitempty" xmlrpc:"managedResourceFlag,omitempty"` // An application delivery controller's management ip address. ManagementIpAddress *string `json:"managementIpAddress,omitempty" xmlrpc:"managementIpAddress,omitempty"` // The date that an application delivery controller record was last modified ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // An application delivery controller's name Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // The network VLAN that an application delivery controller resides on. NetworkVlan *Network_Vlan `json:"networkVlan,omitempty" xmlrpc:"networkVlan,omitempty"` // A count of the network VLANs that an application delivery controller resides on. NetworkVlanCount *uint `json:"networkVlanCount,omitempty" xmlrpc:"networkVlanCount,omitempty"` // The network VLANs that an application delivery controller resides on. NetworkVlans []Network_Vlan `json:"networkVlans,omitempty" xmlrpc:"networkVlans,omitempty"` // Editable notes used to describe an application delivery controller's function Notes *string `json:"notes,omitempty" xmlrpc:"notes,omitempty"` // The total public outbound bandwidth for the current billing cycle. OutboundPublicBandwidthUsage *Float64 `json:"outboundPublicBandwidthUsage,omitempty" xmlrpc:"outboundPublicBandwidthUsage,omitempty"` // The password used to connect to an application delivery controller's management interface when it is operating in advanced view mode. Password *Software_Component_Password `json:"password,omitempty" xmlrpc:"password,omitempty"` // An application delivery controller's primary public IP address. PrimaryIpAddress *string `json:"primaryIpAddress,omitempty" xmlrpc:"primaryIpAddress,omitempty"` // The projected public outbound bandwidth for the current billing cycle. ProjectedPublicBandwidthUsage *Float64 `json:"projectedPublicBandwidthUsage,omitempty" xmlrpc:"projectedPublicBandwidthUsage,omitempty"` // A count of a network application controller's subnets. A subnet is a group of IP addresses SubnetCount *uint `json:"subnetCount,omitempty" xmlrpc:"subnetCount,omitempty"` // A network application controller's subnets. A subnet is a group of IP addresses Subnets []Network_Subnet `json:"subnets,omitempty" xmlrpc:"subnets,omitempty"` // A count of TagReferenceCount *uint `json:"tagReferenceCount,omitempty" xmlrpc:"tagReferenceCount,omitempty"` // no documentation yet TagReferences []Tag_Reference `json:"tagReferences,omitempty" xmlrpc:"tagReferences,omitempty"` // no documentation yet Type *Network_Application_Delivery_Controller_Type `json:"type,omitempty" xmlrpc:"type,omitempty"` // no documentation yet TypeId *int `json:"typeId,omitempty" xmlrpc:"typeId,omitempty"` // A count of VirtualIpAddressCount *uint `json:"virtualIpAddressCount,omitempty" xmlrpc:"virtualIpAddressCount,omitempty"` // no documentation yet VirtualIpAddresses []Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress `json:"virtualIpAddresses,omitempty" xmlrpc:"virtualIpAddresses,omitempty"` }
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.
type Network_Application_Delivery_Controller_Configuration_History ¶
type Network_Application_Delivery_Controller_Configuration_History struct { Entity // The application delivery controller that a configuration history record belongs to. Controller *Network_Application_Delivery_Controller `json:"controller,omitempty" xmlrpc:"controller,omitempty"` // The date a configuration history record was created. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // An configuration history record's unique identifier Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Editable notes used to describe a configuration history record Notes *string `json:"notes,omitempty" xmlrpc:"notes,omitempty"` }
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.
type Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute ¶
type Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute struct { Entity // no documentation yet HealthAttributeTypeId *int `json:"healthAttributeTypeId,omitempty" xmlrpc:"healthAttributeTypeId,omitempty"` // no documentation yet HealthCheck *Network_Application_Delivery_Controller_LoadBalancer_Health_Check `json:"healthCheck,omitempty" xmlrpc:"healthCheck,omitempty"` // no documentation yet HealthCheckId *int `json:"healthCheckId,omitempty" xmlrpc:"healthCheckId,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet Type *Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type `json:"type,omitempty" xmlrpc:"type,omitempty"` // no documentation yet Value *string `json:"value,omitempty" xmlrpc:"value,omitempty"` }
no documentation yet
type Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type ¶
type Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type struct { Entity // no documentation yet Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet Keyname *string `json:"keyname,omitempty" xmlrpc:"keyname,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // no documentation yet ValueExpression *string `json:"valueExpression,omitempty" xmlrpc:"valueExpression,omitempty"` }
no documentation yet
type Network_Application_Delivery_Controller_LoadBalancer_Health_Check ¶
type Network_Application_Delivery_Controller_LoadBalancer_Health_Check struct { Entity // A count of AttributeCount *uint `json:"attributeCount,omitempty" xmlrpc:"attributeCount,omitempty"` // no documentation yet Attributes []Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute `json:"attributes,omitempty" xmlrpc:"attributes,omitempty"` // no documentation yet HealthCheckTypeId *int `json:"healthCheckTypeId,omitempty" xmlrpc:"healthCheckTypeId,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // no documentation yet Notes *string `json:"notes,omitempty" xmlrpc:"notes,omitempty"` // A count of ServiceCount *uint `json:"serviceCount,omitempty" xmlrpc:"serviceCount,omitempty"` // no documentation yet Services []Network_Application_Delivery_Controller_LoadBalancer_Service `json:"services,omitempty" xmlrpc:"services,omitempty"` // no documentation yet Type *Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type `json:"type,omitempty" xmlrpc:"type,omitempty"` }
no documentation yet
type Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type ¶
type Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type struct { Entity // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet Keyname *string `json:"keyname,omitempty" xmlrpc:"keyname,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
no documentation yet
type Network_Application_Delivery_Controller_LoadBalancer_Routing_Method ¶
type Network_Application_Delivery_Controller_LoadBalancer_Routing_Method struct { Entity // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet Keyname *string `json:"keyname,omitempty" xmlrpc:"keyname,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
no documentation yet
type Network_Application_Delivery_Controller_LoadBalancer_Routing_Type ¶
type Network_Application_Delivery_Controller_LoadBalancer_Routing_Type struct { Entity // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet Keyname *string `json:"keyname,omitempty" xmlrpc:"keyname,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
no documentation yet
type Network_Application_Delivery_Controller_LoadBalancer_Service ¶
type Network_Application_Delivery_Controller_LoadBalancer_Service struct { Entity // no documentation yet Enabled *int `json:"enabled,omitempty" xmlrpc:"enabled,omitempty"` // A count of GroupCount *uint `json:"groupCount,omitempty" xmlrpc:"groupCount,omitempty"` // A count of GroupReferenceCount *uint `json:"groupReferenceCount,omitempty" xmlrpc:"groupReferenceCount,omitempty"` // no documentation yet GroupReferences []Network_Application_Delivery_Controller_LoadBalancer_Service_Group_CrossReference `json:"groupReferences,omitempty" xmlrpc:"groupReferences,omitempty"` // no documentation yet Groups []Network_Application_Delivery_Controller_LoadBalancer_Service_Group `json:"groups,omitempty" xmlrpc:"groups,omitempty"` // no documentation yet HealthCheck *Network_Application_Delivery_Controller_LoadBalancer_Health_Check `json:"healthCheck,omitempty" xmlrpc:"healthCheck,omitempty"` // A count of HealthCheckCount *uint `json:"healthCheckCount,omitempty" xmlrpc:"healthCheckCount,omitempty"` // no documentation yet HealthChecks []Network_Application_Delivery_Controller_LoadBalancer_Health_Check `json:"healthChecks,omitempty" xmlrpc:"healthChecks,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet IpAddress *Network_Subnet_IpAddress `json:"ipAddress,omitempty" xmlrpc:"ipAddress,omitempty"` // no documentation yet IpAddressId *int `json:"ipAddressId,omitempty" xmlrpc:"ipAddressId,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // no documentation yet Notes *string `json:"notes,omitempty" xmlrpc:"notes,omitempty"` // no documentation yet Port *int `json:"port,omitempty" xmlrpc:"port,omitempty"` // no documentation yet ServiceGroup *Network_Application_Delivery_Controller_LoadBalancer_Service_Group `json:"serviceGroup,omitempty" xmlrpc:"serviceGroup,omitempty"` // no documentation yet Status *string `json:"status,omitempty" xmlrpc:"status,omitempty"` }
no documentation yet
type Network_Application_Delivery_Controller_LoadBalancer_Service_Group ¶
type Network_Application_Delivery_Controller_LoadBalancer_Service_Group struct { Entity // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // no documentation yet Notes *string `json:"notes,omitempty" xmlrpc:"notes,omitempty"` // no documentation yet RoutingMethod *Network_Application_Delivery_Controller_LoadBalancer_Routing_Method `json:"routingMethod,omitempty" xmlrpc:"routingMethod,omitempty"` // no documentation yet RoutingMethodId *int `json:"routingMethodId,omitempty" xmlrpc:"routingMethodId,omitempty"` // no documentation yet RoutingType *Network_Application_Delivery_Controller_LoadBalancer_Routing_Type `json:"routingType,omitempty" xmlrpc:"routingType,omitempty"` // no documentation yet RoutingTypeId *int `json:"routingTypeId,omitempty" xmlrpc:"routingTypeId,omitempty"` // A count of ServiceCount *uint `json:"serviceCount,omitempty" xmlrpc:"serviceCount,omitempty"` // A count of ServiceReferenceCount *uint `json:"serviceReferenceCount,omitempty" xmlrpc:"serviceReferenceCount,omitempty"` // no documentation yet ServiceReferences []Network_Application_Delivery_Controller_LoadBalancer_Service_Group_CrossReference `json:"serviceReferences,omitempty" xmlrpc:"serviceReferences,omitempty"` // no documentation yet Services []Network_Application_Delivery_Controller_LoadBalancer_Service `json:"services,omitempty" xmlrpc:"services,omitempty"` // The timeout value for connections from remote clients to the load balancer. Timeout values are only valid for HTTP service groups. Timeout *int `json:"timeout,omitempty" xmlrpc:"timeout,omitempty"` // no documentation yet VirtualServer *Network_Application_Delivery_Controller_LoadBalancer_VirtualServer `json:"virtualServer,omitempty" xmlrpc:"virtualServer,omitempty"` // A count of VirtualServerCount *uint `json:"virtualServerCount,omitempty" xmlrpc:"virtualServerCount,omitempty"` // no documentation yet VirtualServers []Network_Application_Delivery_Controller_LoadBalancer_VirtualServer `json:"virtualServers,omitempty" xmlrpc:"virtualServers,omitempty"` }
no documentation yet
type Network_Application_Delivery_Controller_LoadBalancer_Service_Group_CrossReference ¶
type Network_Application_Delivery_Controller_LoadBalancer_Service_Group_CrossReference struct { Entity // no documentation yet Service *Network_Application_Delivery_Controller_LoadBalancer_Service `json:"service,omitempty" xmlrpc:"service,omitempty"` // no documentation yet ServiceGroup *Network_Application_Delivery_Controller_LoadBalancer_Service_Group `json:"serviceGroup,omitempty" xmlrpc:"serviceGroup,omitempty"` // no documentation yet ServiceGroupId *int `json:"serviceGroupId,omitempty" xmlrpc:"serviceGroupId,omitempty"` // no documentation yet ServiceId *int `json:"serviceId,omitempty" xmlrpc:"serviceId,omitempty"` // no documentation yet Weight *int `json:"weight,omitempty" xmlrpc:"weight,omitempty"` }
no documentation yet
type Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress ¶
type Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress struct { Entity // no documentation yet Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // The unique identifier of the SoftLayer customer account that owns the virtual IP address AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // A virtual IP address's associated application delivery controller. ApplicationDeliveryController *Network_Application_Delivery_Controller `json:"applicationDeliveryController,omitempty" xmlrpc:"applicationDeliveryController,omitempty"` // A count of a virtual IP address's associated application delivery controllers. ApplicationDeliveryControllerCount *uint `json:"applicationDeliveryControllerCount,omitempty" xmlrpc:"applicationDeliveryControllerCount,omitempty"` // A virtual IP address's associated application delivery controllers. ApplicationDeliveryControllers []Network_Application_Delivery_Controller `json:"applicationDeliveryControllers,omitempty" xmlrpc:"applicationDeliveryControllers,omitempty"` // 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. BillingItem *Billing_Item `json:"billingItem,omitempty" xmlrpc:"billingItem,omitempty"` // The connection limit for this virtual IP address ConnectionLimit *int `json:"connectionLimit,omitempty" xmlrpc:"connectionLimit,omitempty"` // The units for the connection limit ConnectionLimitUnits *string `json:"connectionLimitUnits,omitempty" xmlrpc:"connectionLimitUnits,omitempty"` // 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. DedicatedBillingItem *Billing_Item_Network_LoadBalancer `json:"dedicatedBillingItem,omitempty" xmlrpc:"dedicatedBillingItem,omitempty"` // A flag that determines if a VIP is dedicated or not. This is used to override the connection limit and use an unlimited value. DedicatedFlag *bool `json:"dedicatedFlag,omitempty" xmlrpc:"dedicatedFlag,omitempty"` // Denotes whether the virtual IP is configured within a high availability cluster. HighAvailabilityFlag *bool `json:"highAvailabilityFlag,omitempty" xmlrpc:"highAvailabilityFlag,omitempty"` // The unique identifier of the virtual IP address record Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet IpAddress *Network_Subnet_IpAddress `json:"ipAddress,omitempty" xmlrpc:"ipAddress,omitempty"` // ID of the IP address this virtual IP utilizes IpAddressId *int `json:"ipAddressId,omitempty" xmlrpc:"ipAddressId,omitempty"` // no documentation yet LoadBalancerHardware []Hardware `json:"loadBalancerHardware,omitempty" xmlrpc:"loadBalancerHardware,omitempty"` // A count of LoadBalancerHardwareCount *uint `json:"loadBalancerHardwareCount,omitempty" xmlrpc:"loadBalancerHardwareCount,omitempty"` // A flag indicating that the load balancer is a managed resource. ManagedResourceFlag *bool `json:"managedResourceFlag,omitempty" xmlrpc:"managedResourceFlag,omitempty"` // User-created notes for this load balancer virtual IP address Notes *string `json:"notes,omitempty" xmlrpc:"notes,omitempty"` // A count of the list of security ciphers enabled for this virtual IP address SecureTransportCipherCount *uint `json:"secureTransportCipherCount,omitempty" xmlrpc:"secureTransportCipherCount,omitempty"` // The list of security ciphers enabled for this virtual IP address SecureTransportCiphers []Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress_SecureTransportCipher `json:"secureTransportCiphers,omitempty" xmlrpc:"secureTransportCiphers,omitempty"` // A count of the list of secure transport protocols enabled for this virtual IP address SecureTransportProtocolCount *uint `json:"secureTransportProtocolCount,omitempty" xmlrpc:"secureTransportProtocolCount,omitempty"` // The list of secure transport protocols enabled for this virtual IP address SecureTransportProtocols []Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress_SecureTransportProtocol `json:"secureTransportProtocols,omitempty" xmlrpc:"secureTransportProtocols,omitempty"` // The SSL certificate currently associated with the VIP. SecurityCertificate *Security_Certificate `json:"securityCertificate,omitempty" xmlrpc:"securityCertificate,omitempty"` // The SSL certificate currently associated with the VIP. Provides chosen certificate visibility to unprivileged users. SecurityCertificateEntry *Security_Certificate_Entry `json:"securityCertificateEntry,omitempty" xmlrpc:"securityCertificateEntry,omitempty"` // The unique identifier of the Security Certificate to be utilized when SSL support is enabled. SecurityCertificateId *int `json:"securityCertificateId,omitempty" xmlrpc:"securityCertificateId,omitempty"` // Determines if the VIP currently has SSL acceleration enabled SslActiveFlag *bool `json:"sslActiveFlag,omitempty" xmlrpc:"sslActiveFlag,omitempty"` // Determines if the VIP is _allowed_ to utilize SSL acceleration SslEnabledFlag *bool `json:"sslEnabledFlag,omitempty" xmlrpc:"sslEnabledFlag,omitempty"` // A count of VirtualServerCount *uint `json:"virtualServerCount,omitempty" xmlrpc:"virtualServerCount,omitempty"` // no documentation yet VirtualServers []Network_Application_Delivery_Controller_LoadBalancer_VirtualServer `json:"virtualServers,omitempty" xmlrpc:"virtualServers,omitempty"` }
no documentation yet
type Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress_SecureTransportCipher ¶
type Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress_SecureTransportCipher struct { Entity // Unique identifier for the cipher instance Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Identifier for the associated encryption algorithm KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // no documentation yet VirtualIpAddress *Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress `json:"virtualIpAddress,omitempty" xmlrpc:"virtualIpAddress,omitempty"` // Identifier for the associated [[SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress (type)|virtual IP address]] instance VirtualIpAddressId *int `json:"virtualIpAddressId,omitempty" xmlrpc:"virtualIpAddressId,omitempty"` }
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.
type Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress_SecureTransportProtocol ¶
type Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress_SecureTransportProtocol struct { Entity // Unique identifier for the protocol instance Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Identifier for the associated communication protocol KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // no documentation yet VirtualIpAddress *Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress `json:"virtualIpAddress,omitempty" xmlrpc:"virtualIpAddress,omitempty"` // Identifier for the associated [[SoftLayer_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress (type)|virtual IP address]] instance VirtualIpAddressId *int `json:"virtualIpAddressId,omitempty" xmlrpc:"virtualIpAddressId,omitempty"` }
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.
type Network_Application_Delivery_Controller_LoadBalancer_VirtualServer ¶
type Network_Application_Delivery_Controller_LoadBalancer_VirtualServer struct { Entity // no documentation yet Allocation *int `json:"allocation,omitempty" xmlrpc:"allocation,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // no documentation yet Notes *string `json:"notes,omitempty" xmlrpc:"notes,omitempty"` // no documentation yet Port *int `json:"port,omitempty" xmlrpc:"port,omitempty"` // no documentation yet RoutingMethod *Network_Application_Delivery_Controller_LoadBalancer_Routing_Method `json:"routingMethod,omitempty" xmlrpc:"routingMethod,omitempty"` // no documentation yet RoutingMethodId *int `json:"routingMethodId,omitempty" xmlrpc:"routingMethodId,omitempty"` // A count of ServiceGroupCount *uint `json:"serviceGroupCount,omitempty" xmlrpc:"serviceGroupCount,omitempty"` // no documentation yet ServiceGroups []Network_Application_Delivery_Controller_LoadBalancer_Service_Group `json:"serviceGroups,omitempty" xmlrpc:"serviceGroups,omitempty"` // no documentation yet VirtualIpAddress *Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress `json:"virtualIpAddress,omitempty" xmlrpc:"virtualIpAddress,omitempty"` // no documentation yet VirtualIpAddressId *int `json:"virtualIpAddressId,omitempty" xmlrpc:"virtualIpAddressId,omitempty"` }
no documentation yet
type Network_Application_Delivery_Controller_Type ¶
type Network_Application_Delivery_Controller_Type struct { Entity // no documentation yet KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
no documentation yet
type Network_Bandwidth_Usage ¶
type Network_Bandwidth_Usage struct { Entity // Incoming bandwidth utilization. AmountIn *Float64 `json:"amountIn,omitempty" xmlrpc:"amountIn,omitempty"` // Outgoing bandwidth utilization. AmountOut *Float64 `json:"amountOut,omitempty" xmlrpc:"amountOut,omitempty"` // ID of the bandwidth usage detail type for this record. BandwidthUsageDetailTypeId *Float64 `json:"bandwidthUsageDetailTypeId,omitempty" xmlrpc:"bandwidthUsageDetailTypeId,omitempty"` // The tracking object this bandwidth usage record describes. TrackingObject *Metric_Tracking_Object `json:"trackingObject,omitempty" xmlrpc:"trackingObject,omitempty"` // In and out bandwidth utilization for a specified time stamp. Type *Network_Bandwidth_Version1_Usage_Detail_Type `json:"type,omitempty" xmlrpc:"type,omitempty"` }
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.
type Network_Bandwidth_Version1_Allocation ¶
type Network_Bandwidth_Version1_Allocation struct { Entity // A bandwidth allotment detail. AllotmentDetail *Network_Bandwidth_Version1_Allotment_Detail `json:"allotmentDetail,omitempty" xmlrpc:"allotmentDetail,omitempty"` // The amount of bandwidth allocated. Amount *Float64 `json:"amount,omitempty" xmlrpc:"amount,omitempty"` // Billing item associated with this hardware allocation. BillingItem *Billing_Item `json:"billingItem,omitempty" xmlrpc:"billingItem,omitempty"` // Internal ID associated with this allocation. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` }
The SoftLayer_Network_Bandwidth_Version1_Allocation data type contains general information relating to a single bandwidth allocation record.
type Network_Bandwidth_Version1_Allotment ¶
type Network_Bandwidth_Version1_Allotment struct { Entity // The account associated with this virtual rack. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // The user account identifier associated with this allotment. AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // A count of the bandwidth allotment detail records associated with this virtual rack. ActiveDetailCount *uint `json:"activeDetailCount,omitempty" xmlrpc:"activeDetailCount,omitempty"` // The bandwidth allotment detail records associated with this virtual rack. ActiveDetails []Network_Bandwidth_Version1_Allotment_Detail `json:"activeDetails,omitempty" xmlrpc:"activeDetails,omitempty"` // A count of the Application Delivery Controller contained within a virtual rack. ApplicationDeliveryControllerCount *uint `json:"applicationDeliveryControllerCount,omitempty" xmlrpc:"applicationDeliveryControllerCount,omitempty"` // The Application Delivery Controller contained within a virtual rack. ApplicationDeliveryControllers []Network_Application_Delivery_Controller `json:"applicationDeliveryControllers,omitempty" xmlrpc:"applicationDeliveryControllers,omitempty"` // The average daily public bandwidth usage for the current billing cycle. AverageDailyPublicBandwidthUsage *Float64 `json:"averageDailyPublicBandwidthUsage,omitempty" xmlrpc:"averageDailyPublicBandwidthUsage,omitempty"` // The bandwidth allotment type of this virtual rack. BandwidthAllotmentType *Network_Bandwidth_Version1_Allotment_Type `json:"bandwidthAllotmentType,omitempty" xmlrpc:"bandwidthAllotmentType,omitempty"` // An identifier marking this allotment as a virtual private rack (1) or a bandwidth pooling(2). BandwidthAllotmentTypeId *int `json:"bandwidthAllotmentTypeId,omitempty" xmlrpc:"bandwidthAllotmentTypeId,omitempty"` // A count of the bare metal server instances contained within a virtual rack. BareMetalInstanceCount *uint `json:"bareMetalInstanceCount,omitempty" xmlrpc:"bareMetalInstanceCount,omitempty"` // The bare metal server instances contained within a virtual rack. BareMetalInstances []Hardware `json:"bareMetalInstances,omitempty" xmlrpc:"bareMetalInstances,omitempty"` // 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. BillingCycleBandwidthUsage []Network_Bandwidth_Usage `json:"billingCycleBandwidthUsage,omitempty" xmlrpc:"billingCycleBandwidthUsage,omitempty"` // 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. BillingCycleBandwidthUsageCount *uint `json:"billingCycleBandwidthUsageCount,omitempty" xmlrpc:"billingCycleBandwidthUsageCount,omitempty"` // A virtual rack's raw private network bandwidth usage data for an account's current billing cycle. BillingCyclePrivateBandwidthUsage *Network_Bandwidth_Usage `json:"billingCyclePrivateBandwidthUsage,omitempty" xmlrpc:"billingCyclePrivateBandwidthUsage,omitempty"` // A virtual rack's raw public network bandwidth usage data for an account's current billing cycle. BillingCyclePublicBandwidthUsage *Network_Bandwidth_Usage `json:"billingCyclePublicBandwidthUsage,omitempty" xmlrpc:"billingCyclePublicBandwidthUsage,omitempty"` // The total public bandwidth used in this virtual rack for an account's current billing cycle. BillingCyclePublicUsageTotal *uint `json:"billingCyclePublicUsageTotal,omitempty" xmlrpc:"billingCyclePublicUsageTotal,omitempty"` // A virtual rack's billing item. BillingItem *Billing_Item `json:"billingItem,omitempty" xmlrpc:"billingItem,omitempty"` // Creation date for an allotment. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // An object that provides commonly used bandwidth summary components for the current billing cycle. CurrentBandwidthSummary *Metric_Tracking_Object_Bandwidth_Summary `json:"currentBandwidthSummary,omitempty" xmlrpc:"currentBandwidthSummary,omitempty"` // A count of the bandwidth allotment detail records associated with this virtual rack. DetailCount *uint `json:"detailCount,omitempty" xmlrpc:"detailCount,omitempty"` // The bandwidth allotment detail records associated with this virtual rack. Details []Network_Bandwidth_Version1_Allotment_Detail `json:"details,omitempty" xmlrpc:"details,omitempty"` // End date for an allotment. EndDate *Time `json:"endDate,omitempty" xmlrpc:"endDate,omitempty"` // The hardware contained within a virtual rack. Hardware []Hardware `json:"hardware,omitempty" xmlrpc:"hardware,omitempty"` // A count of the hardware contained within a virtual rack. HardwareCount *uint `json:"hardwareCount,omitempty" xmlrpc:"hardwareCount,omitempty"` // A virtual rack's internal identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The total public inbound bandwidth used in this virtual rack for an account's current billing cycle. InboundPublicBandwidthUsage *Float64 `json:"inboundPublicBandwidthUsage,omitempty" xmlrpc:"inboundPublicBandwidthUsage,omitempty"` // The location group associated with this virtual rack. LocationGroup *Location_Group `json:"locationGroup,omitempty" xmlrpc:"locationGroup,omitempty"` // Location Group Id for an allotment LocationGroupId *int `json:"locationGroupId,omitempty" xmlrpc:"locationGroupId,omitempty"` // A count of the managed bare metal server instances contained within a virtual rack. ManagedBareMetalInstanceCount *uint `json:"managedBareMetalInstanceCount,omitempty" xmlrpc:"managedBareMetalInstanceCount,omitempty"` // The managed bare metal server instances contained within a virtual rack. ManagedBareMetalInstances []Hardware `json:"managedBareMetalInstances,omitempty" xmlrpc:"managedBareMetalInstances,omitempty"` // The managed hardware contained within a virtual rack. ManagedHardware []Hardware `json:"managedHardware,omitempty" xmlrpc:"managedHardware,omitempty"` // A count of the managed hardware contained within a virtual rack. ManagedHardwareCount *uint `json:"managedHardwareCount,omitempty" xmlrpc:"managedHardwareCount,omitempty"` // A count of the managed Virtual Server contained within a virtual rack. ManagedVirtualGuestCount *uint `json:"managedVirtualGuestCount,omitempty" xmlrpc:"managedVirtualGuestCount,omitempty"` // The managed Virtual Server contained within a virtual rack. ManagedVirtualGuests []Virtual_Guest `json:"managedVirtualGuests,omitempty" xmlrpc:"managedVirtualGuests,omitempty"` // A virtual rack's metric tracking object. This object records all periodic polled data available to this rack. MetricTrackingObject *Metric_Tracking_Object `json:"metricTrackingObject,omitempty" xmlrpc:"metricTrackingObject,omitempty"` // The metric tracking object id for this allotment. MetricTrackingObjectId *int `json:"metricTrackingObjectId,omitempty" xmlrpc:"metricTrackingObjectId,omitempty"` // Text A virtual rack's name. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // The total public outbound bandwidth used in this virtual rack for an account's current billing cycle. OutboundPublicBandwidthUsage *Float64 `json:"outboundPublicBandwidthUsage,omitempty" xmlrpc:"outboundPublicBandwidthUsage,omitempty"` // Whether the bandwidth usage for this bandwidth pool for the current billing cycle exceeds the allocation. OverBandwidthAllocationFlag *int `json:"overBandwidthAllocationFlag,omitempty" xmlrpc:"overBandwidthAllocationFlag,omitempty"` // The private network only hardware contained within a virtual rack. PrivateNetworkOnlyHardware []Hardware `json:"privateNetworkOnlyHardware,omitempty" xmlrpc:"privateNetworkOnlyHardware,omitempty"` // A count of the private network only hardware contained within a virtual rack. PrivateNetworkOnlyHardwareCount *uint `json:"privateNetworkOnlyHardwareCount,omitempty" xmlrpc:"privateNetworkOnlyHardwareCount,omitempty"` // Whether the bandwidth usage for this bandwidth pool for the current billing cycle is projected to exceed the allocation. ProjectedOverBandwidthAllocationFlag *int `json:"projectedOverBandwidthAllocationFlag,omitempty" xmlrpc:"projectedOverBandwidthAllocationFlag,omitempty"` // The projected public outbound bandwidth for this virtual server for the current billing cycle. ProjectedPublicBandwidthUsage *Float64 `json:"projectedPublicBandwidthUsage,omitempty" xmlrpc:"projectedPublicBandwidthUsage,omitempty"` // no documentation yet ServiceProvider *Service_Provider `json:"serviceProvider,omitempty" xmlrpc:"serviceProvider,omitempty"` // Service Provider Id for an allotment ServiceProviderId *int `json:"serviceProviderId,omitempty" xmlrpc:"serviceProviderId,omitempty"` // The combined allocated bandwidth for all servers in a virtual rack. TotalBandwidthAllocated *uint `json:"totalBandwidthAllocated,omitempty" xmlrpc:"totalBandwidthAllocated,omitempty"` // A count of the Virtual Server contained within a virtual rack. VirtualGuestCount *uint `json:"virtualGuestCount,omitempty" xmlrpc:"virtualGuestCount,omitempty"` // The Virtual Server contained within a virtual rack. VirtualGuests []Virtual_Guest `json:"virtualGuests,omitempty" xmlrpc:"virtualGuests,omitempty"` }
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.
type Network_Bandwidth_Version1_Allotment_Detail ¶
type Network_Bandwidth_Version1_Allotment_Detail struct { Entity // Allocated bandwidth. Allocation *Network_Bandwidth_Version1_Allocation `json:"allocation,omitempty" xmlrpc:"allocation,omitempty"` // Allocated bandwidth. AllocationId *int `json:"allocationId,omitempty" xmlrpc:"allocationId,omitempty"` // The parent Bandwidth Pool. BandwidthAllotment *Network_Bandwidth_Version1_Allotment `json:"bandwidthAllotment,omitempty" xmlrpc:"bandwidthAllotment,omitempty"` // Bandwidth Pool associated with this detail. BandwidthAllotmentId *int `json:"bandwidthAllotmentId,omitempty" xmlrpc:"bandwidthAllotmentId,omitempty"` // Beginning this date the bandwidth allotment is active. EffectiveDate *Time `json:"effectiveDate,omitempty" xmlrpc:"effectiveDate,omitempty"` // From this date the bandwidth allotment is no longer active. EndEffectiveDate *Time `json:"endEffectiveDate,omitempty" xmlrpc:"endEffectiveDate,omitempty"` // Internal ID associated with this allotment detail. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Service Provider Id for an allotment ServiceProviderId *int `json:"serviceProviderId,omitempty" xmlrpc:"serviceProviderId,omitempty"` }
The SoftLayer_Network_Bandwidth_Version1_Allotment_Detail data type contains specific information relating to a single bandwidth allotment record.
type Network_Bandwidth_Version1_Allotment_Type ¶
type Network_Bandwidth_Version1_Allotment_Type struct { Entity // no documentation yet Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // no documentation yet ShortDescription *string `json:"shortDescription,omitempty" xmlrpc:"shortDescription,omitempty"` }
The SoftLayer_Network_Bandwidth_Version1_Allotment_Type contains a description of the associated SoftLayer_Network_Bandwidth_Version1_Allotment object.
type Network_Bandwidth_Version1_Usage_Detail ¶
type Network_Bandwidth_Version1_Usage_Detail struct { Entity // Incoming bandwidth utilization . AmountIn *Float64 `json:"amountIn,omitempty" xmlrpc:"amountIn,omitempty"` // Outgoing bandwidth utilization . AmountOut *Float64 `json:"amountOut,omitempty" xmlrpc:"amountOut,omitempty"` // Describes this bandwidth utilization record as on the public or private network interface. BandwidthUsageDetailType *Network_Bandwidth_Version1_Usage_Detail_Type `json:"bandwidthUsageDetailType,omitempty" xmlrpc:"bandwidthUsageDetailType,omitempty"` // Day and time this bandwidth utilization event was recorded. Day *Time `json:"day,omitempty" xmlrpc:"day,omitempty"` }
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.
type Network_Bandwidth_Version1_Usage_Detail_Type ¶
type Network_Bandwidth_Version1_Usage_Detail_Type struct { Entity // Database key associated with this bandwidth detail type. Alias *string `json:"alias,omitempty" xmlrpc:"alias,omitempty"` }
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.
type Network_CdnMarketplace_Account ¶
type Network_CdnMarketplace_Account struct { Entity // SoftLayer account to which the CDN account belongs. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // An associated parent billing item which is active. BillingItem *Billing_Item `json:"billingItem,omitempty" xmlrpc:"billingItem,omitempty"` }
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.
type Network_CdnMarketplace_Configuration_Behavior_Geoblocking ¶
type Network_CdnMarketplace_Configuration_Behavior_Geoblocking struct { Entity // no documentation yet AccessType *string `json:"accessType,omitempty" xmlrpc:"accessType,omitempty"` // no documentation yet RegionType *string `json:"regionType,omitempty" xmlrpc:"regionType,omitempty"` // no documentation yet Regions []string `json:"regions,omitempty" xmlrpc:"regions,omitempty"` // no documentation yet Status *string `json:"status,omitempty" xmlrpc:"status,omitempty"` }
no documentation yet
type Network_CdnMarketplace_Configuration_Behavior_Geoblocking_Type ¶
type Network_CdnMarketplace_Configuration_Behavior_Geoblocking_Type struct { Entity // no documentation yet AccessType []string `json:"accessType,omitempty" xmlrpc:"accessType,omitempty"` // no documentation yet Continent []string `json:"continent,omitempty" xmlrpc:"continent,omitempty"` // no documentation yet CountryOrRegion []string `json:"countryOrRegion,omitempty" xmlrpc:"countryOrRegion,omitempty"` // no documentation yet RegionType []string `json:"regionType,omitempty" xmlrpc:"regionType,omitempty"` }
no documentation yet
type Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection ¶
type Network_CdnMarketplace_Configuration_Behavior_HotlinkProtection struct { Entity // no documentation yet ProtectionType *string `json:"protectionType,omitempty" xmlrpc:"protectionType,omitempty"` // no documentation yet RefererValues *string `json:"refererValues,omitempty" xmlrpc:"refererValues,omitempty"` }
no documentation yet
type Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader ¶ added in v1.0.2
type Network_CdnMarketplace_Configuration_Behavior_ModifyResponseHeader struct {
Entity
}
no documentation yet
type Network_CdnMarketplace_Configuration_Behavior_TokenAuth ¶ added in v1.0.2
type Network_CdnMarketplace_Configuration_Behavior_TokenAuth struct {
Entity
}
no documentation yet
type Network_CdnMarketplace_Configuration_Cache_Purge ¶
type Network_CdnMarketplace_Configuration_Cache_Purge struct {
Entity
}
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.
type Network_CdnMarketplace_Configuration_Cache_PurgeGroup ¶ added in v1.0.1
type Network_CdnMarketplace_Configuration_Cache_PurgeGroup struct {
Entity
}
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.
type Network_CdnMarketplace_Configuration_Cache_PurgeHistory ¶ added in v1.0.1
type Network_CdnMarketplace_Configuration_Cache_PurgeHistory struct {
Entity
}
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".
type Network_CdnMarketplace_Configuration_Cache_TimeToLive ¶
type Network_CdnMarketplace_Configuration_Cache_TimeToLive struct { Entity // date record is created CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // Path where purge will be executed after TTL Path *string `json:"path,omitempty" xmlrpc:"path,omitempty"` // Time interval after which purge will occur repeatedly TimeToLive *int `json:"timeToLive,omitempty" xmlrpc:"timeToLive,omitempty"` }
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.
type Network_CdnMarketplace_Configuration_Mapping ¶
type Network_CdnMarketplace_Configuration_Mapping struct {
Entity
}
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.
type Network_CdnMarketplace_Configuration_Mapping_Path ¶
type Network_CdnMarketplace_Configuration_Mapping_Path struct {
Entity
}
no documentation yet
type Network_CdnMarketplace_Metrics ¶
type Network_CdnMarketplace_Metrics struct {
Entity
}
This Metrics class provides methods to get CDN metrics based on account or mapping unique id.
type Network_CdnMarketplace_Utils_Response ¶
type Network_CdnMarketplace_Utils_Response struct { Entity // no documentation yet Code *int `json:"code,omitempty" xmlrpc:"code,omitempty"` // no documentation yet Message *string `json:"message,omitempty" xmlrpc:"message,omitempty"` }
no documentation yet
type Network_CdnMarketplace_Vendor ¶
type Network_CdnMarketplace_Vendor struct {
Entity
}
The SoftLayer_Network_CdnMarketplace_Vendor contains information regarding a CDN Vendor. This class is associated with SoftLayer_Network_CdnMarketplace_Vendor_Attribute class.
type Network_Component ¶
type Network_Component struct { Entity // Reboot/power (rebootDefault, rebootSoft, rebootHard, powerOn, powerOff and powerCycle) command currently executing by the server's remote management card. ActiveCommand *Hardware_Component_RemoteManagement_Command_Request `json:"activeCommand,omitempty" xmlrpc:"activeCommand,omitempty"` // The network component linking this object to a child device DownlinkComponent *Network_Component `json:"downlinkComponent,omitempty" xmlrpc:"downlinkComponent,omitempty"` // The duplex mode of a network component. DuplexMode *Network_Component_Duplex_Mode `json:"duplexMode,omitempty" xmlrpc:"duplexMode,omitempty"` // A network component's Duplex mode. DuplexModeId *string `json:"duplexModeId,omitempty" xmlrpc:"duplexModeId,omitempty"` // The hardware that a network component resides in. Hardware *Hardware `json:"hardware,omitempty" xmlrpc:"hardware,omitempty"` // The internal identifier of the hardware that a network component belongs to. HardwareId *int `json:"hardwareId,omitempty" xmlrpc:"hardwareId,omitempty"` // no documentation yet HighAvailabilityFirewallFlag *bool `json:"highAvailabilityFirewallFlag,omitempty" xmlrpc:"highAvailabilityFirewallFlag,omitempty"` // A network component's internal identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A count of the records of all IP addresses bound to a network component. IpAddressBindingCount *uint `json:"ipAddressBindingCount,omitempty" xmlrpc:"ipAddressBindingCount,omitempty"` // The records of all IP addresses bound to a network component. IpAddressBindings []Network_Component_IpAddress `json:"ipAddressBindings,omitempty" xmlrpc:"ipAddressBindings,omitempty"` // A count of IpAddressCount *uint `json:"ipAddressCount,omitempty" xmlrpc:"ipAddressCount,omitempty"` // no documentation yet IpAddresses []Network_Subnet_IpAddress `json:"ipAddresses,omitempty" xmlrpc:"ipAddresses,omitempty"` // The IP address of an IPMI-based management network component. IpmiIpAddress *string `json:"ipmiIpAddress,omitempty" xmlrpc:"ipmiIpAddress,omitempty"` // The MAC address of an IPMI-based management network component. IpmiMacAddress *string `json:"ipmiMacAddress,omitempty" xmlrpc:"ipmiMacAddress,omitempty"` // Last reboot/power (rebootDefault, rebootSoft, rebootHard, powerOn, powerOff and powerCycle) command issued to the server's remote management card. LastCommand *Hardware_Component_RemoteManagement_Command_Request `json:"lastCommand,omitempty" xmlrpc:"lastCommand,omitempty"` // A network component's unique MAC address. IPMI-based management network interfaces may not have a MAC address. MacAddress *string `json:"macAddress,omitempty" xmlrpc:"macAddress,omitempty"` // 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. MaxSpeed *int `json:"maxSpeed,omitempty" xmlrpc:"maxSpeed,omitempty"` // The metric tracking object for this network component. MetricTrackingObject *Metric_Tracking_Object `json:"metricTrackingObject,omitempty" xmlrpc:"metricTrackingObject,omitempty"` // The date a network component was last modified. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // 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. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // The upstream network component firewall. NetworkComponentFirewall *Network_Component_Firewall `json:"networkComponentFirewall,omitempty" xmlrpc:"networkComponentFirewall,omitempty"` // A network component's associated group. NetworkComponentGroup *Network_Component_Group `json:"networkComponentGroup,omitempty" xmlrpc:"networkComponentGroup,omitempty"` // All network devices in SoftLayer's network hierarchy that this device is connected to. NetworkHardware []Hardware `json:"networkHardware,omitempty" xmlrpc:"networkHardware,omitempty"` // A count of all network devices in SoftLayer's network hierarchy that this device is connected to. NetworkHardwareCount *uint `json:"networkHardwareCount,omitempty" xmlrpc:"networkHardwareCount,omitempty"` // The VLAN that a network component's subnet is associated with. NetworkVlan *Network_Vlan `json:"networkVlan,omitempty" xmlrpc:"networkVlan,omitempty"` // The unique internal id of the network VLAN that the port belongs to. NetworkVlanId *int `json:"networkVlanId,omitempty" xmlrpc:"networkVlanId,omitempty"` // A count of the VLANs that are trunked to this network component. NetworkVlanTrunkCount *uint `json:"networkVlanTrunkCount,omitempty" xmlrpc:"networkVlanTrunkCount,omitempty"` // The VLANs that are trunked to this network component. NetworkVlanTrunks []Network_Component_Network_Vlan_Trunk `json:"networkVlanTrunks,omitempty" xmlrpc:"networkVlanTrunks,omitempty"` // The viable trunking targets of this component. Viable targets include accessible VLANs in the same pod and network as this component, which are not already natively attached nor trunked to this component. NetworkVlansTrunkable []Network_Vlan `json:"networkVlansTrunkable,omitempty" xmlrpc:"networkVlansTrunkable,omitempty"` // 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. Port *int `json:"port,omitempty" xmlrpc:"port,omitempty"` // A network component's primary IP address. IPMI-based management network interfaces may not have an IP address. PrimaryIpAddress *string `json:"primaryIpAddress,omitempty" xmlrpc:"primaryIpAddress,omitempty"` // The primary IPv4 Address record for a network component. PrimaryIpAddressRecord *Network_Subnet_IpAddress `json:"primaryIpAddressRecord,omitempty" xmlrpc:"primaryIpAddressRecord,omitempty"` // The subnet of the primary IP address assigned to this network component. PrimarySubnet *Network_Subnet `json:"primarySubnet,omitempty" xmlrpc:"primarySubnet,omitempty"` // The primary IPv6 Address record for a network component. PrimaryVersion6IpAddressRecord *Network_Subnet_IpAddress `json:"primaryVersion6IpAddressRecord,omitempty" xmlrpc:"primaryVersion6IpAddressRecord,omitempty"` // A count of the last five reboot/power (rebootDefault, rebootSoft, rebootHard, powerOn, powerOff and powerCycle) commands issued to the server's remote management card. RecentCommandCount *uint `json:"recentCommandCount,omitempty" xmlrpc:"recentCommandCount,omitempty"` // The last five reboot/power (rebootDefault, rebootSoft, rebootHard, powerOn, powerOff and powerCycle) commands issued to the server's remote management card. RecentCommands []Hardware_Component_RemoteManagement_Command_Request `json:"recentCommands,omitempty" xmlrpc:"recentCommands,omitempty"` // Indicates whether the network component is participating in a group of two or more components capable of being operationally redundant, if enabled. RedundancyCapableFlag *bool `json:"redundancyCapableFlag,omitempty" xmlrpc:"redundancyCapableFlag,omitempty"` // Indicates whether the network component is participating in a group of two or more components which is actively providing link redundancy. RedundancyEnabledFlag *bool `json:"redundancyEnabledFlag,omitempty" xmlrpc:"redundancyEnabledFlag,omitempty"` // A count of user(s) credentials to issue commands and/or interact with the server's remote management card. RemoteManagementUserCount *uint `json:"remoteManagementUserCount,omitempty" xmlrpc:"remoteManagementUserCount,omitempty"` // User(s) credentials to issue commands and/or interact with the server's remote management card. RemoteManagementUsers []Hardware_Component_RemoteManagement_User `json:"remoteManagementUsers,omitempty" xmlrpc:"remoteManagementUsers,omitempty"` // A network component's routers. Router *Hardware `json:"router,omitempty" xmlrpc:"router,omitempty"` // A network component's speed, measured in Mbit per second. Speed *int `json:"speed,omitempty" xmlrpc:"speed,omitempty"` // 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. Status *string `json:"status,omitempty" xmlrpc:"status,omitempty"` // Whether a network component's primary ip address is from a storage network subnet or not. [Deprecated] // Deprecated: This function has been marked as deprecated. StorageNetworkFlag *bool `json:"storageNetworkFlag,omitempty" xmlrpc:"storageNetworkFlag,omitempty"` // A count of a network component's subnets. A subnet is a group of IP addresses SubnetCount *uint `json:"subnetCount,omitempty" xmlrpc:"subnetCount,omitempty"` // A network component's subnets. A subnet is a group of IP addresses Subnets []Network_Subnet `json:"subnets,omitempty" xmlrpc:"subnets,omitempty"` // The network component linking this object to parent UplinkComponent *Network_Component `json:"uplinkComponent,omitempty" xmlrpc:"uplinkComponent,omitempty"` // The duplex mode of the uplink network component linking to this object UplinkDuplexMode *Network_Component_Duplex_Mode `json:"uplinkDuplexMode,omitempty" xmlrpc:"uplinkDuplexMode,omitempty"` }
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.
type Network_Component_Duplex_Mode ¶
type Network_Component_Duplex_Mode struct { Entity // no documentation yet Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // no documentation yet Keyname *string `json:"keyname,omitempty" xmlrpc:"keyname,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
Duplex Mode allows finer grained control over networking options and settings.
type Network_Component_Firewall ¶
type Network_Component_Firewall struct { Entity // 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. ApplyServerRuleSubnetCount *uint `json:"applyServerRuleSubnetCount,omitempty" xmlrpc:"applyServerRuleSubnetCount,omitempty"` // The additional subnets linked to this network component firewall, that inherit rules from the host that the context slot is attached to. ApplyServerRuleSubnets []Network_Subnet `json:"applyServerRuleSubnets,omitempty" xmlrpc:"applyServerRuleSubnets,omitempty"` // The billing item for a Hardware Firewall (Dedicated). BillingItem *Billing_Item `json:"billingItem,omitempty" xmlrpc:"billingItem,omitempty"` // The network component of the guest virtual server that this network component firewall belongs to. GuestNetworkComponent *Virtual_Guest_Network_Component `json:"guestNetworkComponent,omitempty" xmlrpc:"guestNetworkComponent,omitempty"` // Unique ID for the network component of the switch interface that this network component firewall is attached to. GuestNetworkComponentId *int `json:"guestNetworkComponentId,omitempty" xmlrpc:"guestNetworkComponentId,omitempty"` // Unique ID for the network component firewall. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The network component of the switch interface that this network component firewall belongs to. NetworkComponent *Network_Component `json:"networkComponent,omitempty" xmlrpc:"networkComponent,omitempty"` // Unique ID for the network component of the switch interface that this network component firewall is attached to. NetworkComponentId *int `json:"networkComponentId,omitempty" xmlrpc:"networkComponentId,omitempty"` // The update requests made for this firewall. NetworkFirewallUpdateRequest []Network_Firewall_Update_Request `json:"networkFirewallUpdateRequest,omitempty" xmlrpc:"networkFirewallUpdateRequest,omitempty"` // A count of the update requests made for this firewall. NetworkFirewallUpdateRequestCount *uint `json:"networkFirewallUpdateRequestCount,omitempty" xmlrpc:"networkFirewallUpdateRequestCount,omitempty"` // A count of the currently running rule set of this network component firewall. RuleCount *uint `json:"ruleCount,omitempty" xmlrpc:"ruleCount,omitempty"` // The currently running rule set of this network component firewall. Rules []Network_Component_Firewall_Rule `json:"rules,omitempty" xmlrpc:"rules,omitempty"` // Current status of the network component firewall. Status "no_edit" means this host is not protected by a hardware firewall. Status "allow_edit" means this host is protected by a hardware firewall and processing firewall rules. Status "bypass" means this host is provisioned behind a hardware firewall, but bypassing the firewall rules. Status *string `json:"status,omitempty" xmlrpc:"status,omitempty"` // A count of the additional subnets linked to this network component firewall. SubnetCount *uint `json:"subnetCount,omitempty" xmlrpc:"subnetCount,omitempty"` // The additional subnets linked to this network component firewall. Subnets []Network_Subnet `json:"subnets,omitempty" xmlrpc:"subnets,omitempty"` }
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.
type Network_Component_Firewall_Rule ¶
type Network_Component_Firewall_Rule struct { Entity // The action that the rule is to take [permit or deny]. Action *string `json:"action,omitempty" xmlrpc:"action,omitempty"` // The destination IP address considered for determining rule application. DestinationIpAddress *string `json:"destinationIpAddress,omitempty" xmlrpc:"destinationIpAddress,omitempty"` // The CIDR is used for determining rule application. This value will DestinationIpCidr *int `json:"destinationIpCidr,omitempty" xmlrpc:"destinationIpCidr,omitempty"` // The destination IP subnet mask considered for determining rule application. DestinationIpSubnetMask *string `json:"destinationIpSubnetMask,omitempty" xmlrpc:"destinationIpSubnetMask,omitempty"` // The ending (upper end of range) destination port considered for determining rule application. DestinationPortRangeEnd *int `json:"destinationPortRangeEnd,omitempty" xmlrpc:"destinationPortRangeEnd,omitempty"` // The starting (lower end of range) destination port considered for determining rule application. DestinationPortRangeStart *int `json:"destinationPortRangeStart,omitempty" xmlrpc:"destinationPortRangeStart,omitempty"` // The rule's internal identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The network component firewall that this rule belongs to. NetworkComponentFirewall *Network_Component_Firewall `json:"networkComponentFirewall,omitempty" xmlrpc:"networkComponentFirewall,omitempty"` // The notes field for the rule. Notes *string `json:"notes,omitempty" xmlrpc:"notes,omitempty"` // The numeric value describing the order in which the rule should be applied. OrderValue *int `json:"orderValue,omitempty" xmlrpc:"orderValue,omitempty"` // The protocol considered for determining rule application. Protocol *string `json:"protocol,omitempty" xmlrpc:"protocol,omitempty"` // The source IP address considered for determining rule application. SourceIpAddress *string `json:"sourceIpAddress,omitempty" xmlrpc:"sourceIpAddress,omitempty"` // The CIDR is used for determining rule application. This value will SourceIpCidr *int `json:"sourceIpCidr,omitempty" xmlrpc:"sourceIpCidr,omitempty"` // The source IP subnet mask considered for determining rule application. SourceIpSubnetMask *string `json:"sourceIpSubnetMask,omitempty" xmlrpc:"sourceIpSubnetMask,omitempty"` // Current status of the network component firewall. Status *string `json:"status,omitempty" xmlrpc:"status,omitempty"` // Whether this rule is an IPv4 rule or an IPv6 rule. If Version *int `json:"version,omitempty" xmlrpc:"version,omitempty"` }
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.
type Network_Component_Firewall_Subnets ¶
type Network_Component_Firewall_Subnets struct { Entity // A boolean flag that indicates whether the subnet should receive all the rules intended for the host on this context slot. ApplyServerRulesFlag *bool `json:"applyServerRulesFlag,omitempty" xmlrpc:"applyServerRulesFlag,omitempty"` // The network component firewall that write rules for this subnet. NetworkComponentFirewall *Network_Component_Firewall `json:"networkComponentFirewall,omitempty" xmlrpc:"networkComponentFirewall,omitempty"` // The subnet that this link binds to the network component firewall. Subnet *Network_Subnet `json:"subnet,omitempty" xmlrpc:"subnet,omitempty"` // The unique identifier of the subnet being linked to the network component firewall. SubnetId *int `json:"subnetId,omitempty" xmlrpc:"subnetId,omitempty"` }
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.
type Network_Component_Group ¶
type Network_Component_Group struct { Entity // no documentation yet GroupTypeId *int `json:"groupTypeId,omitempty" xmlrpc:"groupTypeId,omitempty"` // A succinct label describing the members of this grouping. MembersDescription *string `json:"membersDescription,omitempty" xmlrpc:"membersDescription,omitempty"` // A count of a network component group's associated network components. NetworkComponentCount *uint `json:"networkComponentCount,omitempty" xmlrpc:"networkComponentCount,omitempty"` // A network component group's associated network components. NetworkComponents []Network_Component `json:"networkComponents,omitempty" xmlrpc:"networkComponents,omitempty"` }
no documentation yet
type Network_Component_IpAddress ¶
type Network_Component_IpAddress struct { Entity // The IP address associated with this object's network component. IpAddress *Network_Subnet_IpAddress `json:"ipAddress,omitempty" xmlrpc:"ipAddress,omitempty"` // The network component associated with this object's IP address. NetworkComponent *Network_Component `json:"networkComponent,omitempty" xmlrpc:"networkComponent,omitempty"` }
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.
type Network_Component_Network_Vlan_Trunk ¶
type Network_Component_Network_Vlan_Trunk struct { Entity // A value of '1' indicates the existence of an ongoing request to modify this trunk record. IsUpdating *bool `json:"isUpdating,omitempty" xmlrpc:"isUpdating,omitempty"` // The network component that the VLAN is being trunked to. NetworkComponent *Network_Component `json:"networkComponent,omitempty" xmlrpc:"networkComponent,omitempty"` // The network component's identifier. NetworkComponentId *int `json:"networkComponentId,omitempty" xmlrpc:"networkComponentId,omitempty"` // The VLAN that is being trunked to the network component. NetworkVlan *Network_Vlan `json:"networkVlan,omitempty" xmlrpc:"networkVlan,omitempty"` // The identifier of the network VLAN that is a trunk on the network component. NetworkVlanId *int `json:"networkVlanId,omitempty" xmlrpc:"networkVlanId,omitempty"` }
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.
type Network_Component_RemoteManagement ¶
type Network_Component_RemoteManagement struct {
Network_Component
}
The SoftLayer_Network_Component_RemoteManagement data type contains general information relating to a single SoftLayer remote management network component.
type Network_Component_Uplink_Hardware ¶
type Network_Component_Uplink_Hardware struct { Entity // A network component uplink's connected [[SoftLayer_Hardware|Hardware]]. Hardware *Hardware `json:"hardware,omitempty" xmlrpc:"hardware,omitempty"` // The [[SoftLayer_Network_Component|Network Component]] that a uplink connection belongs to.. NetworkComponent *Network_Component `json:"networkComponent,omitempty" xmlrpc:"networkComponent,omitempty"` }
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.
type Network_Customer_Subnet ¶
type Network_Customer_Subnet struct { Entity // The account id a customer subnet belongs to. AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // 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. Cidr *int `json:"cidr,omitempty" xmlrpc:"cidr,omitempty"` // A customer subnet's unique identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A count of all ip addresses associated with a subnet. IpAddressCount *uint `json:"ipAddressCount,omitempty" xmlrpc:"ipAddressCount,omitempty"` // All ip addresses associated with a subnet. IpAddresses []Network_Customer_Subnet_IpAddress `json:"ipAddresses,omitempty" xmlrpc:"ipAddresses,omitempty"` // 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. Netmask *string `json:"netmask,omitempty" xmlrpc:"netmask,omitempty"` // A subnet's network identifier. This is the first IP address of a subnet. NetworkIdentifier *string `json:"networkIdentifier,omitempty" xmlrpc:"networkIdentifier,omitempty"` // The total number of ip addresses in a subnet. TotalIpAddresses *int `json:"totalIpAddresses,omitempty" xmlrpc:"totalIpAddresses,omitempty"` }
The SoftLayer_Network_Customer_Subnet data type contains general information relating to a single customer subnet (remote).
type Network_Customer_Subnet_IpAddress ¶
type Network_Customer_Subnet_IpAddress struct { Entity // Unique identifier for an ip address. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // An IP address expressed in dotted quad format. IpAddress *string `json:"ipAddress,omitempty" xmlrpc:"ipAddress,omitempty"` // An IP address' user defined note. Notes *string `json:"notes,omitempty" xmlrpc:"notes,omitempty"` // The customer subnet (remote) that the ip address belongs to. Subnet *Network_Customer_Subnet `json:"subnet,omitempty" xmlrpc:"subnet,omitempty"` // The unique identifier for the customer subnet (remote) the ip address belongs to. SubnetId *int `json:"subnetId,omitempty" xmlrpc:"subnetId,omitempty"` // A count of all the address translations that are tied to an IP address. TranslationCount *uint `json:"translationCount,omitempty" xmlrpc:"translationCount,omitempty"` // All the address translations that are tied to an IP address. Translations []Network_Tunnel_Module_Context_Address_Translation `json:"translations,omitempty" xmlrpc:"translations,omitempty"` }
The SoftLayer_Network_Customer_Subnet_IpAddress data type contains general information relating to a single Customer Subnet (Remote) IPv4 address.
type Network_DirectLink_Location ¶
type Network_DirectLink_Location struct { Entity // The Direct Link specific location owner for POP/DC facilities. Like Equinix, Pacnet, Verizon etc. BuildingColocationOwner *string `json:"buildingColocationOwner,omitempty" xmlrpc:"buildingColocationOwner,omitempty"` // The unique identifier of a Direct Link location. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Specifies if The Direct Link specific location has Redundancy:secondary XCR availability. IsRedundantXcr *bool `json:"isRedundantXcr,omitempty" xmlrpc:"isRedundantXcr,omitempty"` // The location of Direct Link facility. Location *Location `json:"location,omitempty" xmlrpc:"location,omitempty"` // The Direct Link specific location ie. Data Center & Network POP facility. Refer to location object Like Dallas in US, London in England etc. LocationId *int `json:"locationId,omitempty" xmlrpc:"locationId,omitempty"` // The Direct Link Market location used in Direct Link Order. Like Europe, North America, Asia pacific etc. MarketGeography *string `json:"marketGeography,omitempty" xmlrpc:"marketGeography,omitempty"` // The Id of Direct Link provider. Provider *Network_DirectLink_Provider `json:"provider,omitempty" xmlrpc:"provider,omitempty"` // The Id of Direct Link service type. ServiceType *Network_DirectLink_ServiceType `json:"serviceType,omitempty" xmlrpc:"serviceType,omitempty"` }
The SoftLayer_Network_DirectLink_Location presents a structure containing attributes of a Direct Link location, and its related object SoftLayer location.
type Network_DirectLink_Provider ¶
type Network_DirectLink_Provider struct { Entity // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
The SoftLayer_Network_DirectLink_Provider presents a structure containing attributes of a Direct Link provider.
type Network_DirectLink_ServiceType ¶
type Network_DirectLink_ServiceType struct { Entity // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet Type *string `json:"type,omitempty" xmlrpc:"type,omitempty"` }
The SoftLayer_Network_DirectLink_ServiceType presents a structure containing attributes of a Direct Link Service Type.
type Network_Firewall_AccessControlList ¶
type Network_Firewall_AccessControlList struct { Entity // no documentation yet Direction *string `json:"direction,omitempty" xmlrpc:"direction,omitempty"` // no documentation yet FirewallContextInterfaceId *int `json:"firewallContextInterfaceId,omitempty" xmlrpc:"firewallContextInterfaceId,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A count of the update requests made for this firewall. NetworkFirewallUpdateRequestCount *uint `json:"networkFirewallUpdateRequestCount,omitempty" xmlrpc:"networkFirewallUpdateRequestCount,omitempty"` // The update requests made for this firewall. NetworkFirewallUpdateRequests []Network_Firewall_Update_Request `json:"networkFirewallUpdateRequests,omitempty" xmlrpc:"networkFirewallUpdateRequests,omitempty"` // no documentation yet NetworkVlan *Network_Vlan `json:"networkVlan,omitempty" xmlrpc:"networkVlan,omitempty"` // A count of the currently running rule set of this context access control list firewall. RuleCount *uint `json:"ruleCount,omitempty" xmlrpc:"ruleCount,omitempty"` // The currently running rule set of this context access control list firewall. Rules []Network_Vlan_Firewall_Rule `json:"rules,omitempty" xmlrpc:"rules,omitempty"` }
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.
type Network_Firewall_Interface ¶
type Network_Firewall_Interface struct {
Network_Firewall_Module_Context_Interface
}
The SoftLayer_Network_Firewall_Interface data type contains general information relating to a single SoftLayer firewall interface. This is the object which ties the firewall context access control list to a firewall. Use the [[SoftLayer Network Firewall Template]] service to pull SoftLayer recommended rule set templates. Use the [[SoftLayer Network Firewall Update Request]] service to submit a firewall update request.
type Network_Firewall_Module_Context_Interface ¶
type Network_Firewall_Module_Context_Interface struct { Entity // A count of FirewallContextAccessControlListCount *uint `json:"firewallContextAccessControlListCount,omitempty" xmlrpc:"firewallContextAccessControlListCount,omitempty"` // no documentation yet FirewallContextAccessControlLists []Network_Firewall_AccessControlList `json:"firewallContextAccessControlLists,omitempty" xmlrpc:"firewallContextAccessControlLists,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // no documentation yet NetworkVlan *Network_Vlan `json:"networkVlan,omitempty" xmlrpc:"networkVlan,omitempty"` }
no documentation yet
type Network_Firewall_Template ¶
type Network_Firewall_Template struct { Entity // A Firewall template's internal identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The name of the firewall rules template. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // A count of the rule set that belongs to this firewall rules template. RuleCount *uint `json:"ruleCount,omitempty" xmlrpc:"ruleCount,omitempty"` // The rule set that belongs to this firewall rules template. Rules []Network_Firewall_Template_Rule `json:"rules,omitempty" xmlrpc:"rules,omitempty"` }
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.
type Network_Firewall_Template_Rule ¶
type Network_Firewall_Template_Rule struct { Entity // The action that this template rule is to take [permit or deny]. Action *string `json:"action,omitempty" xmlrpc:"action,omitempty"` // The destination IP address considered for determining rule application. DestinationIpAddress *string `json:"destinationIpAddress,omitempty" xmlrpc:"destinationIpAddress,omitempty"` // The destination IP subnet mask considered for determining rule application. DestinationIpSubnetMask *string `json:"destinationIpSubnetMask,omitempty" xmlrpc:"destinationIpSubnetMask,omitempty"` // The ending (upper end of range) destination port considered for determining rule application. DestinationPortRangeEnd *int `json:"destinationPortRangeEnd,omitempty" xmlrpc:"destinationPortRangeEnd,omitempty"` // The starting (lower end of range) destination port considered for determining rule application. DestinationPortRangeStart *int `json:"destinationPortRangeStart,omitempty" xmlrpc:"destinationPortRangeStart,omitempty"` // The firewall template that this rule is attached to. FirewallTemplate *Network_Firewall_Template `json:"firewallTemplate,omitempty" xmlrpc:"firewallTemplate,omitempty"` // The unique identifier of the firewall template that a firewall template rule is associated with. FirewallTemplateId *int `json:"firewallTemplateId,omitempty" xmlrpc:"firewallTemplateId,omitempty"` // A Firewall template rule's internal identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The notes field for the firewall template rule. Notes *string `json:"notes,omitempty" xmlrpc:"notes,omitempty"` // The numeric value describing the order in which the rule set should be applied. OrderValue *int `json:"orderValue,omitempty" xmlrpc:"orderValue,omitempty"` // The protocol considered for determining rule application. Protocol *string `json:"protocol,omitempty" xmlrpc:"protocol,omitempty"` // The source IP address considered for determining rule application. SourceIpAddress *string `json:"sourceIpAddress,omitempty" xmlrpc:"sourceIpAddress,omitempty"` // The source IP subnet mask considered for determining rule application. SourceIpSubnetMask *string `json:"sourceIpSubnetMask,omitempty" xmlrpc:"sourceIpSubnetMask,omitempty"` }
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.
type Network_Firewall_Update_Request ¶
type Network_Firewall_Update_Request struct { Entity // Timestamp of when the rules from the update request were applied to the firewall. ApplyDate *Time `json:"applyDate,omitempty" xmlrpc:"applyDate,omitempty"` // The user that authorized this firewall update request. AuthorizingUser *User_Interface `json:"authorizingUser,omitempty" xmlrpc:"authorizingUser,omitempty"` // The unique identifier of the user that authorized the update request. AuthorizingUserId *int `json:"authorizingUserId,omitempty" xmlrpc:"authorizingUserId,omitempty"` // The type of user that authorized the update request [EMP or USR]. AuthorizingUserType *string `json:"authorizingUserType,omitempty" xmlrpc:"authorizingUserType,omitempty"` // Flag indicating whether the request is for a rule bypass configuration [0 or 1]. BypassFlag *bool `json:"bypassFlag,omitempty" xmlrpc:"bypassFlag,omitempty"` // Timestamp of the creation of the record. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // The unique identifier of the firewall access control list that the rule set is destined for. FirewallContextAccessControlListId *int `json:"firewallContextAccessControlListId,omitempty" xmlrpc:"firewallContextAccessControlListId,omitempty"` // The downstream virtual server that the rule set will be applied to. Guest *Virtual_Guest `json:"guest,omitempty" xmlrpc:"guest,omitempty"` // The downstream server that the rule set will be applied to. Hardware *Hardware `json:"hardware,omitempty" xmlrpc:"hardware,omitempty"` // The unique identifier of the server that the rule set is destined to protect. HardwareId *int `json:"hardwareId,omitempty" xmlrpc:"hardwareId,omitempty"` // The unique identifier of the firewall update request. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The network component firewall that the rule set will be applied to. NetworkComponentFirewall *Network_Component_Firewall `json:"networkComponentFirewall,omitempty" xmlrpc:"networkComponentFirewall,omitempty"` // The unique identifier of the network component firewall that the rule set is destined for. NetworkComponentFirewallId *int `json:"networkComponentFirewallId,omitempty" xmlrpc:"networkComponentFirewallId,omitempty"` // A count of the group of rules contained within the update request. RuleCount *uint `json:"ruleCount,omitempty" xmlrpc:"ruleCount,omitempty"` // The group of rules contained within the update request. Rules []Network_Firewall_Update_Request_Rule `json:"rules,omitempty" xmlrpc:"rules,omitempty"` }
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.
type Network_Firewall_Update_Request_Customer ¶
type Network_Firewall_Update_Request_Customer struct {
Network_Firewall_Update_Request
}
A SoftLayer_Ticket_Update_Customer is a single update made by a customer to a ticket.
type Network_Firewall_Update_Request_Employee ¶
type Network_Firewall_Update_Request_Employee struct {
Network_Firewall_Update_Request
}
The SoftLayer_Network_Firewall_Update_Request_Employee data type returns a user object for the SoftLayer employee that created the request.
type Network_Firewall_Update_Request_Rule ¶
type Network_Firewall_Update_Request_Rule struct { Entity // The action that this update request rule is to take [permit or deny]. Action *string `json:"action,omitempty" xmlrpc:"action,omitempty"` // The bypassRuleValidation is used for bypassing the rule validation BypassRuleValidation *bool `json:"bypassRuleValidation,omitempty" xmlrpc:"bypassRuleValidation,omitempty"` // The destination IP address considered for determining rule application. DestinationIpAddress *string `json:"destinationIpAddress,omitempty" xmlrpc:"destinationIpAddress,omitempty"` // The CIDR is used for determining rule application. This value will DestinationIpCidr *int `json:"destinationIpCidr,omitempty" xmlrpc:"destinationIpCidr,omitempty"` // The destination IP subnet mask considered for determining rule application. DestinationIpSubnetMask *string `json:"destinationIpSubnetMask,omitempty" xmlrpc:"destinationIpSubnetMask,omitempty"` // The ending (upper end of range) destination port considered for determining rule application. DestinationPortRangeEnd *int `json:"destinationPortRangeEnd,omitempty" xmlrpc:"destinationPortRangeEnd,omitempty"` // The starting (lower end of range) destination port considered for determining rule application. DestinationPortRangeStart *int `json:"destinationPortRangeStart,omitempty" xmlrpc:"destinationPortRangeStart,omitempty"` // The update request that this rule belongs to. FirewallUpdateRequest *Network_Firewall_Update_Request `json:"firewallUpdateRequest,omitempty" xmlrpc:"firewallUpdateRequest,omitempty"` // The unique identifier of the firewall update request that a firewall update request rule is associated with. FirewallUpdateRequestId *int `json:"firewallUpdateRequestId,omitempty" xmlrpc:"firewallUpdateRequestId,omitempty"` // A Firewall update request rule's internal identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The notes field for the firewall update request rule. Notes *string `json:"notes,omitempty" xmlrpc:"notes,omitempty"` // The numeric value describing the order in which the rule should be applied. OrderValue *int `json:"orderValue,omitempty" xmlrpc:"orderValue,omitempty"` // The protocol considered for determining rule application. Protocol *string `json:"protocol,omitempty" xmlrpc:"protocol,omitempty"` // The source IP address considered for determining rule application. SourceIpAddress *string `json:"sourceIpAddress,omitempty" xmlrpc:"sourceIpAddress,omitempty"` // The CIDR is used for determining rule application. This value will SourceIpCidr *int `json:"sourceIpCidr,omitempty" xmlrpc:"sourceIpCidr,omitempty"` // The source IP subnet mask considered for determining rule application. SourceIpSubnetMask *string `json:"sourceIpSubnetMask,omitempty" xmlrpc:"sourceIpSubnetMask,omitempty"` // Whether this rule is an IPv4 rule or an IPv6 rule. If Version *int `json:"version,omitempty" xmlrpc:"version,omitempty"` }
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.
type Network_Firewall_Update_Request_Rule_Version6 ¶
type Network_Firewall_Update_Request_Rule_Version6 struct {
Network_Firewall_Update_Request_Rule
}
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.
type Network_Gateway ¶
type Network_Gateway struct { Entity // The account for this gateway. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // The internal identifier of the account assigned to this gateway. AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // The VRRP group number for this gateway. This is set internally and cannot be provided on create. GroupNumber *int `json:"groupNumber,omitempty" xmlrpc:"groupNumber,omitempty"` // A gateway's internal identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A count of all VLANs trunked to this gateway. InsideVlanCount *uint `json:"insideVlanCount,omitempty" xmlrpc:"insideVlanCount,omitempty"` // All VLANs trunked to this gateway. InsideVlans []Network_Gateway_Vlan `json:"insideVlans,omitempty" xmlrpc:"insideVlans,omitempty"` // A count of the members for this gateway. MemberCount *uint `json:"memberCount,omitempty" xmlrpc:"memberCount,omitempty"` // The members for this gateway. Members []Network_Gateway_Member `json:"members,omitempty" xmlrpc:"members,omitempty"` // A gateway's name. This is required on create and can be no more than 255 characters. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // The firewall associated with this gateway, if any. NetworkFirewall *Network_Vlan_Firewall `json:"networkFirewall,omitempty" xmlrpc:"networkFirewall,omitempty"` // Whether or not there is a firewall associated with this gateway. NetworkFirewallFlag *bool `json:"networkFirewallFlag,omitempty" xmlrpc:"networkFirewallFlag,omitempty"` // 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. NetworkSpace *string `json:"networkSpace,omitempty" xmlrpc:"networkSpace,omitempty"` // A manufacturer of the gateway os. This could be different from the manufacturer of the bare metal server os if the gateway is a VM. OsManufacturer *string `json:"osManufacturer,omitempty" xmlrpc:"osManufacturer,omitempty"` // The private gateway IP address. PrivateIpAddress *Network_Subnet_IpAddress `json:"privateIpAddress,omitempty" xmlrpc:"privateIpAddress,omitempty"` // The internal identifier of the private IP address for this gateway. PrivateIpAddressId *int `json:"privateIpAddressId,omitempty" xmlrpc:"privateIpAddressId,omitempty"` // The private VLAN for accessing this gateway. PrivateVlan *Network_Vlan `json:"privateVlan,omitempty" xmlrpc:"privateVlan,omitempty"` // The internal identifier of the private VLAN for this gateway. PrivateVlanId *int `json:"privateVlanId,omitempty" xmlrpc:"privateVlanId,omitempty"` // The public gateway IP address. PublicIpAddress *Network_Subnet_IpAddress `json:"publicIpAddress,omitempty" xmlrpc:"publicIpAddress,omitempty"` // The internal identifier of the public IP address for this gateway. PublicIpAddressId *int `json:"publicIpAddressId,omitempty" xmlrpc:"publicIpAddressId,omitempty"` // The public gateway IPv6 address. PublicIpv6Address *Network_Subnet_IpAddress `json:"publicIpv6Address,omitempty" xmlrpc:"publicIpv6Address,omitempty"` // The internal identifier of the public IPv6 address for this gateway. PublicIpv6AddressId *int `json:"publicIpv6AddressId,omitempty" xmlrpc:"publicIpv6AddressId,omitempty"` // The public VLAN for accessing this gateway. PublicVlan *Network_Vlan `json:"publicVlan,omitempty" xmlrpc:"publicVlan,omitempty"` // The internal identifier of the public VLAN for this gateway. This is set internally and cannot be provided on create. PublicVlanId *int `json:"publicVlanId,omitempty" xmlrpc:"publicVlanId,omitempty"` // The current status of the gateway. Status *Network_Gateway_Status `json:"status,omitempty" xmlrpc:"status,omitempty"` // 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. StatusId *int `json:"statusId,omitempty" xmlrpc:"statusId,omitempty"` }
no documentation yet
type Network_Gateway_Licenses ¶ added in v1.1.2
type Network_Gateway_Licenses struct { Entity // no documentation yet Employee *User_Employee `json:"employee,omitempty" xmlrpc:"employee,omitempty"` // no documentation yet ItemKeyName *string `json:"itemKeyName,omitempty" xmlrpc:"itemKeyName,omitempty"` // no documentation yet LicenseCategory *string `json:"licenseCategory,omitempty" xmlrpc:"licenseCategory,omitempty"` }
no documentation yet
type Network_Gateway_Member ¶
type Network_Gateway_Member struct { Entity // The attributes for this member. Attributes *Network_Gateway_Member_Attribute `json:"attributes,omitempty" xmlrpc:"attributes,omitempty"` // The gateway software description for the member. GatewaySoftwareDescription *Software_Description `json:"gatewaySoftwareDescription,omitempty" xmlrpc:"gatewaySoftwareDescription,omitempty"` // no documentation yet GatewaySoftwareId *int `json:"gatewaySoftwareId,omitempty" xmlrpc:"gatewaySoftwareId,omitempty"` // The device for this member. Hardware *Hardware `json:"hardware,omitempty" xmlrpc:"hardware,omitempty"` // The internal identifier of the hardware for this member. HardwareId *int `json:"hardwareId,omitempty" xmlrpc:"hardwareId,omitempty"` // A gateway member's internal identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A count of the gateway licenses for this member. LicenseCount *uint `json:"licenseCount,omitempty" xmlrpc:"licenseCount,omitempty"` // The gateway licenses for this member. Licenses []Network_Gateway_Member_Licenses `json:"licenses,omitempty" xmlrpc:"licenses,omitempty"` // The gateway this member belongs to. NetworkGateway *Network_Gateway `json:"networkGateway,omitempty" xmlrpc:"networkGateway,omitempty"` // The internal identifier of the gateway this member belongs to. NetworkGatewayId *int `json:"networkGatewayId,omitempty" xmlrpc:"networkGatewayId,omitempty"` // A count of the gateway passwords for this member. PasswordCount *uint `json:"passwordCount,omitempty" xmlrpc:"passwordCount,omitempty"` // The gateway passwords for this member. Passwords []Network_Gateway_Member_Passwords `json:"passwords,omitempty" xmlrpc:"passwords,omitempty"` // The priority for this gateway member. This is set internally and cannot be provided on create. Priority *int `json:"priority,omitempty" xmlrpc:"priority,omitempty"` // The public gateway IP address. PublicIpAddress *Network_Subnet_IpAddress `json:"publicIpAddress,omitempty" xmlrpc:"publicIpAddress,omitempty"` }
no documentation yet
type Network_Gateway_Member_Attribute ¶
type Network_Gateway_Member_Attribute struct { Entity // The gateway member has these attributes. GatewayMember *Network_Gateway_Member `json:"gatewayMember,omitempty" xmlrpc:"gatewayMember,omitempty"` // A gateway member's internal identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Indicates if the member has been upgraded. IsUpgraded *int `json:"isUpgraded,omitempty" xmlrpc:"isUpgraded,omitempty"` // The previous version of the gateway software LastVersion *string `json:"lastVersion,omitempty" xmlrpc:"lastVersion,omitempty"` // Timestamp for the expiration date of the license key LicenseExpirationDate *Time `json:"licenseExpirationDate,omitempty" xmlrpc:"licenseExpirationDate,omitempty"` // no documentation yet LicenseKey *string `json:"licenseKey,omitempty" xmlrpc:"licenseKey,omitempty"` // The gateway member for this attribute. MemberId *int `json:"memberId,omitempty" xmlrpc:"memberId,omitempty"` // Network model of the gateway. NetworkModel *string `json:"networkModel,omitempty" xmlrpc:"networkModel,omitempty"` // Password of the user name. Password *string `json:"password,omitempty" xmlrpc:"password,omitempty"` // Timestamp when this gateway member was last upgraded UpgradedDate *Time `json:"upgradedDate,omitempty" xmlrpc:"upgradedDate,omitempty"` // Username associated with the gateway. Username *string `json:"username,omitempty" xmlrpc:"username,omitempty"` // The version of the gateway software Version *string `json:"version,omitempty" xmlrpc:"version,omitempty"` // Precheck Warning code for Version / License Unsupported for member. WarningCode *int `json:"warningCode,omitempty" xmlrpc:"warningCode,omitempty"` }
no documentation yet
type Network_Gateway_Member_Licenses ¶ added in v1.0.6
type Network_Gateway_Member_Licenses struct { Entity // no documentation yet ExpirationDate *Time `json:"expirationDate,omitempty" xmlrpc:"expirationDate,omitempty"` // The gateway license record. GatewayLicense *Network_Gateway_Licenses `json:"gatewayLicense,omitempty" xmlrpc:"gatewayLicense,omitempty"` // The gateway member has these licenses. GatewayMember *Network_Gateway_Member `json:"gatewayMember,omitempty" xmlrpc:"gatewayMember,omitempty"` // no documentation yet LicenseKey *string `json:"licenseKey,omitempty" xmlrpc:"licenseKey,omitempty"` }
no documentation yet
type Network_Gateway_Member_Passwords ¶ added in v1.0.5
type Network_Gateway_Member_Passwords struct { Entity // The gateway member has these password. GatewayMember *Network_Gateway_Member `json:"gatewayMember,omitempty" xmlrpc:"gatewayMember,omitempty"` // A gateway member passlw internal identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The gateway member if for this record. MemberId *int `json:"memberId,omitempty" xmlrpc:"memberId,omitempty"` // Password of the user name. Password *string `json:"password,omitempty" xmlrpc:"password,omitempty"` // Username associated with the gateway. Username *string `json:"username,omitempty" xmlrpc:"username,omitempty"` }
no documentation yet
type Network_Gateway_Precheck ¶ added in v1.0.1
type Network_Gateway_Precheck struct { Entity // Category name Category *string `json:"category,omitempty" xmlrpc:"category,omitempty"` // Gateway precheck status GatewayReadinessValue *string `json:"gatewayReadinessValue,omitempty" xmlrpc:"gatewayReadinessValue,omitempty"` // The gateway member for this precheck. MemberId *int `json:"memberId,omitempty" xmlrpc:"memberId,omitempty"` // Gateway precheck status MemberReadinessValue *string `json:"memberReadinessValue,omitempty" xmlrpc:"memberReadinessValue,omitempty"` // The precheck error status of the member ReturnCode *int `json:"returnCode,omitempty" xmlrpc:"returnCode,omitempty"` }
no documentation yet
type Network_Gateway_Status ¶
type Network_Gateway_Status struct { Entity // A gateway status's description. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // A gateway status's internal identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A gateway status's programmatic name. KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // A gateway status's human-friendly name. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
no documentation yet
type Network_Gateway_VersionUpgrade ¶
type Network_Gateway_VersionUpgrade struct { Entity // Gateway version being upgraded from. FromVersion *string `json:"fromVersion,omitempty" xmlrpc:"fromVersion,omitempty"` // A gateway status's internal identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Is OS Reload required after version upgrade?. OsReloadRequired *int `json:"osReloadRequired,omitempty" xmlrpc:"osReloadRequired,omitempty"` // Gateway version available for upgrade. ToVersion *string `json:"toVersion,omitempty" xmlrpc:"toVersion,omitempty"` }
no documentation yet
type Network_Gateway_Vlan ¶
type Network_Gateway_Vlan struct { Entity // If true, this VLAN is bypassed. If false, it is routed through the gateway. BypassFlag *bool `json:"bypassFlag,omitempty" xmlrpc:"bypassFlag,omitempty"` // A gateway VLAN's internal identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The gateway this VLAN is attached to. NetworkGateway *Network_Gateway `json:"networkGateway,omitempty" xmlrpc:"networkGateway,omitempty"` // The internal identifier of the gateway this VLAN is attached to. NetworkGatewayId *int `json:"networkGatewayId,omitempty" xmlrpc:"networkGatewayId,omitempty"` // The network VLAN record. NetworkVlan *Network_Vlan `json:"networkVlan,omitempty" xmlrpc:"networkVlan,omitempty"` // The internal identifier of the network VLAN. NetworkVlanId *int `json:"networkVlanId,omitempty" xmlrpc:"networkVlanId,omitempty"` }
no documentation yet
type Network_Interconnect_Tenant ¶
type Network_Interconnect_Tenant struct { Entity // no documentation yet AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // Specifies ASN used for BGP. BgpAsn *int `json:"bgpAsn,omitempty" xmlrpc:"bgpAsn,omitempty"` // The active billing item for a network interconnect. BillingItem *Billing_Item_Network_Interconnect `json:"billingItem,omitempty" xmlrpc:"billingItem,omitempty"` // no documentation yet CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // no documentation yet DatacenterName *string `json:"datacenterName,omitempty" xmlrpc:"datacenterName,omitempty"` // no documentation yet ErrorMessage *string `json:"errorMessage,omitempty" xmlrpc:"errorMessage,omitempty"` // The Direct Link connectivity to all SoftLayer data centers if globalRoutingFlag = 1 and local connectivity if globalRoutingFlag = 0. GlobalRoutingFlag *bool `json:"globalRoutingFlag,omitempty" xmlrpc:"globalRoutingFlag,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet InterconnectType *string `json:"interconnectType,omitempty" xmlrpc:"interconnectType,omitempty"` // Link speed of a Direct Link connection. LinkSpeed *int `json:"linkSpeed,omitempty" xmlrpc:"linkSpeed,omitempty"` // IP address (v4 or v6) of "near" router serial interface. No check/update of IP Address table. LocalIpAddress *string `json:"localIpAddress,omitempty" xmlrpc:"localIpAddress,omitempty"` // no documentation yet Location *string `json:"location,omitempty" xmlrpc:"location,omitempty"` // no documentation yet ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // Specifies the Interconnect connection name. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // 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. NewGlobalRoutingFlag *bool `json:"newGlobalRoutingFlag,omitempty" xmlrpc:"newGlobalRoutingFlag,omitempty"` // Updated Link speed of a Direct Link connection. NewLinkSpeed *int `json:"newLinkSpeed,omitempty" xmlrpc:"newLinkSpeed,omitempty"` // This field will have the ticket id if the tenant workflow fails Note *string `json:"note,omitempty" xmlrpc:"note,omitempty"` // Link speed of a Direct Link connection on Equinix Side. PeerLinkSpeed *int `json:"peerLinkSpeed,omitempty" xmlrpc:"peerLinkSpeed,omitempty"` // no documentation yet Port *string `json:"port,omitempty" xmlrpc:"port,omitempty"` // no documentation yet PortLabel *string `json:"portLabel,omitempty" xmlrpc:"portLabel,omitempty"` // no documentation yet Provider *string `json:"provider,omitempty" xmlrpc:"provider,omitempty"` // no documentation yet ProviderAccountId *int `json:"providerAccountId,omitempty" xmlrpc:"providerAccountId,omitempty"` // Specifies redundant connection is available if 1. RedundancyFlag *bool `json:"redundancyFlag,omitempty" xmlrpc:"redundancyFlag,omitempty"` // no documentation yet RemoteIpAddress *string `json:"remoteIpAddress,omitempty" xmlrpc:"remoteIpAddress,omitempty"` // Service key for Interconnect connection. ServiceKey *string `json:"serviceKey,omitempty" xmlrpc:"serviceKey,omitempty"` // no documentation yet ServiceType *Network_DirectLink_ServiceType `json:"serviceType,omitempty" xmlrpc:"serviceType,omitempty"` // no documentation yet ServiceTypeId *int `json:"serviceTypeId,omitempty" xmlrpc:"serviceTypeId,omitempty"` // The direct link connection status. IN_PROGRESS, PROVISIONING, CONNECTION_UP, CONNECTION_DOWN Status *string `json:"status,omitempty" xmlrpc:"status,omitempty"` // no documentation yet VendorName *string `json:"vendorName,omitempty" xmlrpc:"vendorName,omitempty"` // no documentation yet VlanId *int `json:"vlanId,omitempty" xmlrpc:"vlanId,omitempty"` // no documentation yet ZoneName *string `json:"zoneName,omitempty" xmlrpc:"zoneName,omitempty"` }
no documentation yet
type Network_LBaaS_HealthMonitor ¶
type Network_LBaaS_HealthMonitor struct { Entity // Create date of the health monitor instance CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // Health monitor's identifier Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Interval in seconds to perform health check Interval *int `json:"interval,omitempty" xmlrpc:"interval,omitempty"` // Maximum number of health check retries in case of failure MaxRetries *int `json:"maxRetries,omitempty" xmlrpc:"maxRetries,omitempty"` // Modify date of the health monitor instance ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // Type of health check, valid values are "TCP", "HTTP" and "HTTPS" MonitorType *string `json:"monitorType,omitempty" xmlrpc:"monitorType,omitempty"` // Provisioning status of the health monitor, supported values are "CREATE_PENDING", ProvisioningStatus *string `json:"provisioningStatus,omitempty" xmlrpc:"provisioningStatus,omitempty"` // Timeout in seconds to wait for health checks response Timeout *int `json:"timeout,omitempty" xmlrpc:"timeout,omitempty"` // If monitorType is "HTTP" this specifies the whole URL path UrlPath *string `json:"urlPath,omitempty" xmlrpc:"urlPath,omitempty"` // Health monitor's UUID Uuid *string `json:"uuid,omitempty" xmlrpc:"uuid,omitempty"` }
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
type Network_LBaaS_L7HealthMonitor ¶
type Network_LBaaS_L7HealthMonitor struct { Entity // no documentation yet CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // no documentation yet Interval *int `json:"interval,omitempty" xmlrpc:"interval,omitempty"` // no documentation yet MaxRetries *int `json:"maxRetries,omitempty" xmlrpc:"maxRetries,omitempty"` // no documentation yet ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // no documentation yet MonitorType *string `json:"monitorType,omitempty" xmlrpc:"monitorType,omitempty"` // no documentation yet ProvisioningStatus *string `json:"provisioningStatus,omitempty" xmlrpc:"provisioningStatus,omitempty"` // no documentation yet Timeout *int `json:"timeout,omitempty" xmlrpc:"timeout,omitempty"` // no documentation yet UrlPath *string `json:"urlPath,omitempty" xmlrpc:"urlPath,omitempty"` }
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
type Network_LBaaS_L7Member ¶
type Network_LBaaS_L7Member struct { Entity // The IP address of a L7 pool member. Address *string `json:"address,omitempty" xmlrpc:"address,omitempty"` // <<< EOT Specifies when a L7 pool member CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // The ID of a L7 pool member. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // <<< EOT Specifies when a L7 Pool ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // Backends protocol port Port *int `json:"port,omitempty" xmlrpc:"port,omitempty"` // <<< EOT The provisioning status of a L7 pool member. ProvisioningStatus *string `json:"provisioningStatus,omitempty" xmlrpc:"provisioningStatus,omitempty"` // The UUID of a L7 pool member. Uuid *string `json:"uuid,omitempty" xmlrpc:"uuid,omitempty"` // The weight of a L7 pool member. Weight *int `json:"weight,omitempty" xmlrpc:"weight,omitempty"` }
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.
type Network_LBaaS_L7Policy ¶
type Network_LBaaS_L7Policy struct { Entity // 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. Action *string `json:"action,omitempty" xmlrpc:"action,omitempty"` // Specifies when a L7 Policy was created. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // The unique identifier of a policy. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A count of L7RuleCount *uint `json:"l7RuleCount,omitempty" xmlrpc:"l7RuleCount,omitempty"` // no documentation yet L7Rules []Network_LBaaS_L7Rule `json:"l7Rules,omitempty" xmlrpc:"l7Rules,omitempty"` // Specifies when a L7 Policy was updated previously. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // Name of a Policy. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // The order in which the policy is evaluated. Each policy should have a unique priority Priority *int `json:"priority,omitempty" xmlrpc:"priority,omitempty"` // The L7 pool id to which traffic is redirected RedirectL7PoolId *int `json:"redirectL7PoolId,omitempty" xmlrpc:"redirectL7PoolId,omitempty"` // The UUID of the L7 pool object referenced by the policy when the policy action is set to REDIRECT_POOL RedirectL7PoolUuid *string `json:"redirectL7PoolUuid,omitempty" xmlrpc:"redirectL7PoolUuid,omitempty"` // 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. RedirectUrl *string `json:"redirectUrl,omitempty" xmlrpc:"redirectUrl,omitempty"` // The UUID of a Policy. Uuid *string `json:"uuid,omitempty" xmlrpc:"uuid,omitempty"` }
The SoftLayer_Network_LBaaS_L7Policy represents the policy for a listener.
type Network_LBaaS_L7Pool ¶
type Network_LBaaS_L7Pool struct { Entity // Create date of the L7 pool instance CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet L7HealthMonitor *Network_LBaaS_L7HealthMonitor `json:"l7HealthMonitor,omitempty" xmlrpc:"l7HealthMonitor,omitempty"` // A count of L7MemberCount *uint `json:"l7MemberCount,omitempty" xmlrpc:"l7MemberCount,omitempty"` // no documentation yet L7Members []Network_LBaaS_L7Member `json:"l7Members,omitempty" xmlrpc:"l7Members,omitempty"` // no documentation yet L7Policies []Network_LBaaS_L7Policy `json:"l7Policies,omitempty" xmlrpc:"l7Policies,omitempty"` // A count of L7PolicyCount *uint `json:"l7PolicyCount,omitempty" xmlrpc:"l7PolicyCount,omitempty"` // no documentation yet L7SessionAffinity *Network_LBaaS_L7SessionAffinity `json:"l7SessionAffinity,omitempty" xmlrpc:"l7SessionAffinity,omitempty"` // Load balancing algorithm: "ROUNDROBIN", "WEIGHTED_RR", "LEASTCONNECTION" LoadBalancingAlgorithm *string `json:"loadBalancingAlgorithm,omitempty" xmlrpc:"loadBalancingAlgorithm,omitempty"` // Last updated date of the L7 pool ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // Name of the L7 pool. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // Backends protocol, supported protocol is, "HTTP" Protocol *string `json:"protocol,omitempty" xmlrpc:"protocol,omitempty"` // Provisioning status of a load balancer's L7 pool. ProvisioningStatus *string `json:"provisioningStatus,omitempty" xmlrpc:"provisioningStatus,omitempty"` // Instance uuid of the L7 pool Uuid *string `json:"uuid,omitempty" xmlrpc:"uuid,omitempty"` }
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
type Network_LBaaS_L7PoolMembersHealth ¶
type Network_LBaaS_L7PoolMembersHealth struct { Entity // Instance uuid of the L7 pool L7PoolUuid *string `json:"l7PoolUuid,omitempty" xmlrpc:"l7PoolUuid,omitempty"` // Members statistics of the L7 pool MembersHealth []Network_LBaaS_MemberHealth `json:"membersHealth,omitempty" xmlrpc:"membersHealth,omitempty"` }
SoftLayer_Network_LBaaS_L7PoolMembersHealth provides statistics of members belonging to a particular L7 pool.
type Network_LBaaS_L7Rule ¶
type Network_LBaaS_L7Rule struct { Entity // Comparision type for the Rule, It should any of the following values : REGEX, STARTS_WITH, ENDS_WITH, CONTAINS, EQUAL_TO. ComparisonType *string `json:"comparisonType,omitempty" xmlrpc:"comparisonType,omitempty"` // Specifies when a Rule was created CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // The ID of a Rule. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Inverts the result of the value if set, i.e. True will be inverted to False and vice-versa Invert *int `json:"invert,omitempty" xmlrpc:"invert,omitempty"` // Key for Rule type HEADER and COOKIE. Key *string `json:"key,omitempty" xmlrpc:"key,omitempty"` // Specifies when a Rule was updated previously. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // Type of the Rule. It should have any of the following values: HOST_NAME, FILE_TYPE, HEADER, COOKIE, PATH. Type *string `json:"type,omitempty" xmlrpc:"type,omitempty"` // The UUID of a Rule. Uuid *string `json:"uuid,omitempty" xmlrpc:"uuid,omitempty"` // Value for Rule . For type HEADER and COOKIE, this value is compared against the value of the key from HEADER or COOKIE. Value *string `json:"value,omitempty" xmlrpc:"value,omitempty"` }
The SoftLayer_Network_LBaaS_L7Rule represents the Rules that can be attached to a a L7 policy.
type Network_LBaaS_L7SessionAffinity ¶
type Network_LBaaS_L7SessionAffinity struct { Entity // no documentation yet L7Pool *Network_LBaaS_L7Pool `json:"l7Pool,omitempty" xmlrpc:"l7Pool,omitempty"` // Type of the session persistence Type *string `json:"type,omitempty" xmlrpc:"type,omitempty"` }
SoftLayer_Network_LBaaS_L7SessionAffinity represents the session affinity, aka session persistence, configuration for a load balancer backend L7 pool.
type Network_LBaaS_Listener ¶
type Network_LBaaS_Listener struct { Entity // maximum idle time in seconds(Range: 1 to 7200), after which the load balancer brings down the ClientTimeout *int `json:"clientTimeout,omitempty" xmlrpc:"clientTimeout,omitempty"` // Limit of connections a listener can accept ConnectionLimit *int `json:"connectionLimit,omitempty" xmlrpc:"connectionLimit,omitempty"` // Specifies when the listener was created. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // no documentation yet DefaultPool *Network_LBaaS_Pool `json:"defaultPool,omitempty" xmlrpc:"defaultPool,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet L7Policies []Network_LBaaS_L7Policy `json:"l7Policies,omitempty" xmlrpc:"l7Policies,omitempty"` // A count of L7PolicyCount *uint `json:"l7PolicyCount,omitempty" xmlrpc:"l7PolicyCount,omitempty"` // Specifies when the listener was updated previously. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // Listeners protocol, one of "TCP", "HTTP", "HTTPS". Protocol *string `json:"protocol,omitempty" xmlrpc:"protocol,omitempty"` // Listeners protocol port number. ProtocolPort *int `json:"protocolPort,omitempty" xmlrpc:"protocolPort,omitempty"` // The provisioning status of listener. ProvisioningStatus *string `json:"provisioningStatus,omitempty" xmlrpc:"provisioningStatus,omitempty"` // maximum idle time in seconds(Range: 1 to 7200), after which the load balancer brings down the ServerTimeout *int `json:"serverTimeout,omitempty" xmlrpc:"serverTimeout,omitempty"` // This references to SSL/TLS certificate (optional) for a listener TlsCertificateId *int `json:"tlsCertificateId,omitempty" xmlrpc:"tlsCertificateId,omitempty"` // The UUID of a listener. Uuid *string `json:"uuid,omitempty" xmlrpc:"uuid,omitempty"` }
The SoftLayer_Network_LBaaS_Listener type presents a data structure for a load balancers listener, also called frontend.
type Network_LBaaS_LoadBalancer ¶
type Network_LBaaS_LoadBalancer struct { Entity // The account this load balancer belongs to. AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // Address (Host name) of a load balancer. Address *string `json:"address,omitempty" xmlrpc:"address,omitempty"` // Specifies when a load balancer was created. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // Datacenter, where load balancer is located. Datacenter *Location `json:"datacenter,omitempty" xmlrpc:"datacenter,omitempty"` // Description of a load balancer. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // A count of health monitors for the backend members. HealthMonitorCount *uint `json:"healthMonitorCount,omitempty" xmlrpc:"healthMonitorCount,omitempty"` // Health monitors for the backend members. HealthMonitors []Network_LBaaS_HealthMonitor `json:"healthMonitors,omitempty" xmlrpc:"healthMonitors,omitempty"` // The unique identifier of a load balancer. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Specifies whether the data log is enabled for the load balancer. IsDataLogEnabled *int `json:"isDataLogEnabled,omitempty" xmlrpc:"isDataLogEnabled,omitempty"` // Specifies whether the load balancer is a public or internal load balancer. IsPublic *int `json:"isPublic,omitempty" xmlrpc:"isPublic,omitempty"` // A count of l7Pools for load balancer. L7PoolCount *uint `json:"l7PoolCount,omitempty" xmlrpc:"l7PoolCount,omitempty"` // L7Pools for load balancer. L7Pools []Network_LBaaS_L7Pool `json:"l7Pools,omitempty" xmlrpc:"l7Pools,omitempty"` // A count of listeners assigned to load balancer. ListenerCount *uint `json:"listenerCount,omitempty" xmlrpc:"listenerCount,omitempty"` // Listeners assigned to load balancer. Listeners []Network_LBaaS_Listener `json:"listeners,omitempty" xmlrpc:"listeners,omitempty"` // This references to location with type datacenter LocationId *int `json:"locationId,omitempty" xmlrpc:"locationId,omitempty"` // A count of members assigned to load balancer. MemberCount *uint `json:"memberCount,omitempty" xmlrpc:"memberCount,omitempty"` // Members assigned to load balancer. Members []Network_LBaaS_Member `json:"members,omitempty" xmlrpc:"members,omitempty"` // Specifies when a load balancer was updated last. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // The load balancer's name. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // The operation status "ONLINE" or "OFFLINE" of a load balancer. OperatingStatus *string `json:"operatingStatus,omitempty" xmlrpc:"operatingStatus,omitempty"` // Error message of previous API call in case of failure PreviousErrorText *string `json:"previousErrorText,omitempty" xmlrpc:"previousErrorText,omitempty"` // The provisioning status of a load balancer. ProvisioningStatus *string `json:"provisioningStatus,omitempty" xmlrpc:"provisioningStatus,omitempty"` // A count of list of preferred custom ciphers configured for the load balancer. SslCipherCount *uint `json:"sslCipherCount,omitempty" xmlrpc:"sslCipherCount,omitempty"` // list of preferred custom ciphers configured for the load balancer. SslCiphers []Network_LBaaS_SSLCipher `json:"sslCiphers,omitempty" xmlrpc:"sslCiphers,omitempty"` // Specifies the type of load balancer. Type *int `json:"type,omitempty" xmlrpc:"type,omitempty"` // 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. UseSystemPublicIpPool *int `json:"useSystemPublicIpPool,omitempty" xmlrpc:"useSystemPublicIpPool,omitempty"` // The UUID of a load balancer. Uuid *string `json:"uuid,omitempty" xmlrpc:"uuid,omitempty"` }
The SoftLayer_Network_LBaaS_LoadBalancer type presents a structure containing attributes of a load balancer, and its related objects including listeners, pools and members.
type Network_LBaaS_LoadBalancerAppliance ¶ added in v1.1.3
type Network_LBaaS_LoadBalancerAppliance struct { Entity // no documentation yet ComputeId *int `json:"computeId,omitempty" xmlrpc:"computeId,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet LoadBalancerId *int `json:"loadBalancerId,omitempty" xmlrpc:"loadBalancerId,omitempty"` // no documentation yet OperatingStatus *string `json:"operatingStatus,omitempty" xmlrpc:"operatingStatus,omitempty"` // no documentation yet PrivateIp *string `json:"privateIp,omitempty" xmlrpc:"privateIp,omitempty"` // no documentation yet ProvisioningStatus *string `json:"provisioningStatus,omitempty" xmlrpc:"provisioningStatus,omitempty"` // no documentation yet PublicIp *string `json:"publicIp,omitempty" xmlrpc:"publicIp,omitempty"` // no documentation yet UnregisteredAt *Time `json:"unregisteredAt,omitempty" xmlrpc:"unregisteredAt,omitempty"` }
This class represents the load balancers appliances, ie virtual servers, on which the actual load balancer service is running. The relationship between load balancer and appliance is 1-to-N with N=2 for beta and very likely N=3 for post beta. Note that this class is for internal use only.
type Network_LBaaS_LoadBalancerHealthMonitorConfiguration ¶
type Network_LBaaS_LoadBalancerHealthMonitorConfiguration struct { Entity // Backends port BackendPort *int `json:"backendPort,omitempty" xmlrpc:"backendPort,omitempty"` // Backends protocol. Valid values are "TCP", "HTTP" BackendProtocol *string `json:"backendProtocol,omitempty" xmlrpc:"backendProtocol,omitempty"` // Health Monitor UUID, required for update only HealthMonitorUuid *string `json:"healthMonitorUuid,omitempty" xmlrpc:"healthMonitorUuid,omitempty"` // <<< EOT Interval in seconds to perform Interval *int `json:"interval,omitempty" xmlrpc:"interval,omitempty"` // Max number of retries until the member is considered as DOWN MaxRetries *int `json:"maxRetries,omitempty" xmlrpc:"maxRetries,omitempty"` // Health check methods timeout in Timeout *int `json:"timeout,omitempty" xmlrpc:"timeout,omitempty"` // If monitor is "HTTP", this specifies URL path UrlPath *string `json:"urlPath,omitempty" xmlrpc:"urlPath,omitempty"` }
SoftLayer_Network_LBaaS_LoadBalancerHealthMonitorConfiguration specifies the check method to be used for health monitoring backend members.
type Network_LBaaS_LoadBalancerMonitoringMetricDataPoint ¶
type Network_LBaaS_LoadBalancerMonitoringMetricDataPoint struct { Entity // Epoch Time EpochTimestamp *int `json:"epochTimestamp,omitempty" xmlrpc:"epochTimestamp,omitempty"` // a value Value *Float64 `json:"value,omitempty" xmlrpc:"value,omitempty"` }
SoftLayer_Network_LBaaS_LoadBalancerMonitoringMetricDataPoint is a collection of datapoints retrieved from a load balancer instance. The available metrics are: <ul> <li>The metric value </li> <li>The timestamp when the metric value was obtained </li> </ul>
type Network_LBaaS_LoadBalancerProtocolConfiguration ¶
type Network_LBaaS_LoadBalancerProtocolConfiguration struct { Entity // Backends port BackendPort *int `json:"backendPort,omitempty" xmlrpc:"backendPort,omitempty"` // Backends protocol. Valid values are "TCP", "HTTP" BackendProtocol *string `json:"backendProtocol,omitempty" xmlrpc:"backendProtocol,omitempty"` // maximum idle time in seconds(Range: 1 to 7200), after which the load balancer brings down the client-side connection ClientTimeout *int `json:"clientTimeout,omitempty" xmlrpc:"clientTimeout,omitempty"` // Frontends port FrontendPort *int `json:"frontendPort,omitempty" xmlrpc:"frontendPort,omitempty"` // Frontends protocol. Valid values are "TCP", "HTTP" and "HTTPS" FrontendProtocol *string `json:"frontendProtocol,omitempty" xmlrpc:"frontendProtocol,omitempty"` // Listeners UUID, required for update only ListenerUuid *string `json:"listenerUuid,omitempty" xmlrpc:"listenerUuid,omitempty"` // Load balancing method. Valid values are "ROUNDROBIN", "WEIGHTED_RR" and "LEASTCONNECTION" LoadBalancingMethod *string `json:"loadBalancingMethod,omitempty" xmlrpc:"loadBalancingMethod,omitempty"` // Maximum number of allowed connections MaxConn *int `json:"maxConn,omitempty" xmlrpc:"maxConn,omitempty"` // maximum idle time in seconds(Range: 1 to 7200), after which the load balancer brings down the server-side connection ServerTimeout *int `json:"serverTimeout,omitempty" xmlrpc:"serverTimeout,omitempty"` // Sessions cookie name SessionCookieName *string `json:"sessionCookieName,omitempty" xmlrpc:"sessionCookieName,omitempty"` // Session stickiness type. Valid values are "SOURCE_IP" "HTTP_COOKIE" SessionType *string `json:"sessionType,omitempty" xmlrpc:"sessionType,omitempty"` // ssl/tls certificate id TlsCertificateId *int `json:"tlsCertificateId,omitempty" xmlrpc:"tlsCertificateId,omitempty"` }
SoftLayer_Network_LBaaS_LoadBalancerProtocolConfiguration specifies the protocol, port, maximum number of allowed connections and session stickiness for load balancer's front- and backend.
type Network_LBaaS_LoadBalancerServerInstanceInfo ¶
type Network_LBaaS_LoadBalancerServerInstanceInfo struct { Entity // Servers private IP address PrivateIpAddress *string `json:"privateIpAddress,omitempty" xmlrpc:"privateIpAddress,omitempty"` // Servers public IP address PublicIpAddress *string `json:"publicIpAddress,omitempty" xmlrpc:"publicIpAddress,omitempty"` // Load balancing weight for a server Weight *int `json:"weight,omitempty" xmlrpc:"weight,omitempty"` }
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.
type Network_LBaaS_LoadBalancerStatistics ¶
type Network_LBaaS_LoadBalancerStatistics struct { Entity // Number of connections seen at the ConnectionRate *int `json:"connectionRate,omitempty" xmlrpc:"connectionRate,omitempty"` // Data processed by month is the total of bin and bout DataProcessedByMonth *int `json:"dataProcessedByMonth,omitempty" xmlrpc:"dataProcessedByMonth,omitempty"` // Number of members in DOWN health state NumberOfMembersDown *int `json:"numberOfMembersDown,omitempty" xmlrpc:"numberOfMembersDown,omitempty"` // Number of members in UP health state NumberOfMembersUp *int `json:"numberOfMembersUp,omitempty" xmlrpc:"numberOfMembersUp,omitempty"` // Throughput measures the total number of bits Throughput *Float64 `json:"throughput,omitempty" xmlrpc:"throughput,omitempty"` // Number of total active established connections TotalConnections *int `json:"totalConnections,omitempty" xmlrpc:"totalConnections,omitempty"` }
SoftLayer_Network_LBaaS_LoadBalancerStatistics is a collection of metrics retrieved from a load balancer instance. The available metrics are: <ul> <li>NUmber of members up</li> <li>Number of members down</li> <li>Total number of active connections</li> <li>Throughput</li> <li>Data processed by month</li> <li>Connection rate</li> </ul>
type Network_LBaaS_Member ¶
type Network_LBaaS_Member struct { Entity // The IP address of a load balancer member. Address *string `json:"address,omitempty" xmlrpc:"address,omitempty"` // Specifies when a load balancers CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Specifies when a load balancers ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // The provisioning status of a load balancer member. ProvisioningStatus *string `json:"provisioningStatus,omitempty" xmlrpc:"provisioningStatus,omitempty"` // The UUID of a load balancer member. Uuid *string `json:"uuid,omitempty" xmlrpc:"uuid,omitempty"` // The weight of a load balancer member. Weight *int `json:"weight,omitempty" xmlrpc:"weight,omitempty"` }
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.
type Network_LBaaS_MemberHealth ¶
type Network_LBaaS_MemberHealth struct { Entity // Members status (UP/DOWN). Status *string `json:"status,omitempty" xmlrpc:"status,omitempty"` // Members UUID. Uuid *string `json:"uuid,omitempty" xmlrpc:"uuid,omitempty"` }
SoftLayer_Network_LBaaS_MemberHealth is a collection member metrics retrieved from a LBaaS VSI instance. The available metrics are: <ul> <li>Name of the member</li> <li>Status of the member up or down</li> <li>Uuid of the member</li> </ul>
type Network_LBaaS_PolicyRule ¶
type Network_LBaaS_PolicyRule struct { Entity // L7 Policy L7Policy *Network_LBaaS_L7Policy `json:"l7Policy,omitempty" xmlrpc:"l7Policy,omitempty"` // L7 Rules L7Rules []Network_LBaaS_L7Rule `json:"l7Rules,omitempty" xmlrpc:"l7Rules,omitempty"` }
SoftLayer_Network_LBaaS_PolicyRule
This class contains layer 7 policy specifications and an array of associated rules An array of objects of this class must be passed to the API in order to create a policy and its associated rules. <ul> <li>The layer 7 policy object </li> <li>An array of layer 7 rules </li> </ul>
type Network_LBaaS_Pool ¶
type Network_LBaaS_Pool struct { Entity // Create date of the pool instance CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // no documentation yet HealthMonitor *Network_LBaaS_HealthMonitor `json:"healthMonitor,omitempty" xmlrpc:"healthMonitor,omitempty"` // Load balancing algorithm: "ROUNDROBIN", "WEIGHTED_RR", "LEASTCONNECTION" LoadBalancingAlgorithm *string `json:"loadBalancingAlgorithm,omitempty" xmlrpc:"loadBalancingAlgorithm,omitempty"` // A count of MemberCount *uint `json:"memberCount,omitempty" xmlrpc:"memberCount,omitempty"` // no documentation yet Members []Network_LBaaS_Member `json:"members,omitempty" xmlrpc:"members,omitempty"` // Last updated date of the pool ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // Backends protocol, supported protocols are "TCP", "HTTP" and "HTTPS" Protocol *string `json:"protocol,omitempty" xmlrpc:"protocol,omitempty"` // Backends protocol port ProtocolPort *int `json:"protocolPort,omitempty" xmlrpc:"protocolPort,omitempty"` // Provisioning status of a load balancer pool. ProvisioningStatus *string `json:"provisioningStatus,omitempty" xmlrpc:"provisioningStatus,omitempty"` // no documentation yet SessionAffinity *Network_LBaaS_SessionAffinity `json:"sessionAffinity,omitempty" xmlrpc:"sessionAffinity,omitempty"` // Instance uuid of the pool Uuid *string `json:"uuid,omitempty" xmlrpc:"uuid,omitempty"` }
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.
type Network_LBaaS_PoolMembersHealth ¶
type Network_LBaaS_PoolMembersHealth struct { Entity // Members statistics of the pool MembersHealth []Network_LBaaS_MemberHealth `json:"membersHealth,omitempty" xmlrpc:"membersHealth,omitempty"` // Instance uuid of the pool PoolUuid *string `json:"poolUuid,omitempty" xmlrpc:"poolUuid,omitempty"` }
SoftLayer_Network_LBaaS_PoolMembersHealth provides statistics of members belonging to a particular pool.
type Network_LBaaS_SSLCipher ¶
type Network_LBaaS_SSLCipher struct { Entity // Cipher identifier Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Name of the cipher Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
The SoftLayer_Network_LBaaS_SSLCipher type presents a structure that contains attributes of load balancer cipher suites.
type Network_LBaaS_SessionAffinity ¶
type Network_LBaaS_SessionAffinity struct { Entity // no documentation yet Pool *Network_LBaaS_Pool `json:"pool,omitempty" xmlrpc:"pool,omitempty"` // Type of the session persistence Type *string `json:"type,omitempty" xmlrpc:"type,omitempty"` }
SoftLayer_Network_LBaaS_SessionAffinity represents the session affinity, aka session persistence, configuration for a load balancer backend pool.
type Network_LoadBalancer_Service ¶
type Network_LoadBalancer_Service struct { Entity // Connection limit on this service. ConnectionLimit *int `json:"connectionLimit,omitempty" xmlrpc:"connectionLimit,omitempty"` // Creation Date of this service CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // The IP Address of the real server you wish to direct traffic to. Your account must own this IP DestinationIpAddress *string `json:"destinationIpAddress,omitempty" xmlrpc:"destinationIpAddress,omitempty"` // 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. DestinationPort *int `json:"destinationPort,omitempty" xmlrpc:"destinationPort,omitempty"` // 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 Enabled *bool `json:"enabled,omitempty" xmlrpc:"enabled,omitempty"` // The health check type for this service. If one is supplied, the load balancer will occasionally ping your server to determine if it is still up. Servers that are down are removed from the queue and will not be used to handle requests until their status returns to "up". The value of the health check is determined directly by what option you have selected for the routing type. // // {| // |- // ! Type // ! Valid Health Checks // |- // | HTTP // | HTTP, TCP, ICMP // |- // | TCP // | HTTP, TCP, ICMP // |- // | FTP // | TCP, ICMP // |- // | DNS // | DNS, ICMP // |- // | UDP // | None // |} // // HealthCheck *string `json:"healthCheck,omitempty" xmlrpc:"healthCheck,omitempty"` // 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" HealthCheckURL *string `json:"healthCheckURL,omitempty" xmlrpc:"healthCheckURL,omitempty"` // The expected response from the custom HTTP health check. If the requested page contains this response, the check succeeds. HealthResponse *string `json:"healthResponse,omitempty" xmlrpc:"healthResponse,omitempty"` // Unique ID for this object, used for the getObject method, and must be set if you are editing this object. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Last modification date of this service ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // Name of the load balancer service Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // Holds whether this server is up or down. Does not affect load balancer configuration at all, just for the customer's informational purposes Notes *string `json:"notes,omitempty" xmlrpc:"notes,omitempty"` // Peak historical connections since the creation of this service. Is reset any time you make a configuration change PeakConnections *int `json:"peakConnections,omitempty" xmlrpc:"peakConnections,omitempty"` // 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. SourcePort *int `json:"sourcePort,omitempty" xmlrpc:"sourcePort,omitempty"` // 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 `json:"type,omitempty" xmlrpc:"type,omitempty"` // The load balancer that this service belongs to. Vip *Network_LoadBalancer_VirtualIpAddress `json:"vip,omitempty" xmlrpc:"vip,omitempty"` // 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. VipId *int `json:"vipId,omitempty" xmlrpc:"vipId,omitempty"` // 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. Weight *int `json:"weight,omitempty" xmlrpc:"weight,omitempty"` }
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.
type Network_LoadBalancer_VirtualIpAddress ¶
type Network_LoadBalancer_VirtualIpAddress struct { Entity // The account that owns this load balancer. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // The current billing item for the Load Balancer. BillingItem *Billing_Item `json:"billingItem,omitempty" xmlrpc:"billingItem,omitempty"` // Connection limit on this VIP. Can be upgraded through the upgradeConnectionLimit() function ConnectionLimit *int `json:"connectionLimit,omitempty" xmlrpc:"connectionLimit,omitempty"` // 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. CustomerManagedFlag *int `json:"customerManagedFlag,omitempty" xmlrpc:"customerManagedFlag,omitempty"` // Unique ID for this object, used for the getObject method, and must be set if you are editing this object. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // 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. LoadBalancingMethod *string `json:"loadBalancingMethod,omitempty" xmlrpc:"loadBalancingMethod,omitempty"` // A human readable version of loadBalancingMethod, intended mainly for API users. LoadBalancingMethodFullName *string `json:"loadBalancingMethodFullName,omitempty" xmlrpc:"loadBalancingMethodFullName,omitempty"` // A flag indicating that the load balancer is a managed resource. ManagedResourceFlag *bool `json:"managedResourceFlag,omitempty" xmlrpc:"managedResourceFlag,omitempty"` // Date this load balancer was last modified ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // The name of the load balancer instance Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // User-created notes on this load balancer. Notes *string `json:"notes,omitempty" xmlrpc:"notes,omitempty"` // The unique identifier of the Security Certificate to be utilized when SSL support is enabled. SecurityCertificateId *int `json:"securityCertificateId,omitempty" xmlrpc:"securityCertificateId,omitempty"` // A count of the services on this load balancer. ServiceCount *uint `json:"serviceCount,omitempty" xmlrpc:"serviceCount,omitempty"` // the services on this load balancer. Services []Network_LoadBalancer_Service `json:"services,omitempty" xmlrpc:"services,omitempty"` // This is the port for incoming traffic. SourcePort *int `json:"sourcePort,omitempty" xmlrpc:"sourcePort,omitempty"` // The connection type of this VIP. Valid values are HTTP, FTP, TCP, UDP, and DNS. Type *string `json:"type,omitempty" xmlrpc:"type,omitempty"` // The virtual, public-facing IP address for your load balancer. This is the address of all incoming traffic VirtualIpAddress *string `json:"virtualIpAddress,omitempty" xmlrpc:"virtualIpAddress,omitempty"` }
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.
type Network_Logging_Syslog ¶
type Network_Logging_Syslog struct { Entity // Timestamp for when the connection was blocked by the firewall CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // The Destination IP Address of the blocked connection (your end) DestinationIpAddress *string `json:"destinationIpAddress,omitempty" xmlrpc:"destinationIpAddress,omitempty"` // The Destination Port of the blocked connection (your end) DestinationPort *int `json:"destinationPort,omitempty" xmlrpc:"destinationPort,omitempty"` // This tells you what kind of firewall event this log line is for: accept or deny. EventType *string `json:"eventType,omitempty" xmlrpc:"eventType,omitempty"` // Raw syslog message for the event Message *string `json:"message,omitempty" xmlrpc:"message,omitempty"` // Connection protocol used to make the call that was blocked (tcp, udp, etc) Protocol *string `json:"protocol,omitempty" xmlrpc:"protocol,omitempty"` // The Source IP Address of the call that was blocked (attacker's end) SourceIpAddress *string `json:"sourceIpAddress,omitempty" xmlrpc:"sourceIpAddress,omitempty"` // The Source Port where the blocked connection was established (attacker's end) SourcePort *int `json:"sourcePort,omitempty" xmlrpc:"sourcePort,omitempty"` // If this is an aggregation of syslog events, this property shows the total events. TotalEvents *int `json:"totalEvents,omitempty" xmlrpc:"totalEvents,omitempty"` }
The Syslog class holds a single line from the Networking Firewall "Syslog" record, for firewall detected and blocked attempts on a server.
type Network_Message_Delivery ¶
type Network_Message_Delivery struct { Entity // The SoftLayer customer account that a network message delivery account belongs to. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // no documentation yet AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // The billing item for a network message delivery account. BillingItem *Billing_Item `json:"billingItem,omitempty" xmlrpc:"billingItem,omitempty"` // no documentation yet CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // no documentation yet Guid *string `json:"guid,omitempty" xmlrpc:"guid,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // no documentation yet Password *string `json:"password,omitempty" xmlrpc:"password,omitempty"` // The message delivery type of a network message delivery account. Type *Network_Message_Delivery_Type `json:"type,omitempty" xmlrpc:"type,omitempty"` // no documentation yet TypeId *int `json:"typeId,omitempty" xmlrpc:"typeId,omitempty"` // no documentation yet Username *string `json:"username,omitempty" xmlrpc:"username,omitempty"` // The vendor for a network message delivery account. Vendor *Network_Message_Delivery_Vendor `json:"vendor,omitempty" xmlrpc:"vendor,omitempty"` // no documentation yet VendorId *int `json:"vendorId,omitempty" xmlrpc:"vendorId,omitempty"` }
no documentation yet
type Network_Message_Delivery_Attribute ¶
type Network_Message_Delivery_Attribute struct { Entity // no documentation yet NetworkMessageDelivery *Network_Message_Delivery `json:"networkMessageDelivery,omitempty" xmlrpc:"networkMessageDelivery,omitempty"` // no documentation yet Value *string `json:"value,omitempty" xmlrpc:"value,omitempty"` }
no documentation yet
type Network_Message_Delivery_Email_Sendgrid ¶
type Network_Message_Delivery_Email_Sendgrid struct { Network_Message_Delivery // The contact e-mail address used by SendGrid. EmailAddress *string `json:"emailAddress,omitempty" xmlrpc:"emailAddress,omitempty"` // A flag that determines if a SendGrid e-mail delivery account has access to send mail through the SendGrid SMTP server. SmtpAccess *string `json:"smtpAccess,omitempty" xmlrpc:"smtpAccess,omitempty"` }
no documentation yet
type Network_Message_Delivery_Type ¶
type Network_Message_Delivery_Type struct { Entity // no documentation yet Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
no documentation yet
type Network_Message_Delivery_Vendor ¶
type Network_Message_Delivery_Vendor struct { Entity // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
no documentation yet
type Network_Monitor_Version1_Incident ¶
type Network_Monitor_Version1_Incident struct { Entity // A network monitoring incident's status, either the string "SERVICE FAILURE" denoting an ongoing incident or "COMPLETE" meaning the incident has been resolved. Status *string `json:"status,omitempty" xmlrpc:"status,omitempty"` }
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".
type Network_Monitor_Version1_Query_Host ¶
type Network_Monitor_Version1_Query_Host struct { Entity // 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. Arg1Value *string `json:"arg1Value,omitempty" xmlrpc:"arg1Value,omitempty"` // Virtual Guest Identification Number for the guest being monitored. GuestId *int `json:"guestId,omitempty" xmlrpc:"guestId,omitempty"` // The hardware that is being monitored by this monitoring instance Hardware *Hardware `json:"hardware,omitempty" xmlrpc:"hardware,omitempty"` // The ID of the hardware being monitored HardwareId *int `json:"hardwareId,omitempty" xmlrpc:"hardwareId,omitempty"` // Identification Number for the host being monitored. HostId *int `json:"hostId,omitempty" xmlrpc:"hostId,omitempty"` // The unique identifier for this object Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The IP address to be monitored. Must be attached to the hardware on this object IpAddress *string `json:"ipAddress,omitempty" xmlrpc:"ipAddress,omitempty"` // The most recent result for this particular monitoring instance. LastResult *Network_Monitor_Version1_Query_Result `json:"lastResult,omitempty" xmlrpc:"lastResult,omitempty"` // The type of monitoring query that is executed when this hardware is monitored. QueryType *Network_Monitor_Version1_Query_Type `json:"queryType,omitempty" xmlrpc:"queryType,omitempty"` // The ID of the query type to use. QueryTypeId *int `json:"queryTypeId,omitempty" xmlrpc:"queryTypeId,omitempty"` // The action taken when a monitor fails. ResponseAction *Network_Monitor_Version1_Query_ResponseType `json:"responseAction,omitempty" xmlrpc:"responseAction,omitempty"` // The ID of the response action to take when the monitor fails ResponseActionId *int `json:"responseActionId,omitempty" xmlrpc:"responseActionId,omitempty"` // The status of this monitoring instance. Anything other than "ON" means that the monitor has been disabled Status *string `json:"status,omitempty" xmlrpc:"status,omitempty"` // The number of 5-minute cycles to wait before the "responseAction" is taken. If set to 0, the response action will be taken immediately WaitCycles *int `json:"waitCycles,omitempty" xmlrpc:"waitCycles,omitempty"` }
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.
type Network_Monitor_Version1_Query_Host_Stratum ¶
type Network_Monitor_Version1_Query_Host_Stratum struct { Entity // The hardware object that these monitoring permissions applies to. Hardware *Hardware `json:"hardware,omitempty" xmlrpc:"hardware,omitempty"` // The highest level of a monitoring query type allowed on this server MonitorLevel *int `json:"monitorLevel,omitempty" xmlrpc:"monitorLevel,omitempty"` // The highest level of a monitoring response type allowed on this server ResponseLevel *int `json:"responseLevel,omitempty" xmlrpc:"responseLevel,omitempty"` }
The monitoring stratum type stores the maximum level of the various components of the monitoring system that a particular hardware object has access to. This object cannot be accessed by ID, and cannot be modified. The user can access this object through Hardware_Server->availableMonitoring.
There are two values on this object that are important: # monitorLevel determines the highest level of SoftLayer_Network_Monitor_Version1_Query_Type object that can be placed in a monitoring instance on this server # responseLevel determines the highest level of SoftLayer_Network_Monitor_Version1_Query_ResponseType object that can be placed in a monitoring instance on this server
Also note that the query type and response types are available through getAllQueryTypes and getAllResponseTypes, respectively.
type Network_Monitor_Version1_Query_ResponseType ¶
type Network_Monitor_Version1_Query_ResponseType struct { Entity // The description of the action the monitoring system will take on failure ActionDescription *string `json:"actionDescription,omitempty" xmlrpc:"actionDescription,omitempty"` // The unique identifier for this object Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The level of this response. The level the customer has access to is determined by values in SoftLayer_Network_Monitor_Version1_Query_Host_Stratum Level *int `json:"level,omitempty" xmlrpc:"level,omitempty"` }
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.
type Network_Monitor_Version1_Query_Result ¶
type Network_Monitor_Version1_Query_Result struct { Entity // The timestamp of when this monitor was co FinishTime *Time `json:"finishTime,omitempty" xmlrpc:"finishTime,omitempty"` // References the queryHost that this response relates to. QueryHost *Network_Monitor_Version1_Query_Host `json:"queryHost,omitempty" xmlrpc:"queryHost,omitempty"` // 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. ResponseStatus *int `json:"responseStatus,omitempty" xmlrpc:"responseStatus,omitempty"` // The length of time it took the server to respond ResponseTime *Float64 `json:"responseTime,omitempty" xmlrpc:"responseTime,omitempty"` }
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.
type Network_Monitor_Version1_Query_Type ¶
type Network_Monitor_Version1_Query_Type struct { Entity // The type of parameter sent to the monitoring command. ArgumentDescription *string `json:"argumentDescription,omitempty" xmlrpc:"argumentDescription,omitempty"` // Long description of the monitoring type. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // The unique identifier for this object Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // 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 MonitorLevel *int `json:"monitorLevel,omitempty" xmlrpc:"monitorLevel,omitempty"` // Short name of the monitoring type Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
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.
type Network_Pod ¶
type Network_Pod struct { Entity // Identifier for this Pod's Backend Customer Router (BCR) BackendRouterId *int `json:"backendRouterId,omitempty" xmlrpc:"backendRouterId,omitempty"` // Host name of Pod's Backend Customer Router (BCR), e.g. bcr01a.dal09 BackendRouterName *string `json:"backendRouterName,omitempty" xmlrpc:"backendRouterName,omitempty"` // 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. Capabilities []string `json:"capabilities,omitempty" xmlrpc:"capabilities,omitempty"` // Identifier for the Data Center the Pod resides within DatacenterId *int `json:"datacenterId,omitempty" xmlrpc:"datacenterId,omitempty"` // Long form name of the data center in which this Pod resides, e.g. Dallas 9 DatacenterLongName *string `json:"datacenterLongName,omitempty" xmlrpc:"datacenterLongName,omitempty"` // Name of data center in which this Pod resides, e.g. dal09 DatacenterName *string `json:"datacenterName,omitempty" xmlrpc:"datacenterName,omitempty"` // (optional) Identifier for this Pod's Frontend Customer Router (FCR) FrontendRouterId *int `json:"frontendRouterId,omitempty" xmlrpc:"frontendRouterId,omitempty"` // (optional) Host name of Pod's Frontend Customer Router (FCR), e.g. fcr01a.dal09 FrontendRouterName *string `json:"frontendRouterName,omitempty" xmlrpc:"frontendRouterName,omitempty"` // The unique name of the Pod. See [[SoftLayer_Network_Pod (type)]] for details of the name's construction. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
no documentation yet
type Network_Protection_Address ¶
type Network_Protection_Address struct { Entity // no documentation yet Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // no documentation yet DepartmentId *int `json:"departmentId,omitempty" xmlrpc:"departmentId,omitempty"` // no documentation yet IpAddress *string `json:"ipAddress,omitempty" xmlrpc:"ipAddress,omitempty"` // no documentation yet Location *Location `json:"location,omitempty" xmlrpc:"location,omitempty"` // no documentation yet ManagementMethodType *string `json:"managementMethodType,omitempty" xmlrpc:"managementMethodType,omitempty"` // no documentation yet ModifiedUser *User_Employee `json:"modifiedUser,omitempty" xmlrpc:"modifiedUser,omitempty"` // no documentation yet PrimaryRouter *Hardware_Router `json:"primaryRouter,omitempty" xmlrpc:"primaryRouter,omitempty"` // DEPRECATED // Deprecated: This function has been marked as deprecated. ServiceProvider *Service_Provider `json:"serviceProvider,omitempty" xmlrpc:"serviceProvider,omitempty"` // no documentation yet Subnet *Network_Subnet `json:"subnet,omitempty" xmlrpc:"subnet,omitempty"` // no documentation yet SubnetIpAddress *Network_Subnet_IpAddress `json:"subnetIpAddress,omitempty" xmlrpc:"subnetIpAddress,omitempty"` // no documentation yet TerminatedUser *User_Employee `json:"terminatedUser,omitempty" xmlrpc:"terminatedUser,omitempty"` // no documentation yet Ticket *Ticket `json:"ticket,omitempty" xmlrpc:"ticket,omitempty"` // A count of TransactionCount *uint `json:"transactionCount,omitempty" xmlrpc:"transactionCount,omitempty"` // no documentation yet Transactions []Provisioning_Version1_Transaction `json:"transactions,omitempty" xmlrpc:"transactions,omitempty"` // no documentation yet UserDepartment *User_Employee_Department `json:"userDepartment,omitempty" xmlrpc:"userDepartment,omitempty"` // no documentation yet UserRecord *User_Employee `json:"userRecord,omitempty" xmlrpc:"userRecord,omitempty"` }
no documentation yet
type Network_Regional_Internet_Registry ¶
type Network_Regional_Internet_Registry struct { Entity // Unique ID of the object Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The system-level name of the registry KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // The friendly name of the registry Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
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.
type Network_SecurityGroup ¶
type Network_SecurityGroup struct { Entity // The account this security group belongs to. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // The date a security group was created. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // The (optional) description for a security group. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // The unique ID for a security group. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet Metadata *string `json:"metadata,omitempty" xmlrpc:"metadata,omitempty"` // The date a security group was last modified. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // The (optional) name for a security group. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // A count of the network component bindings for this security group. NetworkComponentBindingCount *uint `json:"networkComponentBindingCount,omitempty" xmlrpc:"networkComponentBindingCount,omitempty"` // The network component bindings for this security group. NetworkComponentBindings []Virtual_Network_SecurityGroup_NetworkComponentBinding `json:"networkComponentBindings,omitempty" xmlrpc:"networkComponentBindings,omitempty"` // A count of the order bindings for this security group OrderBindingCount *uint `json:"orderBindingCount,omitempty" xmlrpc:"orderBindingCount,omitempty"` // The order bindings for this security group OrderBindings []Network_SecurityGroup_OrderBinding `json:"orderBindings,omitempty" xmlrpc:"orderBindings,omitempty"` // A count of the rules for this security group. RuleCount *uint `json:"ruleCount,omitempty" xmlrpc:"ruleCount,omitempty"` // The rules for this security group. Rules []Network_SecurityGroup_Rule `json:"rules,omitempty" xmlrpc:"rules,omitempty"` }
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 (type)|rules]] that define how to handle incoming (ingress) and outgoing (egress) traffic to both the public and private interfaces of a virtual server instance and a set of [[SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding (type)|bindings]] to associate virtual guest network components with the security group.
type Network_SecurityGroup_OrderBinding ¶
type Network_SecurityGroup_OrderBinding struct { Entity // The virtual guest associated with the binding Guest *Virtual_Guest `json:"guest,omitempty" xmlrpc:"guest,omitempty"` // The ID of the Virtual Guest associated with the security group. GuestId *int `json:"guestId,omitempty" xmlrpc:"guestId,omitempty"` // The unique ID for a security group, order, binding Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The order associated with the binding Order *Billing_Order `json:"order,omitempty" xmlrpc:"order,omitempty"` // The ID of the order associated with the security group. OrderId *int `json:"orderId,omitempty" xmlrpc:"orderId,omitempty"` // The security group associated with the order SecurityGroup *Network_SecurityGroup `json:"securityGroup,omitempty" xmlrpc:"securityGroup,omitempty"` // The ID of the security group that is associated with the order. SecurityGroupId *int `json:"securityGroupId,omitempty" xmlrpc:"securityGroupId,omitempty"` }
The SoftLayer_Network_SecurityGroup_OrderBinding data type contains links between security groups and product orders.
type Network_SecurityGroup_Request ¶
type Network_SecurityGroup_Request struct { Entity // The unique ID for a request. RequestId *string `json:"requestId,omitempty" xmlrpc:"requestId,omitempty"` }
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.
type Network_SecurityGroup_RequestRules ¶
type Network_SecurityGroup_RequestRules struct { Network_SecurityGroup_Request // Whether the API call was valid or not. Rules []Network_SecurityGroup_Rule `json:"rules,omitempty" xmlrpc:"rules,omitempty"` }
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.
type Network_SecurityGroup_Rule ¶
type Network_SecurityGroup_Rule struct { Entity // The createDate field for a rule. It is essentially the date and time that the security group rule was created. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // The direction of traffic (ingress or egress). Direction *string `json:"direction,omitempty" xmlrpc:"direction,omitempty"` // 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. Ethertype *string `json:"ethertype,omitempty" xmlrpc:"ethertype,omitempty"` // The unique ID for a rule. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The modifyDate field for a rule. It is essentially the date and time that the security group rule was last changed. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // 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. PortRangeMax *int `json:"portRangeMax,omitempty" xmlrpc:"portRangeMax,omitempty"` // The start of the port range for allowed traffic. When the protocol is icmp, this value specifies the icmp type to permit. PortRangeMin *int `json:"portRangeMin,omitempty" xmlrpc:"portRangeMin,omitempty"` // The protocol of packets (icmp, tcp, udp, or vrrp). Protocol *string `json:"protocol,omitempty" xmlrpc:"protocol,omitempty"` // The remote security group allowed as part of this rule. RemoteGroup *Network_SecurityGroup `json:"remoteGroup,omitempty" xmlrpc:"remoteGroup,omitempty"` // The ID of the remote security group allowed as part of the rule. This property is mutually exclusive with the remoteIp property. RemoteGroupId *int `json:"remoteGroupId,omitempty" xmlrpc:"remoteGroupId,omitempty"` // 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. RemoteIp *string `json:"remoteIp,omitempty" xmlrpc:"remoteIp,omitempty"` // The security group of this rule. SecurityGroup *Network_SecurityGroup `json:"securityGroup,omitempty" xmlrpc:"securityGroup,omitempty"` // The ID of the security group that owns the rule. SecurityGroupId *int `json:"securityGroupId,omitempty" xmlrpc:"securityGroupId,omitempty"` }
The SoftLayer_Network_SecurityGroup_Rule data type contains general information for a single rule that belongs to a [[SoftLayer_Network_SecurityGroup|security group]]. 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.
type Network_Security_Scanner_Request ¶
type Network_Security_Scanner_Request struct { Entity // The account associated with a security scan request. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // A request's associated customer account identifier. AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // The date and time that the request is created. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // The virtual guest a security scan is run against. Guest *Virtual_Guest `json:"guest,omitempty" xmlrpc:"guest,omitempty"` // Virtual Guest Identification Number for the guest this security scanner request belongs to. GuestId *int `json:"guestId,omitempty" xmlrpc:"guestId,omitempty"` // The hardware a security scan is run against. Hardware *Hardware `json:"hardware,omitempty" xmlrpc:"hardware,omitempty"` // The identifier of the hardware item a scan is run on. HardwareId *int `json:"hardwareId,omitempty" xmlrpc:"hardwareId,omitempty"` // Identification Number for the host this security scanner request belongs to. HostId *int `json:"hostId,omitempty" xmlrpc:"hostId,omitempty"` // A security scan request's internal identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The IP address that a scan will be performed on. IpAddress *string `json:"ipAddress,omitempty" xmlrpc:"ipAddress,omitempty"` // The date and time that the request was last modified. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // 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. RequestorOwnedFlag *bool `json:"requestorOwnedFlag,omitempty" xmlrpc:"requestorOwnedFlag,omitempty"` // A security scan request's status. Status *Network_Security_Scanner_Request_Status `json:"status,omitempty" xmlrpc:"status,omitempty"` // A request status identifier. StatusId *int `json:"statusId,omitempty" xmlrpc:"statusId,omitempty"` }
The SoftLayer_Network_Security_Scanner_Request data type represents a single vulnerability scan request. It provides information on when the scan was created, last updated, and the current status. The status messages are as follows: *Scan Pending *Scan Processing *Scan Complete *Scan Cancelled *Generating Report.
type Network_Security_Scanner_Request_Status ¶
type Network_Security_Scanner_Request_Status struct { Entity // The identifier of a vulnerability scan's status. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The status message of a vulnerability scan. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
The SoftLayer_Network_Security_Scanner_Request_Status data type represents the current status of a vulnerability scan. The status messages are as follows: *Scan Pending *Scan Processing *Scan Complete *Scan Cancelled *Generating Report.
The status of a vulnerability scan will change over the course of a scan's execution.
type Network_Service_Resource ¶
type Network_Service_Resource struct { Entity // no documentation yet ApiHost *string `json:"apiHost,omitempty" xmlrpc:"apiHost,omitempty"` // no documentation yet ApiPassword *string `json:"apiPassword,omitempty" xmlrpc:"apiPassword,omitempty"` // no documentation yet ApiPath *string `json:"apiPath,omitempty" xmlrpc:"apiPath,omitempty"` // no documentation yet ApiPort *string `json:"apiPort,omitempty" xmlrpc:"apiPort,omitempty"` // no documentation yet ApiProtocol *string `json:"apiProtocol,omitempty" xmlrpc:"apiProtocol,omitempty"` // no documentation yet ApiUsername *string `json:"apiUsername,omitempty" xmlrpc:"apiUsername,omitempty"` // no documentation yet ApiVersion *string `json:"apiVersion,omitempty" xmlrpc:"apiVersion,omitempty"` // A count of AttributeCount *uint `json:"attributeCount,omitempty" xmlrpc:"attributeCount,omitempty"` // no documentation yet Attributes []Network_Service_Resource_Attribute `json:"attributes,omitempty" xmlrpc:"attributes,omitempty"` // The backend IP address for this resource BackendIpAddress *string `json:"backendIpAddress,omitempty" xmlrpc:"backendIpAddress,omitempty"` // no documentation yet Datacenter *Location `json:"datacenter,omitempty" xmlrpc:"datacenter,omitempty"` // The frontend IP address for this resource FrontendIpAddress *string `json:"frontendIpAddress,omitempty" xmlrpc:"frontendIpAddress,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The name associated with this resource Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // no documentation yet NetappVolumeName *string `json:"netappVolumeName,omitempty" xmlrpc:"netappVolumeName,omitempty"` // The hardware information associated with this resource. NetworkDevice *Hardware `json:"networkDevice,omitempty" xmlrpc:"networkDevice,omitempty"` // no documentation yet SshUsername *string `json:"sshUsername,omitempty" xmlrpc:"sshUsername,omitempty"` // The network information associated with this resource. Type *Network_Service_Resource_Type `json:"type,omitempty" xmlrpc:"type,omitempty"` }
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.
type Network_Service_Resource_Attribute ¶
type Network_Service_Resource_Attribute struct { Entity // no documentation yet AttributeType *Network_Service_Resource_Attribute_Type `json:"attributeType,omitempty" xmlrpc:"attributeType,omitempty"` // no documentation yet ServiceResource *Network_Service_Resource `json:"serviceResource,omitempty" xmlrpc:"serviceResource,omitempty"` // no documentation yet Value *string `json:"value,omitempty" xmlrpc:"value,omitempty"` }
no documentation yet
type Network_Service_Resource_Attribute_Type ¶
type Network_Service_Resource_Attribute_Type struct { Entity // no documentation yet Keyname *string `json:"keyname,omitempty" xmlrpc:"keyname,omitempty"` }
no documentation yet
type Network_Service_Resource_CosStor ¶ added in v1.0.1
type Network_Service_Resource_CosStor struct {
Network_Service_Resource
}
The SoftLayer_Network_Service_Resource_CosStor is used to store information related to COS service.
type Network_Service_Resource_Hub ¶
type Network_Service_Resource_Hub struct {
Network_Service_Resource
}
no documentation yet
type Network_Service_Resource_Hub_Swift ¶
type Network_Service_Resource_Hub_Swift struct {
Network_Service_Resource_Hub
}
no documentation yet
type Network_Service_Resource_Type ¶
type Network_Service_Resource_Type struct { Entity // A count of ServiceResourceCount *uint `json:"serviceResourceCount,omitempty" xmlrpc:"serviceResourceCount,omitempty"` // no documentation yet ServiceResources []Network_Service_Resource `json:"serviceResources,omitempty" xmlrpc:"serviceResources,omitempty"` // no documentation yet Type *string `json:"type,omitempty" xmlrpc:"type,omitempty"` }
no documentation yet
type Network_Service_Vpn_Overrides ¶
type Network_Service_Vpn_Overrides struct { Entity // The internal identifier of the record. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Subnet components accessible by a SoftLayer VPN portal user. Subnet *Network_Subnet `json:"subnet,omitempty" xmlrpc:"subnet,omitempty"` // The identifier of a subnet accessible by the SoftLayer portal VPN user. SubnetId *int `json:"subnetId,omitempty" xmlrpc:"subnetId,omitempty"` // SoftLayer VPN portal user. User *User_Customer `json:"user,omitempty" xmlrpc:"user,omitempty"` // The identifier of the SoftLayer portal VPN user. UserId *int `json:"userId,omitempty" xmlrpc:"userId,omitempty"` }
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.
type Network_Storage ¶
type Network_Storage struct { Entity // The account that a Storage services belongs to. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // The internal identifier of the SoftLayer customer account that a Storage account belongs to. AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // Other usernames and passwords associated with a Storage volume. AccountPassword *Account_Password `json:"accountPassword,omitempty" xmlrpc:"accountPassword,omitempty"` // A count of the currently active transactions on a network storage volume. ActiveTransactionCount *uint `json:"activeTransactionCount,omitempty" xmlrpc:"activeTransactionCount,omitempty"` // The currently active transactions on a network storage volume. ActiveTransactions []Provisioning_Version1_Transaction `json:"activeTransactions,omitempty" xmlrpc:"activeTransactions,omitempty"` // no documentation yet AllowDisasterRecoveryFailback *string `json:"allowDisasterRecoveryFailback,omitempty" xmlrpc:"allowDisasterRecoveryFailback,omitempty"` // no documentation yet AllowDisasterRecoveryFailover *string `json:"allowDisasterRecoveryFailover,omitempty" xmlrpc:"allowDisasterRecoveryFailover,omitempty"` // The SoftLayer_Hardware objects which are allowed access to this storage volume. AllowedHardware []Hardware `json:"allowedHardware,omitempty" xmlrpc:"allowedHardware,omitempty"` // A count of the SoftLayer_Hardware objects which are allowed access to this storage volume. AllowedHardwareCount *uint `json:"allowedHardwareCount,omitempty" xmlrpc:"allowedHardwareCount,omitempty"` // A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume. AllowedIpAddressCount *uint `json:"allowedIpAddressCount,omitempty" xmlrpc:"allowedIpAddressCount,omitempty"` // The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume. AllowedIpAddresses []Network_Subnet_IpAddress `json:"allowedIpAddresses,omitempty" xmlrpc:"allowedIpAddresses,omitempty"` // The SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. AllowedReplicationHardware []Hardware `json:"allowedReplicationHardware,omitempty" xmlrpc:"allowedReplicationHardware,omitempty"` // A count of the SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. AllowedReplicationHardwareCount *uint `json:"allowedReplicationHardwareCount,omitempty" xmlrpc:"allowedReplicationHardwareCount,omitempty"` // A count of the SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume's Replicant. AllowedReplicationIpAddressCount *uint `json:"allowedReplicationIpAddressCount,omitempty" xmlrpc:"allowedReplicationIpAddressCount,omitempty"` // The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume's Replicant. AllowedReplicationIpAddresses []Network_Subnet_IpAddress `json:"allowedReplicationIpAddresses,omitempty" xmlrpc:"allowedReplicationIpAddresses,omitempty"` // A count of the SoftLayer_Network_Subnet objects which are allowed access to this storage volume's Replicant. AllowedReplicationSubnetCount *uint `json:"allowedReplicationSubnetCount,omitempty" xmlrpc:"allowedReplicationSubnetCount,omitempty"` // The SoftLayer_Network_Subnet objects which are allowed access to this storage volume's Replicant. AllowedReplicationSubnets []Network_Subnet `json:"allowedReplicationSubnets,omitempty" xmlrpc:"allowedReplicationSubnets,omitempty"` // A count of the SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. AllowedReplicationVirtualGuestCount *uint `json:"allowedReplicationVirtualGuestCount,omitempty" xmlrpc:"allowedReplicationVirtualGuestCount,omitempty"` // The SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant. AllowedReplicationVirtualGuests []Virtual_Guest `json:"allowedReplicationVirtualGuests,omitempty" xmlrpc:"allowedReplicationVirtualGuests,omitempty"` // A count of the SoftLayer_Network_Subnet objects which are allowed access to this storage volume. AllowedSubnetCount *uint `json:"allowedSubnetCount,omitempty" xmlrpc:"allowedSubnetCount,omitempty"` // The SoftLayer_Network_Subnet objects which are allowed access to this storage volume. AllowedSubnets []Network_Subnet `json:"allowedSubnets,omitempty" xmlrpc:"allowedSubnets,omitempty"` // A count of the SoftLayer_Virtual_Guest objects which are allowed access to this storage volume. AllowedVirtualGuestCount *uint `json:"allowedVirtualGuestCount,omitempty" xmlrpc:"allowedVirtualGuestCount,omitempty"` // The SoftLayer_Virtual_Guest objects which are allowed access to this storage volume. AllowedVirtualGuests []Virtual_Guest `json:"allowedVirtualGuests,omitempty" xmlrpc:"allowedVirtualGuests,omitempty"` // The current billing item for a Storage volume. BillingItem *Billing_Item `json:"billingItem,omitempty" xmlrpc:"billingItem,omitempty"` // no documentation yet BillingItemCategory *Product_Item_Category `json:"billingItemCategory,omitempty" xmlrpc:"billingItemCategory,omitempty"` // The amount of space used by the volume, in bytes. BytesUsed *string `json:"bytesUsed,omitempty" xmlrpc:"bytesUsed,omitempty"` // A Storage account's capacity, measured in gigabytes. CapacityGb *int `json:"capacityGb,omitempty" xmlrpc:"capacityGb,omitempty"` // The date a network storage volume was created. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // The schedule id which was executed to create a snapshot. CreationScheduleId *string `json:"creationScheduleId,omitempty" xmlrpc:"creationScheduleId,omitempty"` // A count of CredentialCount *uint `json:"credentialCount,omitempty" xmlrpc:"credentialCount,omitempty"` // no documentation yet Credentials []Network_Storage_Credential `json:"credentials,omitempty" xmlrpc:"credentials,omitempty"` // The Daily Schedule which is associated with this network storage volume. DailySchedule *Network_Storage_Schedule `json:"dailySchedule,omitempty" xmlrpc:"dailySchedule,omitempty"` // Whether or not a network storage volume is a dependent duplicate. DependentDuplicate *string `json:"dependentDuplicate,omitempty" xmlrpc:"dependentDuplicate,omitempty"` // A count of the network storage volumes configured to be dependent duplicates of a volume. DependentDuplicateCount *uint `json:"dependentDuplicateCount,omitempty" xmlrpc:"dependentDuplicateCount,omitempty"` // The network storage volumes configured to be dependent duplicates of a volume. DependentDuplicates []Network_Storage `json:"dependentDuplicates,omitempty" xmlrpc:"dependentDuplicates,omitempty"` // A count of the events which have taken place on a network storage volume. EventCount *uint `json:"eventCount,omitempty" xmlrpc:"eventCount,omitempty"` // The events which have taken place on a network storage volume. Events []Network_Storage_Event `json:"events,omitempty" xmlrpc:"events,omitempty"` // Determines whether the volume is allowed to failback FailbackNotAllowed *string `json:"failbackNotAllowed,omitempty" xmlrpc:"failbackNotAllowed,omitempty"` // Determines whether the volume is allowed to failover FailoverNotAllowed *string `json:"failoverNotAllowed,omitempty" xmlrpc:"failoverNotAllowed,omitempty"` // Retrieves the NFS Network Mount Address Name for a given File Storage Volume. FileNetworkMountAddress *string `json:"fileNetworkMountAddress,omitempty" xmlrpc:"fileNetworkMountAddress,omitempty"` // no documentation yet FixReplicationCurrentStatus *string `json:"fixReplicationCurrentStatus,omitempty" xmlrpc:"fixReplicationCurrentStatus,omitempty"` // The unique identification number of the guest associated with a Storage volume. GuestId *int `json:"guestId,omitempty" xmlrpc:"guestId,omitempty"` // When applicable, the hardware associated with a Storage service. Hardware *Hardware `json:"hardware,omitempty" xmlrpc:"hardware,omitempty"` // The server that is associated with a Storage service. HardwareId *int `json:"hardwareId,omitempty" xmlrpc:"hardwareId,omitempty"` // no documentation yet HasEncryptionAtRest *bool `json:"hasEncryptionAtRest,omitempty" xmlrpc:"hasEncryptionAtRest,omitempty"` // The unique identification number of the host associated with a Storage volume. HostId *int `json:"hostId,omitempty" xmlrpc:"hostId,omitempty"` // The Hourly Schedule which is associated with this network storage volume. HourlySchedule *Network_Storage_Schedule `json:"hourlySchedule,omitempty" xmlrpc:"hourlySchedule,omitempty"` // A Storage account's unique identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The Interval Schedule which is associated with this network storage volume. IntervalSchedule *Network_Storage_Schedule `json:"intervalSchedule,omitempty" xmlrpc:"intervalSchedule,omitempty"` // The maximum number of IOPs selected for this volume. Iops *string `json:"iops,omitempty" xmlrpc:"iops,omitempty"` // Determines whether network storage volume has an active convert dependent clone to Independent transaction. IsConvertToIndependentTransactionInProgress *bool `json:"isConvertToIndependentTransactionInProgress,omitempty" xmlrpc:"isConvertToIndependentTransactionInProgress,omitempty"` // Determines whether dependent volume provision is completed on background. IsDependentDuplicateProvisionCompleted *bool `json:"isDependentDuplicateProvisionCompleted,omitempty" xmlrpc:"isDependentDuplicateProvisionCompleted,omitempty"` // no documentation yet IsInDedicatedServiceResource *bool `json:"isInDedicatedServiceResource,omitempty" xmlrpc:"isInDedicatedServiceResource,omitempty"` // no documentation yet IsMagneticStorage *string `json:"isMagneticStorage,omitempty" xmlrpc:"isMagneticStorage,omitempty"` // Determines whether network storage volume has an active provision transaction. IsProvisionInProgress *bool `json:"isProvisionInProgress,omitempty" xmlrpc:"isProvisionInProgress,omitempty"` // 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. IsReadyForSnapshot *bool `json:"isReadyForSnapshot,omitempty" xmlrpc:"isReadyForSnapshot,omitempty"` // 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. IsReadyToMount *bool `json:"isReadyToMount,omitempty" xmlrpc:"isReadyToMount,omitempty"` // A count of relationship between a container volume and iSCSI LUNs. IscsiLunCount *uint `json:"iscsiLunCount,omitempty" xmlrpc:"iscsiLunCount,omitempty"` // Relationship between a container volume and iSCSI LUNs. IscsiLuns []Network_Storage `json:"iscsiLuns,omitempty" xmlrpc:"iscsiLuns,omitempty"` // The network storage volumes configured to be replicants of this volume. IscsiReplicatingVolume *Network_Storage `json:"iscsiReplicatingVolume,omitempty" xmlrpc:"iscsiReplicatingVolume,omitempty"` // A count of returns the target IP addresses of an iSCSI volume. IscsiTargetIpAddressCount *uint `json:"iscsiTargetIpAddressCount,omitempty" xmlrpc:"iscsiTargetIpAddressCount,omitempty"` // Returns the target IP addresses of an iSCSI volume. IscsiTargetIpAddresses []string `json:"iscsiTargetIpAddresses,omitempty" xmlrpc:"iscsiTargetIpAddresses,omitempty"` // The ID of the LUN volume. LunId *string `json:"lunId,omitempty" xmlrpc:"lunId,omitempty"` // A count of the manually-created snapshots associated with this SoftLayer_Network_Storage volume. Does not support pagination by result limit and offset. ManualSnapshotCount *uint `json:"manualSnapshotCount,omitempty" xmlrpc:"manualSnapshotCount,omitempty"` // The manually-created snapshots associated with this SoftLayer_Network_Storage volume. Does not support pagination by result limit and offset. ManualSnapshots []Network_Storage `json:"manualSnapshots,omitempty" xmlrpc:"manualSnapshots,omitempty"` // A network storage volume's metric tracking object. This object records all periodic polled data available to this volume. MetricTrackingObject *Metric_Tracking_Object `json:"metricTrackingObject,omitempty" xmlrpc:"metricTrackingObject,omitempty"` // Retrieves the NFS Network Mount Path for a given File Storage Volume. MountPath *string `json:"mountPath,omitempty" xmlrpc:"mountPath,omitempty"` // Whether or not a network storage volume may be mounted. MountableFlag *string `json:"mountableFlag,omitempty" xmlrpc:"mountableFlag,omitempty"` // The current status of split or move operation as a part of volume duplication. MoveAndSplitStatus *string `json:"moveAndSplitStatus,omitempty" xmlrpc:"moveAndSplitStatus,omitempty"` // A Storage account's type. Valid examples are "NAS", "LOCKBOX", "ISCSI", "EVAULT", and "HUB". NasType *string `json:"nasType,omitempty" xmlrpc:"nasType,omitempty"` // Public notes related to a Storage volume. Notes *string `json:"notes,omitempty" xmlrpc:"notes,omitempty"` // A count of the subscribers that will be notified for usage amount warnings and overages. NotificationSubscriberCount *uint `json:"notificationSubscriberCount,omitempty" xmlrpc:"notificationSubscriberCount,omitempty"` // The subscribers that will be notified for usage amount warnings and overages. NotificationSubscribers []Notification_User_Subscriber `json:"notificationSubscribers,omitempty" xmlrpc:"notificationSubscribers,omitempty"` // The name of the snapshot that this volume was duplicated from. OriginalSnapshotName *string `json:"originalSnapshotName,omitempty" xmlrpc:"originalSnapshotName,omitempty"` // Volume id of the origin volume from which this volume is been cloned. OriginalVolumeId *int `json:"originalVolumeId,omitempty" xmlrpc:"originalVolumeId,omitempty"` // The name of the volume that this volume was duplicated from. OriginalVolumeName *string `json:"originalVolumeName,omitempty" xmlrpc:"originalVolumeName,omitempty"` // 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. OriginalVolumeSize *string `json:"originalVolumeSize,omitempty" xmlrpc:"originalVolumeSize,omitempty"` // A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type. OsType *Network_Storage_Iscsi_OS_Type `json:"osType,omitempty" xmlrpc:"osType,omitempty"` // A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type ID. OsTypeId *string `json:"osTypeId,omitempty" xmlrpc:"osTypeId,omitempty"` // A count of the volumes or snapshots partnered with a network storage volume in a parental role. ParentPartnershipCount *uint `json:"parentPartnershipCount,omitempty" xmlrpc:"parentPartnershipCount,omitempty"` // The volumes or snapshots partnered with a network storage volume in a parental role. ParentPartnerships []Network_Storage_Partnership `json:"parentPartnerships,omitempty" xmlrpc:"parentPartnerships,omitempty"` // The parent volume of a volume in a complex storage relationship. ParentVolume *Network_Storage `json:"parentVolume,omitempty" xmlrpc:"parentVolume,omitempty"` // A count of the volumes or snapshots partnered with a network storage volume. PartnershipCount *uint `json:"partnershipCount,omitempty" xmlrpc:"partnershipCount,omitempty"` // The volumes or snapshots partnered with a network storage volume. Partnerships []Network_Storage_Partnership `json:"partnerships,omitempty" xmlrpc:"partnerships,omitempty"` // 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. Password *string `json:"password,omitempty" xmlrpc:"password,omitempty"` // A count of all permissions group(s) this volume is in. PermissionsGroupCount *uint `json:"permissionsGroupCount,omitempty" xmlrpc:"permissionsGroupCount,omitempty"` // All permissions group(s) this volume is in. PermissionsGroups []Network_Storage_Group `json:"permissionsGroups,omitempty" xmlrpc:"permissionsGroups,omitempty"` // The properties used to provide additional details about a network storage volume. Properties []Network_Storage_Property `json:"properties,omitempty" xmlrpc:"properties,omitempty"` // A count of the properties used to provide additional details about a network storage volume. PropertyCount *uint `json:"propertyCount,omitempty" xmlrpc:"propertyCount,omitempty"` // The number of IOPs provisioned for this volume. ProvisionedIops *string `json:"provisionedIops,omitempty" xmlrpc:"provisionedIops,omitempty"` // A count of the iSCSI LUN volumes being replicated by this network storage volume. ReplicatingLunCount *uint `json:"replicatingLunCount,omitempty" xmlrpc:"replicatingLunCount,omitempty"` // The iSCSI LUN volumes being replicated by this network storage volume. ReplicatingLuns []Network_Storage `json:"replicatingLuns,omitempty" xmlrpc:"replicatingLuns,omitempty"` // The network storage volume being replicated by a volume. ReplicatingVolume *Network_Storage `json:"replicatingVolume,omitempty" xmlrpc:"replicatingVolume,omitempty"` // A count of the volume replication events. ReplicationEventCount *uint `json:"replicationEventCount,omitempty" xmlrpc:"replicationEventCount,omitempty"` // The volume replication events. ReplicationEvents []Network_Storage_Event `json:"replicationEvents,omitempty" xmlrpc:"replicationEvents,omitempty"` // A count of the network storage volumes configured to be replicants of a volume. ReplicationPartnerCount *uint `json:"replicationPartnerCount,omitempty" xmlrpc:"replicationPartnerCount,omitempty"` // The network storage volumes configured to be replicants of a volume. ReplicationPartners []Network_Storage `json:"replicationPartners,omitempty" xmlrpc:"replicationPartners,omitempty"` // The Replication Schedule associated with a network storage volume. ReplicationSchedule *Network_Storage_Schedule `json:"replicationSchedule,omitempty" xmlrpc:"replicationSchedule,omitempty"` // The current replication status of a network storage volume. Indicates Failover or Failback status. ReplicationStatus *string `json:"replicationStatus,omitempty" xmlrpc:"replicationStatus,omitempty"` // A count of the schedules which are associated with a network storage volume. ScheduleCount *uint `json:"scheduleCount,omitempty" xmlrpc:"scheduleCount,omitempty"` // The schedules which are associated with a network storage volume. Schedules []Network_Storage_Schedule `json:"schedules,omitempty" xmlrpc:"schedules,omitempty"` // Service Provider ID ServiceProviderId *int `json:"serviceProviderId,omitempty" xmlrpc:"serviceProviderId,omitempty"` // The network resource a Storage service is connected to. ServiceResource *Network_Service_Resource `json:"serviceResource,omitempty" xmlrpc:"serviceResource,omitempty"` // The IP address of a Storage resource. ServiceResourceBackendIpAddress *string `json:"serviceResourceBackendIpAddress,omitempty" xmlrpc:"serviceResourceBackendIpAddress,omitempty"` // The name of a Storage's network resource. ServiceResourceName *string `json:"serviceResourceName,omitempty" xmlrpc:"serviceResourceName,omitempty"` // A volume's configured snapshot space size. SnapshotCapacityGb *string `json:"snapshotCapacityGb,omitempty" xmlrpc:"snapshotCapacityGb,omitempty"` // A count of the snapshots associated with this SoftLayer_Network_Storage volume. SnapshotCount *uint `json:"snapshotCount,omitempty" xmlrpc:"snapshotCount,omitempty"` // The creation timestamp of the snapshot on the storage platform. SnapshotCreationTimestamp *string `json:"snapshotCreationTimestamp,omitempty" xmlrpc:"snapshotCreationTimestamp,omitempty"` // The percentage of used snapshot space after which to delete automated snapshots. SnapshotDeletionThresholdPercentage *string `json:"snapshotDeletionThresholdPercentage,omitempty" xmlrpc:"snapshotDeletionThresholdPercentage,omitempty"` // Whether or not a network storage volume may be mounted. SnapshotNotificationStatus *string `json:"snapshotNotificationStatus,omitempty" xmlrpc:"snapshotNotificationStatus,omitempty"` // The snapshot size in bytes. SnapshotSizeBytes *string `json:"snapshotSizeBytes,omitempty" xmlrpc:"snapshotSizeBytes,omitempty"` // A volume's available snapshot reservation space. SnapshotSpaceAvailable *string `json:"snapshotSpaceAvailable,omitempty" xmlrpc:"snapshotSpaceAvailable,omitempty"` // The snapshots associated with this SoftLayer_Network_Storage volume. Snapshots []Network_Storage `json:"snapshots,omitempty" xmlrpc:"snapshots,omitempty"` // no documentation yet StaasVersion *string `json:"staasVersion,omitempty" xmlrpc:"staasVersion,omitempty"` // A count of the network storage groups this volume is attached to. StorageGroupCount *uint `json:"storageGroupCount,omitempty" xmlrpc:"storageGroupCount,omitempty"` // The network storage groups this volume is attached to. StorageGroups []Network_Storage_Group `json:"storageGroups,omitempty" xmlrpc:"storageGroups,omitempty"` // no documentation yet StorageTierLevel *string `json:"storageTierLevel,omitempty" xmlrpc:"storageTierLevel,omitempty"` // A description of the Storage object. StorageType *Network_Storage_Type `json:"storageType,omitempty" xmlrpc:"storageType,omitempty"` // A storage object's type. StorageTypeId *string `json:"storageTypeId,omitempty" xmlrpc:"storageTypeId,omitempty"` // The amount of space used by the volume. TotalBytesUsed *string `json:"totalBytesUsed,omitempty" xmlrpc:"totalBytesUsed,omitempty"` // The total snapshot retention count of all schedules on this network storage volume. TotalScheduleSnapshotRetentionCount *uint `json:"totalScheduleSnapshotRetentionCount,omitempty" xmlrpc:"totalScheduleSnapshotRetentionCount,omitempty"` // This flag indicates whether this storage type is upgradable or not. UpgradableFlag *bool `json:"upgradableFlag,omitempty" xmlrpc:"upgradableFlag,omitempty"` // The usage notification for SL Storage services. UsageNotification *Notification `json:"usageNotification,omitempty" xmlrpc:"usageNotification,omitempty"` // 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. Username *string `json:"username,omitempty" xmlrpc:"username,omitempty"` // The type of network storage service. VendorName *string `json:"vendorName,omitempty" xmlrpc:"vendorName,omitempty"` // When applicable, the virtual guest associated with a Storage service. VirtualGuest *Virtual_Guest `json:"virtualGuest,omitempty" xmlrpc:"virtualGuest,omitempty"` // The username and password history for a Storage service. VolumeHistory []Network_Storage_History `json:"volumeHistory,omitempty" xmlrpc:"volumeHistory,omitempty"` // A count of the username and password history for a Storage service. VolumeHistoryCount *uint `json:"volumeHistoryCount,omitempty" xmlrpc:"volumeHistoryCount,omitempty"` // The current status of a network storage volume. VolumeStatus *string `json:"volumeStatus,omitempty" xmlrpc:"volumeStatus,omitempty"` // The account username and password for the EVault webCC interface. WebccAccount *Account_Password `json:"webccAccount,omitempty" xmlrpc:"webccAccount,omitempty"` // The Weekly Schedule which is associated with this network storage volume. WeeklySchedule *Network_Storage_Schedule `json:"weeklySchedule,omitempty" xmlrpc:"weeklySchedule,omitempty"` }
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.
type Network_Storage_Allowed_Host ¶
type Network_Storage_Allowed_Host struct { Entity // The account to which this allowed host belongs to. AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // A count of the SoftLayer_Network_Storage_Group objects this SoftLayer_Network_Storage_Allowed_Host is present in. AssignedGroupCount *uint `json:"assignedGroupCount,omitempty" xmlrpc:"assignedGroupCount,omitempty"` // The SoftLayer_Network_Storage_Group objects this SoftLayer_Network_Storage_Allowed_Host is present in. AssignedGroups []Network_Storage_Group `json:"assignedGroups,omitempty" xmlrpc:"assignedGroups,omitempty"` // A count of the SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. AssignedIscsiVolumeCount *uint `json:"assignedIscsiVolumeCount,omitempty" xmlrpc:"assignedIscsiVolumeCount,omitempty"` // The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. AssignedIscsiVolumes []Network_Storage `json:"assignedIscsiVolumes,omitempty" xmlrpc:"assignedIscsiVolumes,omitempty"` // A count of the SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. AssignedNfsVolumeCount *uint `json:"assignedNfsVolumeCount,omitempty" xmlrpc:"assignedNfsVolumeCount,omitempty"` // The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. AssignedNfsVolumes []Network_Storage `json:"assignedNfsVolumes,omitempty" xmlrpc:"assignedNfsVolumes,omitempty"` // A count of the SoftLayer_Network_Storage primary volumes whose replicas are allowed access. AssignedReplicationVolumeCount *uint `json:"assignedReplicationVolumeCount,omitempty" xmlrpc:"assignedReplicationVolumeCount,omitempty"` // The SoftLayer_Network_Storage primary volumes whose replicas are allowed access. AssignedReplicationVolumes []Network_Storage `json:"assignedReplicationVolumes,omitempty" xmlrpc:"assignedReplicationVolumes,omitempty"` // A count of the SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. AssignedVolumeCount *uint `json:"assignedVolumeCount,omitempty" xmlrpc:"assignedVolumeCount,omitempty"` // The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access. AssignedVolumes []Network_Storage `json:"assignedVolumes,omitempty" xmlrpc:"assignedVolumes,omitempty"` // The SoftLayer_Network_Storage_Credential this allowed host uses. Credential *Network_Storage_Credential `json:"credential,omitempty" xmlrpc:"credential,omitempty"` // The credential this allowed host will use CredentialId *int `json:"credentialId,omitempty" xmlrpc:"credentialId,omitempty"` // The internal identifier of the igroup Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The name of allowed host, usually an IQN or other identifier Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // no documentation yet ResourceTableId *int `json:"resourceTableId,omitempty" xmlrpc:"resourceTableId,omitempty"` // no documentation yet ResourceTableName *string `json:"resourceTableName,omitempty" xmlrpc:"resourceTableName,omitempty"` // Connections to a target with a source IP in this subnet prefix are allowed. SourceSubnet *string `json:"sourceSubnet,omitempty" xmlrpc:"sourceSubnet,omitempty"` // The SoftLayer_Network_Subnet records assigned to the ACL for this allowed host. SubnetsInAcl []Network_Subnet `json:"subnetsInAcl,omitempty" xmlrpc:"subnetsInAcl,omitempty"` // A count of the SoftLayer_Network_Subnet records assigned to the ACL for this allowed host. SubnetsInAclCount *uint `json:"subnetsInAclCount,omitempty" xmlrpc:"subnetsInAclCount,omitempty"` }
no documentation yet
type Network_Storage_Allowed_Host_Hardware ¶
type Network_Storage_Allowed_Host_Hardware struct { Network_Storage_Allowed_Host // The SoftLayer_Account object which this SoftLayer_Network_Storage_Allowed_Host belongs to. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // The SoftLayer_Hardware object which this SoftLayer_Network_Storage_Allowed_Host is referencing. Resource *Hardware `json:"resource,omitempty" xmlrpc:"resource,omitempty"` }
no documentation yet
type Network_Storage_Allowed_Host_IpAddress ¶
type Network_Storage_Allowed_Host_IpAddress struct { Network_Storage_Allowed_Host // The SoftLayer_Account object which this SoftLayer_Network_Storage_Allowed_Host belongs to. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // The SoftLayer_Network_Subnet_IpAddress object which this SoftLayer_Network_Storage_Allowed_Host is referencing. Resource *Network_Subnet_IpAddress `json:"resource,omitempty" xmlrpc:"resource,omitempty"` }
no documentation yet
type Network_Storage_Allowed_Host_Subnet ¶
type Network_Storage_Allowed_Host_Subnet struct { Network_Storage_Allowed_Host // The SoftLayer_Account object which this SoftLayer_Network_Storage_Allowed_Host belongs to. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // The SoftLayer_Network_Subnet object which this SoftLayer_Network_Storage_Allowed_Host is referencing. Resource *Network_Subnet `json:"resource,omitempty" xmlrpc:"resource,omitempty"` }
no documentation yet
type Network_Storage_Allowed_Host_VirtualGuest ¶
type Network_Storage_Allowed_Host_VirtualGuest struct { Network_Storage_Allowed_Host // The SoftLayer_Account object which this SoftLayer_Network_Storage_Allowed_Host belongs to. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // The SoftLayer_Virtual_Guest object which this SoftLayer_Network_Storage_Allowed_Host is referencing. Resource *Virtual_Guest `json:"resource,omitempty" xmlrpc:"resource,omitempty"` }
no documentation yet
type Network_Storage_Backup ¶
type Network_Storage_Backup struct { Network_Storage // Peak number of bytes used in the vault for the current billing cycle. CurrentCyclePeakUsage *uint `json:"currentCyclePeakUsage,omitempty" xmlrpc:"currentCyclePeakUsage,omitempty"` // Peak number of bytes used in the vault for the previous billing cycle. PreviousCyclePeakUsage *uint `json:"previousCyclePeakUsage,omitempty" xmlrpc:"previousCyclePeakUsage,omitempty"` }
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.
type Network_Storage_Backup_Evault ¶
type Network_Storage_Backup_Evault struct {
Network_Storage_Backup
}
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.
type Network_Storage_Backup_Evault_Version6 ¶
type Network_Storage_Backup_Evault_Version6 struct { Network_Storage_Backup_Evault // A count of statuses (most of the time will be one status) for the agent tied to the EVault Storage services. AgentStatusCount *uint `json:"agentStatusCount,omitempty" xmlrpc:"agentStatusCount,omitempty"` // Statuses (most of the time will be one status) for the agent tied to the EVault Storage services. AgentStatuses []Container_Network_Storage_Evault_WebCc_AgentStatus `json:"agentStatuses,omitempty" xmlrpc:"agentStatuses,omitempty"` // A count of all the of the backup jobs for the EVault Storage account. BackupJobDetailCount *uint `json:"backupJobDetailCount,omitempty" xmlrpc:"backupJobDetailCount,omitempty"` // All the of the backup jobs for the EVault Storage account. BackupJobDetails []Container_Network_Storage_Evault_WebCc_JobDetails `json:"backupJobDetails,omitempty" xmlrpc:"backupJobDetails,omitempty"` // A count of the billing items for plugins tied to the EVault Storage service. PluginBillingItemCount *uint `json:"pluginBillingItemCount,omitempty" xmlrpc:"pluginBillingItemCount,omitempty"` // The billing items for plugins tied to the EVault Storage service. PluginBillingItems []Billing_Item `json:"pluginBillingItems,omitempty" xmlrpc:"pluginBillingItems,omitempty"` // A count of all the of the restore jobs for the EVault Storage account. RestoreJobDetailCount *uint `json:"restoreJobDetailCount,omitempty" xmlrpc:"restoreJobDetailCount,omitempty"` // All the of the restore jobs for the EVault Storage account. RestoreJobDetails []Container_Network_Storage_Evault_WebCc_JobDetails `json:"restoreJobDetails,omitempty" xmlrpc:"restoreJobDetails,omitempty"` // The software component for the EVault base client. SoftwareComponent *Software_Component `json:"softwareComponent,omitempty" xmlrpc:"softwareComponent,omitempty"` // A count of retrieve the task information for the EVault Storage service. TaskCount *uint `json:"taskCount,omitempty" xmlrpc:"taskCount,omitempty"` // Retrieve the task information for the EVault Storage service. Tasks []Container_Network_Storage_Evault_Vault_Task `json:"tasks,omitempty" xmlrpc:"tasks,omitempty"` }
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
type Network_Storage_Credential ¶
type Network_Storage_Credential struct { Entity // This is the account that the storage credential is tied to. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // This is the account id associated with the volume. AccountId *string `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // This is the data that the record was created in the table. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // This is the date that the record was last updated in the table. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // This is the id of the type of credential that this object represents. NasCredentialTypeId *int `json:"nasCredentialTypeId,omitempty" xmlrpc:"nasCredentialTypeId,omitempty"` // These are the SoftLayer_Network_Storage_Allowed_Host entries that this credential is assigned to. NetworkStorageAllowedHosts *Network_Storage_Allowed_Host `json:"networkStorageAllowedHosts,omitempty" xmlrpc:"networkStorageAllowedHosts,omitempty"` // This is the password associated with the volume. Password *string `json:"password,omitempty" xmlrpc:"password,omitempty"` // These are the types of storage that the credential can be assigned to. Type *Network_Storage_Credential_Type `json:"type,omitempty" xmlrpc:"type,omitempty"` // This is the username associated with the volume. Username *string `json:"username,omitempty" xmlrpc:"username,omitempty"` // A count of these are the SoftLayer_Network_Storage volumes that this credential is assigned to. VolumeCount *uint `json:"volumeCount,omitempty" xmlrpc:"volumeCount,omitempty"` // These are the SoftLayer_Network_Storage volumes that this credential is assigned to. Volumes []Network_Storage `json:"volumes,omitempty" xmlrpc:"volumes,omitempty"` }
The SoftLayer_Network_Storage_Credential data type will give you an overview of the usernames that are currently attached to your storage device.
type Network_Storage_Credential_Type ¶
type Network_Storage_Credential_Type struct { Entity // The date a credential type was created. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // A short description of the credential type Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // The key name of the credential type. KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // The date a credential was last modified. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // The human readable name of the credential type. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
<<<
type Network_Storage_Daily_Usage ¶
type Network_Storage_Daily_Usage struct { Entity // no documentation yet BytesUsed *uint `json:"bytesUsed,omitempty" xmlrpc:"bytesUsed,omitempty"` // no documentation yet CdnHttpBandwidth *uint `json:"cdnHttpBandwidth,omitempty" xmlrpc:"cdnHttpBandwidth,omitempty"` // no documentation yet CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // no documentation yet NasVolume *Network_Storage `json:"nasVolume,omitempty" xmlrpc:"nasVolume,omitempty"` // no documentation yet NasVolumeId *int `json:"nasVolumeId,omitempty" xmlrpc:"nasVolumeId,omitempty"` // no documentation yet PublicBandwidthOut *uint `json:"publicBandwidthOut,omitempty" xmlrpc:"publicBandwidthOut,omitempty"` }
no documentation yet
type Network_Storage_DedicatedCluster ¶ added in v1.0.3
type Network_Storage_DedicatedCluster struct { Entity // no documentation yet Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // The SoftLayer_Account->id of the customer account AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // The date when Dedicated service resource entry was created. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // The unique identifier for Dedicated service resource record. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet ServiceResource *Network_Service_Resource `json:"serviceResource,omitempty" xmlrpc:"serviceResource,omitempty"` // The cluster Id that is setup as dedicated for the customer. ServiceResourceId *int `json:"serviceResourceId,omitempty" xmlrpc:"serviceResourceId,omitempty"` }
no documentation yet
type Network_Storage_Event ¶
type Network_Storage_Event struct { Entity // The date an event was created. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // The message text for an event. Message *string `json:"message,omitempty" xmlrpc:"message,omitempty"` // A schedule that is associated with an event. Not all events will have a schedule. Schedule *Network_Storage_Schedule `json:"schedule,omitempty" xmlrpc:"schedule,omitempty"` // An identifier for the schedule which is associated with an event. ScheduleId *int `json:"scheduleId,omitempty" xmlrpc:"scheduleId,omitempty"` // A Storage volume's event type. The type provides a standardized definition for an event. Type *Network_Storage_Event_Type `json:"type,omitempty" xmlrpc:"type,omitempty"` // An identifier for the type of an event. TypeId *int `json:"typeId,omitempty" xmlrpc:"typeId,omitempty"` // The associated volume for an event. Volume *Network_Storage `json:"volume,omitempty" xmlrpc:"volume,omitempty"` // The volume id which an event is associated with. VolumeId *int `json:"volumeId,omitempty" xmlrpc:"volumeId,omitempty"` }
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.
type Network_Storage_Event_Type ¶
type Network_Storage_Event_Type struct { Entity // no documentation yet Keyname *string `json:"keyname,omitempty" xmlrpc:"keyname,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
no documentation yet
type Network_Storage_Group ¶
type Network_Storage_Group struct { Entity // The SoftLayer_Account which owns this group. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // The account ID which owns this group AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // The friendly name of this group Alias *string `json:"alias,omitempty" xmlrpc:"alias,omitempty"` // A count of the allowed hosts list for this group. AllowedHostCount *uint `json:"allowedHostCount,omitempty" xmlrpc:"allowedHostCount,omitempty"` // The allowed hosts list for this group. AllowedHosts []Network_Storage_Allowed_Host `json:"allowedHosts,omitempty" xmlrpc:"allowedHosts,omitempty"` // A count of the network storage volumes this group is attached to. AttachedVolumeCount *uint `json:"attachedVolumeCount,omitempty" xmlrpc:"attachedVolumeCount,omitempty"` // The network storage volumes this group is attached to. AttachedVolumes []Network_Storage `json:"attachedVolumes,omitempty" xmlrpc:"attachedVolumes,omitempty"` // The date this group was created. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // The type which defines this group. GroupType *Network_Storage_Group_Type `json:"groupType,omitempty" xmlrpc:"groupType,omitempty"` // The SoftLayer_Network_Storage_Group_Type which describes this group. GroupTypeId *int `json:"groupTypeId,omitempty" xmlrpc:"groupTypeId,omitempty"` // The internal identifier of the group Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // The OS Type this group is configured for. OsType *Network_Storage_Iscsi_OS_Type `json:"osType,omitempty" xmlrpc:"osType,omitempty"` // A SoftLayer_Network_Storage_OS_Type Operating System designation that this group was created for. OsTypeId *int `json:"osTypeId,omitempty" xmlrpc:"osTypeId,omitempty"` // The network resource this group is created on. ServiceResource *Network_Service_Resource `json:"serviceResource,omitempty" xmlrpc:"serviceResource,omitempty"` // A SoftLayer_Network_Service_Resource that this group was created on. ServiceResourceId *int `json:"serviceResourceId,omitempty" xmlrpc:"serviceResourceId,omitempty"` }
no documentation yet
type Network_Storage_Group_Iscsi ¶
type Network_Storage_Group_Iscsi struct {
Network_Storage_Group
}
no documentation yet
type Network_Storage_Group_Nfs ¶
type Network_Storage_Group_Nfs struct {
Network_Storage_Group
}
no documentation yet
type Network_Storage_Group_Type ¶
type Network_Storage_Group_Type struct { Entity // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
no documentation yet
type Network_Storage_History ¶
type Network_Storage_History struct { Entity // The account that the Storage services belongs to. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // Date the password was changed. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // The Storage service that the password history belongs to. NasVolume *Network_Storage `json:"nasVolume,omitempty" xmlrpc:"nasVolume,omitempty"` // Past notes for the Storage service. Notes *string `json:"notes,omitempty" xmlrpc:"notes,omitempty"` // Password for the Storage service that was used in the past. Password *string `json:"password,omitempty" xmlrpc:"password,omitempty"` // Username for the Storage service. Username *string `json:"username,omitempty" xmlrpc:"username,omitempty"` }
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.
type Network_Storage_Hub ¶
type Network_Storage_Hub struct { Network_Storage // A count of the billing items tied to a Storage service's bandwidth usage. BandwidthBillingItemCount *uint `json:"bandwidthBillingItemCount,omitempty" xmlrpc:"bandwidthBillingItemCount,omitempty"` // The billing items tied to a Storage service's bandwidth usage. BandwidthBillingItems []Billing_Item `json:"bandwidthBillingItems,omitempty" xmlrpc:"bandwidthBillingItems,omitempty"` }
The SoftLayer_Network_Storage_Hub data type models Virtual Server type Storage storage offerings.
type Network_Storage_Hub_Cleversafe_Account ¶
type Network_Storage_Hub_Cleversafe_Account struct { Entity // SoftLayer account to which an IBM Cloud Object Storage account belongs to. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // The ID of the SoftLayer_Account which this IBM Cloud Object Storage account is associated with. AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // An associated parent billing item which is active. Includes billing items which are scheduled to be cancelled in the future. BillingItem *Billing_Item `json:"billingItem,omitempty" xmlrpc:"billingItem,omitempty"` // An associated parent billing item which has been cancelled. CancelledBillingItem *Billing_Item `json:"cancelledBillingItem,omitempty" xmlrpc:"cancelledBillingItem,omitempty"` // A count of credentials used for generating an AWS signature. Max of 2. CredentialCount *uint `json:"credentialCount,omitempty" xmlrpc:"credentialCount,omitempty"` // Credentials used for generating an AWS signature. Max of 2. Credentials []Network_Storage_Credential `json:"credentials,omitempty" xmlrpc:"credentials,omitempty"` // The IMS ID of an IBM Cloud Object Storage account. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Provides an interface to various metrics relating to the usage of an IBM Cloud Object Storage account. MetricTrackingObject *Metric_Tracking_Object `json:"metricTrackingObject,omitempty" xmlrpc:"metricTrackingObject,omitempty"` // A user-defined field of notes. Notes *string `json:"notes,omitempty" xmlrpc:"notes,omitempty"` // Human readable identifier of IBM Cloud Object Storage accounts. Username *string `json:"username,omitempty" xmlrpc:"username,omitempty"` // Unique identifier for an IBM Cloud Object Storage account. Uuid *string `json:"uuid,omitempty" xmlrpc:"uuid,omitempty"` }
no documentation yet
type Network_Storage_Hub_Swift ¶
type Network_Storage_Hub_Swift struct { Network_Storage_Hub // A count of StorageNodeCount *uint `json:"storageNodeCount,omitempty" xmlrpc:"storageNodeCount,omitempty"` // no documentation yet StorageNodes []Network_Service_Resource `json:"storageNodes,omitempty" xmlrpc:"storageNodes,omitempty"` }
no documentation yet
type Network_Storage_Hub_Swift_Container ¶
type Network_Storage_Hub_Swift_Container struct {
Network_Storage_Hub_Swift
}
no documentation yet
type Network_Storage_Hub_Swift_Metrics ¶
type Network_Storage_Hub_Swift_Metrics struct {
Entity
}
no documentation yet
type Network_Storage_Hub_Swift_Share ¶
type Network_Storage_Hub_Swift_Share struct {
}no documentation yet
type Network_Storage_Hub_Swift_Version1 ¶
type Network_Storage_Hub_Swift_Version1 struct {
Network_Storage_Hub_Swift
}
no documentation yet
type Network_Storage_Iscsi ¶
type Network_Storage_Iscsi struct {
Network_Storage
}
The iscsi data type provides access to additional information about an iscsi volume such as the snapshot capacity limit and replication partners.
type Network_Storage_Iscsi_OS_Type ¶
type Network_Storage_Iscsi_OS_Type struct { Entity // The date this OS type record was created. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // The description of this OS type Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // The internal identifier of the OS type selection Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The key name of this OS type KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // The name of this OS type Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
no documentation yet
type Network_Storage_MassDataMigration_CrossRegion_Country_Xref ¶
type Network_Storage_MassDataMigration_CrossRegion_Country_Xref struct { Entity // SoftLayer_Locale_Country Id. Country *Locale_Country `json:"country,omitempty" xmlrpc:"country,omitempty"` // no documentation yet CountryId *int `json:"countryId,omitempty" xmlrpc:"countryId,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Location Group ID of CleverSafe cross region. LocationGroup *Location_Group `json:"locationGroup,omitempty" xmlrpc:"locationGroup,omitempty"` // no documentation yet LocationGroupId *int `json:"locationGroupId,omitempty" xmlrpc:"locationGroupId,omitempty"` }
no documentation yet
type Network_Storage_MassDataMigration_Request ¶
type Network_Storage_MassDataMigration_Request struct { Entity // The account to which the request belongs. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // The account id of the request. AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // A count of the active tickets that are attached to the MDMS request. ActiveTicketCount *uint `json:"activeTicketCount,omitempty" xmlrpc:"activeTicketCount,omitempty"` // The active tickets that are attached to the MDMS request. ActiveTickets []Ticket `json:"activeTickets,omitempty" xmlrpc:"activeTickets,omitempty"` // The customer address where the device is shipped to. Address *Account_Address `json:"address,omitempty" xmlrpc:"address,omitempty"` // The address id of address assigned to this request. AddressId *int `json:"addressId,omitempty" xmlrpc:"addressId,omitempty"` // An associated parent billing item which is active. Includes billing items which are scheduled to be cancelled in the future. BillingItem *Billing_Item `json:"billingItem,omitempty" xmlrpc:"billingItem,omitempty"` // The employee user who created the request. CreateEmployee *User_Employee `json:"createEmployee,omitempty" xmlrpc:"createEmployee,omitempty"` // The customer user who created the request. CreateUser *User_Customer `json:"createUser,omitempty" xmlrpc:"createUser,omitempty"` // The create user id of the request. CreateUserId *int `json:"createUserId,omitempty" xmlrpc:"createUserId,omitempty"` // The device configurations. DeviceConfiguration *Network_Storage_MassDataMigration_Request_DeviceConfiguration `json:"deviceConfiguration,omitempty" xmlrpc:"deviceConfiguration,omitempty"` // The model of device assigned to this request. DeviceModel *string `json:"deviceModel,omitempty" xmlrpc:"deviceModel,omitempty"` // The end date of the request. EndDate *Time `json:"endDate,omitempty" xmlrpc:"endDate,omitempty"` // The unique id of the request. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A count of the key contacts for this requests. KeyContactCount *uint `json:"keyContactCount,omitempty" xmlrpc:"keyContactCount,omitempty"` // The key contacts for this requests. KeyContacts []Network_Storage_MassDataMigration_Request_KeyContact `json:"keyContacts,omitempty" xmlrpc:"keyContacts,omitempty"` // The employee who last modified the request. ModifyEmployee *User_Employee `json:"modifyEmployee,omitempty" xmlrpc:"modifyEmployee,omitempty"` // The customer user who last modified the request. ModifyUser *User_Customer `json:"modifyUser,omitempty" xmlrpc:"modifyUser,omitempty"` // The modify user id of the request. ModifyUserId *int `json:"modifyUserId,omitempty" xmlrpc:"modifyUserId,omitempty"` // The unique id of the request. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // A count of the shipments of the request. ShipmentCount *uint `json:"shipmentCount,omitempty" xmlrpc:"shipmentCount,omitempty"` // The shipments of the request. Shipments []Account_Shipment `json:"shipments,omitempty" xmlrpc:"shipments,omitempty"` // The start date of the request. StartDate *Time `json:"startDate,omitempty" xmlrpc:"startDate,omitempty"` // The status of the request. Status *Network_Storage_MassDataMigration_Request_Status `json:"status,omitempty" xmlrpc:"status,omitempty"` // The status id of the request. StatusId *int `json:"statusId,omitempty" xmlrpc:"statusId,omitempty"` // Ticket that is attached to this mass data migration request. Ticket *Ticket `json:"ticket,omitempty" xmlrpc:"ticket,omitempty"` // A count of all tickets that are attached to the mass data migration request. TicketCount *uint `json:"ticketCount,omitempty" xmlrpc:"ticketCount,omitempty"` // All tickets that are attached to the mass data migration request. Tickets []Ticket `json:"tickets,omitempty" xmlrpc:"tickets,omitempty"` }
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.
type Network_Storage_MassDataMigration_Request_DeviceConfiguration ¶
type Network_Storage_MassDataMigration_Request_DeviceConfiguration struct { Entity // The account id. CosAccountId *int `json:"cosAccountId,omitempty" xmlrpc:"cosAccountId,omitempty"` // The Cloud Object Storage bucket. CosBucket *string `json:"cosBucket,omitempty" xmlrpc:"cosBucket,omitempty"` // The eth1 gateway for connecting to private network in datacenter. Eth1Gateway *string `json:"eth1Gateway,omitempty" xmlrpc:"eth1Gateway,omitempty"` // The eth1 IP address for connecting to private network in datacenter. Eth1IpAddress *string `json:"eth1IpAddress,omitempty" xmlrpc:"eth1IpAddress,omitempty"` // The eth1 netmask for connecting to private network in datacenter. Eth1Netmask *string `json:"eth1Netmask,omitempty" xmlrpc:"eth1Netmask,omitempty"` // The eth3 gateway for connecting to private network at customer's location. Eth3Gateway *string `json:"eth3Gateway,omitempty" xmlrpc:"eth3Gateway,omitempty"` // The eth3 IP address for connecting to private network at customer location. Eth3IpAddress *string `json:"eth3IpAddress,omitempty" xmlrpc:"eth3IpAddress,omitempty"` // The eth3 netmask for connecting to private network in at customer's location. Eth3Netmask *string `json:"eth3Netmask,omitempty" xmlrpc:"eth3Netmask,omitempty"` // The unique id of the request status. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The password for configuring network share. Password *string `json:"password,omitempty" xmlrpc:"password,omitempty"` // The pool lock password for configuring network share. PoolLockPassword *string `json:"poolLockPassword,omitempty" xmlrpc:"poolLockPassword,omitempty"` // The request this device configurations belongs to. Request *Network_Storage_MassDataMigration_Request `json:"request,omitempty" xmlrpc:"request,omitempty"` // The request id. RequestId *int `json:"requestId,omitempty" xmlrpc:"requestId,omitempty"` // The Cloud Object Storage bucket URL. S3Url *string `json:"s3Url,omitempty" xmlrpc:"s3Url,omitempty"` ShareName *string `json:"shareName,omitempty" xmlrpc:"shareName,omitempty"` // The storage account to use for this request. StorageAccount *Network_Storage_Hub_Cleversafe_Account `json:"storageAccount,omitempty" xmlrpc:"storageAccount,omitempty"` // The username for configuring network share. Username *string `json:"username,omitempty" xmlrpc:"username,omitempty"` }
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.
type Network_Storage_MassDataMigration_Request_KeyContact ¶
type Network_Storage_MassDataMigration_Request_KeyContact struct { Entity // The request this key contact belongs to. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // An account number that is linked to a KeyContact. AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // The date a KeyContact was created. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // KeyContact's Email Id. Email *string `json:"email,omitempty" xmlrpc:"email,omitempty"` // The unique id of the key contact. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The date a KeyContact was last modified. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // KeyContact's Name. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // A phone number assigned to a KeyContact. Phone *string `json:"phone,omitempty" xmlrpc:"phone,omitempty"` // The request this key contact belongs to. Request *Network_Storage_MassDataMigration_Request `json:"request,omitempty" xmlrpc:"request,omitempty"` // A request id that is linked to a KeyContact. RequestId *int `json:"requestId,omitempty" xmlrpc:"requestId,omitempty"` }
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.
type Network_Storage_MassDataMigration_Request_Status ¶
type Network_Storage_MassDataMigration_Request_Status struct { Entity // The description of the request status. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // The unique id of the request status. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The unique keyname of the request status. KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // The name of the request status. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
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.
type Network_Storage_Nas ¶
type Network_Storage_Nas struct { Network_Storage // no documentation yet RecentBytesUsed *Network_Storage_Daily_Usage `json:"recentBytesUsed,omitempty" xmlrpc:"recentBytesUsed,omitempty"` }
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.
type Network_Storage_Partnership ¶
type Network_Storage_Partnership struct { Entity // The date a partnership was created. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // The date a partnership was last modified. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // The associated child volume for a partnership. PartnerVolume *Network_Storage `json:"partnerVolume,omitempty" xmlrpc:"partnerVolume,omitempty"` // The child volume id which a partnership is associated with. PartnerVolumeId *int `json:"partnerVolumeId,omitempty" xmlrpc:"partnerVolumeId,omitempty"` // The type provides a standardized definition for a partnership. Type *Network_Storage_Partnership_Type `json:"type,omitempty" xmlrpc:"type,omitempty"` // The associated parent volume for a partnership. Volume *Network_Storage `json:"volume,omitempty" xmlrpc:"volume,omitempty"` // The volume id which a partnership is associated with. VolumeId *int `json:"volumeId,omitempty" xmlrpc:"volumeId,omitempty"` }
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.
type Network_Storage_Partnership_Type ¶
type Network_Storage_Partnership_Type struct { Entity // A type's description, for example 'ISCSI snapshot partnership'. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // A type's key name, for example 'ISCSI_SNAPSHOT'. Keyname *string `json:"keyname,omitempty" xmlrpc:"keyname,omitempty"` // A type's name, for example 'ISCSI Snapshot'. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
A network storage partnership type is used to define the link between two volumes.
type Network_Storage_Property ¶
type Network_Storage_Property struct { Entity // The date a property was created. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // The date a property was last modified; ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // The type provides a standardized definition for a property. Type *Network_Storage_Property_Type `json:"type,omitempty" xmlrpc:"type,omitempty"` // The value of a property. Value *string `json:"value,omitempty" xmlrpc:"value,omitempty"` // The associated volume for a property. Volume *Network_Storage `json:"volume,omitempty" xmlrpc:"volume,omitempty"` // The volume id which a property is associated with. VolumeId *int `json:"volumeId,omitempty" xmlrpc:"volumeId,omitempty"` }
A property provides additional information about a volume which it is assigned to. This information can range from "Mountable" flags to utilized snapshot space.
type Network_Storage_Property_Type ¶
type Network_Storage_Property_Type struct { Entity // A type's description, for example 'Determines whether the volume is currently mountable'. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // A type's keyname, for example 'MOUNTABLE'. Keyname *string `json:"keyname,omitempty" xmlrpc:"keyname,omitempty"` // A type's name, for example 'Mountable'. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
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.
type Network_Storage_Replicant ¶
type Network_Storage_Replicant struct { Network_Storage // When a replicant is in the process of synchronizing with the parent volume this flag will be true. FailbackInProgressFlag *string `json:"failbackInProgressFlag,omitempty" xmlrpc:"failbackInProgressFlag,omitempty"` // The volume name for a replicant. VolumeName *string `json:"volumeName,omitempty" xmlrpc:"volumeName,omitempty"` }
no documentation yet
type Network_Storage_Schedule ¶
type Network_Storage_Schedule struct { Entity // A flag which determines if a schedule is active. Active *int `json:"active,omitempty" xmlrpc:"active,omitempty"` // The date a schedule was created. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // The hour parameter of this schedule. Day *string `json:"day,omitempty" xmlrpc:"day,omitempty"` // The day of the month parameter of this schedule. DayOfMonth *string `json:"dayOfMonth,omitempty" xmlrpc:"dayOfMonth,omitempty"` // The day of the week parameter of this schedule. DayOfWeek *string `json:"dayOfWeek,omitempty" xmlrpc:"dayOfWeek,omitempty"` // A count of events which have been created as the result of a schedule execution. EventCount *uint `json:"eventCount,omitempty" xmlrpc:"eventCount,omitempty"` // Events which have been created as the result of a schedule execution. Events []Network_Storage_Event `json:"events,omitempty" xmlrpc:"events,omitempty"` // The hour parameter of this schedule. Hour *string `json:"hour,omitempty" xmlrpc:"hour,omitempty"` // A schedule's internal identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The minute parameter of this schedule. Minute *string `json:"minute,omitempty" xmlrpc:"minute,omitempty"` // The date a schedule was last modified. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // The month of the year parameter of this schedule. MonthOfYear *string `json:"monthOfYear,omitempty" xmlrpc:"monthOfYear,omitempty"` // A schedule's name, for example 'Daily'. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // The associated partnership for a schedule. Partnership *Network_Storage_Partnership `json:"partnership,omitempty" xmlrpc:"partnership,omitempty"` // The partnership id which a schedule is associated with. PartnershipId *int `json:"partnershipId,omitempty" xmlrpc:"partnershipId,omitempty"` // Properties used for configuration of a schedule. Properties []Network_Storage_Schedule_Property `json:"properties,omitempty" xmlrpc:"properties,omitempty"` // A count of properties used for configuration of a schedule. PropertyCount *uint `json:"propertyCount,omitempty" xmlrpc:"propertyCount,omitempty"` // A count of replica snapshots which have been created as the result of this schedule's execution. ReplicaSnapshotCount *uint `json:"replicaSnapshotCount,omitempty" xmlrpc:"replicaSnapshotCount,omitempty"` // Replica snapshots which have been created as the result of this schedule's execution. ReplicaSnapshots []Network_Storage `json:"replicaSnapshots,omitempty" xmlrpc:"replicaSnapshots,omitempty"` // The number of snapshots this schedule is configured to retain. RetentionCount *string `json:"retentionCount,omitempty" xmlrpc:"retentionCount,omitempty"` // The minute parameter of this schedule. Second *string `json:"second,omitempty" xmlrpc:"second,omitempty"` // A count of snapshots which have been created as the result of this schedule's execution. SnapshotCount *uint `json:"snapshotCount,omitempty" xmlrpc:"snapshotCount,omitempty"` // Snapshots which have been created as the result of this schedule's execution. Snapshots []Network_Storage `json:"snapshots,omitempty" xmlrpc:"snapshots,omitempty"` // The type provides a standardized definition for a schedule. Type *Network_Storage_Schedule_Type `json:"type,omitempty" xmlrpc:"type,omitempty"` // The type id which a schedule is associated with. TypeId *int `json:"typeId,omitempty" xmlrpc:"typeId,omitempty"` // The associated volume for a schedule. Volume *Network_Storage `json:"volume,omitempty" xmlrpc:"volume,omitempty"` // The volume id which a schedule is associated with. VolumeId *int `json:"volumeId,omitempty" xmlrpc:"volumeId,omitempty"` }
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.
type Network_Storage_Schedule_Property ¶
type Network_Storage_Schedule_Property struct { Entity // The date a schedule property was created. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // A schedule property's internal identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The date a schedule property was last modified. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // The associated schedule for a property. Schedule *Network_Storage_Schedule `json:"schedule,omitempty" xmlrpc:"schedule,omitempty"` // The type provides a standardized definition for a property. Type *Network_Storage_Schedule_Property_Type `json:"type,omitempty" xmlrpc:"type,omitempty"` // An identifier for the type of a property. TypeId *int `json:"typeId,omitempty" xmlrpc:"typeId,omitempty"` // The value of a property. Value *string `json:"value,omitempty" xmlrpc:"value,omitempty"` }
Schedule properties provide attributes such as start date, end date, interval, and other properties to a storage schedule.
type Network_Storage_Schedule_Property_Type ¶
type Network_Storage_Schedule_Property_Type struct { Entity // A type's description, for example 'Date for the schedule to start.'. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // A schedule property type's internal identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A schedule property type's key name, for example 'START_DATE'. Keyname *string `json:"keyname,omitempty" xmlrpc:"keyname,omitempty"` // A schedule property type's name, for example 'Start Date'. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // The type of Storage volume type which a property type may be associated with. NasType *string `json:"nasType,omitempty" xmlrpc:"nasType,omitempty"` }
A schedule property type is used to allow for a standardized method of defining network storage schedules.
type Network_Storage_Schedule_Type ¶
type Network_Storage_Schedule_Type struct { Entity // A schedule type's internal identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A schedule type's key name, for example 'SNAPSHOT'. Keyname *string `json:"keyname,omitempty" xmlrpc:"keyname,omitempty"` // A schedule type's name, for example 'Snapshot'. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
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.
type Network_Storage_Snapshot ¶
type Network_Storage_Snapshot struct { Network_Storage // If applicable, the schedule which was executed to create a snapshot. CreationSchedule *Network_Storage_Schedule `json:"creationSchedule,omitempty" xmlrpc:"creationSchedule,omitempty"` // The volume name for the snapshot. VolumeName *string `json:"volumeName,omitempty" xmlrpc:"volumeName,omitempty"` }
no documentation yet
type Network_Storage_Type ¶
type Network_Storage_Type struct { Entity // Human readable description for the associated SoftLayer_Network_Storage object. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // ID which corresponds with storageTypeId on storage objects. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Machine readable description code for the associated SoftLayer_Network_Storage object. KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // A count of the SoftLayer_Network_Storage object that uses this type. VolumeCount *uint `json:"volumeCount,omitempty" xmlrpc:"volumeCount,omitempty"` // The SoftLayer_Network_Storage object that uses this type. Volumes []Network_Storage `json:"volumes,omitempty" xmlrpc:"volumes,omitempty"` }
The SoftLayer_Network_Storage_Type contains a description of the associated SoftLayer_Network_Storage object.
type Network_Subnet ¶
type Network_Subnet struct { Entity // no documentation yet Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // The active regional internet registration for this subnet. ActiveRegistration *Network_Subnet_Registration `json:"activeRegistration,omitempty" xmlrpc:"activeRegistration,omitempty"` // DEPRECATED // Deprecated: This function has been marked as deprecated. ActiveSwipTransaction *Network_Subnet_Swip_Transaction `json:"activeSwipTransaction,omitempty" xmlrpc:"activeSwipTransaction,omitempty"` // DEPRECATED // Deprecated: This function has been marked as deprecated. ActiveTransaction *Provisioning_Version1_Transaction `json:"activeTransaction,omitempty" xmlrpc:"activeTransaction,omitempty"` // The classifier of IP addresses this subnet represents, generally PUBLIC or PRIVATE. This does not necessarily correlate with the network on which the subnet is used. AddressSpace *string `json:"addressSpace,omitempty" xmlrpc:"addressSpace,omitempty"` // The link from this subnet to network storage devices supporting access control lists. AllowedHost *Network_Storage_Allowed_Host `json:"allowedHost,omitempty" xmlrpc:"allowedHost,omitempty"` // The network storage devices this subnet has been granted access to. AllowedNetworkStorage []Network_Storage `json:"allowedNetworkStorage,omitempty" xmlrpc:"allowedNetworkStorage,omitempty"` // A count of the network storage devices this subnet has been granted access to. AllowedNetworkStorageCount *uint `json:"allowedNetworkStorageCount,omitempty" xmlrpc:"allowedNetworkStorageCount,omitempty"` // A count of the network storage device replicas this subnet has been granted access to. AllowedNetworkStorageReplicaCount *uint `json:"allowedNetworkStorageReplicaCount,omitempty" xmlrpc:"allowedNetworkStorageReplicaCount,omitempty"` // The network storage device replicas this subnet has been granted access to. AllowedNetworkStorageReplicas []Network_Storage `json:"allowedNetworkStorageReplicas,omitempty" xmlrpc:"allowedNetworkStorageReplicas,omitempty"` // The active billing item for this subnet. BillingItem *Billing_Item `json:"billingItem,omitempty" xmlrpc:"billingItem,omitempty"` // A count of BoundDescendantCount *uint `json:"boundDescendantCount,omitempty" xmlrpc:"boundDescendantCount,omitempty"` // no documentation yet BoundDescendants []Network_Subnet `json:"boundDescendants,omitempty" xmlrpc:"boundDescendants,omitempty"` // A count of the list of network routers that this subnet is directly associated with, defining where this subnet may be routed on the network. BoundRouterCount *uint `json:"boundRouterCount,omitempty" xmlrpc:"boundRouterCount,omitempty"` // Indicates whether this subnet is associated to a network router and is routable on the network. BoundRouterFlag *bool `json:"boundRouterFlag,omitempty" xmlrpc:"boundRouterFlag,omitempty"` // The list of network routers that this subnet is directly associated with, defining where this subnet may be routed on the network. BoundRouters []Hardware `json:"boundRouters,omitempty" xmlrpc:"boundRouters,omitempty"` // The IP address of this subnet reserved for use as a broadcast address and which is unavailable for other use. Network traffic targeting this IP address will be broadcast to the entire subnet. BroadcastAddress *string `json:"broadcastAddress,omitempty" xmlrpc:"broadcastAddress,omitempty"` // The immediate descendants of this subnet. Children []Network_Subnet `json:"children,omitempty" xmlrpc:"children,omitempty"` // A count of the immediate descendants of this subnet. ChildrenCount *uint `json:"childrenCount,omitempty" xmlrpc:"childrenCount,omitempty"` // The Classless Inter-Domain Routing prefix of this subnet, which specifies the range of spanned IP addresses. // // [Classless_Inter-Domain_Routing at Wikipedia](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) Cidr *int `json:"cidr,omitempty" xmlrpc:"cidr,omitempty"` // The datacenter this subnet is primarily associated with. Datacenter *Location_Datacenter `json:"datacenter,omitempty" xmlrpc:"datacenter,omitempty"` // A count of the descendants of this subnet, including all parents and children. DescendantCount *uint `json:"descendantCount,omitempty" xmlrpc:"descendantCount,omitempty"` // The descendants of this subnet, including all parents and children. Descendants []Network_Subnet `json:"descendants,omitempty" xmlrpc:"descendants,omitempty"` // [DEPRECATED] The description of this subnet. // Deprecated: This function has been marked as deprecated. DisplayLabel *string `json:"displayLabel,omitempty" xmlrpc:"displayLabel,omitempty"` // The IP address target of this statically routed subnet. EndPointIpAddress *Network_Subnet_IpAddress `json:"endPointIpAddress,omitempty" xmlrpc:"endPointIpAddress,omitempty"` // The IP address of this subnet reserved for use on the router as a gateway address and which is unavailable for other use. Gateway *string `json:"gateway,omitempty" xmlrpc:"gateway,omitempty"` // no documentation yet GlobalIpRecord *Network_Subnet_IpAddress_Global `json:"globalIpRecord,omitempty" xmlrpc:"globalIpRecord,omitempty"` // The Bare Metal devices which have been assigned a primary IP address from this subnet. Hardware []Hardware `json:"hardware,omitempty" xmlrpc:"hardware,omitempty"` // A count of the Bare Metal devices which have been assigned a primary IP address from this subnet. HardwareCount *uint `json:"hardwareCount,omitempty" xmlrpc:"hardwareCount,omitempty"` // The unique identifier of this subnet. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A count of the IP address records belonging to this subnet. IpAddressCount *uint `json:"ipAddressCount,omitempty" xmlrpc:"ipAddressCount,omitempty"` // The IP address records belonging to this subnet. IpAddresses []Network_Subnet_IpAddress `json:"ipAddresses,omitempty" xmlrpc:"ipAddresses,omitempty"` // Indicates whether this subnet is owned by the assigned account. IsCustomerOwned *bool `json:"isCustomerOwned,omitempty" xmlrpc:"isCustomerOwned,omitempty"` // Indicates whether the route type of this subnet may be altered. IsCustomerRoutable *bool `json:"isCustomerRoutable,omitempty" xmlrpc:"isCustomerRoutable,omitempty"` // The time this subnet was last modified ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // The bitmask in dotted-quad format for this subnet, which specifies the range of spanned IP addresses. Netmask *string `json:"netmask,omitempty" xmlrpc:"netmask,omitempty"` // The hardware firewall associated to this subnet via access control list. NetworkComponentFirewall *Network_Component_Firewall `json:"networkComponentFirewall,omitempty" xmlrpc:"networkComponentFirewall,omitempty"` // The first IP address of this subnet. NetworkIdentifier *string `json:"networkIdentifier,omitempty" xmlrpc:"networkIdentifier,omitempty"` // A count of NetworkProtectionAddressCount *uint `json:"networkProtectionAddressCount,omitempty" xmlrpc:"networkProtectionAddressCount,omitempty"` // no documentation yet NetworkProtectionAddresses []Network_Protection_Address `json:"networkProtectionAddresses,omitempty" xmlrpc:"networkProtectionAddresses,omitempty"` // A count of the IPSec VPN tunnels associated to this subnet. NetworkTunnelContextCount *uint `json:"networkTunnelContextCount,omitempty" xmlrpc:"networkTunnelContextCount,omitempty"` // The IPSec VPN tunnels associated to this subnet. NetworkTunnelContexts []Network_Tunnel_Module_Context `json:"networkTunnelContexts,omitempty" xmlrpc:"networkTunnelContexts,omitempty"` // The VLAN this subnet is associated with. NetworkVlan *Network_Vlan `json:"networkVlan,omitempty" xmlrpc:"networkVlan,omitempty"` // The identifier of the VLAN associated to this subnet. NetworkVlanId *int `json:"networkVlanId,omitempty" xmlrpc:"networkVlanId,omitempty"` // The customer description of this subnet. Note *string `json:"note,omitempty" xmlrpc:"note,omitempty"` // The pod in which this subnet is currently routed. PodName *string `json:"podName,omitempty" xmlrpc:"podName,omitempty"` // A count of ProtectedIpAddressCount *uint `json:"protectedIpAddressCount,omitempty" xmlrpc:"protectedIpAddressCount,omitempty"` // no documentation yet ProtectedIpAddresses []Network_Subnet_IpAddress `json:"protectedIpAddresses,omitempty" xmlrpc:"protectedIpAddresses,omitempty"` // The RIR which is authoritative over the network in which this subnet resides. RegionalInternetRegistry *Network_Regional_Internet_Registry `json:"regionalInternetRegistry,omitempty" xmlrpc:"regionalInternetRegistry,omitempty"` // A count of the regional internet registrations that have been created for this subnet. RegistrationCount *uint `json:"registrationCount,omitempty" xmlrpc:"registrationCount,omitempty"` // The regional internet registrations that have been created for this subnet. Registrations []Network_Subnet_Registration `json:"registrations,omitempty" xmlrpc:"registrations,omitempty"` // The reverse DNS domain associated with this subnet. ReverseDomain *Dns_Domain `json:"reverseDomain,omitempty" xmlrpc:"reverseDomain,omitempty"` // The role identifier that this subnet is participating in. Roles dictate how a subnet may be used. RoleKeyName *string `json:"roleKeyName,omitempty" xmlrpc:"roleKeyName,omitempty"` // The name of the role the subnet is within. Roles dictate how a subnet may be used. RoleName *string `json:"roleName,omitempty" xmlrpc:"roleName,omitempty"` // The product and route classifier for this routed subnet, with the following values: PRIMARY, SECONDARY, STATIC_TO_IP, GLOBAL_IP, IPSEC_STATIC_NAT. RoutingTypeKeyName *string `json:"routingTypeKeyName,omitempty" xmlrpc:"routingTypeKeyName,omitempty"` // The description of the product and route classifier for this routed subnet, with the following values: Primary, Portable, Static, Global, IPSec Static NAT. RoutingTypeName *string `json:"routingTypeName,omitempty" xmlrpc:"routingTypeName,omitempty"` // [DEPRECATED] Used to sort subnets and group subnets of similar type together for use on customer facing portals. // Deprecated: This function has been marked as deprecated. SortOrder *string `json:"sortOrder,omitempty" xmlrpc:"sortOrder,omitempty"` // The product and route classifier for this routed subnet, with the following values: // * PRIMARY // * ADDITIONAL_PRIMARY // * SECONDARY_ON_VLAN // * STATIC_IP_ROUTED // * PRIMARY_6 // * SUBNET_ON_VLAN // * STATIC_IP_ROUTED_6 // * GLOBAL_IP // * IPSEC_STATIC_NAT // // // "PRIMARY" refers to the principal IPv4 network from which primary IP addresses are assigned to devices. // // "ADDITIONAL_PRIMARY" refers to extra IPv4 networks from which primary IP addresses are assigned to devices. // // "SECONDARY_ON_VLAN" refers to a secondary IPv4 subnet routed as portable. // // "STATIC_IP_ROUTED" refers to a secondary IPv4 subnet routed as static to a single endpoint IPv4 address. // // "PRIMARY_6" refers to the IPv6 network from which primary IPv6 addresses are assigned to devices. // // "SUBNET_ON_VLAN" refers to a secondary IPv6 subnet routed as portable. // // "STATIC_IP_ROUTED_6" refers to a secondary IPv6 subnet routed as static to a single endpoint IPv6 address. // // "GLOBAL_IP" refers to a global IPv4/IPv6 address routed as static to a single endpoint IP address. // // "IPSEC_STATIC_NAT" refers to the networks associated to your IPSec VPN tunnels for NAT purposes. SubnetType *string `json:"subnetType,omitempty" xmlrpc:"subnetType,omitempty"` // DEPRECATED // Deprecated: This function has been marked as deprecated. SwipTransaction []Network_Subnet_Swip_Transaction `json:"swipTransaction,omitempty" xmlrpc:"swipTransaction,omitempty"` // A count of dEPRECATED SwipTransactionCount *uint `json:"swipTransactionCount,omitempty" xmlrpc:"swipTransactionCount,omitempty"` // A count of the tags associated to this subnet. TagReferenceCount *uint `json:"tagReferenceCount,omitempty" xmlrpc:"tagReferenceCount,omitempty"` // The tags associated to this subnet. TagReferences []Tag_Reference `json:"tagReferences,omitempty" xmlrpc:"tagReferences,omitempty"` // The number of IP addresses in this subnet. TotalIpAddresses *Float64 `json:"totalIpAddresses,omitempty" xmlrpc:"totalIpAddresses,omitempty"` // A count of UnboundDescendantCount *uint `json:"unboundDescendantCount,omitempty" xmlrpc:"unboundDescendantCount,omitempty"` // no documentation yet UnboundDescendants []Network_Subnet `json:"unboundDescendants,omitempty" xmlrpc:"unboundDescendants,omitempty"` // 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. UsableIpAddressCount *Float64 `json:"usableIpAddressCount,omitempty" xmlrpc:"usableIpAddressCount,omitempty"` // 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 subnets. UtilizedIpAddressCount *uint `json:"utilizedIpAddressCount,omitempty" xmlrpc:"utilizedIpAddressCount,omitempty"` // The Internet Protocol version of this subnet, either 4 or 6. Version *int `json:"version,omitempty" xmlrpc:"version,omitempty"` // A count of the Virtual Server devices which have been assigned a primary IP address from this subnet. VirtualGuestCount *uint `json:"virtualGuestCount,omitempty" xmlrpc:"virtualGuestCount,omitempty"` // The Virtual Server devices which have been assigned a primary IP address from this subnet. VirtualGuests []Virtual_Guest `json:"virtualGuests,omitempty" xmlrpc:"virtualGuests,omitempty"` }
A subnet represents a continguous range of IP addresses. The range is represented by the networkIdentifer and cidr/netmask properties. The version of a subnet, whether IPv4 or IPv6, is represented by the version property.
When routed, a subnet is associated to a VLAN on your account, which defines its scope on the network. Depending on a subnet's route type, IP addresses may be reserved for network and internal functions, the most common of which is the allocation of network, gateway and broadcast IP addresses.
An unrouted subnet is not active on the network and may generally be routed within the datacenter in which it resides.
[Subnetwork at Wikipedia](http://en.wikipedia.org/wiki/Subnetwork)
[RFC950:Internet Standard Subnetting Procedure](http://datatracker.ietf.org/doc/html/rfc950)
type Network_Subnet_IpAddress ¶
type Network_Subnet_IpAddress struct { Entity // The SoftLayer_Network_Storage_Allowed_Host information to connect this IP Address to Network Storage supporting access control lists. AllowedHost *Network_Storage_Allowed_Host `json:"allowedHost,omitempty" xmlrpc:"allowedHost,omitempty"` // The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to. AllowedNetworkStorage []Network_Storage `json:"allowedNetworkStorage,omitempty" xmlrpc:"allowedNetworkStorage,omitempty"` // A count of the SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to. AllowedNetworkStorageCount *uint `json:"allowedNetworkStorageCount,omitempty" xmlrpc:"allowedNetworkStorageCount,omitempty"` // A count of the SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to. AllowedNetworkStorageReplicaCount *uint `json:"allowedNetworkStorageReplicaCount,omitempty" xmlrpc:"allowedNetworkStorageReplicaCount,omitempty"` // The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to. AllowedNetworkStorageReplicas []Network_Storage `json:"allowedNetworkStorageReplicas,omitempty" xmlrpc:"allowedNetworkStorageReplicas,omitempty"` // The application delivery controller using this address. ApplicationDeliveryController *Network_Application_Delivery_Controller `json:"applicationDeliveryController,omitempty" xmlrpc:"applicationDeliveryController,omitempty"` // 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. ContextTunnelTranslationCount *uint `json:"contextTunnelTranslationCount,omitempty" xmlrpc:"contextTunnelTranslationCount,omitempty"` // 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. ContextTunnelTranslations []Network_Tunnel_Module_Context_Address_Translation `json:"contextTunnelTranslations,omitempty" xmlrpc:"contextTunnelTranslations,omitempty"` // A count of all the subnets routed to an IP address. EndpointSubnetCount *uint `json:"endpointSubnetCount,omitempty" xmlrpc:"endpointSubnetCount,omitempty"` // All the subnets routed to an IP address. EndpointSubnets []Network_Subnet `json:"endpointSubnets,omitempty" xmlrpc:"endpointSubnets,omitempty"` // A network component that is statically routed to an IP address. GuestNetworkComponent *Virtual_Guest_Network_Component `json:"guestNetworkComponent,omitempty" xmlrpc:"guestNetworkComponent,omitempty"` // A network component that is statically routed to an IP address. GuestNetworkComponentBinding *Virtual_Guest_Network_Component_IpAddress `json:"guestNetworkComponentBinding,omitempty" xmlrpc:"guestNetworkComponentBinding,omitempty"` // A server that this IP address is routed to. Hardware *Hardware `json:"hardware,omitempty" xmlrpc:"hardware,omitempty"` // An IP's internal identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // An IP address expressed in dotted quad format. IpAddress *string `json:"ipAddress,omitempty" xmlrpc:"ipAddress,omitempty"` // Indicates if an IP address is reserved to be used as the network broadcast address and cannot be assigned to a network interface IsBroadcast *bool `json:"isBroadcast,omitempty" xmlrpc:"isBroadcast,omitempty"` // Indicates if an IP address is reserved to a gateway and cannot be assigned to a network interface IsGateway *bool `json:"isGateway,omitempty" xmlrpc:"isGateway,omitempty"` // Indicates if an IP address is reserved to a network address and cannot be assigned to a network interface IsNetwork *bool `json:"isNetwork,omitempty" xmlrpc:"isNetwork,omitempty"` // Indicates if an IP address is reserved and cannot be assigned to a network interface IsReserved *bool `json:"isReserved,omitempty" xmlrpc:"isReserved,omitempty"` // A network component that is statically routed to an IP address. NetworkComponent *Network_Component `json:"networkComponent,omitempty" xmlrpc:"networkComponent,omitempty"` // An IP address' user defined note. Note *string `json:"note,omitempty" xmlrpc:"note,omitempty"` // The network gateway appliance using this address as the private IP address. PrivateNetworkGateway *Network_Gateway `json:"privateNetworkGateway,omitempty" xmlrpc:"privateNetworkGateway,omitempty"` // no documentation yet ProtectionAddress []Network_Protection_Address `json:"protectionAddress,omitempty" xmlrpc:"protectionAddress,omitempty"` // A count of ProtectionAddressCount *uint `json:"protectionAddressCount,omitempty" xmlrpc:"protectionAddressCount,omitempty"` // The network gateway appliance using this address as the public IP address. PublicNetworkGateway *Network_Gateway `json:"publicNetworkGateway,omitempty" xmlrpc:"publicNetworkGateway,omitempty"` // An IPMI-based management network component of the IP address. RemoteManagementNetworkComponent *Network_Component `json:"remoteManagementNetworkComponent,omitempty" xmlrpc:"remoteManagementNetworkComponent,omitempty"` // An IP address' associated subnet. Subnet *Network_Subnet `json:"subnet,omitempty" xmlrpc:"subnet,omitempty"` // An IP address' subnet id. SubnetId *int `json:"subnetId,omitempty" xmlrpc:"subnetId,omitempty"` // All events for this IP address stored in the datacenter syslogs from the last 24 hours SyslogEventsOneDay []Network_Logging_Syslog `json:"syslogEventsOneDay,omitempty" xmlrpc:"syslogEventsOneDay,omitempty"` // A count of all events for this IP address stored in the datacenter syslogs from the last 24 hours SyslogEventsOneDayCount *uint `json:"syslogEventsOneDayCount,omitempty" xmlrpc:"syslogEventsOneDayCount,omitempty"` // A count of all events for this IP address stored in the datacenter syslogs from the last 7 days SyslogEventsSevenDayCount *uint `json:"syslogEventsSevenDayCount,omitempty" xmlrpc:"syslogEventsSevenDayCount,omitempty"` // All events for this IP address stored in the datacenter syslogs from the last 7 days SyslogEventsSevenDays []Network_Logging_Syslog `json:"syslogEventsSevenDays,omitempty" xmlrpc:"syslogEventsSevenDays,omitempty"` // Top Ten network datacenter syslog events, grouped by destination port, for the last 24 hours TopTenSyslogEventsByDestinationPortOneDay []Network_Logging_Syslog `json:"topTenSyslogEventsByDestinationPortOneDay,omitempty" xmlrpc:"topTenSyslogEventsByDestinationPortOneDay,omitempty"` // A count of top Ten network datacenter syslog events, grouped by destination port, for the last 24 hours TopTenSyslogEventsByDestinationPortOneDayCount *uint `` /* 129-byte string literal not displayed */ // A count of top Ten network datacenter syslog events, grouped by destination port, for the last 7 days TopTenSyslogEventsByDestinationPortSevenDayCount *uint `` /* 133-byte string literal not displayed */ // Top Ten network datacenter syslog events, grouped by destination port, for the last 7 days TopTenSyslogEventsByDestinationPortSevenDays []Network_Logging_Syslog `json:"topTenSyslogEventsByDestinationPortSevenDays,omitempty" xmlrpc:"topTenSyslogEventsByDestinationPortSevenDays,omitempty"` // Top Ten network datacenter syslog events, grouped by source port, for the last 24 hours TopTenSyslogEventsByProtocolsOneDay []Network_Logging_Syslog `json:"topTenSyslogEventsByProtocolsOneDay,omitempty" xmlrpc:"topTenSyslogEventsByProtocolsOneDay,omitempty"` // A count of top Ten network datacenter syslog events, grouped by source port, for the last 24 hours TopTenSyslogEventsByProtocolsOneDayCount *uint `json:"topTenSyslogEventsByProtocolsOneDayCount,omitempty" xmlrpc:"topTenSyslogEventsByProtocolsOneDayCount,omitempty"` // A count of top Ten network datacenter syslog events, grouped by source port, for the last 7 days TopTenSyslogEventsByProtocolsSevenDayCount *uint `json:"topTenSyslogEventsByProtocolsSevenDayCount,omitempty" xmlrpc:"topTenSyslogEventsByProtocolsSevenDayCount,omitempty"` // Top Ten network datacenter syslog events, grouped by source port, for the last 7 days TopTenSyslogEventsByProtocolsSevenDays []Network_Logging_Syslog `json:"topTenSyslogEventsByProtocolsSevenDays,omitempty" xmlrpc:"topTenSyslogEventsByProtocolsSevenDays,omitempty"` // Top Ten network datacenter syslog events, grouped by source ip address, for the last 24 hours TopTenSyslogEventsBySourceIpOneDay []Network_Logging_Syslog `json:"topTenSyslogEventsBySourceIpOneDay,omitempty" xmlrpc:"topTenSyslogEventsBySourceIpOneDay,omitempty"` // A count of top Ten network datacenter syslog events, grouped by source ip address, for the last 24 hours TopTenSyslogEventsBySourceIpOneDayCount *uint `json:"topTenSyslogEventsBySourceIpOneDayCount,omitempty" xmlrpc:"topTenSyslogEventsBySourceIpOneDayCount,omitempty"` // A count of top Ten network datacenter syslog events, grouped by source ip address, for the last 7 days TopTenSyslogEventsBySourceIpSevenDayCount *uint `json:"topTenSyslogEventsBySourceIpSevenDayCount,omitempty" xmlrpc:"topTenSyslogEventsBySourceIpSevenDayCount,omitempty"` // Top Ten network datacenter syslog events, grouped by source ip address, for the last 7 days TopTenSyslogEventsBySourceIpSevenDays []Network_Logging_Syslog `json:"topTenSyslogEventsBySourceIpSevenDays,omitempty" xmlrpc:"topTenSyslogEventsBySourceIpSevenDays,omitempty"` // Top Ten network datacenter syslog events, grouped by source port, for the last 24 hours TopTenSyslogEventsBySourcePortOneDay []Network_Logging_Syslog `json:"topTenSyslogEventsBySourcePortOneDay,omitempty" xmlrpc:"topTenSyslogEventsBySourcePortOneDay,omitempty"` // A count of top Ten network datacenter syslog events, grouped by source port, for the last 24 hours TopTenSyslogEventsBySourcePortOneDayCount *uint `json:"topTenSyslogEventsBySourcePortOneDayCount,omitempty" xmlrpc:"topTenSyslogEventsBySourcePortOneDayCount,omitempty"` // A count of top Ten network datacenter syslog events, grouped by source port, for the last 7 days TopTenSyslogEventsBySourcePortSevenDayCount *uint `json:"topTenSyslogEventsBySourcePortSevenDayCount,omitempty" xmlrpc:"topTenSyslogEventsBySourcePortSevenDayCount,omitempty"` // Top Ten network datacenter syslog events, grouped by source port, for the last 7 days TopTenSyslogEventsBySourcePortSevenDays []Network_Logging_Syslog `json:"topTenSyslogEventsBySourcePortSevenDays,omitempty" xmlrpc:"topTenSyslogEventsBySourcePortSevenDays,omitempty"` // A virtual guest that this IP address is routed to. VirtualGuest *Virtual_Guest `json:"virtualGuest,omitempty" xmlrpc:"virtualGuest,omitempty"` // A count of virtual licenses allocated for an IP Address. VirtualLicenseCount *uint `json:"virtualLicenseCount,omitempty" xmlrpc:"virtualLicenseCount,omitempty"` // Virtual licenses allocated for an IP Address. VirtualLicenses []Software_VirtualLicense `json:"virtualLicenses,omitempty" xmlrpc:"virtualLicenses,omitempty"` }
The SoftLayer_Network_Subnet_IpAddress data type contains general information relating to a single SoftLayer IPv4 address.
type Network_Subnet_IpAddress_Global ¶
type Network_Subnet_IpAddress_Global struct { Entity // no documentation yet Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // DEPRECATED // Deprecated: This function has been marked as deprecated. ActiveTransaction *Provisioning_Version1_Transaction `json:"activeTransaction,omitempty" xmlrpc:"activeTransaction,omitempty"` // The billing item for this Global IP. BillingItem *Billing_Item_Network_Subnet_IpAddress_Global `json:"billingItem,omitempty" xmlrpc:"billingItem,omitempty"` // A Global IP Address' associated description Description *int `json:"description,omitempty" xmlrpc:"description,omitempty"` // no documentation yet DestinationIpAddress *Network_Subnet_IpAddress `json:"destinationIpAddress,omitempty" xmlrpc:"destinationIpAddress,omitempty"` // A Global IP Address' associated [[SoftLayer_Network_Subnet_IpAddress|ipAddress]] ID DestinationIpAddressId *int `json:"destinationIpAddressId,omitempty" xmlrpc:"destinationIpAddressId,omitempty"` // A Global IP Address' unique identifier Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet IpAddress *Network_Subnet_IpAddress `json:"ipAddress,omitempty" xmlrpc:"ipAddress,omitempty"` // A Global IP Address' associated [[SoftLayer_Account|account]] ID IpAddressId *int `json:"ipAddressId,omitempty" xmlrpc:"ipAddressId,omitempty"` // A Global IP Address' associated type [[SoftLayer_Network_Subnet_IpAddress_Global_Type|id]] ID TypeId *int `json:"typeId,omitempty" xmlrpc:"typeId,omitempty"` }
no documentation yet
type Network_Subnet_IpAddress_UsageDetail ¶ added in v1.1.3
type Network_Subnet_IpAddress_UsageDetail struct { Entity // The IP address. IpAddress *string `json:"ipAddress,omitempty" xmlrpc:"ipAddress,omitempty"` // The unique identifier of the IP address record. IpAddressId *int `json:"ipAddressId,omitempty" xmlrpc:"ipAddressId,omitempty"` // A description of the resource IP address assignment. ResourceContext *string `json:"resourceContext,omitempty" xmlrpc:"resourceContext,omitempty"` // The fully qualified name of the assigned resource. ResourceFullyQualifiedName *string `json:"resourceFullyQualifiedName,omitempty" xmlrpc:"resourceFullyQualifiedName,omitempty"` // The unique identifier of the assigned resource. ResourceId *int `json:"resourceId,omitempty" xmlrpc:"resourceId,omitempty"` // The name of the assigned resource. ResourceName *string `json:"resourceName,omitempty" xmlrpc:"resourceName,omitempty"` // The type of the assigned resource. ResourceType *string `json:"resourceType,omitempty" xmlrpc:"resourceType,omitempty"` // The unique identifier of the subnet the IP address belongs to. SubnetId *int `json:"subnetId,omitempty" xmlrpc:"subnetId,omitempty"` }
Describes an IP address assigned to a resource on your network.
Details on the associated resource are also provided, described below. Details include the resource's type, unique identifier, name, fully qualified name, and context, the contents of which depends on the resource's type. If the fully qualified name is not included for a resource type below, the resource's name will apply.
The following resource types and associated dependent properties are supported:
* <b>HARDWARE</b>: A [Bare Metal Server](/reference/datatypes/SoftLayer_Hardware_Server)
-- <i>resourceName</i>: The hostname of the server.
-- <i>resourceFullyQualifiedName</i>: The fully qualified domain name of the server.
-- <i>resourceContext</i>: The name of the network component or network component group assigned to the IP address, <i>e.g. eth0/2</i>.
* <b>GUEST</b>: A [Virtual Server Instance](/reference/datatypes/SoftLayer_Virtual_Guest)
-- <i>resourceName</i>: The hostname of the guest.
-- <i>resourceFullyQualifiedName</i>: The fully qualified domain name of the guest.
-- <i>resourceContext</i>: The name of the virtual network component assigned to the IP address, <i>e.g. eth0</i>.
* <b>GATEWAY</b>: A [Network Gateway](/reference/datatypes/SoftLayer_Network_Gateway)
-- <i>resourceName</i>: The name of the gateway.
-- <i>resourceContext</i>: Either the term "virtual" to indicate a gateway IP address, or the name of the network component or network component group assigned to the IP address followed by the id-value of the [Bare Metal Server](/reference/datatypes/SoftLayer_Hardware_Server) gateway member surrounded by '<', '>', <i>e.g. eth1/3<123456></i>.
- <b>FIREWALL_MULTIVLAN</b>: A [Multi-VLAN Firewall](/reference/datatypes/SoftLayer_Network_Vlan_Firewall)
-- <i>resourceName</i>: The name of the firewall.
-- <i>resourceContext</i>: The term "virtual" to indicate a firewall IP address.
- <b>LBAAS</b>: A [Cloud Load Balancer](/reference/datatypes/SoftLayer_Network_LBaaS_LoadBalancer)
-- <i>resourceName</i>: The name of the load balancer.
-- <i>resourceFullyQualifiedName</i>: The full DNS address of the load balancer.
-- <i>resourceContext</i>: The term "ephemeral" to indicate a currently assigned IP address, subject to change. Users are strongly encouraged to access the service by the fully qualified DNS name and not the underlying IP addresses. The UUID of the load balancer is also provided, surrounded by '<' and '>', e.g. ephemeral<84f0affb-0d5e-40f1-ad87-a92d6544936a>
- <b>NETSCALER_VPX</b>: A [Netscaler VPX Load Balancer](/reference/datatypes/SoftLayer_Network_Application_Delivery_Controller)
-- <i>resourceName</i>: The hostname of the load balancer.
-- <i>resourceFullyQualifiedName</i>: The fully qualified domain name of the load balancer.
-- <i>resourceContext</i>: Either the term "nsip" to indicate the management IP address, or the name of the network component assigned to the IP address followed by the id-value of the [Virtual Server Instance](/reference/datatypes/SoftLayer_Virtual_Guest) load balancer host surrounded by '<', '>', <i>e.g. eth1<123456></i>.
- <b>NETSCALER_MPX</b>: A [Netscaler MPX Load Balancer](/reference/datatypes/SoftLayer_Hardware_LoadBalancer)
-- <i>resourceName</i>: The hostname of the load balancer.
-- <i>resourceFullyQualifiedName</i>: The fully qualified domain name of the load balancer.
-- <i>resourceContext</i>: The name of the network component or network component group assigned to the IP address, <i>e.g. eth0/2</i>.
type Network_Subnet_IpAddress_Version6 ¶
type Network_Subnet_IpAddress_Version6 struct { Network_Subnet_IpAddress // The network gateway appliance using this address as the public IPv6 address. PublicVersion6NetworkGateway *Network_Gateway `json:"publicVersion6NetworkGateway,omitempty" xmlrpc:"publicVersion6NetworkGateway,omitempty"` }
The SoftLayer_Network_Subnet_IpAddress data type contains general information relating to a single SoftLayer IPv6 address.
type Network_Subnet_Registration ¶
type Network_Subnet_Registration struct { Entity // [Deprecated] The account that this registration belongs to. // Deprecated: This function has been marked as deprecated. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // The registration object's associated [[SoftLayer_Account|account]] id AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // The CIDR prefix for the registered subnet Cidr *int `json:"cidr,omitempty" xmlrpc:"cidr,omitempty"` // no documentation yet CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // A count of [Deprecated] The cross-reference records that tie the [[SoftLayer_Account_Regional_Registry_Detail]] objects to the registration object. DetailReferenceCount *uint `json:"detailReferenceCount,omitempty" xmlrpc:"detailReferenceCount,omitempty"` // [Deprecated] The cross-reference records that tie the [[SoftLayer_Account_Regional_Registry_Detail]] objects to the registration object. // Deprecated: This function has been marked as deprecated. DetailReferences []Network_Subnet_Registration_Details `json:"detailReferences,omitempty" xmlrpc:"detailReferences,omitempty"` // A count of [Deprecated] The related registration events. EventCount *uint `json:"eventCount,omitempty" xmlrpc:"eventCount,omitempty"` // [Deprecated] The related registration events. // Deprecated: This function has been marked as deprecated. Events []Network_Subnet_Registration_Event `json:"events,omitempty" xmlrpc:"events,omitempty"` // Unique ID of the registration object Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // [Deprecated] The "network" detail object. // Deprecated: This function has been marked as deprecated. NetworkDetail *Account_Regional_Registry_Detail `json:"networkDetail,omitempty" xmlrpc:"networkDetail,omitempty"` // The RIR-specific handle or name of the registered subnet. This field is read-only. NetworkHandle *string `json:"networkHandle,omitempty" xmlrpc:"networkHandle,omitempty"` // The base IP address of the registered subnet NetworkIdentifier *string `json:"networkIdentifier,omitempty" xmlrpc:"networkIdentifier,omitempty"` // [Deprecated] The "person" detail object. // Deprecated: This function has been marked as deprecated. PersonDetail *Account_Regional_Registry_Detail `json:"personDetail,omitempty" xmlrpc:"personDetail,omitempty"` // [Deprecated] The related Regional Internet Registry. // Deprecated: This function has been marked as deprecated. RegionalInternetRegistry *Network_Regional_Internet_Registry `json:"regionalInternetRegistry,omitempty" xmlrpc:"regionalInternetRegistry,omitempty"` // [Deprecated] The RIR handle that this registration object belongs to. This field may not be populated until the registration is complete. // Deprecated: This function has been marked as deprecated. RegionalInternetRegistryHandle *Account_Rwhois_Handle `json:"regionalInternetRegistryHandle,omitempty" xmlrpc:"regionalInternetRegistryHandle,omitempty"` // The registration object's associated [[SoftLayer_Account_Rwhois_Handle|RIR handle]] id RegionalInternetRegistryHandleId *int `json:"regionalInternetRegistryHandleId,omitempty" xmlrpc:"regionalInternetRegistryHandleId,omitempty"` // The registration object's associated [[SoftLayer_Network_Regional_Internet_Registry|RIR]] id RegionalInternetRegistryId *int `json:"regionalInternetRegistryId,omitempty" xmlrpc:"regionalInternetRegistryId,omitempty"` // [Deprecated] The status of this registration. // Deprecated: This function has been marked as deprecated. Status *Network_Subnet_Registration_Status `json:"status,omitempty" xmlrpc:"status,omitempty"` // The registration object's associated [[SoftLayer_Network_Subnet_Registration_Status|status]] id StatusId *int `json:"statusId,omitempty" xmlrpc:"statusId,omitempty"` // [Deprecated] The subnet that this registration pertains to. // Deprecated: This function has been marked as deprecated. Subnet *Network_Subnet `json:"subnet,omitempty" xmlrpc:"subnet,omitempty"` }
The subnet registration service has been deprecated.
The subnet registration data type contains general information relating to a single subnet registration instance. These registration instances can be updated to reflect changes, and will record the changes in the [[SoftLayer_Network_Subnet_Registration_Event|events]].
type Network_Subnet_Registration_Apnic ¶
type Network_Subnet_Registration_Apnic struct {
Network_Subnet_Registration
}
The APNIC subnet registration type has been deprecated.
APNIC-specific registration object. For more detail see [[SoftLayer_Network_Subnet_Registration (type)|SoftLayer_Network_Subnet_Registration]].
type Network_Subnet_Registration_Arin ¶
type Network_Subnet_Registration_Arin struct {
Network_Subnet_Registration
}
The ARIN subnet registration type has been deprecated.
ARIN-specific registration object. For more detail see [[SoftLayer_Network_Subnet_Registration (type)|SoftLayer_Network_Subnet_Registration]].
type Network_Subnet_Registration_Details ¶
type Network_Subnet_Registration_Details struct { Entity // no documentation yet CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // [Deprecated] The related [[SoftLayer_Account_Regional_Registry_Detail|detail object]]. // Deprecated: This function has been marked as deprecated. Detail *Account_Regional_Registry_Detail `json:"detail,omitempty" xmlrpc:"detail,omitempty"` // Numeric ID of the related [[SoftLayer_Account_Regional_Registry_Detail]] object DetailId *int `json:"detailId,omitempty" xmlrpc:"detailId,omitempty"` // Unique numeric ID of the object Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // [Deprecated] The related [[SoftLayer_Network_Subnet_Registration|registration object]]. // Deprecated: This function has been marked as deprecated. Registration *Network_Subnet_Registration `json:"registration,omitempty" xmlrpc:"registration,omitempty"` // Numeric ID of the related [[SoftLayer_Network_Subnet_Registration]] object RegistrationId *int `json:"registrationId,omitempty" xmlrpc:"registrationId,omitempty"` }
The subnet registration details type has been deprecated.
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.
type Network_Subnet_Registration_Event ¶
type Network_Subnet_Registration_Event struct { Entity // no documentation yet CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // Unique numeric ID of the event object Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A string message indicating what took place during this event Message *string `json:"message,omitempty" xmlrpc:"message,omitempty"` // no documentation yet ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // [Deprecated] The registration this event pertains to. // Deprecated: This function has been marked as deprecated. Registration *Network_Subnet_Registration `json:"registration,omitempty" xmlrpc:"registration,omitempty"` // The numeric ID of the related [[SoftLayer_Network_Subnet_Registration]] object RegistrationId *int `json:"registrationId,omitempty" xmlrpc:"registrationId,omitempty"` // [Deprecated] The type of this event. // Deprecated: This function has been marked as deprecated. Type *Network_Subnet_Registration_Event_Type `json:"type,omitempty" xmlrpc:"type,omitempty"` // The numeric ID of the associated [[SoftLayer_Network_Subnet_Registration_Event_Type|event type]] object TypeId *int `json:"typeId,omitempty" xmlrpc:"typeId,omitempty"` }
The subnet registration event type has been deprecated.
Each time a [[SoftLayer_Network_Subnet_Registration|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. *
type Network_Subnet_Registration_Event_Type ¶
type Network_Subnet_Registration_Event_Type struct { Entity // no documentation yet // Deprecated: This function has been marked as deprecated. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // Unique numeric ID of the event type object Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Code-friendly string name of the event type KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // no documentation yet // Deprecated: This function has been marked as deprecated. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // Human-readable name of the event type Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
The subnet registration event type type has been deprecated.
Subnet Registration Event Type objects describe the nature of a [[SoftLayer_Network_Subnet_Registration_Event]]
The standard values for these objects are as follows: <ul> <li><strong>REGISTRATION_CREATED</strong> - Indicates that the registration has been created</li> <li><strong>REGISTRATION_UPDATED</strong> - Indicates that the registration has been updated</li> <li><strong>REGISTRATION_CANCELLED</strong> - Indicates that the registration has been cancelled</li> <li><strong>RIR_RESPONSE</strong> - Indicates that an action taken against the RIR has produced a response. More details will be provided in the event message.</li> <li><strong>ERROR</strong> - Indicates that an error has been encountered. More details will be provided in the event message.</li> <li><strong>NOTE</strong> - An employee or other system has entered a note regarding the registration. The note content will be provided in the event message.</li> </ul>
type Network_Subnet_Registration_Ripe ¶
type Network_Subnet_Registration_Ripe struct {
Network_Subnet_Registration
}
The RIPE subnet registration type has been deprecated.
RIPE-specific registration object. For more detail see [[SoftLayer_Network_Subnet_Registration (type)|SoftLayer_Network_Subnet_Registration]].
type Network_Subnet_Registration_Status ¶
type Network_Subnet_Registration_Status struct { Entity // no documentation yet // Deprecated: This function has been marked as deprecated. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // Unique numeric ID of the status object Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Code-friendly string name of the status KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // no documentation yet // Deprecated: This function has been marked as deprecated. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // Human-readable name of the status Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
The subnet registration status type has been deprecated.
Subnet Registration Status objects describe the current status of a subnet registration.
The standard values for these objects are as follows: <ul> <li><strong>OPEN</strong> - Indicates that the registration object is new and has yet to be submitted to the RIR</li> <li><strong>PENDING</strong> - Indicates that the registration object has been submitted to the RIR and is awaiting response</li> <li><strong>COMPLETE</strong> - Indicates that the RIR action has completed</li> <li><strong>DELETED</strong> - Indicates that the registration object has been gracefully removed is no longer valid</li> <li><strong>CANCELLED</strong> - Indicates that the registration object has been abruptly removed is no longer valid</li> </ul>
type Network_Subnet_Rwhois_Data ¶
type Network_Subnet_Rwhois_Data struct { Entity // 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. AbuseEmail *string `json:"abuseEmail,omitempty" xmlrpc:"abuseEmail,omitempty"` // The SoftLayer customer account associated with this reverse WHOIS data. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // An account's RWHOIS data's associated account identifier. AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // The first line of the mailing address associated with an account's RWHOIS data. Address1 *string `json:"address1,omitempty" xmlrpc:"address1,omitempty"` // The second line of the mailing address associated with an account's RWHOIS data. Address2 *string `json:"address2,omitempty" xmlrpc:"address2,omitempty"` // The city of the mailing address associated with an account's RWHOIS data. City *string `json:"city,omitempty" xmlrpc:"city,omitempty"` // The company name associated with an account's RWHOIS data. CompanyName *string `json:"companyName,omitempty" xmlrpc:"companyName,omitempty"` // A two-letter abbreviation of the country of the mailing address associated with an account's RWHOIS data. Country *string `json:"country,omitempty" xmlrpc:"country,omitempty"` // The date an account's RWHOIS data was created. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // The first name associated with an account's RWHOIS data. FirstName *string `json:"firstName,omitempty" xmlrpc:"firstName,omitempty"` // An account's RWHOIS data's internal identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The last name associated with an account's RWHOIS data. LastName *string `json:"lastName,omitempty" xmlrpc:"lastName,omitempty"` // The date an account's RWHOIS data was last modified. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // The postal code of the mailing address associated with an account's RWHOIS data. PostalCode *string `json:"postalCode,omitempty" xmlrpc:"postalCode,omitempty"` // Whether an account's RWHOIS data refers to a private residence or not. PrivateResidenceFlag *bool `json:"privateResidenceFlag,omitempty" xmlrpc:"privateResidenceFlag,omitempty"` // 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. State *string `json:"state,omitempty" xmlrpc:"state,omitempty"` }
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.
type Network_Subnet_Swip_Transaction ¶
type Network_Subnet_Swip_Transaction struct { Entity // The Account whose RWHOIS data was used to SWIP this subnet Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // A SWIP transaction's unique identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A Name describing which state a SWIP transaction is in. StatusName *string `json:"statusName,omitempty" xmlrpc:"statusName,omitempty"` // The subnet that this SWIP transaction was created for. Subnet *Network_Subnet `json:"subnet,omitempty" xmlrpc:"subnet,omitempty"` // ID Number of the Subnet for this SWIP transaction. SubnetId *int `json:"subnetId,omitempty" xmlrpc:"subnetId,omitempty"` }
**DEPRECATED** The SoftLayer_Network_Subnet_Swip_Transaction data type contains basic information tracked at SoftLayer to allow automation of Swip creation, update, and removal requests. A specific transaction is attached to an accountId and a subnetId. This also contains a "Status Name" which tells the customer what the transaction is doing:
* REQUEST QUEUED: Request is queued up to be sent to ARIN * REQUEST SENT: The email request has been sent to ARIN * REQUEST CONFIRMED: ARIN has confirmed that the request is good, and should be available in 24 hours * OK: The subnet has been checked with WHOIS and it the SWIP transaction has completed correctly * REMOVE QUEUED: A subnet is queued to be removed from ARIN's systems * REMOVE SENT: The removal email request has been sent to ARIN * REMOVE CONFIRMED: ARIN has confirmed that the removal request is good, and the subnet should be clear in WHOIS in 24 hours * DELETED: This specific SWIP Transaction has been removed from ARIN and is no longer in effect * SOFTLAYER MANUALLY PROCESSING: Sometimes a request doesn't go through correctly and has to be manually processed by SoftLayer. This may take some time.
type Network_Tunnel_Module_Context ¶
type Network_Tunnel_Module_Context struct { Entity // The account that a network tunnel belongs to. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // A network tunnel's account identifier. AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // DEPRECATED // Deprecated: This function has been marked as deprecated. ActiveTransaction *Provisioning_Version1_Transaction `json:"activeTransaction,omitempty" xmlrpc:"activeTransaction,omitempty"` // A count of a network tunnel's address translations. AddressTranslationCount *uint `json:"addressTranslationCount,omitempty" xmlrpc:"addressTranslationCount,omitempty"` // A network tunnel's address translations. AddressTranslations []Network_Tunnel_Module_Context_Address_Translation `json:"addressTranslations,omitempty" xmlrpc:"addressTranslations,omitempty"` // 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. AdvancedConfigurationFlag *int `json:"advancedConfigurationFlag,omitempty" xmlrpc:"advancedConfigurationFlag,omitempty"` // A count of subnets that provide access to SoftLayer services such as the management portal and the SoftLayer API. AllAvailableServiceSubnetCount *uint `json:"allAvailableServiceSubnetCount,omitempty" xmlrpc:"allAvailableServiceSubnetCount,omitempty"` // Subnets that provide access to SoftLayer services such as the management portal and the SoftLayer API. AllAvailableServiceSubnets []Network_Subnet `json:"allAvailableServiceSubnets,omitempty" xmlrpc:"allAvailableServiceSubnets,omitempty"` // The current billing item for network tunnel. BillingItem *Billing_Item `json:"billingItem,omitempty" xmlrpc:"billingItem,omitempty"` // The date a network tunnel was created. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // 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. CustomerPeerIpAddress *string `json:"customerPeerIpAddress,omitempty" xmlrpc:"customerPeerIpAddress,omitempty"` // A count of remote subnets that are allowed access through a network tunnel. CustomerSubnetCount *uint `json:"customerSubnetCount,omitempty" xmlrpc:"customerSubnetCount,omitempty"` // Remote subnets that are allowed access through a network tunnel. CustomerSubnets []Network_Customer_Subnet `json:"customerSubnets,omitempty" xmlrpc:"customerSubnets,omitempty"` // The datacenter location for one end of the network tunnel that allows access to account's private subnets. Datacenter *Location `json:"datacenter,omitempty" xmlrpc:"datacenter,omitempty"` // The name giving to a network tunnel by a user. FriendlyName *string `json:"friendlyName,omitempty" xmlrpc:"friendlyName,omitempty"` // A network tunnel's unique identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // 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. InternalPeerIpAddress *string `json:"internalPeerIpAddress,omitempty" xmlrpc:"internalPeerIpAddress,omitempty"` // A count of private subnets that can be accessed through the network tunnel. InternalSubnetCount *uint `json:"internalSubnetCount,omitempty" xmlrpc:"internalSubnetCount,omitempty"` // Private subnets that can be accessed through the network tunnel. InternalSubnets []Network_Subnet `json:"internalSubnets,omitempty" xmlrpc:"internalSubnets,omitempty"` // 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. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // A network tunnel's unique name used on the network device. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // Authentication used to generate keys for protecting the negotiations for a network tunnel. PhaseOneAuthentication *string `json:"phaseOneAuthentication,omitempty" xmlrpc:"phaseOneAuthentication,omitempty"` // 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. PhaseOneDiffieHellmanGroup *int `json:"phaseOneDiffieHellmanGroup,omitempty" xmlrpc:"phaseOneDiffieHellmanGroup,omitempty"` // Encryption used to generate keys for protecting the negotiations for a network tunnel. PhaseOneEncryption *string `json:"phaseOneEncryption,omitempty" xmlrpc:"phaseOneEncryption,omitempty"` // 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. PhaseOneKeylife *int `json:"phaseOneKeylife,omitempty" xmlrpc:"phaseOneKeylife,omitempty"` // The authentication used in phase 2 proposal negotiation process. PhaseTwoAuthentication *string `json:"phaseTwoAuthentication,omitempty" xmlrpc:"phaseTwoAuthentication,omitempty"` // 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. PhaseTwoDiffieHellmanGroup *int `json:"phaseTwoDiffieHellmanGroup,omitempty" xmlrpc:"phaseTwoDiffieHellmanGroup,omitempty"` // The encryption used in phase 2 proposal negotiation process. PhaseTwoEncryption *string `json:"phaseTwoEncryption,omitempty" xmlrpc:"phaseTwoEncryption,omitempty"` // 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. PhaseTwoKeylife *int `json:"phaseTwoKeylife,omitempty" xmlrpc:"phaseTwoKeylife,omitempty"` // 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. PhaseTwoPerfectForwardSecrecy *int `json:"phaseTwoPerfectForwardSecrecy,omitempty" xmlrpc:"phaseTwoPerfectForwardSecrecy,omitempty"` PresharedKey *string `json:"presharedKey,omitempty" xmlrpc:"presharedKey,omitempty"` // A count of service subnets that can be access through the network tunnel. ServiceSubnetCount *uint `json:"serviceSubnetCount,omitempty" xmlrpc:"serviceSubnetCount,omitempty"` // Service subnets that can be access through the network tunnel. ServiceSubnets []Network_Subnet `json:"serviceSubnets,omitempty" xmlrpc:"serviceSubnets,omitempty"` // A count of subnets used for a network tunnel's address translations. StaticRouteSubnetCount *uint `json:"staticRouteSubnetCount,omitempty" xmlrpc:"staticRouteSubnetCount,omitempty"` // Subnets used for a network tunnel's address translations. StaticRouteSubnets []Network_Subnet `json:"staticRouteSubnets,omitempty" xmlrpc:"staticRouteSubnets,omitempty"` // DEPRECATED // Deprecated: This function has been marked as deprecated. TransactionHistory []Provisioning_Version1_Transaction `json:"transactionHistory,omitempty" xmlrpc:"transactionHistory,omitempty"` // A count of dEPRECATED TransactionHistoryCount *uint `json:"transactionHistoryCount,omitempty" xmlrpc:"transactionHistoryCount,omitempty"` }
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.
type Network_Tunnel_Module_Context_Address_Translation ¶
type Network_Tunnel_Module_Context_Address_Translation struct { Entity // The ip address record that will receive the encrypted traffic. CustomerIpAddress *string `json:"customerIpAddress,omitempty" xmlrpc:"customerIpAddress,omitempty"` // The unique identifier for the ip address record that will receive the encrypted traffic. CustomerIpAddressId *int `json:"customerIpAddressId,omitempty" xmlrpc:"customerIpAddressId,omitempty"` // The ip address record for the ip that will receive the encrypted traffic from the IPSec network tunnel. CustomerIpAddressRecord *Network_Customer_Subnet_IpAddress `json:"customerIpAddressRecord,omitempty" xmlrpc:"customerIpAddressRecord,omitempty"` // An address translation's unique identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The ip address record that will deliver the encrypted traffic. InternalIpAddress *string `json:"internalIpAddress,omitempty" xmlrpc:"internalIpAddress,omitempty"` // The unique identifier for the ip address record that will deliver the encrypted traffic. InternalIpAddressId *int `json:"internalIpAddressId,omitempty" xmlrpc:"internalIpAddressId,omitempty"` // The ip address record for the ip that will deliver the encrypted traffic from the IPSec network tunnel. InternalIpAddressRecord *Network_Subnet_IpAddress `json:"internalIpAddressRecord,omitempty" xmlrpc:"internalIpAddressRecord,omitempty"` // The IPSec network tunnel an address translation belongs to. NetworkTunnelContext *Network_Tunnel_Module_Context `json:"networkTunnelContext,omitempty" xmlrpc:"networkTunnelContext,omitempty"` // An address translation's network tunnel identifier. NetworkTunnelContextId *int `json:"networkTunnelContextId,omitempty" xmlrpc:"networkTunnelContextId,omitempty"` // A name or description given to an address translation to help identify the address translation. Notes *string `json:"notes,omitempty" xmlrpc:"notes,omitempty"` }
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.
type Network_Vlan ¶
type Network_Vlan struct { Entity // The account this VLAN is associated with. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // The identifier of the account this VLAN is assigned to. AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // A count of the primary IPv4 subnets routed on this VLAN, excluding the primarySubnet. AdditionalPrimarySubnetCount *uint `json:"additionalPrimarySubnetCount,omitempty" xmlrpc:"additionalPrimarySubnetCount,omitempty"` // The primary IPv4 subnets routed on this VLAN, excluding the primarySubnet. AdditionalPrimarySubnets []Network_Subnet `json:"additionalPrimarySubnets,omitempty" xmlrpc:"additionalPrimarySubnets,omitempty"` // The gateway device this VLAN is associated with for routing purposes. AttachedNetworkGateway *Network_Gateway `json:"attachedNetworkGateway,omitempty" xmlrpc:"attachedNetworkGateway,omitempty"` // A value of '1' indicates this VLAN is associated with a gateway device for routing purposes. AttachedNetworkGatewayFlag *bool `json:"attachedNetworkGatewayFlag,omitempty" xmlrpc:"attachedNetworkGatewayFlag,omitempty"` // The gateway device VLAN context this VLAN is associated with for routing purposes. AttachedNetworkGatewayVlan *Network_Gateway_Vlan `json:"attachedNetworkGatewayVlan,omitempty" xmlrpc:"attachedNetworkGatewayVlan,omitempty"` // The billing item for this VLAN. BillingItem *Billing_Item `json:"billingItem,omitempty" xmlrpc:"billingItem,omitempty"` // The datacenter this VLAN is associated with. Datacenter *Location `json:"datacenter,omitempty" xmlrpc:"datacenter,omitempty"` // A value of '1' indicates this VLAN is associated with a firewall device. This does not include Hardware Firewalls. DedicatedFirewallFlag *int `json:"dedicatedFirewallFlag,omitempty" xmlrpc:"dedicatedFirewallFlag,omitempty"` // [DEPRECATED] The extension router that this VLAN is associated with. // Deprecated: This function has been marked as deprecated. ExtensionRouter *Hardware_Router `json:"extensionRouter,omitempty" xmlrpc:"extensionRouter,omitempty"` // A count of the VSI network interfaces connected to this VLAN and associated with a Hardware Firewall. FirewallGuestNetworkComponentCount *uint `json:"firewallGuestNetworkComponentCount,omitempty" xmlrpc:"firewallGuestNetworkComponentCount,omitempty"` // The VSI network interfaces connected to this VLAN and associated with a Hardware Firewall. FirewallGuestNetworkComponents []Network_Component_Firewall `json:"firewallGuestNetworkComponents,omitempty" xmlrpc:"firewallGuestNetworkComponents,omitempty"` // A count of the context for the firewall device associated with this VLAN. FirewallInterfaceCount *uint `json:"firewallInterfaceCount,omitempty" xmlrpc:"firewallInterfaceCount,omitempty"` // The context for the firewall device associated with this VLAN. FirewallInterfaces []Network_Firewall_Module_Context_Interface `json:"firewallInterfaces,omitempty" xmlrpc:"firewallInterfaces,omitempty"` // A count of the uplinks of the hardware network interfaces connected natively to this VLAN and associated with a Hardware Firewall. FirewallNetworkComponentCount *uint `json:"firewallNetworkComponentCount,omitempty" xmlrpc:"firewallNetworkComponentCount,omitempty"` // The uplinks of the hardware network interfaces connected natively to this VLAN and associated with a Hardware Firewall. FirewallNetworkComponents []Network_Component_Firewall `json:"firewallNetworkComponents,omitempty" xmlrpc:"firewallNetworkComponents,omitempty"` // A count of the access rules for the firewall device associated with this VLAN. FirewallRuleCount *uint `json:"firewallRuleCount,omitempty" xmlrpc:"firewallRuleCount,omitempty"` // The access rules for the firewall device associated with this VLAN. FirewallRules []Network_Vlan_Firewall_Rule `json:"firewallRules,omitempty" xmlrpc:"firewallRules,omitempty"` // A human readable, unique identifier for this VLAN. FullyQualifiedName *string `json:"fullyQualifiedName,omitempty" xmlrpc:"fullyQualifiedName,omitempty"` // A count of the VSI network interfaces connected to this VLAN. GuestNetworkComponentCount *uint `json:"guestNetworkComponentCount,omitempty" xmlrpc:"guestNetworkComponentCount,omitempty"` // The VSI network interfaces connected to this VLAN. GuestNetworkComponents []Virtual_Guest_Network_Component `json:"guestNetworkComponents,omitempty" xmlrpc:"guestNetworkComponents,omitempty"` // The hardware with network interfaces connected natively to this VLAN. Hardware []Hardware `json:"hardware,omitempty" xmlrpc:"hardware,omitempty"` // A count of the hardware with network interfaces connected natively to this VLAN. HardwareCount *uint `json:"hardwareCount,omitempty" xmlrpc:"hardwareCount,omitempty"` // A value of '1' indicates this VLAN is associated with a firewall device in a high availability configuration. HighAvailabilityFirewallFlag *bool `json:"highAvailabilityFirewallFlag,omitempty" xmlrpc:"highAvailabilityFirewallFlag,omitempty"` // The unique identifier of this VLAN. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A value of '1' indicates this VLAN's pod has VSI local disk storage capability. LocalDiskStorageCapabilityFlag *bool `json:"localDiskStorageCapabilityFlag,omitempty" xmlrpc:"localDiskStorageCapabilityFlag,omitempty"` // The time this VLAN was last modified. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // The customer name for this VLAN. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // A count of the hardware network interfaces connected natively to this VLAN. NetworkComponentCount *uint `json:"networkComponentCount,omitempty" xmlrpc:"networkComponentCount,omitempty"` // A count of the hardware network interfaces connected via trunk to this VLAN. NetworkComponentTrunkCount *uint `json:"networkComponentTrunkCount,omitempty" xmlrpc:"networkComponentTrunkCount,omitempty"` // The hardware network interfaces connected via trunk to this VLAN. NetworkComponentTrunks []Network_Component_Network_Vlan_Trunk `json:"networkComponentTrunks,omitempty" xmlrpc:"networkComponentTrunks,omitempty"` // The hardware network interfaces connected natively to this VLAN. NetworkComponents []Network_Component `json:"networkComponents,omitempty" xmlrpc:"networkComponents,omitempty"` // The viable hardware network interface 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 connected, either natively or trunked. NetworkComponentsTrunkable []Network_Component `json:"networkComponentsTrunkable,omitempty" xmlrpc:"networkComponentsTrunkable,omitempty"` // The network that this VLAN is on, either PUBLIC or PRIVATE, if applicable. NetworkSpace *string `json:"networkSpace,omitempty" xmlrpc:"networkSpace,omitempty"` // The firewall device associated with this VLAN. NetworkVlanFirewall *Network_Vlan_Firewall `json:"networkVlanFirewall,omitempty" xmlrpc:"networkVlanFirewall,omitempty"` // An internal description of this VLAN, if applicable. Note *string `json:"note,omitempty" xmlrpc:"note,omitempty"` // The pod this VLAN is associated with. PodName *string `json:"podName,omitempty" xmlrpc:"podName,omitempty"` // The router device that this VLAN is associated with. PrimaryRouter *Hardware_Router `json:"primaryRouter,omitempty" xmlrpc:"primaryRouter,omitempty"` // A primary IPv4 subnet routed on this VLAN, if accessible. PrimarySubnet *Network_Subnet `json:"primarySubnet,omitempty" xmlrpc:"primarySubnet,omitempty"` // A count of all primary subnets routed on this VLAN. PrimarySubnetCount *uint `json:"primarySubnetCount,omitempty" xmlrpc:"primarySubnetCount,omitempty"` // The identifier of a primary IPv4 subnet routed on this VLAN. PrimarySubnetId *int `json:"primarySubnetId,omitempty" xmlrpc:"primarySubnetId,omitempty"` // The primary IPv6 subnet routed on this VLAN, if IPv6 is enabled. PrimarySubnetVersion6 *Network_Subnet `json:"primarySubnetVersion6,omitempty" xmlrpc:"primarySubnetVersion6,omitempty"` // All primary subnets routed on this VLAN. PrimarySubnets []Network_Subnet `json:"primarySubnets,omitempty" xmlrpc:"primarySubnets,omitempty"` // A count of the gateway devices with connectivity supported by this private VLAN. PrivateNetworkGatewayCount *uint `json:"privateNetworkGatewayCount,omitempty" xmlrpc:"privateNetworkGatewayCount,omitempty"` // The gateway devices with connectivity supported by this private VLAN. PrivateNetworkGateways []Network_Gateway `json:"privateNetworkGateways,omitempty" xmlrpc:"privateNetworkGateways,omitempty"` // A count of iP addresses routed on this VLAN which are actively associated with network protections. ProtectedIpAddressCount *uint `json:"protectedIpAddressCount,omitempty" xmlrpc:"protectedIpAddressCount,omitempty"` // IP addresses routed on this VLAN which are actively associated with network protections. ProtectedIpAddresses []Network_Subnet_IpAddress `json:"protectedIpAddresses,omitempty" xmlrpc:"protectedIpAddresses,omitempty"` // A count of the gateway devices with connectivity supported by this public VLAN. PublicNetworkGatewayCount *uint `json:"publicNetworkGatewayCount,omitempty" xmlrpc:"publicNetworkGatewayCount,omitempty"` // The gateway devices with connectivity supported by this public VLAN. PublicNetworkGateways []Network_Gateway `json:"publicNetworkGateways,omitempty" xmlrpc:"publicNetworkGateways,omitempty"` // A value of '1' indicates this VLAN's pod has VSI SAN disk storage capability. SanStorageCapabilityFlag *bool `json:"sanStorageCapabilityFlag,omitempty" xmlrpc:"sanStorageCapabilityFlag,omitempty"` // [DEPRECATED] The secondary router device that this VLAN is associated with. // Deprecated: This function has been marked as deprecated. SecondaryRouter *Hardware `json:"secondaryRouter,omitempty" xmlrpc:"secondaryRouter,omitempty"` // A count of all non-primary subnets routed on this VLAN. SecondarySubnetCount *uint `json:"secondarySubnetCount,omitempty" xmlrpc:"secondarySubnetCount,omitempty"` // All non-primary subnets routed on this VLAN. SecondarySubnets []Network_Subnet `json:"secondarySubnets,omitempty" xmlrpc:"secondarySubnets,omitempty"` // A count of all subnets routed on this VLAN. SubnetCount *uint `json:"subnetCount,omitempty" xmlrpc:"subnetCount,omitempty"` // All subnets routed on this VLAN. Subnets []Network_Subnet `json:"subnets,omitempty" xmlrpc:"subnets,omitempty"` // A count of the tags associated to this VLAN. TagReferenceCount *uint `json:"tagReferenceCount,omitempty" xmlrpc:"tagReferenceCount,omitempty"` // The tags associated to this VLAN. TagReferences []Tag_Reference `json:"tagReferences,omitempty" xmlrpc:"tagReferences,omitempty"` // The number of primary IPv4 addresses routed on this VLAN. TotalPrimaryIpAddressCount *uint `json:"totalPrimaryIpAddressCount,omitempty" xmlrpc:"totalPrimaryIpAddressCount,omitempty"` // The type for this VLAN, with the following values: STANDARD, GATEWAY, INTERCONNECT Type *Network_Vlan_Type `json:"type,omitempty" xmlrpc:"type,omitempty"` // A count of the VSIs with network interfaces connected to this VLAN. VirtualGuestCount *uint `json:"virtualGuestCount,omitempty" xmlrpc:"virtualGuestCount,omitempty"` // The VSIs with network interfaces connected to this VLAN. VirtualGuests []Virtual_Guest `json:"virtualGuests,omitempty" xmlrpc:"virtualGuests,omitempty"` // The number of this VLAN configured on the network. VlanNumber *int `json:"vlanNumber,omitempty" xmlrpc:"vlanNumber,omitempty"` }
VLANs comprise the fundamental segmentation model on the network, isolating customer networks from one another.
VLANs are scoped to a single network, generally public or private, and a pod. Through association to a single VLAN, assigned subnets are routed on the network to provide IP address connectivity.
Compute devices are associated to a single VLAN per active network, to which the Primary IP Address and containing Primary Subnet belongs. Additional VLANs may be associated to bare metal devices using VLAN trunking.
[VLAN at Wikipedia](https://en.wikipedia.org/wiki/VLAN)
type Network_Vlan_Firewall ¶
type Network_Vlan_Firewall struct { Entity // no documentation yet AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // 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. AdministrativeBypassFlag *string `json:"administrativeBypassFlag,omitempty" xmlrpc:"administrativeBypassFlag,omitempty"` // A firewall's allotted bandwidth (measured in GB). BandwidthAllocation *Float64 `json:"bandwidthAllocation,omitempty" xmlrpc:"bandwidthAllocation,omitempty"` // The raw bandwidth usage data for the current billing cycle. One object will be returned for each network this firewall is attached to. BillingCycleBandwidthUsage []Network_Bandwidth_Usage `json:"billingCycleBandwidthUsage,omitempty" xmlrpc:"billingCycleBandwidthUsage,omitempty"` // 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. BillingCycleBandwidthUsageCount *uint `json:"billingCycleBandwidthUsageCount,omitempty" xmlrpc:"billingCycleBandwidthUsageCount,omitempty"` // The raw private bandwidth usage data for the current billing cycle. BillingCyclePrivateBandwidthUsage *Network_Bandwidth_Usage `json:"billingCyclePrivateBandwidthUsage,omitempty" xmlrpc:"billingCyclePrivateBandwidthUsage,omitempty"` // The raw public bandwidth usage data for the current billing cycle. BillingCyclePublicBandwidthUsage *Network_Bandwidth_Usage `json:"billingCyclePublicBandwidthUsage,omitempty" xmlrpc:"billingCyclePublicBandwidthUsage,omitempty"` // The billing item for a Hardware Firewall (Dedicated). BillingItem *Billing_Item `json:"billingItem,omitempty" xmlrpc:"billingItem,omitempty"` // Administrative bypass request status. BypassRequestStatus *string `json:"bypassRequestStatus,omitempty" xmlrpc:"bypassRequestStatus,omitempty"` // Whether or not this firewall can be directly logged in to. CustomerManagedFlag *bool `json:"customerManagedFlag,omitempty" xmlrpc:"customerManagedFlag,omitempty"` // The datacenter that the firewall resides in. Datacenter *Location `json:"datacenter,omitempty" xmlrpc:"datacenter,omitempty"` // The firewall device type. FirewallType *string `json:"firewallType,omitempty" xmlrpc:"firewallType,omitempty"` // 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. FullyQualifiedDomainName *string `json:"fullyQualifiedDomainName,omitempty" xmlrpc:"fullyQualifiedDomainName,omitempty"` // A firewall's unique identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The credentials to log in to a firewall device. This is only present for dedicated appliances. ManagementCredentials *Software_Component_Password `json:"managementCredentials,omitempty" xmlrpc:"managementCredentials,omitempty"` // A firewall's metric tracking object. MetricTrackingObject *Metric_Tracking_Object `json:"metricTrackingObject,omitempty" xmlrpc:"metricTrackingObject,omitempty"` // The metric tracking object ID for this firewall. MetricTrackingObjectId *int `json:"metricTrackingObjectId,omitempty" xmlrpc:"metricTrackingObjectId,omitempty"` // A count of the update requests made for this firewall. NetworkFirewallUpdateRequestCount *uint `json:"networkFirewallUpdateRequestCount,omitempty" xmlrpc:"networkFirewallUpdateRequestCount,omitempty"` // The update requests made for this firewall. NetworkFirewallUpdateRequests []Network_Firewall_Update_Request `json:"networkFirewallUpdateRequests,omitempty" xmlrpc:"networkFirewallUpdateRequests,omitempty"` // The gateway associated with this firewall, if any. NetworkGateway *Network_Gateway `json:"networkGateway,omitempty" xmlrpc:"networkGateway,omitempty"` // The VLAN object that a firewall is associated with and protecting. NetworkVlan *Network_Vlan `json:"networkVlan,omitempty" xmlrpc:"networkVlan,omitempty"` // A count of the VLAN objects that a firewall is associated with and protecting. NetworkVlanCount *uint `json:"networkVlanCount,omitempty" xmlrpc:"networkVlanCount,omitempty"` // The VLAN objects that a firewall is associated with and protecting. NetworkVlans []Network_Vlan `json:"networkVlans,omitempty" xmlrpc:"networkVlans,omitempty"` // 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. PrimaryIpAddress *string `json:"primaryIpAddress,omitempty" xmlrpc:"primaryIpAddress,omitempty"` // A count of the currently running rule set of this network component firewall. RuleCount *uint `json:"ruleCount,omitempty" xmlrpc:"ruleCount,omitempty"` // The currently running rule set of this network component firewall. Rules []Network_Vlan_Firewall_Rule `json:"rules,omitempty" xmlrpc:"rules,omitempty"` // A count of TagReferenceCount *uint `json:"tagReferenceCount,omitempty" xmlrpc:"tagReferenceCount,omitempty"` // no documentation yet TagReferences []Tag_Reference `json:"tagReferences,omitempty" xmlrpc:"tagReferences,omitempty"` // A firewall's associated upgrade request object, if any. UpgradeRequest *Product_Upgrade_Request `json:"upgradeRequest,omitempty" xmlrpc:"upgradeRequest,omitempty"` }
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.
type Network_Vlan_Firewall_Rule ¶
type Network_Vlan_Firewall_Rule struct { Entity // The action that the rule is to take [permit or deny]. Action *string `json:"action,omitempty" xmlrpc:"action,omitempty"` // The destination IP address considered for determining rule application. DestinationIpAddress *string `json:"destinationIpAddress,omitempty" xmlrpc:"destinationIpAddress,omitempty"` // The CIDR is used for determining rule application. This value will DestinationIpCidr *int `json:"destinationIpCidr,omitempty" xmlrpc:"destinationIpCidr,omitempty"` // The destination IP subnet mask considered for determining rule application. DestinationIpSubnetMask *string `json:"destinationIpSubnetMask,omitempty" xmlrpc:"destinationIpSubnetMask,omitempty"` // The ending (upper end of range) destination port considered for determining rule application. DestinationPortRangeEnd *int `json:"destinationPortRangeEnd,omitempty" xmlrpc:"destinationPortRangeEnd,omitempty"` // The starting (lower end of range) destination port considered for determining rule application. DestinationPortRangeStart *int `json:"destinationPortRangeStart,omitempty" xmlrpc:"destinationPortRangeStart,omitempty"` // The rule's internal identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The network component firewall that this rule belongs to. NetworkComponentFirewall *Network_Component_Firewall `json:"networkComponentFirewall,omitempty" xmlrpc:"networkComponentFirewall,omitempty"` // The notes field for the rule. Notes *string `json:"notes,omitempty" xmlrpc:"notes,omitempty"` // The numeric value describing the order in which the rule should be applied. OrderValue *int `json:"orderValue,omitempty" xmlrpc:"orderValue,omitempty"` // The protocol considered for determining rule application. Protocol *string `json:"protocol,omitempty" xmlrpc:"protocol,omitempty"` // The source IP address considered for determining rule application. SourceIpAddress *string `json:"sourceIpAddress,omitempty" xmlrpc:"sourceIpAddress,omitempty"` // The CIDR is used for determining rule application. This value will SourceIpCidr *int `json:"sourceIpCidr,omitempty" xmlrpc:"sourceIpCidr,omitempty"` // The source IP subnet mask considered for determining rule application. SourceIpSubnetMask *string `json:"sourceIpSubnetMask,omitempty" xmlrpc:"sourceIpSubnetMask,omitempty"` // Current status of the network component firewall. Status *string `json:"status,omitempty" xmlrpc:"status,omitempty"` // Whether this rule is an IPv4 rule or an IPv6 rule. If Version *int `json:"version,omitempty" xmlrpc:"version,omitempty"` }
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.
type Network_Vlan_Type ¶
type Network_Vlan_Type struct { Entity // no documentation yet Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
no documentation yet
type Notification ¶
type Notification struct { Entity // Unique identifier for the notification. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Name that can be used by external systems to refer to a notification. KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // Friendly name for the notification. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // A count of the preferences related to the notification. These are preferences are configurable and optional for subscribers to use. PreferenceCount *uint `json:"preferenceCount,omitempty" xmlrpc:"preferenceCount,omitempty"` // The preferences related to the notification. These are preferences are configurable and optional for subscribers to use. Preferences []Notification_Preference `json:"preferences,omitempty" xmlrpc:"preferences,omitempty"` // A count of the required preferences related to the notification. While configurable, the subscriber does not have the option whether to use the preference. RequiredPreferenceCount *uint `json:"requiredPreferenceCount,omitempty" xmlrpc:"requiredPreferenceCount,omitempty"` // The required preferences related to the notification. While configurable, the subscriber does not have the option whether to use the preference. RequiredPreferences []Notification_Preference `json:"requiredPreferences,omitempty" xmlrpc:"requiredPreferences,omitempty"` }
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.
type Notification_Delivery_Method ¶
type Notification_Delivery_Method struct { Entity // Determines if the delivery method is still used by the system. Active *int `json:"active,omitempty" xmlrpc:"active,omitempty"` // Description used for the delivery method. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // Unique identifier for the various notification delivery methods. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Name that can be used by external systems to refer to delivery method. KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // Friendly name used for the delivery method. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
Provides details for the delivery methods available.
type Notification_Mobile ¶
type Notification_Mobile struct {
Notification
}
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.
type Notification_Occurrence_Account ¶
type Notification_Occurrence_Account struct { Entity // no documentation yet Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // no documentation yet Active *int `json:"active,omitempty" xmlrpc:"active,omitempty"` // no documentation yet LastNotificationUpdate *Notification_Occurrence_Update `json:"lastNotificationUpdate,omitempty" xmlrpc:"lastNotificationUpdate,omitempty"` // no documentation yet NotificationOccurrenceEvent *Notification_Occurrence_Event `json:"notificationOccurrenceEvent,omitempty" xmlrpc:"notificationOccurrenceEvent,omitempty"` }
no documentation yet
type Notification_Occurrence_Event ¶
type Notification_Occurrence_Event struct { Entity // Indicates whether or not this event has been acknowledged by the user. AcknowledgedFlag *bool `json:"acknowledgedFlag,omitempty" xmlrpc:"acknowledgedFlag,omitempty"` // 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. AttachmentCount *uint `json:"attachmentCount,omitempty" xmlrpc:"attachmentCount,omitempty"` // 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. Attachments []Notification_Occurrence_Event_Attachment `json:"attachments,omitempty" xmlrpc:"attachments,omitempty"` // When this event will end. EndDate *Time `json:"endDate,omitempty" xmlrpc:"endDate,omitempty"` // The first update for this event. FirstUpdate *Notification_Occurrence_Update `json:"firstUpdate,omitempty" xmlrpc:"firstUpdate,omitempty"` // Unique identifier for this event. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A count of a collection of accounts impacted by this event. Each impacted account record relates directly to a [[SoftLayer_Account]]. ImpactedAccountCount *uint `json:"impactedAccountCount,omitempty" xmlrpc:"impactedAccountCount,omitempty"` // A collection of accounts impacted by this event. Each impacted account record relates directly to a [[SoftLayer_Account]]. ImpactedAccounts []Notification_Occurrence_Account `json:"impactedAccounts,omitempty" xmlrpc:"impactedAccounts,omitempty"` // 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]]. ImpactedResourceCount *uint `json:"impactedResourceCount,omitempty" xmlrpc:"impactedResourceCount,omitempty"` // 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]]. ImpactedResources []Notification_Occurrence_Resource `json:"impactedResources,omitempty" xmlrpc:"impactedResources,omitempty"` // A count of a collection of users impacted by this event. Each impacted user record relates directly to a [[SoftLayer_User_Customer]]. ImpactedUserCount *uint `json:"impactedUserCount,omitempty" xmlrpc:"impactedUserCount,omitempty"` // A collection of users impacted by this event. Each impacted user record relates directly to a [[SoftLayer_User_Customer]]. ImpactedUsers []Notification_Occurrence_User `json:"impactedUsers,omitempty" xmlrpc:"impactedUsers,omitempty"` // Latest count of users impacted by this event. LastImpactedUserCount *int `json:"lastImpactedUserCount,omitempty" xmlrpc:"lastImpactedUserCount,omitempty"` // The last update for this event. LastUpdate *Notification_Occurrence_Update `json:"lastUpdate,omitempty" xmlrpc:"lastUpdate,omitempty"` // When this event was last updated. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // The type of event such as planned or unplanned maintenance. NotificationOccurrenceEventType *Notification_Occurrence_Event_Type `json:"notificationOccurrenceEventType,omitempty" xmlrpc:"notificationOccurrenceEventType,omitempty"` // no documentation yet RecoveryTime *int `json:"recoveryTime,omitempty" xmlrpc:"recoveryTime,omitempty"` // When this event started. StartDate *Time `json:"startDate,omitempty" xmlrpc:"startDate,omitempty"` // no documentation yet StatusCode *Notification_Occurrence_Status_Code `json:"statusCode,omitempty" xmlrpc:"statusCode,omitempty"` // Brief description of this event. Subject *string `json:"subject,omitempty" xmlrpc:"subject,omitempty"` // Details of this event. Summary *string `json:"summary,omitempty" xmlrpc:"summary,omitempty"` // Unique identifier for the [[SoftLayer_Ticket]] associated with this event. SystemTicketId *int `json:"systemTicketId,omitempty" xmlrpc:"systemTicketId,omitempty"` // A count of all updates for this event. UpdateCount *uint `json:"updateCount,omitempty" xmlrpc:"updateCount,omitempty"` // All updates for this event. Updates []Notification_Occurrence_Update `json:"updates,omitempty" xmlrpc:"updates,omitempty"` }
no documentation yet
type Notification_Occurrence_Event_Attachment ¶
type Notification_Occurrence_Event_Attachment struct { Entity // The date the file was attached to the event. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // The name of the file attached to the event. FileName *string `json:"fileName,omitempty" xmlrpc:"fileName,omitempty"` // The size of the file, measured in bytes. FileSize *string `json:"fileSize,omitempty" xmlrpc:"fileSize,omitempty"` // A event attachments' unique identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet NotificationOccurrenceEvent *Notification_Occurrence_Event `json:"notificationOccurrenceEvent,omitempty" xmlrpc:"notificationOccurrenceEvent,omitempty"` // The unique event identifier that the file is attached to. NotificationOccurrenceEventId *int `json:"notificationOccurrenceEventId,omitempty" xmlrpc:"notificationOccurrenceEventId,omitempty"` }
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.
type Notification_Occurrence_Event_Type ¶
type Notification_Occurrence_Event_Type struct { Entity // The friendly unique identifier for this event type. KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` }
This represents the type of SoftLayer_Notification_Occurrence_Event.
type Notification_Occurrence_Resource ¶
type Notification_Occurrence_Resource struct { Entity // no documentation yet Active *int `json:"active,omitempty" xmlrpc:"active,omitempty"` // <<< EOT A label which gives some background as to what piece of FilterLabel *string `json:"filterLabel,omitempty" xmlrpc:"filterLabel,omitempty"` // The associated event. NotificationOccurrenceEvent *Notification_Occurrence_Event `json:"notificationOccurrenceEvent,omitempty" xmlrpc:"notificationOccurrenceEvent,omitempty"` // <<< EOT The unique identifier for the associated NotificationOccurrenceEventId *int `json:"notificationOccurrenceEventId,omitempty" xmlrpc:"notificationOccurrenceEventId,omitempty"` // The physical resource. Resource interface{} `json:"resource,omitempty" xmlrpc:"resource,omitempty"` // <<< EOT The unique identifier for the [[SoftLayer_Account]] associated with ResourceAccountId *int `json:"resourceAccountId,omitempty" xmlrpc:"resourceAccountId,omitempty"` // no documentation yet ResourceName *string `json:"resourceName,omitempty" xmlrpc:"resourceName,omitempty"` // <<< EOT The unique identifier for the physical resource that is associated ResourceTableId *int `json:"resourceTableId,omitempty" xmlrpc:"resourceTableId,omitempty"` }
This type contains general information relating to any hardware or services that may be impacted by a SoftLayer_Notification_Occurrence_Event.
type Notification_Occurrence_Resource_Hardware ¶
type Notification_Occurrence_Resource_Hardware struct { Notification_Occurrence_Resource // no documentation yet Hostname *string `json:"hostname,omitempty" xmlrpc:"hostname,omitempty"` // no documentation yet PrivateIp *string `json:"privateIp,omitempty" xmlrpc:"privateIp,omitempty"` // no documentation yet PublicIp *string `json:"publicIp,omitempty" xmlrpc:"publicIp,omitempty"` // no documentation yet ResourceType *string `json:"resourceType,omitempty" xmlrpc:"resourceType,omitempty"` }
This type contains general information related to a [[SoftLayer_Hardware]] resource that is impacted by a [[SoftLayer_Notification_Occurrence_Event]].
type Notification_Occurrence_Resource_Network_Application_Delivery_Controller ¶
type Notification_Occurrence_Resource_Network_Application_Delivery_Controller struct { Notification_Occurrence_Resource // no documentation yet Hostname *string `json:"hostname,omitempty" xmlrpc:"hostname,omitempty"` // no documentation yet PrivateIp *string `json:"privateIp,omitempty" xmlrpc:"privateIp,omitempty"` // no documentation yet PublicIp *string `json:"publicIp,omitempty" xmlrpc:"publicIp,omitempty"` // no documentation yet ResourceType *string `json:"resourceType,omitempty" xmlrpc:"resourceType,omitempty"` }
This type contains general information related to a [[SoftLayer_Network_Application_Delivery_Controller]] resource that is impacted by a [[SoftLayer_Notification_Occurrence_Event]].
type Notification_Occurrence_Resource_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress ¶
type Notification_Occurrence_Resource_Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress struct { Notification_Occurrence_Resource // no documentation yet Hostname *string `json:"hostname,omitempty" xmlrpc:"hostname,omitempty"` // no documentation yet PublicIp *string `json:"publicIp,omitempty" xmlrpc:"publicIp,omitempty"` // no documentation yet ResourceType *string `json:"resourceType,omitempty" xmlrpc:"resourceType,omitempty"` }
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]].
type Notification_Occurrence_Resource_Network_Storage_Iscsi_NetApp ¶
type Notification_Occurrence_Resource_Network_Storage_Iscsi_NetApp struct { Notification_Occurrence_Resource // no documentation yet Hostname *string `json:"hostname,omitempty" xmlrpc:"hostname,omitempty"` // no documentation yet PrivateIp *string `json:"privateIp,omitempty" xmlrpc:"privateIp,omitempty"` // no documentation yet ResourceType *string `json:"resourceType,omitempty" xmlrpc:"resourceType,omitempty"` }
This type contains general information related to a [[SoftLayer_Network_Storage_Iscsi_NetApp]] resource that is impacted by a [[SoftLayer_Notification_Occurrence_Event]].
type Notification_Occurrence_Resource_Network_Storage_Lockbox ¶
type Notification_Occurrence_Resource_Network_Storage_Lockbox struct { Notification_Occurrence_Resource // no documentation yet Hostname *string `json:"hostname,omitempty" xmlrpc:"hostname,omitempty"` // no documentation yet PrivateIp *string `json:"privateIp,omitempty" xmlrpc:"privateIp,omitempty"` // no documentation yet ResourceType *string `json:"resourceType,omitempty" xmlrpc:"resourceType,omitempty"` }
This type contains general information related to a [[SoftLayer_Network_Storage_Lockbox]] resource that is impacted by a [[SoftLayer_Notification_Occurrence_Event]].
type Notification_Occurrence_Resource_Network_Storage_Nas ¶
type Notification_Occurrence_Resource_Network_Storage_Nas struct { Notification_Occurrence_Resource // no documentation yet Hostname *string `json:"hostname,omitempty" xmlrpc:"hostname,omitempty"` // no documentation yet PrivateIp *string `json:"privateIp,omitempty" xmlrpc:"privateIp,omitempty"` // no documentation yet ResourceType *string `json:"resourceType,omitempty" xmlrpc:"resourceType,omitempty"` }
This type contains general information related to a [[SoftLayer_Network_Storage_Nas]] resource that is impacted by a [[SoftLayer_Notification_Occurrence_Event]].
type Notification_Occurrence_Resource_Network_Storage_NetApp_Volume ¶
type Notification_Occurrence_Resource_Network_Storage_NetApp_Volume struct { Notification_Occurrence_Resource // no documentation yet Hostname *string `json:"hostname,omitempty" xmlrpc:"hostname,omitempty"` // no documentation yet PrivateIp *string `json:"privateIp,omitempty" xmlrpc:"privateIp,omitempty"` // no documentation yet ResourceType *string `json:"resourceType,omitempty" xmlrpc:"resourceType,omitempty"` }
This type contains general information related to a [[SoftLayer_Network_Storage]] resource that is impacted by a [[SoftLayer_Notification_Occurrence_Event]].
type Notification_Occurrence_Resource_Network_Storage_NetApp_Volume_Replicant_Iscsi ¶
type Notification_Occurrence_Resource_Network_Storage_NetApp_Volume_Replicant_Iscsi struct { Notification_Occurrence_Resource // no documentation yet Hostname *string `json:"hostname,omitempty" xmlrpc:"hostname,omitempty"` // no documentation yet PrivateIp *string `json:"privateIp,omitempty" xmlrpc:"privateIp,omitempty"` // no documentation yet ResourceType *string `json:"resourceType,omitempty" xmlrpc:"resourceType,omitempty"` }
This type contains general information related to a [[SoftLayer_Network_Storage_Iscsi]] resource that is impacted by a [[SoftLayer_Notification_Occurrence_Event]].
type Notification_Occurrence_Resource_Network_Storage_NetApp_Volume_Replicant_Nas ¶
type Notification_Occurrence_Resource_Network_Storage_NetApp_Volume_Replicant_Nas struct { Notification_Occurrence_Resource // no documentation yet Hostname *string `json:"hostname,omitempty" xmlrpc:"hostname,omitempty"` // no documentation yet PrivateIp *string `json:"privateIp,omitempty" xmlrpc:"privateIp,omitempty"` // no documentation yet ResourceType *string `json:"resourceType,omitempty" xmlrpc:"resourceType,omitempty"` }
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]].
type Notification_Occurrence_Resource_Virtual ¶
type Notification_Occurrence_Resource_Virtual struct { Notification_Occurrence_Resource // no documentation yet Hostname *string `json:"hostname,omitempty" xmlrpc:"hostname,omitempty"` // no documentation yet PrivateIp *string `json:"privateIp,omitempty" xmlrpc:"privateIp,omitempty"` // no documentation yet PublicIp *string `json:"publicIp,omitempty" xmlrpc:"publicIp,omitempty"` // no documentation yet ResourceType *string `json:"resourceType,omitempty" xmlrpc:"resourceType,omitempty"` }
This type contains general information related to a [[SoftLayer_Virtual_Guest]] resource that is impacted by a [[SoftLayer_Notification_Occurrence_Event]].
type Notification_Occurrence_Status_Code ¶
type Notification_Occurrence_Status_Code struct { Entity // no documentation yet Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // no documentation yet KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
no documentation yet
type Notification_Occurrence_Update ¶
type Notification_Occurrence_Update struct { Entity // no documentation yet Contents *string `json:"contents,omitempty" xmlrpc:"contents,omitempty"` // no documentation yet CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // no documentation yet Employee *User_Employee `json:"employee,omitempty" xmlrpc:"employee,omitempty"` // no documentation yet EndDate *Time `json:"endDate,omitempty" xmlrpc:"endDate,omitempty"` // no documentation yet NotificationOccurrenceEvent *Notification_Occurrence_Event `json:"notificationOccurrenceEvent,omitempty" xmlrpc:"notificationOccurrenceEvent,omitempty"` // no documentation yet StartDate *Time `json:"startDate,omitempty" xmlrpc:"startDate,omitempty"` }
no documentation yet
type Notification_Occurrence_User ¶
type Notification_Occurrence_User struct { Entity // no documentation yet AcknowledgedFlag *int `json:"acknowledgedFlag,omitempty" xmlrpc:"acknowledgedFlag,omitempty"` // no documentation yet Active *int `json:"active,omitempty" xmlrpc:"active,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A count of a collection of resources impacted by the associated event. ImpactedResourceCount *uint `json:"impactedResourceCount,omitempty" xmlrpc:"impactedResourceCount,omitempty"` // A collection of resources impacted by the associated event. ImpactedResources []Notification_Occurrence_Resource `json:"impactedResources,omitempty" xmlrpc:"impactedResources,omitempty"` // The associated event. NotificationOccurrenceEvent *Notification_Occurrence_Event `json:"notificationOccurrenceEvent,omitempty" xmlrpc:"notificationOccurrenceEvent,omitempty"` // The impacted user. User *User_Customer `json:"user,omitempty" xmlrpc:"user,omitempty"` // no documentation yet UsrRecordId *int `json:"usrRecordId,omitempty" xmlrpc:"usrRecordId,omitempty"` }
This type contains general information relating to a user that may be impacted by a [[SoftLayer_Notification_Occurrence_Event]].
type Notification_Preference ¶
type Notification_Preference struct { Entity // A description of what the preference is used for. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // Unique identifier for the notification preference. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Name that can be used by external systems to refer to preference. KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // Largest value allowed for the preference. MaximumValue *string `json:"maximumValue,omitempty" xmlrpc:"maximumValue,omitempty"` // Smallest value allowed for the preference. MinimumValue *string `json:"minimumValue,omitempty" xmlrpc:"minimumValue,omitempty"` // Friendly name for the notification. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // The unit of measure used for the preference's value, minimum and maximum as well. Units *string `json:"units,omitempty" xmlrpc:"units,omitempty"` // Default value used when setting up preferences for a new subscriber. Value *string `json:"value,omitempty" xmlrpc:"value,omitempty"` }
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.
type Notification_Subscriber ¶
type Notification_Subscriber struct { Entity // no documentation yet Active *int `json:"active,omitempty" xmlrpc:"active,omitempty"` // no documentation yet CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // A count of DeliveryMethodCount *uint `json:"deliveryMethodCount,omitempty" xmlrpc:"deliveryMethodCount,omitempty"` // no documentation yet DeliveryMethods []Notification_Subscriber_Delivery_Method `json:"deliveryMethods,omitempty" xmlrpc:"deliveryMethods,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // no documentation yet Notification *Notification `json:"notification,omitempty" xmlrpc:"notification,omitempty"` // no documentation yet NotificationId *int `json:"notificationId,omitempty" xmlrpc:"notificationId,omitempty"` // no documentation yet NotificationSubscriberTypeId *int `json:"notificationSubscriberTypeId,omitempty" xmlrpc:"notificationSubscriberTypeId,omitempty"` // no documentation yet NotificationSubscriberTypeResourceId *int `json:"notificationSubscriberTypeResourceId,omitempty" xmlrpc:"notificationSubscriberTypeResourceId,omitempty"` }
no documentation yet
type Notification_Subscriber_Customer ¶
type Notification_Subscriber_Customer struct { Notification_Subscriber // no documentation yet SubscriberRecord *User_Customer `json:"subscriberRecord,omitempty" xmlrpc:"subscriberRecord,omitempty"` }
no documentation yet
type Notification_Subscriber_Delivery_Method ¶
type Notification_Subscriber_Delivery_Method struct { Entity // Indicates the subscriber's delivery method availability for notifications. Active *int `json:"active,omitempty" xmlrpc:"active,omitempty"` // Date the subscriber's delivery method was created. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // Date the subscriber's delivery method was last modified. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // no documentation yet NotificationDeliveryMethod *Notification_Delivery_Method `json:"notificationDeliveryMethod,omitempty" xmlrpc:"notificationDeliveryMethod,omitempty"` // Identifier for the notification delivery method. NotificationDeliveryMethodId *int `json:"notificationDeliveryMethodId,omitempty" xmlrpc:"notificationDeliveryMethodId,omitempty"` // no documentation yet NotificationSubscriber *Notification_Subscriber `json:"notificationSubscriber,omitempty" xmlrpc:"notificationSubscriber,omitempty"` // Identifier for the subscriber. NotificationSubscriberId *int `json:"notificationSubscriberId,omitempty" xmlrpc:"notificationSubscriberId,omitempty"` }
Provides details for the subscriber's delivery methods.
type Notification_User_Subscriber ¶
type Notification_User_Subscriber struct { Entity // The current status of the subscription. Active *int `json:"active,omitempty" xmlrpc:"active,omitempty"` // A count of the delivery methods used to send the subscribed notification. DeliveryMethodCount *uint `json:"deliveryMethodCount,omitempty" xmlrpc:"deliveryMethodCount,omitempty"` // The delivery methods used to send the subscribed notification. DeliveryMethods []Notification_Delivery_Method `json:"deliveryMethods,omitempty" xmlrpc:"deliveryMethods,omitempty"` // Unique identifier of the subscriber that will receive the alerts. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Notification subscribed to. Notification *Notification `json:"notification,omitempty" xmlrpc:"notification,omitempty"` // Unique identifier of the notification subscribed to. NotificationId *int `json:"notificationId,omitempty" xmlrpc:"notificationId,omitempty"` // A count of associated subscriber preferences used for the notification subscription. For example, preferences include number of deliveries (limit) and threshold. PreferenceCount *uint `json:"preferenceCount,omitempty" xmlrpc:"preferenceCount,omitempty"` // Associated subscriber preferences used for the notification subscription. For example, preferences include number of deliveries (limit) and threshold. Preferences []Notification_User_Subscriber_Preference `json:"preferences,omitempty" xmlrpc:"preferences,omitempty"` // A count of preference details such as description, minimum and maximum limits, default value and unit of measure. PreferencesDetailCount *uint `json:"preferencesDetailCount,omitempty" xmlrpc:"preferencesDetailCount,omitempty"` // Preference details such as description, minimum and maximum limits, default value and unit of measure. PreferencesDetails []Notification_Preference `json:"preferencesDetails,omitempty" xmlrpc:"preferencesDetails,omitempty"` // The subscriber id to resource id mapping. ResourceRecord *Notification_User_Subscriber_Resource `json:"resourceRecord,omitempty" xmlrpc:"resourceRecord,omitempty"` // User record for the subscription. UserRecord *User_Customer `json:"userRecord,omitempty" xmlrpc:"userRecord,omitempty"` // Unique identifier of the user the subscription is for. UserRecordId *int `json:"userRecordId,omitempty" xmlrpc:"userRecordId,omitempty"` }
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.
type Notification_User_Subscriber_Billing ¶
type Notification_User_Subscriber_Billing struct {
Notification_User_Subscriber
}
A notification subscriber will have details pertaining to the subscriber's notification subscription. You can receive details such as preferences, details of the preferences, delivery methods and the delivery methods for the subscriber.
NOTE: There are preferences and delivery methods that cannot be modified. Also, there are some subscriptions that are required.
type Notification_User_Subscriber_Delivery_Method ¶
type Notification_User_Subscriber_Delivery_Method struct { Entity // Determines if the delivery method is active for the user. Active *int `json:"active,omitempty" xmlrpc:"active,omitempty"` // Provides details for the method used to deliver the notification (email, sms, ticket). DeliveryMethod *Notification_Delivery_Method `json:"deliveryMethod,omitempty" xmlrpc:"deliveryMethod,omitempty"` // Unique identifier of the method used to deliver notification. NotificationMethodId *int `json:"notificationMethodId,omitempty" xmlrpc:"notificationMethodId,omitempty"` // The Subscriber information tied to the delivery method. NotificationUserSubscriber *Notification_User_Subscriber `json:"notificationUserSubscriber,omitempty" xmlrpc:"notificationUserSubscriber,omitempty"` // Unique identifier of the subscriber tied to the delivery method. NotificationUserSubscriberId *int `json:"notificationUserSubscriberId,omitempty" xmlrpc:"notificationUserSubscriberId,omitempty"` }
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.
type Notification_User_Subscriber_Mobile ¶
type Notification_User_Subscriber_Mobile struct {
Notification_User_Subscriber
}
A notification subscriber will have details pertaining to the subscriber's notification subscription. You can receive details such as preferences, details of the preferences, delivery methods and the delivery methods for the subscriber.
NOTE: There are preferences and delivery methods that cannot be modified. Also, there are some subscriptions that are required.
type Notification_User_Subscriber_Preference ¶
type Notification_User_Subscriber_Preference struct { Entity // Details such name, keyname, minimum and maximum values for the preference. DefaultPreference *Notification_Preference `json:"defaultPreference,omitempty" xmlrpc:"defaultPreference,omitempty"` // Unique identifier for the subscriber's preferences. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // 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. NotificationPreferenceId *int `json:"notificationPreferenceId,omitempty" xmlrpc:"notificationPreferenceId,omitempty"` // Details of the subscriber tied to the preference. NotificationUserSubscriber *Notification_User_Subscriber `json:"notificationUserSubscriber,omitempty" xmlrpc:"notificationUserSubscriber,omitempty"` // Unique identifier of the subscriber tied to the subscriber preference. NotificationUserSubscriberId *int `json:"notificationUserSubscriberId,omitempty" xmlrpc:"notificationUserSubscriberId,omitempty"` // The user supplied value to "override" the "default" preference's value. Value *string `json:"value,omitempty" xmlrpc:"value,omitempty"` }
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.
type Notification_User_Subscriber_Resource ¶
type Notification_User_Subscriber_Resource struct { Entity // The Subscriber information tied to the resource service. NotificationUserSubscriber *Notification_User_Subscriber `json:"notificationUserSubscriber,omitempty" xmlrpc:"notificationUserSubscriber,omitempty"` // Unique identifier of the subscriber that will receive the alerts for the resource subscribed to a notification. NotificationUserSubscriberId *int `json:"notificationUserSubscriberId,omitempty" xmlrpc:"notificationUserSubscriberId,omitempty"` // Unique identifier for a SoftLayer service that is subscribed to a notification. Currently, the SoftLayer services that can be subscribed to notifications are: // // Storage EVault CDN // // ResourceTableId *int `json:"resourceTableId,omitempty" xmlrpc:"resourceTableId,omitempty"` }
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.
type Policy_Document_Acceptance_Quote ¶
type Policy_Document_Acceptance_Quote struct { Entity // no documentation yet Resource *Billing_Order_Quote `json:"resource,omitempty" xmlrpc:"resource,omitempty"` }
The SoftLayer_Billing_Oder_Quote data type records acceptance of policy documents for a quote.
type Product_Catalog ¶
type Product_Catalog struct { Entity // A count of brands using this Catalog BrandCount *uint `json:"brandCount,omitempty" xmlrpc:"brandCount,omitempty"` // Brands using this Catalog Brands []Brand `json:"brands,omitempty" xmlrpc:"brands,omitempty"` // The Key Name of the Catalog, used for direct references KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // A count of packages available in this catalog PackageCount *uint `json:"packageCount,omitempty" xmlrpc:"packageCount,omitempty"` // Packages available in this catalog Packages []Product_Package `json:"packages,omitempty" xmlrpc:"packages,omitempty"` // A count of prices available in this catalog PriceCount *uint `json:"priceCount,omitempty" xmlrpc:"priceCount,omitempty"` // Prices available in this catalog Prices []Product_Item_Price `json:"prices,omitempty" xmlrpc:"prices,omitempty"` // A count of products available in catalog ProductCount *uint `json:"productCount,omitempty" xmlrpc:"productCount,omitempty"` // Products available in catalog Products []Product_Item `json:"products,omitempty" xmlrpc:"products,omitempty"` }
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.
type Product_Catalog_Item_Price ¶
type Product_Catalog_Item_Price struct { Entity // Catalog being assigned Catalog *Product_Catalog `json:"catalog,omitempty" xmlrpc:"catalog,omitempty"` // The id of the Catalog the Item Price is part of. CatalogId *int `json:"catalogId,omitempty" xmlrpc:"catalogId,omitempty"` // The time the Item Price was defined in the Catalog CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // The time the Item Price was changed for the Catalog ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // Price being assigned Price *Product_Item_Price `json:"price,omitempty" xmlrpc:"price,omitempty"` // The id of the Item Price that is part of the Catalog. PriceId *int `json:"priceId,omitempty" xmlrpc:"priceId,omitempty"` }
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.
type Product_Group ¶
type Product_Group struct { Entity // The name of the product group. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
The SoftLayer_Product_Group data type contains product group relationship.
type Product_Item ¶
type Product_Item struct { Entity // A count of ActivePresaleEventCount *uint `json:"activePresaleEventCount,omitempty" xmlrpc:"activePresaleEventCount,omitempty"` // no documentation yet ActivePresaleEvents []Sales_Presale_Event `json:"activePresaleEvents,omitempty" xmlrpc:"activePresaleEvents,omitempty"` // A count of active usage based prices. ActiveUsagePriceCount *uint `json:"activeUsagePriceCount,omitempty" xmlrpc:"activeUsagePriceCount,omitempty"` // Active usage based prices. ActiveUsagePrices []Product_Item_Price `json:"activeUsagePrices,omitempty" xmlrpc:"activeUsagePrices,omitempty"` // A count of the attribute values for a product item. These are additional properties that give extra information about the product being sold. AttributeCount *uint `json:"attributeCount,omitempty" xmlrpc:"attributeCount,omitempty"` // The attribute values for a product item. These are additional properties that give extra information about the product being sold. Attributes []Product_Item_Attribute `json:"attributes,omitempty" xmlrpc:"attributes,omitempty"` // A count of attributes that govern when an item may no longer be available. AvailabilityAttributeCount *uint `json:"availabilityAttributeCount,omitempty" xmlrpc:"availabilityAttributeCount,omitempty"` // Attributes that govern when an item may no longer be available. AvailabilityAttributes []Product_Item_Attribute `json:"availabilityAttributes,omitempty" xmlrpc:"availabilityAttributes,omitempty"` // An item's special billing type, if applicable. BillingType *string `json:"billingType,omitempty" xmlrpc:"billingType,omitempty"` // 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. Bundle []Product_Item_Bundles `json:"bundle,omitempty" xmlrpc:"bundle,omitempty"` // 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. BundleCount *uint `json:"bundleCount,omitempty" xmlrpc:"bundleCount,omitempty"` // 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. BundleItemCount *uint `json:"bundleItemCount,omitempty" xmlrpc:"bundleItemCount,omitempty"` // 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. BundleItems []Product_Item `json:"bundleItems,omitempty" xmlrpc:"bundleItems,omitempty"` // 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. Capacity *Float64 `json:"capacity,omitempty" xmlrpc:"capacity,omitempty"` // When the product capacity is best described as a range, this holds the ceiling of the range. CapacityMaximum *string `json:"capacityMaximum,omitempty" xmlrpc:"capacityMaximum,omitempty"` // When the product capacity is best described as a range, this holds the floor of the range. CapacityMinimum *string `json:"capacityMinimum,omitempty" xmlrpc:"capacityMinimum,omitempty"` // This flag indicates that this product is restricted by a capacity on a related product. CapacityRestrictedProductFlag *bool `json:"capacityRestrictedProductFlag,omitempty" xmlrpc:"capacityRestrictedProductFlag,omitempty"` // An item's associated item categories. Categories []Product_Item_Category `json:"categories,omitempty" xmlrpc:"categories,omitempty"` // A count of an item's associated item categories. CategoryCount *uint `json:"categoryCount,omitempty" xmlrpc:"categoryCount,omitempty"` // A count of some product items have configuration templates which can be used to during provisioning of that product. ConfigurationTemplateCount *uint `json:"configurationTemplateCount,omitempty" xmlrpc:"configurationTemplateCount,omitempty"` // Some product items have configuration templates which can be used to during provisioning of that product. ConfigurationTemplates []Configuration_Template `json:"configurationTemplates,omitempty" xmlrpc:"configurationTemplates,omitempty"` // 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. Conflicts []Product_Item_Resource_Conflict `json:"conflicts,omitempty" xmlrpc:"conflicts,omitempty"` // 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|getCapacityRestrictedProductFlag]] CoreRestrictedItemFlag *bool `json:"coreRestrictedItemFlag,omitempty" xmlrpc:"coreRestrictedItemFlag,omitempty"` // A product's description Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // Some product items have a downgrade path. This is the first product item in the downgrade path. DowngradeItem *Product_Item `json:"downgradeItem,omitempty" xmlrpc:"downgradeItem,omitempty"` // A count of some product items have a downgrade path. These are those product items. DowngradeItemCount *uint `json:"downgradeItemCount,omitempty" xmlrpc:"downgradeItemCount,omitempty"` // Some product items have a downgrade path. These are those product items. DowngradeItems []Product_Item `json:"downgradeItems,omitempty" xmlrpc:"downgradeItems,omitempty"` // 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. GlobalCategoryConflicts []Product_Item_Resource_Conflict `json:"globalCategoryConflicts,omitempty" xmlrpc:"globalCategoryConflicts,omitempty"` // The hardware generic component model ID of the product. HardwareGenericComponentId *int `json:"hardwareGenericComponentId,omitempty" xmlrpc:"hardwareGenericComponentId,omitempty"` // The generic hardware component that this item represents. HardwareGenericComponentModel *Hardware_Component_Model_Generic `json:"hardwareGenericComponentModel,omitempty" xmlrpc:"hardwareGenericComponentModel,omitempty"` // no documentation yet HideFromPortalFlag *bool `json:"hideFromPortalFlag,omitempty" xmlrpc:"hideFromPortalFlag,omitempty"` // A product's internal identification number Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet IneligibleForAccountDiscountFlag *bool `json:"ineligibleForAccountDiscountFlag,omitempty" xmlrpc:"ineligibleForAccountDiscountFlag,omitempty"` // DEPRECATED. An item's inventory status per datacenter. Inventory []Product_Package_Inventory `json:"inventory,omitempty" xmlrpc:"inventory,omitempty"` // A count of dEPRECATED. An item's inventory status per datacenter. InventoryCount *uint `json:"inventoryCount,omitempty" xmlrpc:"inventoryCount,omitempty"` // Flag to indicate the server product is engineered for a multi-server solution. (Deprecated) IsEngineeredServerProduct *bool `json:"isEngineeredServerProduct,omitempty" xmlrpc:"isEngineeredServerProduct,omitempty"` // An item's primary item category. ItemCategory *Product_Item_Category `json:"itemCategory,omitempty" xmlrpc:"itemCategory,omitempty"` // A products tax category internal identification number ItemTaxCategoryId *int `json:"itemTaxCategoryId,omitempty" xmlrpc:"itemTaxCategoryId,omitempty"` // A unique key name for the product. KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // no documentation yet LocalDiskFlag *bool `json:"localDiskFlag,omitempty" xmlrpc:"localDiskFlag,omitempty"` // An item's location conflicts. For example, Dual Path network functionality cannot be ordered in WDC and as such is a conflict. LocationConflicts []Product_Item_Resource_Conflict `json:"locationConflicts,omitempty" xmlrpc:"locationConflicts,omitempty"` // Detailed product description LongDescription *string `json:"longDescription,omitempty" xmlrpc:"longDescription,omitempty"` // Indicates whether an item is a M.2 disk controller. M2ControllerFlag *bool `json:"m2ControllerFlag,omitempty" xmlrpc:"m2ControllerFlag,omitempty"` // Indicates whether an item is a M.2 drive. M2DriveFlag *bool `json:"m2DriveFlag,omitempty" xmlrpc:"m2DriveFlag,omitempty"` // The minimum number of bays that support NVMe SSDs. MinimumNvmeBays *int `json:"minimumNvmeBays,omitempty" xmlrpc:"minimumNvmeBays,omitempty"` // Indicates whether an item is a NVMe SSD. NvmeDiskFlag *bool `json:"nvmeDiskFlag,omitempty" xmlrpc:"nvmeDiskFlag,omitempty"` // no documentation yet ObjectStorageClusterGeolocationType *string `json:"objectStorageClusterGeolocationType,omitempty" xmlrpc:"objectStorageClusterGeolocationType,omitempty"` // no documentation yet ObjectStorageItemFlag *bool `json:"objectStorageItemFlag,omitempty" xmlrpc:"objectStorageItemFlag,omitempty"` // no documentation yet ObjectStorageServiceClass *string `json:"objectStorageServiceClass,omitempty" xmlrpc:"objectStorageServiceClass,omitempty"` // A count of a collection of all the SoftLayer_Product_Package(s) in which this item exists. PackageCount *uint `json:"packageCount,omitempty" xmlrpc:"packageCount,omitempty"` // A collection of all the SoftLayer_Product_Package(s) in which this item exists. Packages []Product_Package `json:"packages,omitempty" xmlrpc:"packages,omitempty"` // Indicates whether an item is a PCIe drive. PcieDriveFlag *bool `json:"pcieDriveFlag,omitempty" xmlrpc:"pcieDriveFlag,omitempty"` // The number of cores that a processor has. PhysicalCoreCapacity *string `json:"physicalCoreCapacity,omitempty" xmlrpc:"physicalCoreCapacity,omitempty"` // A count of PresaleEventCount *uint `json:"presaleEventCount,omitempty" xmlrpc:"presaleEventCount,omitempty"` // no documentation yet PresaleEvents []Sales_Presale_Event `json:"presaleEvents,omitempty" xmlrpc:"presaleEvents,omitempty"` // A count of a product item's prices. PriceCount *uint `json:"priceCount,omitempty" xmlrpc:"priceCount,omitempty"` // A product item's prices. Prices []Product_Item_Price `json:"prices,omitempty" xmlrpc:"prices,omitempty"` // The number of private network interfaces provided by a port_speed product. PrivateInterfaceCount *uint `json:"privateInterfaceCount,omitempty" xmlrpc:"privateInterfaceCount,omitempty"` // The number of public network interfaces provided by a port_speed product. PublicInterfaceCount *uint `json:"publicInterfaceCount,omitempty" xmlrpc:"publicInterfaceCount,omitempty"` // If an item must be ordered with another item, it will have a requirement item here. Requirements []Product_Item_Requirement `json:"requirements,omitempty" xmlrpc:"requirements,omitempty"` // A count of an item's rules. This includes the requirements and conflicts to resources that an item has. RuleCount *uint `json:"ruleCount,omitempty" xmlrpc:"ruleCount,omitempty"` // An item's rules. This includes the requirements and conflicts to resources that an item has. Rules []Product_Item_Rule `json:"rules,omitempty" xmlrpc:"rules,omitempty"` // The SoftLayer_Software_Description tied to this item. This will only be populated for software items. SoftwareDescription *Software_Description `json:"softwareDescription,omitempty" xmlrpc:"softwareDescription,omitempty"` // The unique identifier of the SoftLayer_Software_Description tied to this item. SoftwareDescriptionId *int `json:"softwareDescriptionId,omitempty" xmlrpc:"softwareDescriptionId,omitempty"` // The total number of cores for a speed select server product. SpeedSelectServerCoreCount *string `json:"speedSelectServerCoreCount,omitempty" xmlrpc:"speedSelectServerCoreCount,omitempty"` // Indicates a speed select server item. SpeedSelectServerFlag *bool `json:"speedSelectServerFlag,omitempty" xmlrpc:"speedSelectServerFlag,omitempty"` // An item's tax category, if applicable. TaxCategory *Product_Item_Tax_Category `json:"taxCategory,omitempty" xmlrpc:"taxCategory,omitempty"` // A count of third-party policy assignments for this product. ThirdPartyPolicyAssignmentCount *uint `json:"thirdPartyPolicyAssignmentCount,omitempty" xmlrpc:"thirdPartyPolicyAssignmentCount,omitempty"` // Third-party policy assignments for this product. ThirdPartyPolicyAssignments []Product_Item_Policy_Assignment `json:"thirdPartyPolicyAssignments,omitempty" xmlrpc:"thirdPartyPolicyAssignments,omitempty"` // The 3rd party vendor for a support subscription item. (Deprecated) ThirdPartySupportVendor *string `json:"thirdPartySupportVendor,omitempty" xmlrpc:"thirdPartySupportVendor,omitempty"` // The total number of physical processing cores (excluding virtual cores / hyperthreads) for this server. TotalPhysicalCoreCapacity *int `json:"totalPhysicalCoreCapacity,omitempty" xmlrpc:"totalPhysicalCoreCapacity,omitempty"` // Shows the total number of cores. This is deprecated. Use [[SoftLayer_Product_Item/getCapacity|getCapacity]] for guest_core products and [[SoftLayer_Product_Item/getTotalPhysicalCoreCapacity|getTotalPhysicalCoreCapacity]] for server products TotalPhysicalCoreCount *int `json:"totalPhysicalCoreCount,omitempty" xmlrpc:"totalPhysicalCoreCount,omitempty"` // The total number of processors for this server. TotalProcessorCapacity *int `json:"totalProcessorCapacity,omitempty" xmlrpc:"totalProcessorCapacity,omitempty"` // The unit of measurement that a product item is measured in. Units *string `json:"units,omitempty" xmlrpc:"units,omitempty"` // Some product items have an upgrade path. This is the next product item in the upgrade path. UpgradeItem *Product_Item `json:"upgradeItem,omitempty" xmlrpc:"upgradeItem,omitempty"` // A count of some product items have an upgrade path. These are those upgrade product items. UpgradeItemCount *uint `json:"upgradeItemCount,omitempty" xmlrpc:"upgradeItemCount,omitempty"` // A products upgrade item's internal identification number UpgradeItemId *int `json:"upgradeItemId,omitempty" xmlrpc:"upgradeItemId,omitempty"` // Some product items have an upgrade path. These are those upgrade product items. UpgradeItems []Product_Item `json:"upgradeItems,omitempty" xmlrpc:"upgradeItems,omitempty"` }
The SoftLayer_Product_Item data type contains general information relating to a single SoftLayer product.
type Product_Item_Attribute ¶
type Product_Item_Attribute struct { Entity // This represents the attribute type of this product attribute. AttributeType *Product_Item_Attribute_Type `json:"attributeType,omitempty" xmlrpc:"attributeType,omitempty"` // This represents the attribute type's key name of this product attribute. AttributeTypeKeyName *string `json:"attributeTypeKeyName,omitempty" xmlrpc:"attributeTypeKeyName,omitempty"` // This is the primary key value for the product attribute. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // This represents the product that an attribute is tied to. Item *Product_Item `json:"item,omitempty" xmlrpc:"item,omitempty"` // This is a foreign key value for the [[SoftLayer_Product_Item_Attribute_Type]]. ItemAttributeTypeId *int `json:"itemAttributeTypeId,omitempty" xmlrpc:"itemAttributeTypeId,omitempty"` // This is a foreign key value for the [[SoftLayer_Product_Item]]. ItemId *int `json:"itemId,omitempty" xmlrpc:"itemId,omitempty"` // This is the value for the attribute. Value *string `json:"value,omitempty" xmlrpc:"value,omitempty"` }
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.
type Product_Item_Attribute_Type ¶
type Product_Item_Attribute_Type struct { Entity // This is the unique identifier of the attribute type. KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // This is the user-friendly readable name of the attribute type. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
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|product attribute]] by a unique key name value.
type Product_Item_Billing_Type ¶
type Product_Item_Billing_Type struct { Entity // A keyword describing a SoftLayer product item billing type. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
The SoftLayer_Product_Item_Billing_Type data type models special billing types for non-monthly billed items in the SoftLayer product catalog.
type Product_Item_Bundles ¶
type Product_Item_Bundles struct { Entity // Item in bundle. BundleItem *Product_Item `json:"bundleItem,omitempty" xmlrpc:"bundleItem,omitempty"` // Identifier for bundle. BundleItemId *int `json:"bundleItemId,omitempty" xmlrpc:"bundleItemId,omitempty"` // Category bundle falls in. Category *Product_Item_Category `json:"category,omitempty" xmlrpc:"category,omitempty"` // Identifier for record. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Price of item in bundle ItemPrice *Product_Item_Price `json:"itemPrice,omitempty" xmlrpc:"itemPrice,omitempty"` // Identifier for price. ItemPriceId *int `json:"itemPriceId,omitempty" xmlrpc:"itemPriceId,omitempty"` }
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.
type Product_Item_Category ¶
type Product_Item_Category struct { Entity // A count of the billing items associated with an account that share a category code with an item category's category code. BillingItemCount *uint `json:"billingItemCount,omitempty" xmlrpc:"billingItemCount,omitempty"` // The billing items associated with an account that share a category code with an item category's category code. BillingItems []Billing_Item `json:"billingItems,omitempty" xmlrpc:"billingItems,omitempty"` // The code used to identify this category. CategoryCode *string `json:"categoryCode,omitempty" xmlrpc:"categoryCode,omitempty"` // This invoice item's "item category group". Group *Product_Item_Category_Group `json:"group,omitempty" xmlrpc:"group,omitempty"` // A count of a collection of service offering category groups. Each group contains a collection of items associated with this category. GroupCount *uint `json:"groupCount,omitempty" xmlrpc:"groupCount,omitempty"` // A collection of service offering category groups. Each group contains a collection of items associated with this category. Groups []Product_Package_Item_Category_Group `json:"groups,omitempty" xmlrpc:"groups,omitempty"` // identifier for category. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The friendly, descriptive name of the category as seen on the order forms and on invoices. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // A count of any unique options associated with an item category. OrderOptionCount *uint `json:"orderOptionCount,omitempty" xmlrpc:"orderOptionCount,omitempty"` // Any unique options associated with an item category. OrderOptions []Product_Item_Category_Order_Option_Type `json:"orderOptions,omitempty" xmlrpc:"orderOptions,omitempty"` // A count of a list of configuration available in this category.' PackageConfigurationCount *uint `json:"packageConfigurationCount,omitempty" xmlrpc:"packageConfigurationCount,omitempty"` // A list of configuration available in this category.' PackageConfigurations []Product_Package_Order_Configuration `json:"packageConfigurations,omitempty" xmlrpc:"packageConfigurations,omitempty"` // A count of a list of preset configurations this category is used in.' PresetConfigurationCount *uint `json:"presetConfigurationCount,omitempty" xmlrpc:"presetConfigurationCount,omitempty"` // A list of preset configurations this category is used in.' PresetConfigurations []Product_Package_Preset_Configuration `json:"presetConfigurations,omitempty" xmlrpc:"presetConfigurations,omitempty"` // 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 QuantityLimit *int `json:"quantityLimit,omitempty" xmlrpc:"quantityLimit,omitempty"` // A count of the questions that are associated with an item category. QuestionCount *uint `json:"questionCount,omitempty" xmlrpc:"questionCount,omitempty"` // A count of the question references that are associated with an item category. QuestionReferenceCount *uint `json:"questionReferenceCount,omitempty" xmlrpc:"questionReferenceCount,omitempty"` // The question references that are associated with an item category. QuestionReferences []Product_Item_Category_Question_Xref `json:"questionReferences,omitempty" xmlrpc:"questionReferences,omitempty"` // The questions that are associated with an item category. Questions []Product_Item_Category_Question `json:"questions,omitempty" xmlrpc:"questions,omitempty"` // 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). SortOrder *int `json:"sortOrder,omitempty" xmlrpc:"sortOrder,omitempty"` }
The SoftLayer_Product_Item_Category data type contains general category information for prices.
type Product_Item_Category_Group ¶
type Product_Item_Category_Group struct { Entity // identifier for category group. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The friendly, descriptive name of the category group as seen on the order forms and on invoices. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
The SoftLayer_Product_Item_Category_Group data type contains general category group information.
type Product_Item_Category_Order_Option_Type ¶
type Product_Item_Category_Order_Option_Type struct { Entity // An item category order type's description. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // An item category order type's unique identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A simple description for an item category order type. Keyname *string `json:"keyname,omitempty" xmlrpc:"keyname,omitempty"` // An item category order type's name. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // The value of the item category type's option. Value *string `json:"value,omitempty" xmlrpc:"value,omitempty"` }
The SoftLayer_Product_Item_Category_Order_Option_Type data type contains options that can be applied to orders for prices.
type Product_Item_Category_Question ¶
type Product_Item_Category_Question struct { Entity // The type of answer expected. AnswerValueExpression *string `json:"answerValueExpression,omitempty" xmlrpc:"answerValueExpression,omitempty"` // The description for the question. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // The type of field that should be used in an HTML form to accept an answer from an end user. FieldType *Product_Item_Category_Question_Field_Type `json:"fieldType,omitempty" xmlrpc:"fieldType,omitempty"` // The type of field to use. FieldTypeId *int `json:"fieldTypeId,omitempty" xmlrpc:"fieldTypeId,omitempty"` // identifier for category. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A count of the link between an item category and an item category question. ItemCategoryReferenceCount *uint `json:"itemCategoryReferenceCount,omitempty" xmlrpc:"itemCategoryReferenceCount,omitempty"` // The link between an item category and an item category question. ItemCategoryReferences []Product_Item_Category_Question_Xref `json:"itemCategoryReferences,omitempty" xmlrpc:"itemCategoryReferences,omitempty"` // The keyname for the question. KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // The question for the category. Question *string `json:"question,omitempty" xmlrpc:"question,omitempty"` // An example and/or explanation of what the answer for the question is expected to look like. ValueExample *string `json:"valueExample,omitempty" xmlrpc:"valueExample,omitempty"` }
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.
type Product_Item_Category_Question_Field_Type ¶
type Product_Item_Category_Question_Field_Type struct { Entity // Identifier for the question type. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Keyname for the question field type. KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // Short name for the question field type. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
The SoftLayer_Product_Item_Category_Question_Field_Type data type represents the recommended type of field that should be rendered on an HTML form.
type Product_Item_Category_Question_Xref ¶
type Product_Item_Category_Question_Xref struct { Entity // Identifier for category question xref record. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The product item category that this reference points to. ItemCategory *Product_Item_Category `json:"itemCategory,omitempty" xmlrpc:"itemCategory,omitempty"` // Identifier for item category. ItemCategoryId *int `json:"itemCategoryId,omitempty" xmlrpc:"itemCategoryId,omitempty"` // Identifier for the question. LocationId *int `json:"locationId,omitempty" xmlrpc:"locationId,omitempty"` // The item category question that this reference points to. Question *Product_Item_Category_Question `json:"question,omitempty" xmlrpc:"question,omitempty"` // Identifier for the question. QuestionId *int `json:"questionId,omitempty" xmlrpc:"questionId,omitempty"` // Flag to indicate whether an answer is required for the question.. Required *bool `json:"required,omitempty" xmlrpc:"required,omitempty"` }
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.
type Product_Item_Overage_Price ¶
type Product_Item_Overage_Price struct { Entity // no documentation yet DefaultOverageItem *Product_Item `json:"defaultOverageItem,omitempty" xmlrpc:"defaultOverageItem,omitempty"` // no documentation yet Item *Product_Item `json:"item,omitempty" xmlrpc:"item,omitempty"` }
no documentation yet
type Product_Item_Policy_Assignment ¶
type Product_Item_Policy_Assignment struct { Entity // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The name of the assigned policy. PolicyName *string `json:"policyName,omitempty" xmlrpc:"policyName,omitempty"` // The [[SoftLayer_Product_Item]] for this policy assignment. Product *Product_Item `json:"product,omitempty" xmlrpc:"product,omitempty"` // no documentation yet ProductId *int `json:"productId,omitempty" xmlrpc:"productId,omitempty"` }
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.
type Product_Item_Price ¶
type Product_Item_Price struct { Entity // A count of the account that the item price is restricted to. AccountRestrictionCount *uint `json:"accountRestrictionCount,omitempty" xmlrpc:"accountRestrictionCount,omitempty"` // The account that the item price is restricted to. AccountRestrictions []Product_Item_Price_Account_Restriction `json:"accountRestrictions,omitempty" xmlrpc:"accountRestrictions,omitempty"` // A count of AttributeCount *uint `json:"attributeCount,omitempty" xmlrpc:"attributeCount,omitempty"` // no documentation yet Attributes []Product_Item_Price_Attribute `json:"attributes,omitempty" xmlrpc:"attributes,omitempty"` // Signifies pricing that is only available on a bare metal reserved capacity order. BareMetalReservedCapacityFlag *bool `json:"bareMetalReservedCapacityFlag,omitempty" xmlrpc:"bareMetalReservedCapacityFlag,omitempty"` // Whether the price is for Big Data OS/Journal disks only. (Deprecated) BigDataOsJournalDiskFlag *bool `json:"bigDataOsJournalDiskFlag,omitempty" xmlrpc:"bigDataOsJournalDiskFlag,omitempty"` // A count of cross reference for bundles BundleReferenceCount *uint `json:"bundleReferenceCount,omitempty" xmlrpc:"bundleReferenceCount,omitempty"` // cross reference for bundles BundleReferences []Product_Item_Bundles `json:"bundleReferences,omitempty" xmlrpc:"bundleReferences,omitempty"` // The maximum capacity value for which this price is suitable. CapacityRestrictionMaximum *string `json:"capacityRestrictionMaximum,omitempty" xmlrpc:"capacityRestrictionMaximum,omitempty"` // The minimum capacity value for which this price is suitable. CapacityRestrictionMinimum *string `json:"capacityRestrictionMinimum,omitempty" xmlrpc:"capacityRestrictionMinimum,omitempty"` // The type of capacity restriction by which this price must abide. CapacityRestrictionType *string `json:"capacityRestrictionType,omitempty" xmlrpc:"capacityRestrictionType,omitempty"` // All categories which this item is a member. Categories []Product_Item_Category `json:"categories,omitempty" xmlrpc:"categories,omitempty"` // A count of all categories which this item is a member. CategoryCount *uint `json:"categoryCount,omitempty" xmlrpc:"categoryCount,omitempty"` // 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. CurrentPriceFlag *bool `json:"currentPriceFlag,omitempty" xmlrpc:"currentPriceFlag,omitempty"` // Signifies pricing that is only available on a dedicated host virtual server order. DedicatedHostInstanceFlag *bool `json:"dedicatedHostInstanceFlag,omitempty" xmlrpc:"dedicatedHostInstanceFlag,omitempty"` // Whether this price defines a software license for its product item. DefinedSoftwareLicenseFlag *bool `json:"definedSoftwareLicenseFlag,omitempty" xmlrpc:"definedSoftwareLicenseFlag,omitempty"` // Eligibility strategy to assess if a customer can order using this price. EligibilityStrategy *string `json:"eligibilityStrategy,omitempty" xmlrpc:"eligibilityStrategy,omitempty"` // The hourly price for this item, should this item be part of an hourly pricing package. HourlyRecurringFee *Float64 `json:"hourlyRecurringFee,omitempty" xmlrpc:"hourlyRecurringFee,omitempty"` // The unique identifier of a Product Item Price. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The product item a price is tied to. Item *Product_Item `json:"item,omitempty" xmlrpc:"item,omitempty"` // The unique identifier for a product Item ItemId *int `json:"itemId,omitempty" xmlrpc:"itemId,omitempty"` // The labor fee for a product item price. LaborFee *Float64 `json:"laborFee,omitempty" xmlrpc:"laborFee,omitempty"` // 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|verification]] and [[SoftLayer_Product_Order/placeOrder|placement]], 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. LocationGroupId *int `json:"locationGroupId,omitempty" xmlrpc:"locationGroupId,omitempty"` // On sale flag. OnSaleFlag *bool `json:"onSaleFlag,omitempty" xmlrpc:"onSaleFlag,omitempty"` // The one time fee for a product item price. OneTimeFee *Float64 `json:"oneTimeFee,omitempty" xmlrpc:"oneTimeFee,omitempty"` // 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() OneTimeFeeTax *Float64 `json:"oneTimeFeeTax,omitempty" xmlrpc:"oneTimeFeeTax,omitempty"` // Order options for the category that this price is associated with. OrderOptions []Product_Item_Category_Order_Option_Type `json:"orderOptions,omitempty" xmlrpc:"orderOptions,omitempty"` // A count of OrderPremiumCount *uint `json:"orderPremiumCount,omitempty" xmlrpc:"orderPremiumCount,omitempty"` // no documentation yet OrderPremiums []Product_Item_Price_Premium `json:"orderPremiums,omitempty" xmlrpc:"orderPremiums,omitempty"` // A count of a price's packages under which this item is sold. PackageCount *uint `json:"packageCount,omitempty" xmlrpc:"packageCount,omitempty"` // A count of cross reference for packages PackageReferenceCount *uint `json:"packageReferenceCount,omitempty" xmlrpc:"packageReferenceCount,omitempty"` // cross reference for packages PackageReferences []Product_Package_Item_Prices `json:"packageReferences,omitempty" xmlrpc:"packageReferences,omitempty"` // A price's packages under which this item is sold. Packages []Product_Package `json:"packages,omitempty" xmlrpc:"packages,omitempty"` // A count of a list of preset configurations this price is used in.' PresetConfigurationCount *uint `json:"presetConfigurationCount,omitempty" xmlrpc:"presetConfigurationCount,omitempty"` // A list of preset configurations this price is used in.' PresetConfigurations []Product_Package_Preset_Configuration `json:"presetConfigurations,omitempty" xmlrpc:"presetConfigurations,omitempty"` // The type keyname of this price which can be STANDARD, TIERED, or TERM. PriceType *string `json:"priceType,omitempty" xmlrpc:"priceType,omitempty"` // 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. PricingLocationGroup *Location_Group_Pricing `json:"pricingLocationGroup,omitempty" xmlrpc:"pricingLocationGroup,omitempty"` // A recurring fee is a fee that happens every billing period. This fee is represented as a floating point decimal in US dollars ($USD). ProratedRecurringFee *Float64 `json:"proratedRecurringFee,omitempty" xmlrpc:"proratedRecurringFee,omitempty"` // A price's tax amount of the recurring fee. This is only populated after the order is verified via SoftLayer_Product_Order::verifyOrder() ProratedRecurringFeeTax *Float64 `json:"proratedRecurringFeeTax,omitempty" xmlrpc:"proratedRecurringFeeTax,omitempty"` // no documentation yet Quantity *int `json:"quantity,omitempty" xmlrpc:"quantity,omitempty"` // A recurring fee is a fee that happens every billing period. This fee is represented as a floating point decimal in US dollars ($USD). RecurringFee *Float64 `json:"recurringFee,omitempty" xmlrpc:"recurringFee,omitempty"` // A price's tax amount of the recurring fee. This is only populated after the order is verified via SoftLayer_Product_Order::verifyOrder() RecurringFeeTax *Float64 `json:"recurringFeeTax,omitempty" xmlrpc:"recurringFeeTax,omitempty"` // The number of server cores required to order this item. This is deprecated. Use [[SoftLayer_Product_Item_Price/getCapacityRestrictionMinimum|getCapacityRestrictionMinimum]] and [[SoftLayer_Product_Item_Price/getCapacityRestrictionMaximum|getCapacityRestrictionMaximum]] RequiredCoreCount *int `json:"requiredCoreCount,omitempty" xmlrpc:"requiredCoreCount,omitempty"` // Signifies pricing that is only available on a reserved capacity virtual server order. ReservedCapacityInstanceFlag *bool `json:"reservedCapacityInstanceFlag,omitempty" xmlrpc:"reservedCapacityInstanceFlag,omitempty"` // The setup fee associated with a product item price. SetupFee *Float64 `json:"setupFee,omitempty" xmlrpc:"setupFee,omitempty"` // Used for ordering items on sales orders. Sort *int `json:"sort,omitempty" xmlrpc:"sort,omitempty"` // The number of months a term lasts for a term-based price TermLength *int `json:"termLength,omitempty" xmlrpc:"termLength,omitempty"` // 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]]. TierMinimumThreshold *int `json:"tierMinimumThreshold,omitempty" xmlrpc:"tierMinimumThreshold,omitempty"` // The rate for a usage based item UsageRate *Float64 `json:"usageRate,omitempty" xmlrpc:"usageRate,omitempty"` }
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).
type Product_Item_Price_Account_Restriction ¶
type Product_Item_Price_Account_Restriction struct { Entity // The account the item price is restricted to. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // The account id for the item price account restriction. AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // The unique identifier for the item price account restriction. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The item price that has the account restriction. ItemPrice *Product_Item_Price `json:"itemPrice,omitempty" xmlrpc:"itemPrice,omitempty"` // The item price id for the item price account restriction. ItemPriceId *int `json:"itemPriceId,omitempty" xmlrpc:"itemPriceId,omitempty"` }
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.
type Product_Item_Price_Attribute ¶
type Product_Item_Price_Attribute struct { Entity // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet ItemPrice *Product_Item_Price `json:"itemPrice,omitempty" xmlrpc:"itemPrice,omitempty"` // no documentation yet ItemPriceAttributeType *Product_Item_Price_Attribute_Type `json:"itemPriceAttributeType,omitempty" xmlrpc:"itemPriceAttributeType,omitempty"` // no documentation yet ItemPriceAttributeTypeId *int `json:"itemPriceAttributeTypeId,omitempty" xmlrpc:"itemPriceAttributeTypeId,omitempty"` // no documentation yet ItemPriceId *int `json:"itemPriceId,omitempty" xmlrpc:"itemPriceId,omitempty"` // no documentation yet Value *string `json:"value,omitempty" xmlrpc:"value,omitempty"` }
no documentation yet
type Product_Item_Price_Attribute_Type ¶
type Product_Item_Price_Attribute_Type struct { Entity // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet Keyname *string `json:"keyname,omitempty" xmlrpc:"keyname,omitempty"` }
no documentation yet
type Product_Item_Price_Premium ¶
type Product_Item_Price_Premium struct { Entity // no documentation yet HourlyModifier *Float64 `json:"hourlyModifier,omitempty" xmlrpc:"hourlyModifier,omitempty"` // no documentation yet ItemPrice *Product_Item_Price `json:"itemPrice,omitempty" xmlrpc:"itemPrice,omitempty"` // no documentation yet ItemPriceId *int `json:"itemPriceId,omitempty" xmlrpc:"itemPriceId,omitempty"` // no documentation yet Location *Location `json:"location,omitempty" xmlrpc:"location,omitempty"` // no documentation yet LocationId *int `json:"locationId,omitempty" xmlrpc:"locationId,omitempty"` // no documentation yet MonthlyModifier *Float64 `json:"monthlyModifier,omitempty" xmlrpc:"monthlyModifier,omitempty"` // no documentation yet Package *Product_Package `json:"package,omitempty" xmlrpc:"package,omitempty"` // no documentation yet PackageId *int `json:"packageId,omitempty" xmlrpc:"packageId,omitempty"` }
no documentation yet
type Product_Item_Requirement ¶
type Product_Item_Requirement struct { Entity // Identifier for this record. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Item requirement applies to. Item *Product_Item `json:"item,omitempty" xmlrpc:"item,omitempty"` // This is the id of the item affected by the requirement. ItemId *int `json:"itemId,omitempty" xmlrpc:"itemId,omitempty"` // This is a custom message to display to the user when this requirement shortfall arises. Message *string `json:"message,omitempty" xmlrpc:"message,omitempty"` // The product containing the requirement. Product *Product_Item `json:"product,omitempty" xmlrpc:"product,omitempty"` // This is the id of the item required. RequiredItemId *int `json:"requiredItemId,omitempty" xmlrpc:"requiredItemId,omitempty"` }
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.
type Product_Item_Resource_Conflict ¶
type Product_Item_Resource_Conflict struct { Entity // no documentation yet Item *Product_Item `json:"item,omitempty" xmlrpc:"item,omitempty"` // The unique identifier of the item that contains the conflict. ItemId *int `json:"itemId,omitempty" xmlrpc:"itemId,omitempty"` // An optional conflict message. Message *string `json:"message,omitempty" xmlrpc:"message,omitempty"` // no documentation yet Package *Product_Package `json:"package,omitempty" xmlrpc:"package,omitempty"` // The unique identifier of the service offering that is associated with the conflict. PackageId *int `json:"packageId,omitempty" xmlrpc:"packageId,omitempty"` // The unique identifier of the conflicting type. ResourceTableId *int `json:"resourceTableId,omitempty" xmlrpc:"resourceTableId,omitempty"` }
no documentation yet
type Product_Item_Resource_Conflict_Item ¶
type Product_Item_Resource_Conflict_Item struct { Product_Item_Resource_Conflict // A product item that conflicts with another product item. Resource *Product_Item `json:"resource,omitempty" xmlrpc:"resource,omitempty"` }
no documentation yet
type Product_Item_Resource_Conflict_Item_Category ¶
type Product_Item_Resource_Conflict_Item_Category struct { Product_Item_Resource_Conflict // An item category that conflicts with a product item. Resource *Product_Item_Category `json:"resource,omitempty" xmlrpc:"resource,omitempty"` }
no documentation yet
type Product_Item_Resource_Conflict_Location ¶
type Product_Item_Resource_Conflict_Location struct { Product_Item_Resource_Conflict // A location that conflicts with a product item. Resource *Location `json:"resource,omitempty" xmlrpc:"resource,omitempty"` }
no documentation yet
type Product_Item_Rule ¶
type Product_Item_Rule struct { Entity // The product item that a rule applies to. Item *Product_Item `json:"item,omitempty" xmlrpc:"item,omitempty"` // A count of ItemCategoryResourceCount *uint `json:"itemCategoryResourceCount,omitempty" xmlrpc:"itemCategoryResourceCount,omitempty"` // no documentation yet ItemCategoryResources []Product_Item_Rule_Resource_Item_Category `json:"itemCategoryResources,omitempty" xmlrpc:"itemCategoryResources,omitempty"` // The unique identifier of the item that the rule applies to. ItemId *int `json:"itemId,omitempty" xmlrpc:"itemId,omitempty"` // A count of ItemResourceCount *uint `json:"itemResourceCount,omitempty" xmlrpc:"itemResourceCount,omitempty"` // no documentation yet ItemResources []Product_Item_Rule_Resource_Item `json:"itemResources,omitempty" xmlrpc:"itemResources,omitempty"` // A count of LocationResourceCount *uint `json:"locationResourceCount,omitempty" xmlrpc:"locationResourceCount,omitempty"` // no documentation yet LocationResources []Product_Item_Rule_Resource_Location `json:"locationResources,omitempty" xmlrpc:"locationResources,omitempty"` // An optional message shown for when the rule is found to be invalid when ordering. Message *string `json:"message,omitempty" xmlrpc:"message,omitempty"` // no documentation yet Operation *string `json:"operation,omitempty" xmlrpc:"operation,omitempty"` // The package that a rule is applicable to when ordering. If no package exists, the rule applies to any package. Package *Product_Package `json:"package,omitempty" xmlrpc:"package,omitempty"` // The unique identifier of the service offering that is associated with the rule. PackageId *int `json:"packageId,omitempty" xmlrpc:"packageId,omitempty"` // A count of PermissionResourceCount *uint `json:"permissionResourceCount,omitempty" xmlrpc:"permissionResourceCount,omitempty"` // no documentation yet PermissionResources []Product_Item_Rule_Resource_Permission `json:"permissionResources,omitempty" xmlrpc:"permissionResources,omitempty"` // A count of resources for this rule that are validated when ordering. ResourceCount *uint `json:"resourceCount,omitempty" xmlrpc:"resourceCount,omitempty"` // Resources for this rule that are validated when ordering. Resources []Product_Item_Rule_Resource `json:"resources,omitempty" xmlrpc:"resources,omitempty"` // The type a rule is. The type affects how the rule is validated when ordering. Type *Product_Item_Rule_Type `json:"type,omitempty" xmlrpc:"type,omitempty"` // The unique identifier of the type of resource rule. TypeId *int `json:"typeId,omitempty" xmlrpc:"typeId,omitempty"` }
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.
type Product_Item_Rule_Resource ¶
type Product_Item_Rule_Resource struct { Entity // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The unique identifier of the resource. ResourceTableId *int `json:"resourceTableId,omitempty" xmlrpc:"resourceTableId,omitempty"` // no documentation yet Rule *Product_Item_Rule `json:"rule,omitempty" xmlrpc:"rule,omitempty"` // The unique identifier of the rule this resource is included in. RuleId *int `json:"ruleId,omitempty" xmlrpc:"ruleId,omitempty"` }
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.
type Product_Item_Rule_Resource_Item ¶
type Product_Item_Rule_Resource_Item struct { Product_Item_Rule_Resource // A product item that the associated rule applies to. Resource *Product_Item `json:"resource,omitempty" xmlrpc:"resource,omitempty"` }
no documentation yet
type Product_Item_Rule_Resource_Item_Category ¶
type Product_Item_Rule_Resource_Item_Category struct { Product_Item_Rule_Resource // An item category that the associated rule applies to. Resource *Product_Item_Category `json:"resource,omitempty" xmlrpc:"resource,omitempty"` }
no documentation yet
type Product_Item_Rule_Resource_Location ¶
type Product_Item_Rule_Resource_Location struct { Product_Item_Rule_Resource // A location that the associated rule applies to. Resource *Location `json:"resource,omitempty" xmlrpc:"resource,omitempty"` }
no documentation yet
type Product_Item_Rule_Resource_Permission ¶
type Product_Item_Rule_Resource_Permission struct { Product_Item_Rule_Resource // A user permission that the associated rule applies to. Resource *User_Customer_CustomerPermission_Permission `json:"resource,omitempty" xmlrpc:"resource,omitempty"` }
no documentation yet
type Product_Item_Rule_Type ¶
type Product_Item_Rule_Type struct { Entity // The identifier for the item rule type. KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` }
The item rule type data type represents the type of an item rule.
type Product_Item_Server_Group ¶
type Product_Item_Server_Group struct { Entity // The server group's string identifier KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // The server group's friendly name Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
The SoftLayer_Product_Item_Server_Group data type details the type of compute service a [[SoftLayer_Product_Item (type)|SoftLayer_Product_Item]] or [[SoftLayer_Product_Package_Preset (type)|SoftLayer_Product_Package_Preset]] belongs to.
type Product_Item_Tax_Category ¶
type Product_Item_Tax_Category struct { Entity // An internal identifier for each tax category. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A count of ItemCount *uint `json:"itemCount,omitempty" xmlrpc:"itemCount,omitempty"` // no documentation yet Items []Product_Item `json:"items,omitempty" xmlrpc:"items,omitempty"` // The key name of the tax category. KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // The name of the tax category. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // The status of the tax category. StatusFlag *int `json:"statusFlag,omitempty" xmlrpc:"statusFlag,omitempty"` }
The SoftLayer_Product_Item_Tax_Category data type contains the tax categories that are associated with products.
type Product_Package ¶
type Product_Package struct { Entity // A count of the preset configurations available only for the authenticated account and this package. AccountRestrictedActivePresetCount *uint `json:"accountRestrictedActivePresetCount,omitempty" xmlrpc:"accountRestrictedActivePresetCount,omitempty"` // The preset configurations available only for the authenticated account and this package. AccountRestrictedActivePresets []Product_Package_Preset `json:"accountRestrictedActivePresets,omitempty" xmlrpc:"accountRestrictedActivePresets,omitempty"` // The results from this call are similar to [[SoftLayer_Product_Package/getCategories|getCategories]], but these ONLY include account-restricted prices. Not all accounts have restricted pricing. AccountRestrictedCategories []Product_Item_Category `json:"accountRestrictedCategories,omitempty" xmlrpc:"accountRestrictedCategories,omitempty"` // A count of the results from this call are similar to [[SoftLayer_Product_Package/getCategories|getCategories]], but these ONLY include account-restricted prices. Not all accounts have restricted pricing. AccountRestrictedCategoryCount *uint `json:"accountRestrictedCategoryCount,omitempty" xmlrpc:"accountRestrictedCategoryCount,omitempty"` // The flag to indicate if there are any restricted prices in a package for the currently-active account. AccountRestrictedPricesFlag *bool `json:"accountRestrictedPricesFlag,omitempty" xmlrpc:"accountRestrictedPricesFlag,omitempty"` // A count of the available preset configurations for this package. ActivePresetCount *uint `json:"activePresetCount,omitempty" xmlrpc:"activePresetCount,omitempty"` // The available preset configurations for this package. ActivePresets []Product_Package_Preset `json:"activePresets,omitempty" xmlrpc:"activePresets,omitempty"` // A count of a collection of valid RAM items available for purchase in this package. ActiveRamItemCount *uint `json:"activeRamItemCount,omitempty" xmlrpc:"activeRamItemCount,omitempty"` // A collection of valid RAM items available for purchase in this package. ActiveRamItems []Product_Item `json:"activeRamItems,omitempty" xmlrpc:"activeRamItems,omitempty"` // A count of a collection of valid server items available for purchase in this package. ActiveServerItemCount *uint `json:"activeServerItemCount,omitempty" xmlrpc:"activeServerItemCount,omitempty"` // A collection of valid server items available for purchase in this package. ActiveServerItems []Product_Item `json:"activeServerItems,omitempty" xmlrpc:"activeServerItems,omitempty"` // A count of a collection of valid software items available for purchase in this package. ActiveSoftwareItemCount *uint `json:"activeSoftwareItemCount,omitempty" xmlrpc:"activeSoftwareItemCount,omitempty"` // A collection of valid software items available for purchase in this package. ActiveSoftwareItems []Product_Item `json:"activeSoftwareItems,omitempty" xmlrpc:"activeSoftwareItems,omitempty"` // A count of a collection of [[SoftLayer_Product_Item_Price]] objects for pay-as-you-go usage. ActiveUsagePriceCount *uint `json:"activeUsagePriceCount,omitempty" xmlrpc:"activeUsagePriceCount,omitempty"` // A collection of [[SoftLayer_Product_Item_Price]] objects for pay-as-you-go usage. ActiveUsagePrices []Product_Item_Price `json:"activeUsagePrices,omitempty" xmlrpc:"activeUsagePrices,omitempty"` // This flag indicates that the package is an additional service. AdditionalServiceFlag *bool `json:"additionalServiceFlag,omitempty" xmlrpc:"additionalServiceFlag,omitempty"` // A count of AttributeCount *uint `json:"attributeCount,omitempty" xmlrpc:"attributeCount,omitempty"` // no documentation yet Attributes []Product_Package_Attribute `json:"attributes,omitempty" xmlrpc:"attributes,omitempty"` // A count of a collection of valid locations for this package. (Deprecated - Use [[SoftLayer_Product_Package/getRegions|getRegions]]) AvailableLocationCount *uint `json:"availableLocationCount,omitempty" xmlrpc:"availableLocationCount,omitempty"` // A collection of valid locations for this package. (Deprecated - Use [[SoftLayer_Product_Package/getRegions|getRegions]]) AvailableLocations []Product_Package_Locations `json:"availableLocations,omitempty" xmlrpc:"availableLocations,omitempty"` // The maximum number of available disk storage units associated with the servers in a package. AvailableStorageUnits *uint `json:"availableStorageUnits,omitempty" xmlrpc:"availableStorageUnits,omitempty"` // 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. Categories []Product_Item_Category `json:"categories,omitempty" xmlrpc:"categories,omitempty"` // The item categories associated with a package, including information detailing which item categories are required as part of a SoftLayer product order. Configuration []Product_Package_Order_Configuration `json:"configuration,omitempty" xmlrpc:"configuration,omitempty"` // 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. ConfigurationCount *uint `json:"configurationCount,omitempty" xmlrpc:"configurationCount,omitempty"` // The default boot category code for the package. DefaultBootCategoryCode *string `json:"defaultBootCategoryCode,omitempty" xmlrpc:"defaultBootCategoryCode,omitempty"` // A count of a collection of valid RAM items available for purchase in this package. DefaultRamItemCount *uint `json:"defaultRamItemCount,omitempty" xmlrpc:"defaultRamItemCount,omitempty"` // A collection of valid RAM items available for purchase in this package. DefaultRamItems []Product_Item `json:"defaultRamItems,omitempty" xmlrpc:"defaultRamItems,omitempty"` // A count of the package that represents a multi-server solution. (Deprecated) DeploymentCount *uint `json:"deploymentCount,omitempty" xmlrpc:"deploymentCount,omitempty"` // The node type for a package in a solution deployment. DeploymentNodeType *string `json:"deploymentNodeType,omitempty" xmlrpc:"deploymentNodeType,omitempty"` // A count of the packages that are allowed in a multi-server solution. (Deprecated) DeploymentPackageCount *uint `json:"deploymentPackageCount,omitempty" xmlrpc:"deploymentPackageCount,omitempty"` // The packages that are allowed in a multi-server solution. (Deprecated) DeploymentPackages []Product_Package `json:"deploymentPackages,omitempty" xmlrpc:"deploymentPackages,omitempty"` // The solution deployment type. DeploymentType *string `json:"deploymentType,omitempty" xmlrpc:"deploymentType,omitempty"` // The package that represents a multi-server solution. (Deprecated) Deployments []Product_Package `json:"deployments,omitempty" xmlrpc:"deployments,omitempty"` // 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. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // This flag indicates the package does not allow custom disk partitions. DisallowCustomDiskPartitions *bool `json:"disallowCustomDiskPartitions,omitempty" xmlrpc:"disallowCustomDiskPartitions,omitempty"` // The Softlayer order step is optionally step-based. This returns the first SoftLayer_Product_Package_Order_Step in the step-based order process. FirstOrderStep *Product_Package_Order_Step `json:"firstOrderStep,omitempty" xmlrpc:"firstOrderStep,omitempty"` // 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. FirstOrderStepId *int `json:"firstOrderStepId,omitempty" xmlrpc:"firstOrderStepId,omitempty"` // Whether the package is a specialized network gateway appliance package. GatewayApplianceFlag *bool `json:"gatewayApplianceFlag,omitempty" xmlrpc:"gatewayApplianceFlag,omitempty"` // This flag indicates that the package supports GPUs. GpuFlag *bool `json:"gpuFlag,omitempty" xmlrpc:"gpuFlag,omitempty"` // Determines whether the package contains prices that can be ordered hourly. HourlyBillingAvailableFlag *bool `json:"hourlyBillingAvailableFlag,omitempty" xmlrpc:"hourlyBillingAvailableFlag,omitempty"` // Packages with this flag do not allow monthly orders. HourlyOnlyOrders *bool `json:"hourlyOnlyOrders,omitempty" xmlrpc:"hourlyOnlyOrders,omitempty"` // A package's internal identifier. Everything regarding a SoftLayer_Product_Package is tied back to this id. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet IsActive *int `json:"isActive,omitempty" xmlrpc:"isActive,omitempty"` // The item-item conflicts associated with a package. ItemConflicts []Product_Item_Resource_Conflict `json:"itemConflicts,omitempty" xmlrpc:"itemConflicts,omitempty"` // A count of a collection of valid items available for purchase in this package. ItemCount *uint `json:"itemCount,omitempty" xmlrpc:"itemCount,omitempty"` // The item-location conflicts associated with a package. ItemLocationConflicts []Product_Item_Resource_Conflict `json:"itemLocationConflicts,omitempty" xmlrpc:"itemLocationConflicts,omitempty"` // A count of a collection of SoftLayer_Product_Item_Prices that are valid for this package. ItemPriceCount *uint `json:"itemPriceCount,omitempty" xmlrpc:"itemPriceCount,omitempty"` // A count of cross reference for item prices ItemPriceReferenceCount *uint `json:"itemPriceReferenceCount,omitempty" xmlrpc:"itemPriceReferenceCount,omitempty"` // cross reference for item prices ItemPriceReferences []Product_Package_Item_Prices `json:"itemPriceReferences,omitempty" xmlrpc:"itemPriceReferences,omitempty"` // A collection of SoftLayer_Product_Item_Prices that are valid for this package. ItemPrices []Product_Item_Price `json:"itemPrices,omitempty" xmlrpc:"itemPrices,omitempty"` // A collection of valid items available for purchase in this package. Items []Product_Item `json:"items,omitempty" xmlrpc:"items,omitempty"` // A unique key name for the package. KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // A count of a collection of valid locations for this package. (Deprecated - Use [[SoftLayer_Product_Package/getRegions|getRegions]]) LocationCount *uint `json:"locationCount,omitempty" xmlrpc:"locationCount,omitempty"` // A collection of valid locations for this package. (Deprecated - Use [[SoftLayer_Product_Package/getRegions|getRegions]]) Locations []Location `json:"locations,omitempty" xmlrpc:"locations,omitempty"` // The lowest server [[SoftLayer_Product_Item_Price]] related to this package. LowestServerPrice *Product_Item_Price `json:"lowestServerPrice,omitempty" xmlrpc:"lowestServerPrice,omitempty"` // The maximum available network speed associated with the package. MaximumPortSpeed *uint `json:"maximumPortSpeed,omitempty" xmlrpc:"maximumPortSpeed,omitempty"` // The minimum available network speed associated with the package. MinimumPortSpeed *uint `json:"minimumPortSpeed,omitempty" xmlrpc:"minimumPortSpeed,omitempty"` // This flag indicates that this is a MongoDB engineered package. (Deprecated) MongoDbEngineeredFlag *bool `json:"mongoDbEngineeredFlag,omitempty" xmlrpc:"mongoDbEngineeredFlag,omitempty"` // The description of the package. For server packages, this is usually a detailed description of processor type and count. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // Services ordered from this package cannot have upgrades or downgrades performed. NoUpgradesFlag *bool `json:"noUpgradesFlag,omitempty" xmlrpc:"noUpgradesFlag,omitempty"` // Whether the package is not in compliance with EU support. NonEuCompliantFlag *bool `json:"nonEuCompliantFlag,omitempty" xmlrpc:"nonEuCompliantFlag,omitempty"` // A count of the premium price modifiers associated with the [[SoftLayer_Product_Item_Price]] and [[SoftLayer_Location]] objects in a package. OrderPremiumCount *uint `json:"orderPremiumCount,omitempty" xmlrpc:"orderPremiumCount,omitempty"` // The premium price modifiers associated with the [[SoftLayer_Product_Item_Price]] and [[SoftLayer_Location]] objects in a package. OrderPremiums []Product_Item_Price_Premium `json:"orderPremiums,omitempty" xmlrpc:"orderPremiums,omitempty"` // This flag indicates if the package may be available in PoP locations in addition to Datacenters. PopLocationAvailabilityFlag *bool `json:"popLocationAvailabilityFlag,omitempty" xmlrpc:"popLocationAvailabilityFlag,omitempty"` // This flag indicates the package is pre-configured. (Deprecated) PreconfiguredFlag *bool `json:"preconfiguredFlag,omitempty" xmlrpc:"preconfiguredFlag,omitempty"` // Whether the package requires the user to define a preset configuration. PresetConfigurationRequiredFlag *bool `json:"presetConfigurationRequiredFlag,omitempty" xmlrpc:"presetConfigurationRequiredFlag,omitempty"` // Whether the package prevents the user from specifying a Vlan. PreventVlanSelectionFlag *bool `json:"preventVlanSelectionFlag,omitempty" xmlrpc:"preventVlanSelectionFlag,omitempty"` // This flag indicates the package is for a private hosted cloud deployment. (Deprecated) PrivateHostedCloudPackageFlag *bool `json:"privateHostedCloudPackageFlag,omitempty" xmlrpc:"privateHostedCloudPackageFlag,omitempty"` // The server role of the private hosted cloud deployment. (Deprecated) PrivateHostedCloudPackageType *string `json:"privateHostedCloudPackageType,omitempty" xmlrpc:"privateHostedCloudPackageType,omitempty"` // Whether the package only has access to the private network. PrivateNetworkOnlyFlag *bool `json:"privateNetworkOnlyFlag,omitempty" xmlrpc:"privateNetworkOnlyFlag,omitempty"` // Whether the package is a specialized mass storage QuantaStor package. (Deprecated) QuantaStorPackageFlag *bool `json:"quantaStorPackageFlag,omitempty" xmlrpc:"quantaStorPackageFlag,omitempty"` // This flag indicates the package does not allow different disks with RAID. RaidDiskRestrictionFlag *bool `json:"raidDiskRestrictionFlag,omitempty" xmlrpc:"raidDiskRestrictionFlag,omitempty"` // This flag determines if the package contains a redundant power supply product. RedundantPowerFlag *bool `json:"redundantPowerFlag,omitempty" xmlrpc:"redundantPowerFlag,omitempty"` // A count of the regional locations that a package is available in. RegionCount *uint `json:"regionCount,omitempty" xmlrpc:"regionCount,omitempty"` // The regional locations that a package is available in. Regions []Location_Region `json:"regions,omitempty" xmlrpc:"regions,omitempty"` // This currently contains no information but is here for future use. SubDescription *string `json:"subDescription,omitempty" xmlrpc:"subDescription,omitempty"` // The top level category code for this service offering. TopLevelItemCategoryCode *string `json:"topLevelItemCategoryCode,omitempty" xmlrpc:"topLevelItemCategoryCode,omitempty"` // The type of service offering. This property can be used to help filter packages. Type *Product_Package_Type `json:"type,omitempty" xmlrpc:"type,omitempty"` // The server unit size this package will match to. UnitSize *int `json:"unitSize,omitempty" xmlrpc:"unitSize,omitempty"` }
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.
type Product_Package_Attribute ¶
type Product_Package_Attribute struct { Entity // no documentation yet AttributeType *Product_Package_Attribute_Type `json:"attributeType,omitempty" xmlrpc:"attributeType,omitempty"` // no documentation yet Package *Product_Package `json:"package,omitempty" xmlrpc:"package,omitempty"` // no documentation yet Value *string `json:"value,omitempty" xmlrpc:"value,omitempty"` }
no documentation yet
type Product_Package_Attribute_Type ¶
type Product_Package_Attribute_Type struct { Entity // no documentation yet Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // no documentation yet KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
no documentation yet
type Product_Package_Inventory ¶
type Product_Package_Inventory struct { Entity // DEPRECATED. The number of units available for purchase in inventory for a single item in a single datacenter. AvailableInventoryCount *int `json:"availableInventoryCount,omitempty" xmlrpc:"availableInventoryCount,omitempty"` // The product package item that is associated with an inventory record. Item *Product_Item `json:"item,omitempty" xmlrpc:"item,omitempty"` // DEPRECATED. The unique identifier of the product item that an inventory record is associated with. ItemId *int `json:"itemId,omitempty" xmlrpc:"itemId,omitempty"` // The datacenter that an inventory record is located in. Location *Location `json:"location,omitempty" xmlrpc:"location,omitempty"` // DEPRECATED. The unique identifier of the datacenter that an inventory record is located in. LocationId *int `json:"locationId,omitempty" xmlrpc:"locationId,omitempty"` // DEPRECATED. The date that an inventory record was last updated. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // DEPRECATED. Whether an inventory record is marked as "overstock". OverstockFlag *int `json:"overstockFlag,omitempty" xmlrpc:"overstockFlag,omitempty"` // The product package that is associated with an inventory record. Package *Product_Package `json:"package,omitempty" xmlrpc:"package,omitempty"` // DEPRECATED. The unique identifier of the product package that an inventory record is associated with. PackageId *int `json:"packageId,omitempty" xmlrpc:"packageId,omitempty"` }
This is deprecated.
type Product_Package_Item_Category_Group ¶
type Product_Package_Item_Category_Group struct { Entity // no documentation yet Category *Product_Item_Category `json:"category,omitempty" xmlrpc:"category,omitempty"` // The item category id associated with this group. ItemCategoryId *int `json:"itemCategoryId,omitempty" xmlrpc:"itemCategoryId,omitempty"` // no documentation yet Package *Product_Package `json:"package,omitempty" xmlrpc:"package,omitempty"` // The service offering id associated with this group. PackageId *int `json:"packageId,omitempty" xmlrpc:"packageId,omitempty"` // A count of PriceCount *uint `json:"priceCount,omitempty" xmlrpc:"priceCount,omitempty"` // no documentation yet Prices []Product_Item_Price `json:"prices,omitempty" xmlrpc:"prices,omitempty"` // The sort value for this group. Sort *int `json:"sort,omitempty" xmlrpc:"sort,omitempty"` // An optional title associated with this group. E.g., for operating systems, this will be the manufacturer. Title *string `json:"title,omitempty" xmlrpc:"title,omitempty"` }
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.
type Product_Package_Item_Prices ¶
type Product_Package_Item_Prices struct { Entity // The unique identifier for SoftLayer_Product_Package_Item_Price. This is only needed as a reference. The important data is the itemPriceId property. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The item price to which this object belongs. The item price has details regarding cost for the item it belongs to. ItemPrice *Product_Item_Price `json:"itemPrice,omitempty" xmlrpc:"itemPrice,omitempty"` // 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 ItemPriceId *int `json:"itemPriceId,omitempty" xmlrpc:"itemPriceId,omitempty"` // The package to which this object belongs. Package *Product_Package `json:"package,omitempty" xmlrpc:"package,omitempty"` // The Package ID to which this price reference belongs PackageId *int `json:"packageId,omitempty" xmlrpc:"packageId,omitempty"` }
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.
type Product_Package_Items ¶
type Product_Package_Items struct { Entity // The unique identifier for this object. It is not used anywhere but in this object. Id *string `json:"id,omitempty" xmlrpc:"id,omitempty"` // The item to which this object belongs. Item *Product_Item `json:"item,omitempty" xmlrpc:"item,omitempty"` // The SoftLayer_Product_Item id to which this instance of the object belongs. ItemId *int `json:"itemId,omitempty" xmlrpc:"itemId,omitempty"` // The package to which this object belongs. Package *Product_Package `json:"package,omitempty" xmlrpc:"package,omitempty"` // The SoftLayer_Product_Package id to which this instance of the object belongs. PackageId *int `json:"packageId,omitempty" xmlrpc:"packageId,omitempty"` }
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.
type Product_Package_Locations ¶
type Product_Package_Locations struct { Entity // This describes the availability of the package tied to this location. DeliveryTimeInformation *string `json:"deliveryTimeInformation,omitempty" xmlrpc:"deliveryTimeInformation,omitempty"` // A simple flag which describes whether or not this location is available for this package. IsAvailable *int `json:"isAvailable,omitempty" xmlrpc:"isAvailable,omitempty"` // The location to which this object belongs. Location *Location `json:"location,omitempty" xmlrpc:"location,omitempty"` // The location id tied to this object. LocationId *int `json:"locationId,omitempty" xmlrpc:"locationId,omitempty"` // The package to which this object belongs. Package *Product_Package `json:"package,omitempty" xmlrpc:"package,omitempty"` // The SoftLayer_Product_Package ID tied to this object. PackageId *int `json:"packageId,omitempty" xmlrpc:"packageId,omitempty"` }
Most packages are available in many locations. This object describes that availability for each package.
type Product_Package_Order_Configuration ¶
type Product_Package_Order_Configuration struct { Entity // Signifies that selections associated with the configuration are automatically provided by being bundled to another configurations selection. The actual bundling is on the product. BundledFlag *bool `json:"bundledFlag,omitempty" xmlrpc:"bundledFlag,omitempty"` // The error message displayed if the submitted order does not contain this item category, if it is required. ErrorMessage *string `json:"errorMessage,omitempty" xmlrpc:"errorMessage,omitempty"` // The unique identifier for this object. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // 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. IsRequired *int `json:"isRequired,omitempty" xmlrpc:"isRequired,omitempty"` // The item category for this configuration instance. ItemCategory *Product_Item_Category `json:"itemCategory,omitempty" xmlrpc:"itemCategory,omitempty"` // The SoftLayer_Product_Item_Category. ItemCategoryId *int `json:"itemCategoryId,omitempty" xmlrpc:"itemCategoryId,omitempty"` // The order step ID for this particular option in the package. OrderStepId *int `json:"orderStepId,omitempty" xmlrpc:"orderStepId,omitempty"` // The package to which this instance belongs. Package *Product_Package `json:"package,omitempty" xmlrpc:"package,omitempty"` // The PackageId tied to this instance. PackageId *int `json:"packageId,omitempty" xmlrpc:"packageId,omitempty"` // This is an integer used to show the order in which each item Category should be displayed. This is merely the suggested order. Sort *int `json:"sort,omitempty" xmlrpc:"sort,omitempty"` // The step to which this instance belongs. Step *Product_Package_Order_Step `json:"step,omitempty" xmlrpc:"step,omitempty"` // Whether or not the item category is term-based. TermFlag *bool `json:"termFlag,omitempty" xmlrpc:"termFlag,omitempty"` }
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.
type Product_Package_Order_Step ¶
type Product_Package_Order_Step struct { Entity // The unique identifier for this object. It is not used anywhere but in this object. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A count of the next steps in the ordering process for the package tied to this object, including this step. InclusivePreviousStepCount *uint `json:"inclusivePreviousStepCount,omitempty" xmlrpc:"inclusivePreviousStepCount,omitempty"` // The next steps in the ordering process for the package tied to this object, including this step. InclusivePreviousSteps []Product_Package_Order_Step_Next `json:"inclusivePreviousSteps,omitempty" xmlrpc:"inclusivePreviousSteps,omitempty"` // A count of the next steps in the ordering process for the package tied to this object. NextStepCount *uint `json:"nextStepCount,omitempty" xmlrpc:"nextStepCount,omitempty"` // The next steps in the ordering process for the package tied to this object. NextSteps []Product_Package_Order_Step_Next `json:"nextSteps,omitempty" xmlrpc:"nextSteps,omitempty"` // A count of the item to which this object belongs. PreviousStepCount *uint `json:"previousStepCount,omitempty" xmlrpc:"previousStepCount,omitempty"` // The item to which this object belongs. PreviousSteps []Product_Package_Order_Step_Next `json:"previousSteps,omitempty" xmlrpc:"previousSteps,omitempty"` // The number of the step in the order process for this package. These are sequential and only needed for step-based ordering. Step *string `json:"step,omitempty" xmlrpc:"step,omitempty"` }
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.
type Product_Package_Order_Step_Next ¶
type Product_Package_Order_Step_Next struct { Entity // The unique identifier for this object. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The unique identifier for SoftLayer_Product_Package_Order_Step for the next step in the process. NextOrderStepId *int `json:"nextOrderStepId,omitempty" xmlrpc:"nextOrderStepId,omitempty"` // The unique identifier for SoftLayer_Product_Package_Order_Step for the current step. OrderStepId *int `json:"orderStepId,omitempty" xmlrpc:"orderStepId,omitempty"` // The SoftLayer_Product_Package_Order_Step to which this object belongs. Step *Product_Package_Order_Step `json:"step,omitempty" xmlrpc:"step,omitempty"` }
This datatype simply describes which steps are next in line for ordering.
type Product_Package_Preset ¶
type Product_Package_Preset struct { Entity // no documentation yet AvailableStorageUnits *uint `json:"availableStorageUnits,omitempty" xmlrpc:"availableStorageUnits,omitempty"` // When true this preset is for ordering a Bare Metal Reserved server. BareMetalReservedFlag *bool `json:"bareMetalReservedFlag,omitempty" xmlrpc:"bareMetalReservedFlag,omitempty"` // The item categories that are included in this package preset configuration. Categories []Product_Item_Category `json:"categories,omitempty" xmlrpc:"categories,omitempty"` // A count of the item categories that are included in this package preset configuration. CategoryCount *uint `json:"categoryCount,omitempty" xmlrpc:"categoryCount,omitempty"` // The compute family this configuration belongs to. ComputeGroup *Product_Item_Server_Group `json:"computeGroup,omitempty" xmlrpc:"computeGroup,omitempty"` // The preset configuration (category and price). Configuration []Product_Package_Preset_Configuration `json:"configuration,omitempty" xmlrpc:"configuration,omitempty"` // A count of the preset configuration (category and price). ConfigurationCount *uint `json:"configurationCount,omitempty" xmlrpc:"configurationCount,omitempty"` // A description of the package preset. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // When true this preset is only allowed to upgrade/downgrade to other presets in the same compute family. DisallowedComputeGroupUpgradeFlag *bool `json:"disallowedComputeGroupUpgradeFlag,omitempty" xmlrpc:"disallowedComputeGroupUpgradeFlag,omitempty"` // A package preset with this flag set will not allow the price's defined in the preset configuration to be overriden during order placement. FixedConfigurationFlag *bool `json:"fixedConfigurationFlag,omitempty" xmlrpc:"fixedConfigurationFlag,omitempty"` // A preset's internal identifier. Everything regarding a SoftLayer_Product_Package_Preset is tied back to this id. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The status of the package preset. IsActive *string `json:"isActive,omitempty" xmlrpc:"isActive,omitempty"` // The key name of the package preset. For the base configuration of a package the preset key name is "DEFAULT". KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // 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. LocationCount *uint `json:"locationCount,omitempty" xmlrpc:"locationCount,omitempty"` // The locations this preset configuration is available in. If empty the preset is available in all locations the package is available in. Locations []Location `json:"locations,omitempty" xmlrpc:"locations,omitempty"` // The lowest server prices related to this package preset. LowestPresetServerPrice *Product_Item_Price `json:"lowestPresetServerPrice,omitempty" xmlrpc:"lowestPresetServerPrice,omitempty"` // The name of the package preset. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // The package this preset belongs to. Package *Product_Package `json:"package,omitempty" xmlrpc:"package,omitempty"` // The item categories associated with a package preset, including information detailing which item categories are required as part of a SoftLayer product order. PackageConfiguration []Product_Package_Order_Configuration `json:"packageConfiguration,omitempty" xmlrpc:"packageConfiguration,omitempty"` // 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. PackageConfigurationCount *uint `json:"packageConfigurationCount,omitempty" xmlrpc:"packageConfigurationCount,omitempty"` // The package id for the package this preset belongs to. PackageId *int `json:"packageId,omitempty" xmlrpc:"packageId,omitempty"` // A count of the item prices that are included in this package preset configuration. PriceCount *uint `json:"priceCount,omitempty" xmlrpc:"priceCount,omitempty"` // The item prices that are included in this package preset configuration. Prices []Product_Item_Price `json:"prices,omitempty" xmlrpc:"prices,omitempty"` // A count of describes how all disks in this preset will be configured. StorageGroupTemplateArrayCount *uint `json:"storageGroupTemplateArrayCount,omitempty" xmlrpc:"storageGroupTemplateArrayCount,omitempty"` // Describes how all disks in this preset will be configured. StorageGroupTemplateArrays []Configuration_Storage_Group_Template_Group `json:"storageGroupTemplateArrays,omitempty" xmlrpc:"storageGroupTemplateArrays,omitempty"` // The starting hourly price for this configuration. Additional options not defined in the preset may increase the cost. TotalMinimumHourlyFee *Float64 `json:"totalMinimumHourlyFee,omitempty" xmlrpc:"totalMinimumHourlyFee,omitempty"` // The starting monthly price for this configuration. Additional options not defined in the preset may increase the cost. TotalMinimumRecurringFee *Float64 `json:"totalMinimumRecurringFee,omitempty" xmlrpc:"totalMinimumRecurringFee,omitempty"` }
Package presets are used to simplify ordering by eliminating the need for price ids when submitting orders.
Orders submitted with a preset id defined will use the prices included in the package preset. Prices submitted on an order with a preset id will replace the prices included in the package preset for that prices category. If the package preset has a fixed configuration flag <em>(fixedConfigurationFlag)</em> set then the prices included in the preset configuration cannot be replaced by prices submitted on the order. The only exception to the fixed configuration flag would be if a price submitted on the order is an account-restricted price for the same product item.
type Product_Package_Preset_Attribute ¶
type Product_Package_Preset_Attribute struct { Entity // no documentation yet AttributeType *Product_Package_Preset_Attribute_Type `json:"attributeType,omitempty" xmlrpc:"attributeType,omitempty"` // The internal identifier of the type of attribute that a pacakge preset attribute belongs to. AttributeTypeId *int `json:"attributeTypeId,omitempty" xmlrpc:"attributeTypeId,omitempty"` // A package preset attribute's internal identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet Preset *Product_Package_Preset `json:"preset,omitempty" xmlrpc:"preset,omitempty"` // The internal identifier of the package preset an attribute belongs to. PresetId *int `json:"presetId,omitempty" xmlrpc:"presetId,omitempty"` // A package preset's attribute value. Value *string `json:"value,omitempty" xmlrpc:"value,omitempty"` }
Package preset attributes contain supplementary information for a package preset.
type Product_Package_Preset_Attribute_Type ¶
type Product_Package_Preset_Attribute_Type struct { Entity // A brief description of a package preset attribute type. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // A package preset attribute type's internal identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A package preset attribute type's key name. This is typically a shorter version of an attribute type's name. KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // A package preset attribute type's name. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
SoftLayer_Product_Package_Preset_Attribute_Type models the type of attribute that can be assigned to a package preset.
type Product_Package_Preset_Configuration ¶
type Product_Package_Preset_Configuration struct { Entity // no documentation yet Category *Product_Item_Category `json:"category,omitempty" xmlrpc:"category,omitempty"` // no documentation yet PackagePreset *Product_Package_Preset `json:"packagePreset,omitempty" xmlrpc:"packagePreset,omitempty"` // no documentation yet Price *Product_Item_Price `json:"price,omitempty" xmlrpc:"price,omitempty"` }
no documentation yet
type Product_Package_Server ¶
type Product_Package_Server struct { Entity // Flag to indicate if the server a Bare Metal Reserved offering. BareMetalReservedFlag *bool `json:"bareMetalReservedFlag,omitempty" xmlrpc:"bareMetalReservedFlag,omitempty"` // no documentation yet Catalog *Product_Catalog `json:"catalog,omitempty" xmlrpc:"catalog,omitempty"` // The unique identifier of a [[SoftLayer_Product_Catalog]]. CatalogId *int `json:"catalogId,omitempty" xmlrpc:"catalogId,omitempty"` // Comma-separated list of datacenter names this server is available in Datacenters *string `json:"datacenters,omitempty" xmlrpc:"datacenters,omitempty"` // The minimum amount of RAM the server is configured with. DefaultRamCapacity *Float64 `json:"defaultRamCapacity,omitempty" xmlrpc:"defaultRamCapacity,omitempty"` // Flag to indicate if the server configuration supports dual path network routing. DualPathNetworkFlag *bool `json:"dualPathNetworkFlag,omitempty" xmlrpc:"dualPathNetworkFlag,omitempty"` // no documentation yet FlexCoreServerFlag *bool `json:"flexCoreServerFlag,omitempty" xmlrpc:"flexCoreServerFlag,omitempty"` // Indicates whether or not the server contains a GPU. GpuFlag *bool `json:"gpuFlag,omitempty" xmlrpc:"gpuFlag,omitempty"` // Flag to determine if a server is available for hourly billing. HourlyBillingFlag *bool `json:"hourlyBillingFlag,omitempty" xmlrpc:"hourlyBillingFlag,omitempty"` // The unique identifier of a [[SoftLayer_Product_Package_Server]]. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet Item *Product_Item `json:"item,omitempty" xmlrpc:"item,omitempty"` // The unique identifier of a [[SoftLayer_Product_Item]]. ItemId *int `json:"itemId,omitempty" xmlrpc:"itemId,omitempty"` // no documentation yet ItemPrice *Product_Item_Price `json:"itemPrice,omitempty" xmlrpc:"itemPrice,omitempty"` // The unique identifier of a [[SoftLayer_Product_Item_Price]]. ItemPriceId *int `json:"itemPriceId,omitempty" xmlrpc:"itemPriceId,omitempty"` // The maximum number of hard drives the server can support. MaximumDriveCount *int `json:"maximumDriveCount,omitempty" xmlrpc:"maximumDriveCount,omitempty"` // The maximum available network speed for the server. MaximumPortSpeed *Float64 `json:"maximumPortSpeed,omitempty" xmlrpc:"maximumPortSpeed,omitempty"` // The maximum amount of RAM the server can support. MaximumRamCapacity *Float64 `json:"maximumRamCapacity,omitempty" xmlrpc:"maximumRamCapacity,omitempty"` // The minimum available network speed for the server. MinimumPortSpeed *Float64 `json:"minimumPortSpeed,omitempty" xmlrpc:"minimumPortSpeed,omitempty"` // no documentation yet NetworkGatewayApplianceRoleFlag *bool `json:"networkGatewayApplianceRoleFlag,omitempty" xmlrpc:"networkGatewayApplianceRoleFlag,omitempty"` // DEPRECATED. Indicates whether or not the server is being sold as part of an outlet package. // Deprecated: This function has been marked as deprecated. OutletFlag *bool `json:"outletFlag,omitempty" xmlrpc:"outletFlag,omitempty"` // no documentation yet Package *Product_Package `json:"package,omitempty" xmlrpc:"package,omitempty"` // The unique identifier of a [[SoftLayer_Product_Package]]. PackageId *int `json:"packageId,omitempty" xmlrpc:"packageId,omitempty"` // The type of service offering/package. PackageType *string `json:"packageType,omitempty" xmlrpc:"packageType,omitempty"` // Flag to indicate if the server is an IBM Power server. PowerServerFlag *bool `json:"powerServerFlag,omitempty" xmlrpc:"powerServerFlag,omitempty"` // no documentation yet Preset *Product_Package_Preset `json:"preset,omitempty" xmlrpc:"preset,omitempty"` // The unique identifier of a [[SoftLayer_Product_Package_Preset]]. PresetId *int `json:"presetId,omitempty" xmlrpc:"presetId,omitempty"` // Indicates whether or not the server can only be configured with a private network. PrivateNetworkOnlyFlag *bool `json:"privateNetworkOnlyFlag,omitempty" xmlrpc:"privateNetworkOnlyFlag,omitempty"` // The processor's bus speed. ProcessorBusSpeed *string `json:"processorBusSpeed,omitempty" xmlrpc:"processorBusSpeed,omitempty"` // The amount of cache the processor has. ProcessorCache *string `json:"processorCache,omitempty" xmlrpc:"processorCache,omitempty"` // The number of cores in each processor. ProcessorCores *int `json:"processorCores,omitempty" xmlrpc:"processorCores,omitempty"` // The number of processors the server has. ProcessorCount *int `json:"processorCount,omitempty" xmlrpc:"processorCount,omitempty"` // The manufacturer of the server's processor. ProcessorManufacturer *string `json:"processorManufacturer,omitempty" xmlrpc:"processorManufacturer,omitempty"` // The model of the server's processor. ProcessorModel *string `json:"processorModel,omitempty" xmlrpc:"processorModel,omitempty"` // The name of the server's processor. ProcessorName *string `json:"processorName,omitempty" xmlrpc:"processorName,omitempty"` // The processor speed. ProcessorSpeed *string `json:"processorSpeed,omitempty" xmlrpc:"processorSpeed,omitempty"` // The name of the server product. ProductName *string `json:"productName,omitempty" xmlrpc:"productName,omitempty"` // Indicates whether or not the server has the capability to support a redundant power supply. RedundantPowerFlag *bool `json:"redundantPowerFlag,omitempty" xmlrpc:"redundantPowerFlag,omitempty"` // Flag to indicate if the server is SAP certified. SapCertifiedServerFlag *bool `json:"sapCertifiedServerFlag,omitempty" xmlrpc:"sapCertifiedServerFlag,omitempty"` // 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. StartingHourlyPrice *Float64 `json:"startingHourlyPrice,omitempty" xmlrpc:"startingHourlyPrice,omitempty"` // The monthly starting price for the server. This includes a sum of all the minimum required items, including RAM and hard drives. StartingMonthlyPrice *Float64 `json:"startingMonthlyPrice,omitempty" xmlrpc:"startingMonthlyPrice,omitempty"` // The length of a term if a server has a term-based price TermLength *int `json:"termLength,omitempty" xmlrpc:"termLength,omitempty"` // The total number of processor cores available for the server. TotalCoreCount *int `json:"totalCoreCount,omitempty" xmlrpc:"totalCoreCount,omitempty"` // Flag to indicate if the server configuration supports TXT/TPM. TxtTpmFlag *bool `json:"txtTpmFlag,omitempty" xmlrpc:"txtTpmFlag,omitempty"` // The size of the server. UnitSize *int `json:"unitSize,omitempty" xmlrpc:"unitSize,omitempty"` // Flag to indicate if the server is a VMware vSAN Node configuration. VmwareVsanNodeFlag *bool `json:"vmwareVsanNodeFlag,omitempty" xmlrpc:"vmwareVsanNodeFlag,omitempty"` }
The SoftLayer_Product_Package_Server data type contains summarized information for bare metal servers regarding pricing, processor stats, and feature sets.
type Product_Package_Server_Option ¶
type Product_Package_Server_Option struct { Entity // The unique identifier of a Catalog. CatalogId *int `json:"catalogId,omitempty" xmlrpc:"catalogId,omitempty"` // A description of the option. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // The unique identifier of a Package Server Option. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The type of option. Type *string `json:"type,omitempty" xmlrpc:"type,omitempty"` // The value of the the option. Value *string `json:"value,omitempty" xmlrpc:"value,omitempty"` }
The [[SoftLayer_Product_Package_Server_Option]] data type contains various data points associated with package servers that can be used in selection criteria.
type Product_Package_Type ¶
type Product_Package_Type struct { Entity // The package type's unique identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The unique key name of the package type. Use this value when filtering. KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // The name of the package type. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // A count of all the packages associated with the given package type. PackageCount *uint `json:"packageCount,omitempty" xmlrpc:"packageCount,omitempty"` // All the packages associated with the given package type. Packages []Product_Package `json:"packages,omitempty" xmlrpc:"packages,omitempty"` }
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.
type Product_Upgrade_Request ¶
type Product_Upgrade_Request struct { Entity // The account that an order belongs to Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // The unique internal id of a SoftLayer account AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // Indicates that the upgrade request has completed or has been cancelled. CompletedFlag *bool `json:"completedFlag,omitempty" xmlrpc:"completedFlag,omitempty"` // The date an upgrade request was created. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // The unique internal id of the last modified user EmployeeId *int `json:"employeeId,omitempty" xmlrpc:"employeeId,omitempty"` // The unique internal id of the virtual server that an upgrade will be done GuestId *int `json:"guestId,omitempty" xmlrpc:"guestId,omitempty"` // The unique internal id of the hardware that an upgrade will be done HardwareId *int `json:"hardwareId,omitempty" xmlrpc:"hardwareId,omitempty"` // An upgrade request's internal identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // This is the invoice associated with the upgrade request. For hourly servers or services, an invoice will not be available. Invoice *Billing_Invoice `json:"invoice,omitempty" xmlrpc:"invoice,omitempty"` // The time that system admin starts working on the order item. This is used for upgrade orders. MaintenanceStartTimeUtc *Time `json:"maintenanceStartTimeUtc,omitempty" xmlrpc:"maintenanceStartTimeUtc,omitempty"` // The date an upgrade request was last modified. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // An order record associated to the upgrade request Order *Billing_Order `json:"order,omitempty" xmlrpc:"order,omitempty"` // The unique internal id of the order that an upgrade request is related to OrderId *int `json:"orderId,omitempty" xmlrpc:"orderId,omitempty"` // The total amount of fees OrderTotal *Float64 `json:"orderTotal,omitempty" xmlrpc:"orderTotal,omitempty"` // The prorated total amount of recurring fees ProratedTotal *Float64 `json:"proratedTotal,omitempty" xmlrpc:"proratedTotal,omitempty"` // A server object associated with the upgrade request if any. Server *Hardware `json:"server,omitempty" xmlrpc:"server,omitempty"` // The current status of the upgrade request. Status *Product_Upgrade_Request_Status `json:"status,omitempty" xmlrpc:"status,omitempty"` // The unique internal id of an upgrade status StatusId *int `json:"statusId,omitempty" xmlrpc:"statusId,omitempty"` // The ticket that is used to coordinate the upgrade process. Ticket *Ticket `json:"ticket,omitempty" xmlrpc:"ticket,omitempty"` // The unique internal id of the ticket related to an upgrade request TicketId *int `json:"ticketId,omitempty" xmlrpc:"ticketId,omitempty"` // The user that placed the order. User *User_Customer `json:"user,omitempty" xmlrpc:"user,omitempty"` // The unique internal id of the customer who place the order UserId *int `json:"userId,omitempty" xmlrpc:"userId,omitempty"` // A virtual server object associated with the upgrade request if any. VirtualGuest *Virtual_Guest `json:"virtualGuest,omitempty" xmlrpc:"virtualGuest,omitempty"` }
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]].
type Product_Upgrade_Request_Status ¶
type Product_Upgrade_Request_Status struct { Entity // The detailed description of an upgrade request status. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // An internal identifier of an upgrade request status. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The name of an upgrade request status. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // The status code of an upgrade request status. StatusCode *string `json:"statusCode,omitempty" xmlrpc:"statusCode,omitempty"` }
The SoftLayer_Product_Upgrade_Request_Status data type contains detailed information relating to an hardware or software upgrade request.
type Provisioning_Hook ¶
type Provisioning_Hook struct { Entity // no documentation yet Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // The ID of the account the script belongs to. AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // no documentation yet CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // no documentation yet HookType *Provisioning_Hook_Type `json:"hookType,omitempty" xmlrpc:"hookType,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // The name of the hook. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // The ID of the type of hook the script is identified as. Currently only CUSTOMER_PROVIDED_HOOK has been implemented. TypeId *int `json:"typeId,omitempty" xmlrpc:"typeId,omitempty"` // 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. Uri *string `json:"uri,omitempty" xmlrpc:"uri,omitempty"` }
The SoftLayer_Provisioning_Hook contains all the information needed to add a hook into a server/Virtual provision and os reload.
type Provisioning_Hook_Type ¶
type Provisioning_Hook_Type struct { Entity // no documentation yet Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
no documentation yet
type Provisioning_Maintenance_Classification ¶
type Provisioning_Maintenance_Classification struct { Entity // The id of the maintenance classification. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet ItemCategories []Provisioning_Maintenance_Classification_Item_Category `json:"itemCategories,omitempty" xmlrpc:"itemCategories,omitempty"` // A count of ItemCategoryCount *uint `json:"itemCategoryCount,omitempty" xmlrpc:"itemCategoryCount,omitempty"` // The number of slots required for the maintenance classification. Slots *int `json:"slots,omitempty" xmlrpc:"slots,omitempty"` // The type or name of the maintenance classification. Type *string `json:"type,omitempty" xmlrpc:"type,omitempty"` }
The SoftLayer_Provisioning_Maintenance_Classification represent a maintenance type for the specific hardware maintenance desired.
type Provisioning_Maintenance_Classification_Item_Category ¶
type Provisioning_Maintenance_Classification_Item_Category struct { Entity // no documentation yet ItemCategoryId *int `json:"itemCategoryId,omitempty" xmlrpc:"itemCategoryId,omitempty"` // no documentation yet MaintenanceClassification *Provisioning_Maintenance_Classification `json:"maintenanceClassification,omitempty" xmlrpc:"maintenanceClassification,omitempty"` // no documentation yet MaintenanceClassificationId *int `json:"maintenanceClassificationId,omitempty" xmlrpc:"maintenanceClassificationId,omitempty"` }
no documentation yet
type Provisioning_Maintenance_Slots ¶
type Provisioning_Maintenance_Slots struct { Entity // The available slots for a maintenance window. AvailableSlots *int `json:"availableSlots,omitempty" xmlrpc:"availableSlots,omitempty"` }
The SoftLayer_Provisioning_Maintenance_Slots represent the available slots for a given maintenance window at a SoftLayer data center.
type Provisioning_Maintenance_Ticket ¶
type Provisioning_Maintenance_Ticket struct { Entity // no documentation yet AvailableSlots *Provisioning_Maintenance_Slots `json:"availableSlots,omitempty" xmlrpc:"availableSlots,omitempty"` // no documentation yet MaintClassId *int `json:"maintClassId,omitempty" xmlrpc:"maintClassId,omitempty"` // no documentation yet MaintWindowId *int `json:"maintWindowId,omitempty" xmlrpc:"maintWindowId,omitempty"` // no documentation yet MaintenanceClass *Provisioning_Maintenance_Classification `json:"maintenanceClass,omitempty" xmlrpc:"maintenanceClass,omitempty"` // no documentation yet MaintenanceDate *Time `json:"maintenanceDate,omitempty" xmlrpc:"maintenanceDate,omitempty"` // no documentation yet Ticket *Ticket `json:"ticket,omitempty" xmlrpc:"ticket,omitempty"` // no documentation yet TicketId *int `json:"ticketId,omitempty" xmlrpc:"ticketId,omitempty"` }
no documentation yet
type Provisioning_Maintenance_Window ¶
type Provisioning_Maintenance_Window struct { Entity // The date and time a maintenance window is scheduled to begin. BeginDate *Time `json:"beginDate,omitempty" xmlrpc:"beginDate,omitempty"` // An ISO-8601 numeric representation of the day of the week that a maintenance window is performed. 1: Monday, 7: Sunday DayOfWeek *int `json:"dayOfWeek,omitempty" xmlrpc:"dayOfWeek,omitempty"` // The date and time a maintenance window is scheduled to end. EndDate *Time `json:"endDate,omitempty" xmlrpc:"endDate,omitempty"` // Id of the maintenance window Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // An internal identifier of the location (data center) record that a maintenance window takes place in. LocationId *int `json:"locationId,omitempty" xmlrpc:"locationId,omitempty"` // An internal identifier of the datacenter timezone. PortalTzId *int `json:"portalTzId,omitempty" xmlrpc:"portalTzId,omitempty"` }
The SoftLayer_Provisioning_Maintenance_Window represent a time window that SoftLayer performs a hardware or software maintenance and upgrades.
type Provisioning_Version1_Transaction ¶
type Provisioning_Version1_Transaction struct { Entity // The account that a transaction belongs to. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // The date a transaction was created. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // The amount of seconds that have elapsed since the transaction was last modified. ElapsedSeconds *int `json:"elapsedSeconds,omitempty" xmlrpc:"elapsedSeconds,omitempty"` // The guest record for this transaction. Guest *Virtual_Guest `json:"guest,omitempty" xmlrpc:"guest,omitempty"` // A transaction's associated guest identification number. GuestId *int `json:"guestId,omitempty" xmlrpc:"guestId,omitempty"` // The hardware object for this transaction. Hardware *Hardware `json:"hardware,omitempty" xmlrpc:"hardware,omitempty"` // A transaction's associated hardware identification number. HardwareId *int `json:"hardwareId,omitempty" xmlrpc:"hardwareId,omitempty"` // A transaction's identifying number. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet Loopback []Provisioning_Version1_Transaction `json:"loopback,omitempty" xmlrpc:"loopback,omitempty"` // A count of LoopbackCount *uint `json:"loopbackCount,omitempty" xmlrpc:"loopbackCount,omitempty"` // The date a transaction was last modified. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // A transactions current state in the order process. OrderTracking *Provisioning_Version1_Transaction_OrderTracking `json:"orderTracking,omitempty" xmlrpc:"orderTracking,omitempty"` // A count of PendingTransactionCount *uint `json:"pendingTransactionCount,omitempty" xmlrpc:"pendingTransactionCount,omitempty"` // no documentation yet PendingTransactions []Provisioning_Version1_Transaction `json:"pendingTransactions,omitempty" xmlrpc:"pendingTransactions,omitempty"` // The date the transaction status was last modified. StatusChangeDate *Time `json:"statusChangeDate,omitempty" xmlrpc:"statusChangeDate,omitempty"` // no documentation yet TicketScheduledActionReference []Ticket_Attachment `json:"ticketScheduledActionReference,omitempty" xmlrpc:"ticketScheduledActionReference,omitempty"` // A count of TicketScheduledActionReferenceCount *uint `json:"ticketScheduledActionReferenceCount,omitempty" xmlrpc:"ticketScheduledActionReferenceCount,omitempty"` // A transaction's group. This group object determines what type of service is being done on the hardware. TransactionGroup *Provisioning_Version1_Transaction_Group `json:"transactionGroup,omitempty" xmlrpc:"transactionGroup,omitempty"` // A transaction's status. This status object determines the state it is in the transaction group. TransactionStatus *Provisioning_Version1_Transaction_Status `json:"transactionStatus,omitempty" xmlrpc:"transactionStatus,omitempty"` }
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.
type Provisioning_Version1_Transaction_Group ¶
type Provisioning_Version1_Transaction_Group struct { Entity // Average time, in minutes, for this type of transaction to complete. Please note that this is only an estimate. AverageTimeToComplete *Float64 `json:"averageTimeToComplete,omitempty" xmlrpc:"averageTimeToComplete,omitempty"` // A transaction group's name. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
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.
type Provisioning_Version1_Transaction_History ¶
type Provisioning_Version1_Transaction_History struct { Entity // The finish date of a transaction history record. FinishDate *Time `json:"finishDate,omitempty" xmlrpc:"finishDate,omitempty"` // The guest from where transaction history originates. Guest *Virtual_Guest `json:"guest,omitempty" xmlrpc:"guest,omitempty"` // The guest ID associated with a transaction history. GuestId *int `json:"guestId,omitempty" xmlrpc:"guestId,omitempty"` // The hardware from where transaction history originates. Hardware *Hardware `json:"hardware,omitempty" xmlrpc:"hardware,omitempty"` // The hardware ID associated with a transaction history. HardwareId *int `json:"hardwareId,omitempty" xmlrpc:"hardwareId,omitempty"` // The host ID associated with a transaction history. HostId *int `json:"hostId,omitempty" xmlrpc:"hostId,omitempty"` // The ID associated with a transaction history. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The start date of a transaction history record. StartDate *Time `json:"startDate,omitempty" xmlrpc:"startDate,omitempty"` // The transaction from where transaction history originates. Transaction *Provisioning_Version1_Transaction `json:"transaction,omitempty" xmlrpc:"transaction,omitempty"` // The transaction ID associated with a transaction history. TransactionId *int `json:"transactionId,omitempty" xmlrpc:"transactionId,omitempty"` // The transaction status of a transaction history. TransactionStatus *Provisioning_Version1_Transaction_Status `json:"transactionStatus,omitempty" xmlrpc:"transactionStatus,omitempty"` // The transaction status ID associated with a transaction history. TransactionStatusId *int `json:"transactionStatusId,omitempty" xmlrpc:"transactionStatusId,omitempty"` }
no documentation yet
type Provisioning_Version1_Transaction_OrderTracking ¶ added in v1.0.6
type Provisioning_Version1_Transaction_OrderTracking struct { Entity // A id for tracking order. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Invoice ID InvoiceId *int `json:"invoiceId,omitempty" xmlrpc:"invoiceId,omitempty"` // The order state id. OrderStateId *int `json:"orderStateId,omitempty" xmlrpc:"orderStateId,omitempty"` // no documentation yet OrderTrackingState *Provisioning_Version1_Transaction_OrderTrackingState `json:"orderTrackingState,omitempty" xmlrpc:"orderTrackingState,omitempty"` // no documentation yet Transaction *Provisioning_Version1_Transaction `json:"transaction,omitempty" xmlrpc:"transaction,omitempty"` // The transaction id of the order. TransactionId *int `json:"transactionId,omitempty" xmlrpc:"transactionId,omitempty"` }
no documentation yet
type Provisioning_Version1_Transaction_OrderTrackingState ¶ added in v1.0.6
type Provisioning_Version1_Transaction_OrderTrackingState struct { Entity // The order tracking state description. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // A id for tracking order. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The order tracking state keyname. KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // The transaction name of the order. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
no documentation yet
type Provisioning_Version1_Transaction_Status ¶
type Provisioning_Version1_Transaction_Status struct { Entity // Hardware transaction status average duration. AverageDuration *Float64 `json:"averageDuration,omitempty" xmlrpc:"averageDuration,omitempty"` // Transaction status friendly name. FriendlyName *string `json:"friendlyName,omitempty" xmlrpc:"friendlyName,omitempty"` // Transaction status name. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // A count of NonCompletedTransactionCount *uint `json:"nonCompletedTransactionCount,omitempty" xmlrpc:"nonCompletedTransactionCount,omitempty"` // no documentation yet NonCompletedTransactions []Provisioning_Version1_Transaction `json:"nonCompletedTransactions,omitempty" xmlrpc:"nonCompletedTransactions,omitempty"` }
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.
type Resource_Group ¶
type Resource_Group struct { Entity // A count of a resource group's associated group ancestors. AncestorGroupCount *uint `json:"ancestorGroupCount,omitempty" xmlrpc:"ancestorGroupCount,omitempty"` // A resource group's associated group ancestors. AncestorGroups []Resource_Group `json:"ancestorGroups,omitempty" xmlrpc:"ancestorGroups,omitempty"` // A count of a resource group's associated attributes. AttributeCount *uint `json:"attributeCount,omitempty" xmlrpc:"attributeCount,omitempty"` // A resource group's associated attributes. Attributes []Resource_Group_Attribute `json:"attributes,omitempty" xmlrpc:"attributes,omitempty"` // A resource group's creation date. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // A resource group's description. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // A count of a resource group's associated hardware members. HardwareMemberCount *uint `json:"hardwareMemberCount,omitempty" xmlrpc:"hardwareMemberCount,omitempty"` // A resource group's associated hardware members. HardwareMembers []Resource_Group_Member `json:"hardwareMembers,omitempty" xmlrpc:"hardwareMembers,omitempty"` // A resource group's ID. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A resource group's keyname. KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // A count of a resource group's associated members. MemberCount *uint `json:"memberCount,omitempty" xmlrpc:"memberCount,omitempty"` // A resource group's associated members. Members []Resource_Group_Member `json:"members,omitempty" xmlrpc:"members,omitempty"` // A resource group's name. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // A resource group's associated root resource group. RootResourceGroup *Resource_Group `json:"rootResourceGroup,omitempty" xmlrpc:"rootResourceGroup,omitempty"` // no documentation yet RootResourceGroupId *int `json:"rootResourceGroupId,omitempty" xmlrpc:"rootResourceGroupId,omitempty"` // A count of a resource group's associated subnet members. SubnetMemberCount *uint `json:"subnetMemberCount,omitempty" xmlrpc:"subnetMemberCount,omitempty"` // A resource group's associated subnet members. SubnetMembers []Resource_Group_Member `json:"subnetMembers,omitempty" xmlrpc:"subnetMembers,omitempty"` // A resource group's associated template. Template *Resource_Group_Template `json:"template,omitempty" xmlrpc:"template,omitempty"` // A resource group's template ID. TemplateId *int `json:"templateId,omitempty" xmlrpc:"templateId,omitempty"` // A count of a resource group's associated VLAN members. VlanMemberCount *uint `json:"vlanMemberCount,omitempty" xmlrpc:"vlanMemberCount,omitempty"` // A resource group's associated VLAN members. VlanMembers []Resource_Group_Member `json:"vlanMembers,omitempty" xmlrpc:"vlanMembers,omitempty"` }
no documentation yet
type Resource_Group_Attribute ¶
type Resource_Group_Attribute struct { Entity // A resource group attribute's creation date. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // A resource group attribute's resource group. Group *Resource_Group `json:"group,omitempty" xmlrpc:"group,omitempty"` // A resource group attribute's ID. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A resource group attribute's type. Type *Resource_Group_Attribute_Type `json:"type,omitempty" xmlrpc:"type,omitempty"` // A resource group attribute's value. Value *string `json:"value,omitempty" xmlrpc:"value,omitempty"` }
no documentation yet
type Resource_Group_Attribute_Type ¶
type Resource_Group_Attribute_Type struct { Entity // no documentation yet Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
no documentation yet
type Resource_Group_Descendant_Reference ¶
type Resource_Group_Descendant_Reference struct { Entity // no documentation yet Group *Resource_Group `json:"group,omitempty" xmlrpc:"group,omitempty"` // no documentation yet GroupMember *Resource_Group_Member `json:"groupMember,omitempty" xmlrpc:"groupMember,omitempty"` }
The SoftLayer_Resource_Group_Descendant_Reference data type simplifies the link between one SoftLayer_Resource_Group_Member object and all of its parents.
type Resource_Group_Member ¶
type Resource_Group_Member struct { Entity // A count of a resource group member's associated attributes. AttributeCount *uint `json:"attributeCount,omitempty" xmlrpc:"attributeCount,omitempty"` // A resource group member's associated attributes. Attributes []Resource_Group_Member_Attribute `json:"attributes,omitempty" xmlrpc:"attributes,omitempty"` // A resource group member's creation date. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // A count of a resource group member's associated member descendants. DescendantMemberCount *uint `json:"descendantMemberCount,omitempty" xmlrpc:"descendantMemberCount,omitempty"` // A resource group member's associated member descendants. DescendantMembers []Resource_Group_Member `json:"descendantMembers,omitempty" xmlrpc:"descendantMembers,omitempty"` // A resource group member's resource group. Group *Resource_Group `json:"group,omitempty" xmlrpc:"group,omitempty"` // A resource group member's ID. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A count of a resource group member's associated roles. RoleCount *uint `json:"roleCount,omitempty" xmlrpc:"roleCount,omitempty"` // A resource group member's associated roles. Roles []Resource_Group_Role `json:"roles,omitempty" xmlrpc:"roles,omitempty"` // A resource group member's status. Status *string `json:"status,omitempty" xmlrpc:"status,omitempty"` // A resource group member's type. Type *Resource_Group_Member_Type `json:"type,omitempty" xmlrpc:"type,omitempty"` }
no documentation yet
type Resource_Group_Member_Attribute ¶
type Resource_Group_Member_Attribute struct { Entity // A resource group member attribute's creation date. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // A resource group member attribute's ID. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A resource group member attribute's resource group member. Member *Resource_Group_Member `json:"member,omitempty" xmlrpc:"member,omitempty"` // A resource group member attribute's type. Type *Resource_Group_Member_Attribute_Type `json:"type,omitempty" xmlrpc:"type,omitempty"` // A resource group member attribute's value. Value *string `json:"value,omitempty" xmlrpc:"value,omitempty"` }
no documentation yet
type Resource_Group_Member_Attribute_Type ¶
type Resource_Group_Member_Attribute_Type struct { Entity // no documentation yet Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
no documentation yet
type Resource_Group_Member_CloudStack_Version3_Cluster ¶
type Resource_Group_Member_CloudStack_Version3_Cluster struct { Resource_Group_Member // A resource group member's associated cluster. Resource *Resource_Group `json:"resource,omitempty" xmlrpc:"resource,omitempty"` }
no documentation yet
type Resource_Group_Member_CloudStack_Version3_Pod ¶
type Resource_Group_Member_CloudStack_Version3_Pod struct { Resource_Group_Member // A resource group member's associated pod. Resource *Resource_Group `json:"resource,omitempty" xmlrpc:"resource,omitempty"` }
no documentation yet
type Resource_Group_Member_CloudStack_Version3_Zone ¶
type Resource_Group_Member_CloudStack_Version3_Zone struct { Resource_Group_Member // A resource group member's associated zone. Resource *Resource_Group `json:"resource,omitempty" xmlrpc:"resource,omitempty"` }
no documentation yet
type Resource_Group_Member_Hardware ¶
type Resource_Group_Member_Hardware struct { Resource_Group_Member // A resource group member's associated hardware. Resource *Hardware `json:"resource,omitempty" xmlrpc:"resource,omitempty"` // A resource group hardware member's associated server arbiter-only state. ServerArbiterOnly *Resource_Group_Member_Attribute `json:"serverArbiterOnly,omitempty" xmlrpc:"serverArbiterOnly,omitempty"` // A resource group hardware member's associated server hidden state. ServerHidden *Resource_Group_Member_Attribute `json:"serverHidden,omitempty" xmlrpc:"serverHidden,omitempty"` // A resource group hardware member's associated server priority. ServerPriority *Resource_Group_Member_Attribute `json:"serverPriority,omitempty" xmlrpc:"serverPriority,omitempty"` // A resource group hardware member's associated server slave delay (in seconds). ServerSlaveDelay *Resource_Group_Member_Attribute `json:"serverSlaveDelay,omitempty" xmlrpc:"serverSlaveDelay,omitempty"` // A resource group hardware member's associated server tags (in JSON format). ServerTags *Resource_Group_Member_Attribute `json:"serverTags,omitempty" xmlrpc:"serverTags,omitempty"` // A resource group hardware member's associated server vote count. ServerVotes *Resource_Group_Member_Attribute `json:"serverVotes,omitempty" xmlrpc:"serverVotes,omitempty"` }
no documentation yet
type Resource_Group_Member_Network_Storage ¶
type Resource_Group_Member_Network_Storage struct { Resource_Group_Member // A resource group member's associated network storage. Resource *Network_Storage `json:"resource,omitempty" xmlrpc:"resource,omitempty"` }
no documentation yet
type Resource_Group_Member_Network_Subnet ¶
type Resource_Group_Member_Network_Subnet struct { Resource_Group_Member // A resource group member's associated network subnet. Resource *Network_Subnet `json:"resource,omitempty" xmlrpc:"resource,omitempty"` }
no documentation yet
type Resource_Group_Member_Network_Vlan ¶
type Resource_Group_Member_Network_Vlan struct { Resource_Group_Member // A resource group member's associated network VLAN. Resource *Network_Vlan `json:"resource,omitempty" xmlrpc:"resource,omitempty"` }
no documentation yet
type Resource_Group_Member_Resource_Group ¶
type Resource_Group_Member_Resource_Group struct { Resource_Group_Member // A resource group member's associated resource group. Resource *Resource_Group `json:"resource,omitempty" xmlrpc:"resource,omitempty"` }
no documentation yet
type Resource_Group_Member_Role_Link ¶
type Resource_Group_Member_Role_Link struct { Entity // A resource group member's ID. GroupMemberId *int `json:"groupMemberId,omitempty" xmlrpc:"groupMemberId,omitempty"` // A resource group's template role ID. GroupTemplateRoleId *int `json:"groupTemplateRoleId,omitempty" xmlrpc:"groupTemplateRoleId,omitempty"` }
no documentation yet
type Resource_Group_Member_Software_Component_Password ¶
type Resource_Group_Member_Software_Component_Password struct { Resource_Group_Member // A resource group member's associated software component password. Resource *Software_Component_Password `json:"resource,omitempty" xmlrpc:"resource,omitempty"` }
no documentation yet
type Resource_Group_Member_Type ¶
type Resource_Group_Member_Type struct { Entity // A resource group member's type description. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // A resource group member's type keyname. KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` }
no documentation yet
type Resource_Group_Member_Virtual_Host_Pool ¶
type Resource_Group_Member_Virtual_Host_Pool struct {
Resource_Group_Member
}
no documentation yet
type Resource_Group_Role ¶
type Resource_Group_Role struct { Entity // A resource group role's description. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // A resource group role's ID. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A resource group role's keyname. KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // A count of a resource group's role. MemberLinkCount *uint `json:"memberLinkCount,omitempty" xmlrpc:"memberLinkCount,omitempty"` // A resource group's role. MemberLinks []Resource_Group_Member_Role_Link `json:"memberLinks,omitempty" xmlrpc:"memberLinks,omitempty"` }
no documentation yet
type Resource_Group_Template ¶
type Resource_Group_Template struct { Entity // no documentation yet Children []Resource_Group_Template `json:"children,omitempty" xmlrpc:"children,omitempty"` // A count of ChildrenCount *uint `json:"childrenCount,omitempty" xmlrpc:"childrenCount,omitempty"` // A resource group template's description. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A resource group template's keyname. KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // A count of MemberCount *uint `json:"memberCount,omitempty" xmlrpc:"memberCount,omitempty"` // no documentation yet Members []Resource_Group_Template_Member `json:"members,omitempty" xmlrpc:"members,omitempty"` }
no documentation yet
type Resource_Group_Template_Member ¶
type Resource_Group_Template_Member struct { Entity // no documentation yet MaxQuantity *int `json:"maxQuantity,omitempty" xmlrpc:"maxQuantity,omitempty"` // no documentation yet MinQuantity *int `json:"minQuantity,omitempty" xmlrpc:"minQuantity,omitempty"` // no documentation yet Role *Resource_Group_Role `json:"role,omitempty" xmlrpc:"role,omitempty"` // no documentation yet RoleId *int `json:"roleId,omitempty" xmlrpc:"roleId,omitempty"` // no documentation yet Template *Resource_Group_Template `json:"template,omitempty" xmlrpc:"template,omitempty"` // no documentation yet TemplateId *int `json:"templateId,omitempty" xmlrpc:"templateId,omitempty"` }
no documentation yet
type Result_Detector ¶ added in v1.0.5
type Result_Detector struct { // An array of terms that were matched in the resource object. MatchedTerms []string `json:"matchedTerms,omitempty" xmlrpc:"matchedTerms,omitempty"` // The score ratio of the result for relevance to the search criteria. RelevanceScore *Float64 `json:"relevanceScore,omitempty" xmlrpc:"relevanceScore,omitempty"` // A search results resource object that matched search criteria. Resource interface{} `json:"resource,omitempty" xmlrpc:"resource,omitempty"` // The type of the resource object that matched search criteria. ResourceType *string `json:"resourceType,omitempty" xmlrpc:"resourceType,omitempty"` }
Used for detecting the search result before the real unmarshalling can begin
type Sales_Presale_Event ¶
type Sales_Presale_Event struct { Entity // 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. ActiveFlag *bool `json:"activeFlag,omitempty" xmlrpc:"activeFlag,omitempty"` // Description of the presale event. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // End date of the presale event. Orders can be approved and provisioned after this date. EndDate *Time `json:"endDate,omitempty" xmlrpc:"endDate,omitempty"` // A flag to indicate that the presale event is expired. A presale event is expired if the current time is after the end date. ExpiredFlag *bool `json:"expiredFlag,omitempty" xmlrpc:"expiredFlag,omitempty"` // Presale event unique identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The [[SoftLayer_Product_Item]] associated with the presale event. Item *Product_Item `json:"item,omitempty" xmlrpc:"item,omitempty"` // [[SoftLayer_Product_Item]] id associated with the presale event. ItemId *int `json:"itemId,omitempty" xmlrpc:"itemId,omitempty"` // The [[SoftLayer_Location]] associated with the presale event. Location *Location `json:"location,omitempty" xmlrpc:"location,omitempty"` // [[SoftLayer_Location]] id for the presale event. LocationId *int `json:"locationId,omitempty" xmlrpc:"locationId,omitempty"` // A count of the orders ([[SoftLayer_Billing_Order]]) associated with this presale event that were created for the customer's account. OrderCount *uint `json:"orderCount,omitempty" xmlrpc:"orderCount,omitempty"` // The orders ([[SoftLayer_Billing_Order]]) associated with this presale event that were created for the customer's account. Orders []Billing_Order `json:"orders,omitempty" xmlrpc:"orders,omitempty"` // Start date of the presale event. Orders cannot be approved before this date. StartDate *Time `json:"startDate,omitempty" xmlrpc:"startDate,omitempty"` }
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.
type Scale_Asset_Virtual_Guest ¶
type Scale_Asset_Virtual_Guest struct {
Scale_Asset
}
no documentation yet
type Scale_Group ¶
type Scale_Group struct { Entity // The identifier of the account assigned to this group. AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` }
no documentation yet
type Scale_LoadBalancer ¶
type Scale_LoadBalancer struct { Entity // The identifier for the health check of this load balancer configuration HealthCheckId *int `json:"healthCheckId,omitempty" xmlrpc:"healthCheckId,omitempty"` }
no documentation yet
type Scale_Member_Virtual_Guest ¶
type Scale_Member_Virtual_Guest struct {
Scale_Member
}
no documentation yet
type Scale_Network_Vlan ¶
type Scale_Network_Vlan struct { Entity // The identifier for the VLAN to scale with. NetworkVlanId *int `json:"networkVlanId,omitempty" xmlrpc:"networkVlanId,omitempty"` }
no documentation yet
type Security_Certificate ¶
type Security_Certificate struct { Entity // The number of services currently associated with the certificate. AssociatedServiceCount *int `json:"associatedServiceCount,omitempty" xmlrpc:"associatedServiceCount,omitempty"` // 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. Certificate *string `json:"certificate,omitempty" xmlrpc:"certificate,omitempty"` // 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. CertificateSigningRequest *string `json:"certificateSigningRequest,omitempty" xmlrpc:"certificateSigningRequest,omitempty"` // The common name (usually a domain name) encoded within the certificate. // // This property is read only. Changes made will be silently ignored. CommonName *string `json:"commonName,omitempty" xmlrpc:"commonName,omitempty"` // 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. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // The ID of the certificate record. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // 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. IntermediateCertificate *string `json:"intermediateCertificate,omitempty" xmlrpc:"intermediateCertificate,omitempty"` // The size (number of bits) of the public key represented by the certificate. KeySize *int `json:"keySize,omitempty" xmlrpc:"keySize,omitempty"` // A count of cloud Load Balancer [LBaaS] listeners currently associated with the certificate. LbaasListenerCount *uint `json:"lbaasListenerCount,omitempty" xmlrpc:"lbaasListenerCount,omitempty"` // Cloud Load Balancer [LBaaS] listeners currently associated with the certificate. LbaasListeners []Network_LBaaS_Listener `json:"lbaasListeners,omitempty" xmlrpc:"lbaasListeners,omitempty"` // A count of the load balancers virtual IP addresses currently associated with the certificate. LoadBalancerVirtualIpAddressCount *uint `json:"loadBalancerVirtualIpAddressCount,omitempty" xmlrpc:"loadBalancerVirtualIpAddressCount,omitempty"` // The load balancers virtual IP addresses currently associated with the certificate. LoadBalancerVirtualIpAddresses []Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress `json:"loadBalancerVirtualIpAddresses,omitempty" xmlrpc:"loadBalancerVirtualIpAddresses,omitempty"` // 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. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // A note to help describe the certificate. Notes *string `json:"notes,omitempty" xmlrpc:"notes,omitempty"` // The organizational name encoded in the certificate. // // This property is read only. Changes made will be silently ignored. OrganizationName *string `json:"organizationName,omitempty" xmlrpc:"organizationName,omitempty"` // The private key in the key/certificate pair. // // This property may only be modified when no services are associated. See associatedServiceCount. PrivateKey *string `json:"privateKey,omitempty" xmlrpc:"privateKey,omitempty"` // The UTC timestamp representing the beginning of the certificate's validity // // This property is read only. Changes made will be silently ignored. ValidityBegin *Time `json:"validityBegin,omitempty" xmlrpc:"validityBegin,omitempty"` // The number of days remaining in the validity period for the certificate. // // This property is read only. Changes made will be silently ignored. ValidityDays *int `json:"validityDays,omitempty" xmlrpc:"validityDays,omitempty"` // The UTC timestamp representing the end of the certificate's validity period. // // This property is read only. Changes made will be silently ignored. ValidityEnd *Time `json:"validityEnd,omitempty" xmlrpc:"validityEnd,omitempty"` }
no documentation yet
type Security_Certificate_Entry ¶
type Security_Certificate_Entry struct { Entity // The ID of the certificate record. CertificateId *int `json:"certificateId,omitempty" xmlrpc:"certificateId,omitempty"` // The common name (usually a domain name) encoded within the certificate. CommonName *string `json:"commonName,omitempty" xmlrpc:"commonName,omitempty"` // The size (number of bits) of the public key represented by the certificate. KeySize *int `json:"keySize,omitempty" xmlrpc:"keySize,omitempty"` // The organizational name encoded in the certificate. OrganizationName *string `json:"organizationName,omitempty" xmlrpc:"organizationName,omitempty"` // The UTC timestamp representing the beginning of the certificate's validity ValidityBegin *Time `json:"validityBegin,omitempty" xmlrpc:"validityBegin,omitempty"` // The number of days remaining in the validity period for the certificate. ValidityDays *int `json:"validityDays,omitempty" xmlrpc:"validityDays,omitempty"` // The UTC timestamp representing the end of the certificate's validity period. ValidityEnd *Time `json:"validityEnd,omitempty" xmlrpc:"validityEnd,omitempty"` }
no documentation yet
type Security_Certificate_Request ¶
type Security_Certificate_Request struct { Entity // The account to which a SSL certificate request belongs. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // This is a reference to your SoftLayer account. AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // The email address of a person who will approve your SSL certificate order. This is usually an email address of your domain administrator. ApproverEmailAddress *string `json:"approverEmailAddress,omitempty" xmlrpc:"approverEmailAddress,omitempty"` // A Certificate Signing Request (CSR) string CertificateSigningRequest *string `json:"certificateSigningRequest,omitempty" xmlrpc:"certificateSigningRequest,omitempty"` // A domain name of a SSL certificate request CommonName *string `json:"commonName,omitempty" xmlrpc:"commonName,omitempty"` // The date a SSL certificate request was created. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // The date of your SSL certificate went into effect EffectiveDate *Time `json:"effectiveDate,omitempty" xmlrpc:"effectiveDate,omitempty"` // The expiration date of your SSL certificate ExpirationDate *Time `json:"expirationDate,omitempty" xmlrpc:"expirationDate,omitempty"` // The internal identifier of an SSL certificate request Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The date a SSL certificate request was last modified. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // The order contains the information related to a SSL certificate request. Order *Billing_Order `json:"order,omitempty" xmlrpc:"order,omitempty"` // The associated order item for this SSL certificate request. OrderItem *Billing_Order_Item `json:"orderItem,omitempty" xmlrpc:"orderItem,omitempty"` // The status of a SSL certificate request. Status *Security_Certificate_Request_Status `json:"status,omitempty" xmlrpc:"status,omitempty"` // A status id reflecting the state of a SSL certificate request StatusId *int `json:"statusId,omitempty" xmlrpc:"statusId,omitempty"` // The technical contact email address. TechnicalContactEmailAddress *string `json:"technicalContactEmailAddress,omitempty" xmlrpc:"technicalContactEmailAddress,omitempty"` }
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.
type Security_Certificate_Request_ServerType ¶
type Security_Certificate_Request_ServerType struct { Entity // The description of the certificate server type. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // The internal identifier of the certificate server type. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The name of the certificate server type. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // The value of the certificate server type. Value *int `json:"value,omitempty" xmlrpc:"value,omitempty"` }
Represents a server type that can be specified when ordering an SSL certificate.
type Security_Certificate_Request_Status ¶
type Security_Certificate_Request_Status struct { Entity // The description of a SSL certificate request status Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // The internal identifier of an SSL certificate request status Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The status name Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
Represents the status of an SSL certificate request.
type Security_Directory_Service_Host_Xref_Hardware ¶
type Security_Directory_Service_Host_Xref_Hardware struct { Entity // The hardware object. Host *Hardware `json:"host,omitempty" xmlrpc:"host,omitempty"` }
SoftLayer_Security_Directory_Service_Host_Xref_Hardware extends the [[SoftLayer_Security_Directory_Service_Host_Xref]] data type to include hardware specific properties.
type Security_Level ¶
type Security_Level struct { Entity // The unique name of the security level the account is under KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // The name of the security level the account is under Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
The SoftLayer_Security_Level data type contains the security level restriction for the account
type Security_SecureTransportCipher ¶
type Security_SecureTransportCipher struct { Entity // Unique identifier for the encryption algorithm KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` }
Encryption algorithm intended for use in SSL/TLS communications
type Security_SecureTransportProtocol ¶
type Security_SecureTransportProtocol struct { Entity // Unique identifier for the protocol KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // List of the supported encryption ciphers SupportedSecureTransportCiphers []Security_SecureTransportCipher `json:"supportedSecureTransportCiphers,omitempty" xmlrpc:"supportedSecureTransportCiphers,omitempty"` }
Protocol intended for use in secure communications
type Security_Ssh_Key ¶
type Security_Ssh_Key struct { Entity // no documentation yet Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // A count of the image template groups that are linked to an SSH key. BlockDeviceTemplateGroupCount *uint `json:"blockDeviceTemplateGroupCount,omitempty" xmlrpc:"blockDeviceTemplateGroupCount,omitempty"` // The image template groups that are linked to an SSH key. BlockDeviceTemplateGroups []Virtual_Guest_Block_Device_Template_Group `json:"blockDeviceTemplateGroups,omitempty" xmlrpc:"blockDeviceTemplateGroups,omitempty"` // The date a ssh key was added. // // This property is read only. Changes made will be silently ignored. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // 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. Fingerprint *string `json:"fingerprint,omitempty" xmlrpc:"fingerprint,omitempty"` // The ID of the ssh key record. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The ssh key. Key *string `json:"key,omitempty" xmlrpc:"key,omitempty"` // A descriptive name used to identify a ssh key. Label *string `json:"label,omitempty" xmlrpc:"label,omitempty"` // The date a ssh key was last modified. // // This property is read only. Changes made will be silently ignored. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // A small note about a ssh key to use at your discretion. Notes *string `json:"notes,omitempty" xmlrpc:"notes,omitempty"` // A count of the OS root users that are linked to an SSH key. SoftwarePasswordCount *uint `json:"softwarePasswordCount,omitempty" xmlrpc:"softwarePasswordCount,omitempty"` // The OS root users that are linked to an SSH key. SoftwarePasswords []Software_Component_Password `json:"softwarePasswords,omitempty" xmlrpc:"softwarePasswords,omitempty"` }
no documentation yet
type Service_External_Resource ¶
type Service_External_Resource struct { Entity // The customer account that is consuming the service. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // The customer account that is consuming the related service. AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // The unique identifier in the service provider's system. ExternalIdentifier *string `json:"externalIdentifier,omitempty" xmlrpc:"externalIdentifier,omitempty"` // An external resource's unique identifier in the SoftLayer system. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` }
The SoftLayer_Service_External_Resource is a placeholder that references a service being provided outside of the standard SoftLayer system.
type Service_Provider ¶
type Service_Provider struct { Entity // no documentation yet Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
no documentation yet
type Software_AccountLicense ¶
type Software_AccountLicense struct { Entity // The customer account this Account License belongs to. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // The ID of the SoftLayer Account to which this Account License belongs to. AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // The billing item for a software account license. BillingItem *Billing_Item `json:"billingItem,omitempty" xmlrpc:"billingItem,omitempty"` // 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. Capacity *string `json:"capacity,omitempty" xmlrpc:"capacity,omitempty"` // The License Key for this specific Account License. Key *string `json:"key,omitempty" xmlrpc:"key,omitempty"` // The SoftLayer_Software_Description that this account license is for. SoftwareDescription *Software_Description `json:"softwareDescription,omitempty" xmlrpc:"softwareDescription,omitempty"` // The unit of measurement that an account license has the capacity of. Units *string `json:"units,omitempty" xmlrpc:"units,omitempty"` }
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.
type Software_Component ¶
type Software_Component struct { Entity // The average amount of time that a software component takes to install. AverageInstallationDuration *uint `json:"averageInstallationDuration,omitempty" xmlrpc:"averageInstallationDuration,omitempty"` // The billing item for a software component. BillingItem *Billing_Item `json:"billingItem,omitempty" xmlrpc:"billingItem,omitempty"` // The hardware this Software Component is installed upon. Hardware *Hardware `json:"hardware,omitempty" xmlrpc:"hardware,omitempty"` // Hardware Identification Number for the server this Software Component is installed upon. HardwareId *int `json:"hardwareId,omitempty" xmlrpc:"hardwareId,omitempty"` // An ID number identifying this Software Component (Software Installation) Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The manufacturer code that is needed to activate a license. ManufacturerActivationCode *string `json:"manufacturerActivationCode,omitempty" xmlrpc:"manufacturerActivationCode,omitempty"` // A license key for this specific installation of software, if it is needed. ManufacturerLicenseInstance *string `json:"manufacturerLicenseInstance,omitempty" xmlrpc:"manufacturerLicenseInstance,omitempty"` // A count of username/Password pairs used for access to this Software Installation. PasswordCount *uint `json:"passwordCount,omitempty" xmlrpc:"passwordCount,omitempty"` // History Records for Software Passwords. PasswordHistory []Software_Component_Password_History `json:"passwordHistory,omitempty" xmlrpc:"passwordHistory,omitempty"` // A count of history Records for Software Passwords. PasswordHistoryCount *uint `json:"passwordHistoryCount,omitempty" xmlrpc:"passwordHistoryCount,omitempty"` // Username/Password pairs used for access to this Software Installation. Passwords []Software_Component_Password `json:"passwords,omitempty" xmlrpc:"passwords,omitempty"` // The Software Description of this Software Component. SoftwareDescription *Software_Description `json:"softwareDescription,omitempty" xmlrpc:"softwareDescription,omitempty"` // The License this Software Component uses. SoftwareLicense *Software_License `json:"softwareLicense,omitempty" xmlrpc:"softwareLicense,omitempty"` // The virtual guest this software component is installed upon. VirtualGuest *Virtual_Guest `json:"virtualGuest,omitempty" xmlrpc:"virtualGuest,omitempty"` }
A SoftLayer_Software_Component ties the installation of a specific piece of software onto a specific piece of hardware.
SoftLayer_Software_Component works with SoftLayer_Software_License and SoftLayer_Software_Description to tie this all together.
<ul> <li>SoftLayer_Software_Component is the installation of a specific piece of software onto a specific piece of hardware in accordance to a software license. <ul> <li>SoftLayer_Software_License dictates when and how a specific piece of software may be installed onto a piece of hardware. <ul> <li>SoftLayer_Software_Description describes a specific piece of software which can be installed onto hardware in accordance with it's license agreement. </li></ul></li></ul></li></ul>
type Software_Component_Analytics ¶
type Software_Component_Analytics struct {
Software_Component
}
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.
type Software_Component_Analytics_Urchin ¶
type Software_Component_Analytics_Urchin struct {
Software_Component_Analytics
}
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.
type Software_Component_AntivirusSpyware ¶
type Software_Component_AntivirusSpyware struct {
Software_Component
}
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.
type Software_Component_AntivirusSpyware_Mcafee ¶
type Software_Component_AntivirusSpyware_Mcafee struct {
Software_Component_AntivirusSpyware
}
The SoftLayer_Software_Component_AntivirusSpyware_Mcafee represents a single anti-virus/spyware software component.
type Software_Component_AntivirusSpyware_Mcafee_Epo_Version36 ¶
type Software_Component_AntivirusSpyware_Mcafee_Epo_Version36 struct { Software_Component_AntivirusSpyware_Mcafee // The virus scan agent details. AgentDetails *McAfee_Epolicy_Orchestrator_Version36_Agent_Details `json:"agentDetails,omitempty" xmlrpc:"agentDetails,omitempty"` // The current anti-virus policy. CurrentAntivirusPolicy *int `json:"currentAntivirusPolicy,omitempty" xmlrpc:"currentAntivirusPolicy,omitempty"` // The virus definition file version. DataFileVersion *McAfee_Epolicy_Orchestrator_Version36_Product_Properties `json:"dataFileVersion,omitempty" xmlrpc:"dataFileVersion,omitempty"` // The version of ePolicy Orchestrator that the anti-virus/spyware client communicates with. EpoVersion *string `json:"epoVersion,omitempty" xmlrpc:"epoVersion,omitempty"` // A count of the latest access protection events. LatestAccessProtectionEventCount *uint `json:"latestAccessProtectionEventCount,omitempty" xmlrpc:"latestAccessProtectionEventCount,omitempty"` // The latest access protection events. LatestAccessProtectionEvents []McAfee_Epolicy_Orchestrator_Version36_Antivirus_Event_AccessProtection `json:"latestAccessProtectionEvents,omitempty" xmlrpc:"latestAccessProtectionEvents,omitempty"` // A count of the latest anti-virus events. LatestAntivirusEventCount *uint `json:"latestAntivirusEventCount,omitempty" xmlrpc:"latestAntivirusEventCount,omitempty"` // The latest anti-virus events. LatestAntivirusEvents []McAfee_Epolicy_Orchestrator_Version36_Antivirus_Event `json:"latestAntivirusEvents,omitempty" xmlrpc:"latestAntivirusEvents,omitempty"` // A count of the latest spyware events. LatestSpywareEventCount *uint `json:"latestSpywareEventCount,omitempty" xmlrpc:"latestSpywareEventCount,omitempty"` // The latest spyware events. LatestSpywareEvents []McAfee_Epolicy_Orchestrator_Version36_Antivirus_Event `json:"latestSpywareEvents,omitempty" xmlrpc:"latestSpywareEvents,omitempty"` // The current transaction status of a server. TransactionStatus *string `json:"transactionStatus,omitempty" xmlrpc:"transactionStatus,omitempty"` }
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.
type Software_Component_AntivirusSpyware_Mcafee_Epo_Version45 ¶
type Software_Component_AntivirusSpyware_Mcafee_Epo_Version45 struct { Software_Component_AntivirusSpyware_Mcafee // The virus scan agent details. AgentDetails *McAfee_Epolicy_Orchestrator_Version45_Agent_Details `json:"agentDetails,omitempty" xmlrpc:"agentDetails,omitempty"` // The current anti-virus policy. CurrentAntivirusPolicy *int `json:"currentAntivirusPolicy,omitempty" xmlrpc:"currentAntivirusPolicy,omitempty"` // The virus definition file version. DataFileVersion *McAfee_Epolicy_Orchestrator_Version45_Product_Properties `json:"dataFileVersion,omitempty" xmlrpc:"dataFileVersion,omitempty"` // The version of ePolicy Orchestrator that the anti-virus/spyware client communicates with. EpoVersion *string `json:"epoVersion,omitempty" xmlrpc:"epoVersion,omitempty"` // The current transaction status of a server. TransactionStatus *string `json:"transactionStatus,omitempty" xmlrpc:"transactionStatus,omitempty"` }
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.
type Software_Component_AntivirusSpyware_Mcafee_Epo_Version51 ¶ added in v1.0.1
type Software_Component_AntivirusSpyware_Mcafee_Epo_Version51 struct { Software_Component_AntivirusSpyware_Mcafee // The virus scan agent details. AgentDetails *McAfee_Epolicy_Orchestrator_Version51_Agent_Details `json:"agentDetails,omitempty" xmlrpc:"agentDetails,omitempty"` // The current anti-virus policy. CurrentAntivirusPolicy *int `json:"currentAntivirusPolicy,omitempty" xmlrpc:"currentAntivirusPolicy,omitempty"` // The virus definition file version. DataFileVersion *McAfee_Epolicy_Orchestrator_Version51_Product_Properties `json:"dataFileVersion,omitempty" xmlrpc:"dataFileVersion,omitempty"` // The version of McAfee ePO Server that the anti-virus/spyware client communicates with. EpoVersion *string `json:"epoVersion,omitempty" xmlrpc:"epoVersion,omitempty"` // The version of ePolicy Server that the host IPS client communicates with. TransactionStatus *string `json:"transactionStatus,omitempty" xmlrpc:"transactionStatus,omitempty"` }
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.
type Software_Component_ControlPanel ¶
type Software_Component_ControlPanel struct {
Software_Component
}
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.
type Software_Component_ControlPanel_Cpanel ¶
type Software_Component_ControlPanel_Cpanel struct {
Software_Component
}
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.
type Software_Component_ControlPanel_Idera ¶
type Software_Component_ControlPanel_Idera struct {
Software_Component
}
This object specifies a specific type of control panel Software Component: An Idera instance.
type Software_Component_ControlPanel_Idera_ServerBackup ¶
type Software_Component_ControlPanel_Idera_ServerBackup struct {
Software_Component_ControlPanel_Idera
}
This object specifies a specific type of Software Component: A Idera Server Backup instance.
type Software_Component_ControlPanel_Microsoft ¶
type Software_Component_ControlPanel_Microsoft struct {
Software_Component
}
This object is a parent class for Microsoft Products, like Web Matrix
type Software_Component_ControlPanel_Microsoft_WebPlatform ¶
type Software_Component_ControlPanel_Microsoft_WebPlatform struct {
Software_Component_ControlPanel_Microsoft
}
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.
type Software_Component_ControlPanel_Parallels ¶
type Software_Component_ControlPanel_Parallels struct {
Software_Component
}
This object is a parent class for SWSoft Products, like Plesk
type Software_Component_ControlPanel_Parallels_Plesk ¶
type Software_Component_ControlPanel_Parallels_Plesk struct {
Software_Component_ControlPanel_Parallels
}
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.
type Software_Component_ControlPanel_R1soft ¶
type Software_Component_ControlPanel_R1soft struct {
Software_Component
}
This object specifies a specific type of control panel Software Component: A R1soft instance.
type Software_Component_ControlPanel_R1soft_Cdp ¶
type Software_Component_ControlPanel_R1soft_Cdp struct {
Software_Component_ControlPanel_R1soft
}
This object specifies a specific type of Software Component: A R1soft continuous data protection instance.
type Software_Component_ControlPanel_R1soft_ServerBackup ¶
type Software_Component_ControlPanel_R1soft_ServerBackup struct {
Software_Component_ControlPanel_R1soft
}
This object specifies a specific type of Software Component: A R1Soft Server Backup instance.
type Software_Component_ControlPanel_Swsoft ¶
type Software_Component_ControlPanel_Swsoft struct {
Software_Component
}
This object is a parent class for SWSoft Products, like Plesk
type Software_Component_ControlPanel_WebhostAutomation ¶
type Software_Component_ControlPanel_WebhostAutomation struct {
Software_Component
}
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.
type Software_Component_HostIps ¶
type Software_Component_HostIps struct {
Software_Component
}
This object specifies a specific type of Software Component: A Host Intrusion Protection System instance.
type Software_Component_HostIps_Mcafee ¶
type Software_Component_HostIps_Mcafee struct {
Software_Component_HostIps
}
The SoftLayer_Software_Component_HostIps_Mcafee represents a single host IPS software component.
type Software_Component_HostIps_Mcafee_Epo_Version36_Hips ¶
type Software_Component_HostIps_Mcafee_Epo_Version36_Hips struct { Software_Component_HostIps_Mcafee // The host IPS agent details. AgentDetails *McAfee_Epolicy_Orchestrator_Version36_Agent_Details `json:"agentDetails,omitempty" xmlrpc:"agentDetails,omitempty"` // A count of the names of the possible policy options for the application mode setting. ApplicationModePolicyNameCount *uint `json:"applicationModePolicyNameCount,omitempty" xmlrpc:"applicationModePolicyNameCount,omitempty"` // The names of the possible policy options for the application mode setting. ApplicationModePolicyNames []McAfee_Epolicy_Orchestrator_Version36_Policy_Object `json:"applicationModePolicyNames,omitempty" xmlrpc:"applicationModePolicyNames,omitempty"` // A count of the names of the possible policy options for the application rule set setting. ApplicationRuleSetPolicyNameCount *uint `json:"applicationRuleSetPolicyNameCount,omitempty" xmlrpc:"applicationRuleSetPolicyNameCount,omitempty"` // The names of the possible policy options for the application rule set setting. ApplicationRuleSetPolicyNames []McAfee_Epolicy_Orchestrator_Version36_Policy_Object `json:"applicationRuleSetPolicyNames,omitempty" xmlrpc:"applicationRuleSetPolicyNames,omitempty"` // A count of the names of the possible options for the enforcement policy setting. EnforcementPolicyNameCount *uint `json:"enforcementPolicyNameCount,omitempty" xmlrpc:"enforcementPolicyNameCount,omitempty"` // The names of the possible options for the enforcement policy setting. EnforcementPolicyNames []McAfee_Epolicy_Orchestrator_Version36_Policy_Object `json:"enforcementPolicyNames,omitempty" xmlrpc:"enforcementPolicyNames,omitempty"` // The version of ePolicy Orchestrator that the host IPS client communicates with. EpoVersion *string `json:"epoVersion,omitempty" xmlrpc:"epoVersion,omitempty"` // A count of the names of the possible policy options for the firewall mode setting. FirewallModePolicyNameCount *uint `json:"firewallModePolicyNameCount,omitempty" xmlrpc:"firewallModePolicyNameCount,omitempty"` // The names of the possible policy options for the firewall mode setting. FirewallModePolicyNames []McAfee_Epolicy_Orchestrator_Version36_Policy_Object `json:"firewallModePolicyNames,omitempty" xmlrpc:"firewallModePolicyNames,omitempty"` // A count of the names of the possible policy options for the firewall rule set setting. FirewallRuleSetPolicyNameCount *uint `json:"firewallRuleSetPolicyNameCount,omitempty" xmlrpc:"firewallRuleSetPolicyNameCount,omitempty"` // The names of the possible policy options for the firewall rule set setting. FirewallRuleSetPolicyNames []McAfee_Epolicy_Orchestrator_Version36_Policy_Object `json:"firewallRuleSetPolicyNames,omitempty" xmlrpc:"firewallRuleSetPolicyNames,omitempty"` // A count of the names of the possible policy options for the host IPS mode setting. IpsModePolicyNameCount *uint `json:"ipsModePolicyNameCount,omitempty" xmlrpc:"ipsModePolicyNameCount,omitempty"` // The names of the possible policy options for the host IPS mode setting. IpsModePolicyNames []McAfee_Epolicy_Orchestrator_Version36_Policy_Object `json:"ipsModePolicyNames,omitempty" xmlrpc:"ipsModePolicyNames,omitempty"` // A count of the names of the possible policy options for the host IPS protection setting. IpsProtectionPolicyNameCount *uint `json:"ipsProtectionPolicyNameCount,omitempty" xmlrpc:"ipsProtectionPolicyNameCount,omitempty"` // The names of the possible policy options for the host IPS protection setting. IpsProtectionPolicyNames []McAfee_Epolicy_Orchestrator_Version36_Policy_Object `json:"ipsProtectionPolicyNames,omitempty" xmlrpc:"ipsProtectionPolicyNames,omitempty"` // The current transaction status of a server. TransactionStatus *string `json:"transactionStatus,omitempty" xmlrpc:"transactionStatus,omitempty"` }
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.
type Software_Component_HostIps_Mcafee_Epo_Version36_Hips_Version6 ¶
type Software_Component_HostIps_Mcafee_Epo_Version36_Hips_Version6 struct { Software_Component_HostIps_Mcafee_Epo_Version36_Hips // A count of the blocked application events for this software component. BlockedApplicationEventCount *uint `json:"blockedApplicationEventCount,omitempty" xmlrpc:"blockedApplicationEventCount,omitempty"` // The blocked application events for this software component. BlockedApplicationEvents []McAfee_Epolicy_Orchestrator_Version36_Hips_Version6_BlockedApplicationEvent `json:"blockedApplicationEvents,omitempty" xmlrpc:"blockedApplicationEvents,omitempty"` // A count of the host IPS events for this software component. IpsEventCount *uint `json:"ipsEventCount,omitempty" xmlrpc:"ipsEventCount,omitempty"` // The host IPS events for this software component. IpsEvents []McAfee_Epolicy_Orchestrator_Version36_Hips_Version6_IPSEvent `json:"ipsEvents,omitempty" xmlrpc:"ipsEvents,omitempty"` }
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.
type Software_Component_HostIps_Mcafee_Epo_Version36_Hips_Version7 ¶
type Software_Component_HostIps_Mcafee_Epo_Version36_Hips_Version7 struct { Software_Component_HostIps_Mcafee_Epo_Version36_Hips // A count of the blocked application events for this software component. BlockedApplicationEventCount *uint `json:"blockedApplicationEventCount,omitempty" xmlrpc:"blockedApplicationEventCount,omitempty"` // The blocked application events for this software component. BlockedApplicationEvents []McAfee_Epolicy_Orchestrator_Version36_Hips_Version7_BlockedApplicationEvent `json:"blockedApplicationEvents,omitempty" xmlrpc:"blockedApplicationEvents,omitempty"` // A count of the host IPS events for this software component. IpsEventCount *uint `json:"ipsEventCount,omitempty" xmlrpc:"ipsEventCount,omitempty"` // The host IPS events for this software component. IpsEvents []McAfee_Epolicy_Orchestrator_Version36_Hips_Version7_IPSEvent `json:"ipsEvents,omitempty" xmlrpc:"ipsEvents,omitempty"` }
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.
type Software_Component_HostIps_Mcafee_Epo_Version45_Hips ¶
type Software_Component_HostIps_Mcafee_Epo_Version45_Hips struct { Software_Component_HostIps_Mcafee // The host IPS agent details. AgentDetails *McAfee_Epolicy_Orchestrator_Version45_Agent_Details `json:"agentDetails,omitempty" xmlrpc:"agentDetails,omitempty"` // A count of the names of the possible policy options for the application mode setting. ApplicationModePolicyNameCount *uint `json:"applicationModePolicyNameCount,omitempty" xmlrpc:"applicationModePolicyNameCount,omitempty"` // The names of the possible policy options for the application mode setting. ApplicationModePolicyNames []McAfee_Epolicy_Orchestrator_Version45_Policy_Object `json:"applicationModePolicyNames,omitempty" xmlrpc:"applicationModePolicyNames,omitempty"` // A count of the names of the possible policy options for the application rule set setting. ApplicationRuleSetPolicyNameCount *uint `json:"applicationRuleSetPolicyNameCount,omitempty" xmlrpc:"applicationRuleSetPolicyNameCount,omitempty"` // The names of the possible policy options for the application rule set setting. ApplicationRuleSetPolicyNames []McAfee_Epolicy_Orchestrator_Version45_Policy_Object `json:"applicationRuleSetPolicyNames,omitempty" xmlrpc:"applicationRuleSetPolicyNames,omitempty"` // A count of the names of the possible options for the enforcement policy setting. EnforcementPolicyNameCount *uint `json:"enforcementPolicyNameCount,omitempty" xmlrpc:"enforcementPolicyNameCount,omitempty"` // The names of the possible options for the enforcement policy setting. EnforcementPolicyNames []McAfee_Epolicy_Orchestrator_Version45_Policy_Object `json:"enforcementPolicyNames,omitempty" xmlrpc:"enforcementPolicyNames,omitempty"` // The version of ePolicy Orchestrator that the host IPS client communicates with. EpoVersion *string `json:"epoVersion,omitempty" xmlrpc:"epoVersion,omitempty"` // A count of the names of the possible policy options for the firewall mode setting. FirewallModePolicyNameCount *uint `json:"firewallModePolicyNameCount,omitempty" xmlrpc:"firewallModePolicyNameCount,omitempty"` // The names of the possible policy options for the firewall mode setting. FirewallModePolicyNames []McAfee_Epolicy_Orchestrator_Version45_Policy_Object `json:"firewallModePolicyNames,omitempty" xmlrpc:"firewallModePolicyNames,omitempty"` // A count of the names of the possible policy options for the firewall rule set setting. FirewallRuleSetPolicyNameCount *uint `json:"firewallRuleSetPolicyNameCount,omitempty" xmlrpc:"firewallRuleSetPolicyNameCount,omitempty"` // The names of the possible policy options for the firewall rule set setting. FirewallRuleSetPolicyNames []McAfee_Epolicy_Orchestrator_Version45_Policy_Object `json:"firewallRuleSetPolicyNames,omitempty" xmlrpc:"firewallRuleSetPolicyNames,omitempty"` // A count of the names of the possible policy options for the host IPS mode setting. IpsModePolicyNameCount *uint `json:"ipsModePolicyNameCount,omitempty" xmlrpc:"ipsModePolicyNameCount,omitempty"` // The names of the possible policy options for the host IPS mode setting. IpsModePolicyNames []McAfee_Epolicy_Orchestrator_Version45_Policy_Object `json:"ipsModePolicyNames,omitempty" xmlrpc:"ipsModePolicyNames,omitempty"` // A count of the names of the possible policy options for the host IPS protection setting. IpsProtectionPolicyNameCount *uint `json:"ipsProtectionPolicyNameCount,omitempty" xmlrpc:"ipsProtectionPolicyNameCount,omitempty"` // The names of the possible policy options for the host IPS protection setting. IpsProtectionPolicyNames []McAfee_Epolicy_Orchestrator_Version45_Policy_Object `json:"ipsProtectionPolicyNames,omitempty" xmlrpc:"ipsProtectionPolicyNames,omitempty"` // The current transaction status of a server. TransactionStatus *string `json:"transactionStatus,omitempty" xmlrpc:"transactionStatus,omitempty"` }
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.
type Software_Component_HostIps_Mcafee_Epo_Version45_Hips_Version7 ¶
type Software_Component_HostIps_Mcafee_Epo_Version45_Hips_Version7 struct {
Software_Component_HostIps_Mcafee_Epo_Version45_Hips
}
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.
type Software_Component_HostIps_Mcafee_Epo_Version45_Hips_Version8 ¶
type Software_Component_HostIps_Mcafee_Epo_Version45_Hips_Version8 struct {
Software_Component_HostIps_Mcafee_Epo_Version45_Hips
}
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.
type Software_Component_HostIps_Mcafee_Epo_Version51 ¶ added in v1.0.1
type Software_Component_HostIps_Mcafee_Epo_Version51 struct { Software_Component_HostIps_Mcafee // The virus scan agent details. AgentDetails *McAfee_Epolicy_Orchestrator_Version51_Agent_Details `json:"agentDetails,omitempty" xmlrpc:"agentDetails,omitempty"` // no documentation yet EpoVersion *string `json:"epoVersion,omitempty" xmlrpc:"epoVersion,omitempty"` // no documentation yet FirewallModePolicyNames []McAfee_Epolicy_Orchestrator_Version51_Policy_Object `json:"firewallModePolicyNames,omitempty" xmlrpc:"firewallModePolicyNames,omitempty"` // no documentation yet FirewallRuleSetPolicyNames []McAfee_Epolicy_Orchestrator_Version51_Policy_Object `json:"firewallRuleSetPolicyNames,omitempty" xmlrpc:"firewallRuleSetPolicyNames,omitempty"` // no documentation yet IpsModePolicyNames []McAfee_Epolicy_Orchestrator_Version51_Policy_Object `json:"ipsModePolicyNames,omitempty" xmlrpc:"ipsModePolicyNames,omitempty"` // no documentation yet IpsProtectionPolicyNames []McAfee_Epolicy_Orchestrator_Version51_Policy_Object `json:"ipsProtectionPolicyNames,omitempty" xmlrpc:"ipsProtectionPolicyNames,omitempty"` // no documentation yet TransactionStatus *string `json:"transactionStatus,omitempty" xmlrpc:"transactionStatus,omitempty"` }
The SoftLayer_Software_Component_HostIps_Mcafee_Epo_Version51 data type represents a single McAfee Secure Host IPS software component that uses the ePO Server.
type Software_Component_OperatingSystem ¶
type Software_Component_OperatingSystem struct { Software_Component // The date in which the license for this software expires. LicenseExpirationDate *Time `json:"licenseExpirationDate,omitempty" xmlrpc:"licenseExpirationDate,omitempty"` // A count of an operating system's associated [[SoftLayer_Hardware_Component_Partition_Template|Partition Templates]] that can be used to configure a hardware drive. PartitionTemplateCount *uint `json:"partitionTemplateCount,omitempty" xmlrpc:"partitionTemplateCount,omitempty"` // An operating system's associated [[SoftLayer_Hardware_Component_Partition_Template|Partition Templates]] that can be used to configure a hardware drive. PartitionTemplates []Hardware_Component_Partition_Template `json:"partitionTemplates,omitempty" xmlrpc:"partitionTemplates,omitempty"` // An operating systems associated [[SoftLayer_Provisioning_Version1_Transaction_Group|Transaction Group]]. A transaction group is a list of operations that will occur during the installment of an operating system. ReloadTransactionGroup *Provisioning_Version1_Transaction_Group `json:"reloadTransactionGroup,omitempty" xmlrpc:"reloadTransactionGroup,omitempty"` }
SoftLayer_Software_Component_OperatingSystem extends the [[SoftLayer_Software_Component]] data type to include operating system specific properties.
type Software_Component_Package ¶
type Software_Component_Package struct {
Software_Component
}
This object specifies a specific type of Software Component: A package instance.
type Software_Component_Package_Management ¶
type Software_Component_Package_Management struct {
Software_Component_Package
}
This object specifies a specific type of Software Component: A package management instance.
type Software_Component_Package_Management_Ksplice ¶
type Software_Component_Package_Management_Ksplice struct {
Software_Component_Package_Management
}
This object specifies a specific type of Software Component: A Ksplice instance.
type Software_Component_Password ¶
type Software_Component_Password struct { Entity // The date this username/password pair was created. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // An id number for this specific username/password pair. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The date of the last modification to this username/password pair. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // A note string stored for this username/password pair. Notes *string `json:"notes,omitempty" xmlrpc:"notes,omitempty"` // The password part of the username/password pair. Password *string `json:"password,omitempty" xmlrpc:"password,omitempty"` // The application access port for the Software Component. Port *int `json:"port,omitempty" xmlrpc:"port,omitempty"` // The SoftLayer_Software_Component instance that this username/password pair is valid for. Software *Software_Component `json:"software,omitempty" xmlrpc:"software,omitempty"` // An id number for the software component this username/password pair is valid for. SoftwareId *int `json:"softwareId,omitempty" xmlrpc:"softwareId,omitempty"` // A count of sSH keys to be installed on the server during provisioning or an OS reload. SshKeyCount *uint `json:"sshKeyCount,omitempty" xmlrpc:"sshKeyCount,omitempty"` // SSH keys to be installed on the server during provisioning or an OS reload. SshKeys []Security_Ssh_Key `json:"sshKeys,omitempty" xmlrpc:"sshKeys,omitempty"` // The username part of the username/password pair. Username *string `json:"username,omitempty" xmlrpc:"username,omitempty"` }
This SoftLayer_Software_Component_Password data type contains a password for a specific software component instance.
type Software_Component_Password_History ¶
type Software_Component_Password_History struct { Entity // The date this username/password pair was created. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // A note string stored for this username/password pair. Notes *string `json:"notes,omitempty" xmlrpc:"notes,omitempty"` // The password part of this specific password history instance. Password *string `json:"password,omitempty" xmlrpc:"password,omitempty"` // An installed and licensed instance of a piece of software SoftwareComponent *Software_Component `json:"softwareComponent,omitempty" xmlrpc:"softwareComponent,omitempty"` // The id number for the Software Component this username/password pair is for. SoftwareComponentId *int `json:"softwareComponentId,omitempty" xmlrpc:"softwareComponentId,omitempty"` // The username part of this specific password history instance. Username *string `json:"username,omitempty" xmlrpc:"username,omitempty"` }
This object allows you to find the history of password changes for a specific SoftLayer_Software Component
type Software_Component_Security ¶
type Software_Component_Security struct {
Software_Component
}
This object specifies a specific type of Software Component: A security instance. Security installations have custom configurations for password requirements.
type Software_Component_Security_SafeNet ¶
type Software_Component_Security_SafeNet struct {
Software_Component_Security
}
This object specifies a specific Software Component: A SafeNet instance. SafeNet installations have custom configurations for password requirements.
type Software_Component_Trellix ¶ added in v1.0.6
type Software_Component_Trellix struct {
Software_Component
}
This object specifies a specific type of Software Component: An Trellix instance. Trellix installations have specific properties and methods such as SoftLayer_Software_Component_Trellix::updateTrellixPolicy. Defaults are initiated by this object.
type Software_Description ¶
type Software_Description struct { Entity // A count of AttributeCount *uint `json:"attributeCount,omitempty" xmlrpc:"attributeCount,omitempty"` // no documentation yet Attributes []Software_Description_Attribute `json:"attributes,omitempty" xmlrpc:"attributes,omitempty"` // The average amount of time that a software description takes to install. AverageInstallationDuration *int `json:"averageInstallationDuration,omitempty" xmlrpc:"averageInstallationDuration,omitempty"` // A count of a list of the software descriptions that are compatible with this software description. CompatibleSoftwareDescriptionCount *uint `json:"compatibleSoftwareDescriptionCount,omitempty" xmlrpc:"compatibleSoftwareDescriptionCount,omitempty"` // A list of the software descriptions that are compatible with this software description. CompatibleSoftwareDescriptions []Software_Description `json:"compatibleSoftwareDescriptions,omitempty" xmlrpc:"compatibleSoftwareDescriptions,omitempty"` // This is set to '1' if this Software Description describes a Control Panel. ControlPanel *int `json:"controlPanel,omitempty" xmlrpc:"controlPanel,omitempty"` // A count of the feature attributes of a software description. FeatureCount *uint `json:"featureCount,omitempty" xmlrpc:"featureCount,omitempty"` // The feature attributes of a software description. Features []Software_Description_Feature `json:"features,omitempty" xmlrpc:"features,omitempty"` // An ID number to identify this Software Description. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The latest version of a software description. LatestVersion []Software_Description `json:"latestVersion,omitempty" xmlrpc:"latestVersion,omitempty"` // A count of the latest version of a software description. LatestVersionCount *uint `json:"latestVersionCount,omitempty" xmlrpc:"latestVersionCount,omitempty"` // 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. LicenseTermUnit *string `json:"licenseTermUnit,omitempty" xmlrpc:"licenseTermUnit,omitempty"` // The number of units (licenseTermUnit) a new license is valid for at the time of registration. LicenseTermValue *int `json:"licenseTermValue,omitempty" xmlrpc:"licenseTermValue,omitempty"` // The manufacturer, name and version of a piece of software. LongDescription *string `json:"longDescription,omitempty" xmlrpc:"longDescription,omitempty"` // 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. Manufacturer *string `json:"manufacturer,omitempty" xmlrpc:"manufacturer,omitempty"` // 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. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // This is set to '1' if this Software Description describes an Operating System. OperatingSystem *int `json:"operatingSystem,omitempty" xmlrpc:"operatingSystem,omitempty"` // A count of the various product items to which this software description is linked. ProductItemCount *uint `json:"productItemCount,omitempty" xmlrpc:"productItemCount,omitempty"` // The various product items to which this software description is linked. ProductItems []Product_Item `json:"productItems,omitempty" xmlrpc:"productItems,omitempty"` // This details the provisioning transaction group for this software. This is only valid for Operating System software. ProvisionTransactionGroup *Provisioning_Version1_Transaction_Group `json:"provisionTransactionGroup,omitempty" xmlrpc:"provisionTransactionGroup,omitempty"` // 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. ReferenceCode *string `json:"referenceCode,omitempty" xmlrpc:"referenceCode,omitempty"` // 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. ReloadTransactionGroup *Provisioning_Version1_Transaction_Group `json:"reloadTransactionGroup,omitempty" xmlrpc:"reloadTransactionGroup,omitempty"` // The default user created for a given a software description. RequiredUser *string `json:"requiredUser,omitempty" xmlrpc:"requiredUser,omitempty"` // A count of software Licenses that govern this Software Description. SoftwareLicenseCount *uint `json:"softwareLicenseCount,omitempty" xmlrpc:"softwareLicenseCount,omitempty"` // Software Licenses that govern this Software Description. SoftwareLicenses []Software_License `json:"softwareLicenses,omitempty" xmlrpc:"softwareLicenses,omitempty"` // A suggestion for an upgrade path from this Software Description UpgradeSoftwareDescription *Software_Description `json:"upgradeSoftwareDescription,omitempty" xmlrpc:"upgradeSoftwareDescription,omitempty"` // Contains the ID of the suggested upgrade from this Software_Description to a more powerful software installation. UpgradeSoftwareDescriptionId *int `json:"upgradeSoftwareDescriptionId,omitempty" xmlrpc:"upgradeSoftwareDescriptionId,omitempty"` // A suggestion for an upgrade path from this Software Description (Deprecated - Use upgradeSoftwareDescription) UpgradeSwDesc *Software_Description `json:"upgradeSwDesc,omitempty" xmlrpc:"upgradeSwDesc,omitempty"` // Contains the ID of the suggested upgrade from this Software_Description to a more powerful software installation. (Deprecated - Use upgradeSoftwareDescriptionId) UpgradeSwDescId *int `json:"upgradeSwDescId,omitempty" xmlrpc:"upgradeSwDescId,omitempty"` // A count of ValidFilesystemTypeCount *uint `json:"validFilesystemTypeCount,omitempty" xmlrpc:"validFilesystemTypeCount,omitempty"` // no documentation yet ValidFilesystemTypes []Configuration_Storage_Filesystem_Type `json:"validFilesystemTypes,omitempty" xmlrpc:"validFilesystemTypes,omitempty"` // The version of this specific piece of software. Version *string `json:"version,omitempty" xmlrpc:"version,omitempty"` // This is set to '1' if this Software Description can be licensed to a Virtual Machine (an IP address). VirtualLicense *int `json:"virtualLicense,omitempty" xmlrpc:"virtualLicense,omitempty"` // This is set to '1' if this Software Description a platform for hosting virtual servers. VirtualizationPlatform *int `json:"virtualizationPlatform,omitempty" xmlrpc:"virtualizationPlatform,omitempty"` }
This class holds a description for a specific installation of a Software Component.
SoftLayer_Software_Licenses tie a Software Component (A specific installation on a piece of hardware) to it's description.
The "Manufacturer" and "Name" properties of a SoftLayer_Software_Description are used by the framework to factory specific objects, objects that may have special methods for that specific piece of software, or objects that contain application specific data, such as default ports. For example, if you create a SoftLayer_Software_Component who's SoftLayer_Software_License points to the SoftLayer_Software_Description for "Swsoft" "Plesk", you'll actually get a SoftLayer_Software_Component_Swsoft_Plesk object.
type Software_Description_Attribute ¶
type Software_Description_Attribute struct { Entity // no documentation yet SoftwareDescription *Software_Description `json:"softwareDescription,omitempty" xmlrpc:"softwareDescription,omitempty"` // no documentation yet Type *Software_Description_Attribute_Type `json:"type,omitempty" xmlrpc:"type,omitempty"` // The value that was assigned to this attribute. Value *string `json:"value,omitempty" xmlrpc:"value,omitempty"` }
The SoftLayer_Software_Description_Attribute data type represents an attributes associated with this software description.
type Software_Description_Attribute_Type ¶
type Software_Description_Attribute_Type struct { Entity // The keyname for this attribute type. Keyname *string `json:"keyname,omitempty" xmlrpc:"keyname,omitempty"` }
The SoftLayer_Software_Description_Attribute_Type data type represents the type of an attribute.
type Software_Description_Feature ¶
type Software_Description_Feature struct { Entity // The unique identifier for a software description feature. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A unique name used to reference this software description feature. KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // The name of a software description feature. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // The vendor that a software description feature belongs to. Vendor *string `json:"vendor,omitempty" xmlrpc:"vendor,omitempty"` }
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.
type Software_Description_RequiredUser ¶
type Software_Description_RequiredUser struct { Entity // If the default password is set the user will be created with that password, otherwise a random password is generated. DefaultPassword *string `json:"defaultPassword,omitempty" xmlrpc:"defaultPassword,omitempty"` // If this software has a required user (such as "root") this string contains it's name. Username *string `json:"username,omitempty" xmlrpc:"username,omitempty"` }
This class represents a software description's required user
type Software_License ¶
type Software_License struct { Entity // The account that owns this specific License instance. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // An ID number for this specific License type. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The account that owns this specific License instance. Owner *Account `json:"owner,omitempty" xmlrpc:"owner,omitempty"` // A Description of the software that this license instance is valid for. SoftwareDescription *Software_Description `json:"softwareDescription,omitempty" xmlrpc:"softwareDescription,omitempty"` // The ID number of a Software Description that this specific license is valid for. SoftwareDescriptionId *int `json:"softwareDescriptionId,omitempty" xmlrpc:"softwareDescriptionId,omitempty"` }
This class describes a specific type of license, like a Microsoft Windows Site License, a GPL license, or a license of another type.
type Software_VirtualLicense ¶
type Software_VirtualLicense struct { Entity // The customer account this Virtual License belongs to. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // The ID of the SoftLayer Account to which this Virtual License belongs to. AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // The billing item for a software virtual license. BillingItem *Billing_Item `json:"billingItem,omitempty" xmlrpc:"billingItem,omitempty"` // The hardware record to which the software virtual license is assigned. HostHardware *Hardware_Server `json:"hostHardware,omitempty" xmlrpc:"hostHardware,omitempty"` // The ID of the SoftLayer Hardware Server record to which this Virtual License belongs. HostHardwareId *int `json:"hostHardwareId,omitempty" xmlrpc:"hostHardwareId,omitempty"` // An ID number for this Virtual License instance. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The specific IP address this Virtual License belongs to. IpAddress *string `json:"ipAddress,omitempty" xmlrpc:"ipAddress,omitempty"` // The IP Address record associated with a virtual license. IpAddressRecord *Network_Subnet_IpAddress `json:"ipAddressRecord,omitempty" xmlrpc:"ipAddressRecord,omitempty"` // The License Key for this specific Virtual License. Key *string `json:"key,omitempty" xmlrpc:"key,omitempty"` // A "notes" string attached to this specific Virtual License. Notes *string `json:"notes,omitempty" xmlrpc:"notes,omitempty"` // The SoftLayer_Software_Description that this virtual license is for. SoftwareDescription *Software_Description `json:"softwareDescription,omitempty" xmlrpc:"softwareDescription,omitempty"` // The Software Description ID this Virtual License is for. SoftwareDescriptionId *int `json:"softwareDescriptionId,omitempty" xmlrpc:"softwareDescriptionId,omitempty"` // The subnet this Virtual License's IP address belongs to. Subnet *Network_Subnet `json:"subnet,omitempty" xmlrpc:"subnet,omitempty"` // The ID of the SoftLayer Network Subnet this Virtual License belongs to. SubnetId *int `json:"subnetId,omitempty" xmlrpc:"subnetId,omitempty"` }
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".
type Sprint_Container_CostRecovery ¶ added in v1.1.3
type Sprint_Container_CostRecovery struct { Entity // no documentation yet AccountId *string `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // no documentation yet AccountType *string `json:"accountType,omitempty" xmlrpc:"accountType,omitempty"` // no documentation yet Country *string `json:"country,omitempty" xmlrpc:"country,omitempty"` // no documentation yet DateClosed *string `json:"dateClosed,omitempty" xmlrpc:"dateClosed,omitempty"` // no documentation yet Department *string `json:"department,omitempty" xmlrpc:"department,omitempty"` // no documentation yet Division *string `json:"division,omitempty" xmlrpc:"division,omitempty"` // no documentation yet Status *string `json:"status,omitempty" xmlrpc:"status,omitempty"` }
no documentation yet
type Survey ¶
type Survey struct { Entity // A flag indicating if a survey can be taken. Active *int `json:"active,omitempty" xmlrpc:"active,omitempty"` // The date that a survey had originally started. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // A survey's id. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A survey's name or title. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // A count of the questions for a survey. QuestionCount *uint `json:"questionCount,omitempty" xmlrpc:"questionCount,omitempty"` // The questions for a survey. Questions []Survey_Question `json:"questions,omitempty" xmlrpc:"questions,omitempty"` // The status of the survey Status *Survey_Status `json:"status,omitempty" xmlrpc:"status,omitempty"` // The status id of the survey. StatusId *int `json:"statusId,omitempty" xmlrpc:"statusId,omitempty"` // The type of survey Type *Survey_Type `json:"type,omitempty" xmlrpc:"type,omitempty"` // The type id of the survey. TypeId *int `json:"typeId,omitempty" xmlrpc:"typeId,omitempty"` }
The SoftLayer_Survey data type contains general information relating to a single SoftLayer survey.
type Survey_Answer ¶
type Survey_Answer struct { Entity // A survey answer's answer that a user can response too. Answer *string `json:"answer,omitempty" xmlrpc:"answer,omitempty"` // A value indicating the order in when a survey answer will be displayed to a user. AnswerOrder *int `json:"answerOrder,omitempty" xmlrpc:"answerOrder,omitempty"` // A survey answer's Id. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The survey question that this answer belongs to. SurveyQuestion *Survey_Question `json:"surveyQuestion,omitempty" xmlrpc:"surveyQuestion,omitempty"` // A survey answer's associated [[SoftLayer_Survey_Question|Survey Question]] Id. SurveyQuestionId *int `json:"surveyQuestionId,omitempty" xmlrpc:"surveyQuestionId,omitempty"` }
The SoftLayer_Survey_Answer data type contains general information relating to a single SoftLayer survey answer.
type Survey_Question ¶
type Survey_Question struct { Entity // A count of the possible answers for a survey question. AnswerCount *uint `json:"answerCount,omitempty" xmlrpc:"answerCount,omitempty"` // The possible answers for a survey question. Answers []Survey_Answer `json:"answers,omitempty" xmlrpc:"answers,omitempty"` // A survey question's Id. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A flag indicating that a survey question requires a response. IsRequired *int `json:"isRequired,omitempty" xmlrpc:"isRequired,omitempty"` // A flag indicating that a survey question can have multiple answers responded to. MultiAnswer *int `json:"multiAnswer,omitempty" xmlrpc:"multiAnswer,omitempty"` // A survey question's question. Question *string `json:"question,omitempty" xmlrpc:"question,omitempty"` // A value indicating the order in when a survey question will be asked. QuestionOrder *int `json:"questionOrder,omitempty" xmlrpc:"questionOrder,omitempty"` // The survey that a question belongs to. Survey *Survey `json:"survey,omitempty" xmlrpc:"survey,omitempty"` // A survey question's associated [[SoftLayer_Survey|Survey]] Id. SurveyId *int `json:"surveyId,omitempty" xmlrpc:"surveyId,omitempty"` }
The SoftLayer_Survey_Question data type contains general information relating to a single SoftLayer survey question.
type Survey_Response ¶
type Survey_Response struct { Entity // The user typed response for the [[SoftLayer_Survey_Answer|Survey Answer]] that a response is associated with. OtherAnswer *string `json:"otherAnswer,omitempty" xmlrpc:"otherAnswer,omitempty"` // The survey answer that this response was to. SurveyAnswer *Survey_Answer `json:"surveyAnswer,omitempty" xmlrpc:"surveyAnswer,omitempty"` // The Id of the [[SoftLayer_Survey_Answer|Survey Answer]] that a response was made for. SurveyAnswerId *int `json:"surveyAnswerId,omitempty" xmlrpc:"surveyAnswerId,omitempty"` }
The SoftLayer_Survey_Response data type contains general information relating to a single SoftLayer survey response.
type Survey_Status ¶
type Survey_Status struct { Entity // Description of a survey status Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // Internal identifier of a survey status Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Name of a survey status Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
The SoftLayer_Survey_Status data type contains survey status information.
type Survey_Type ¶
type Survey_Type struct { Entity // Description of a survey type Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // Internal identifier of a survey type Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Name of a survey type Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
The SoftLayer_Survey_Type data type contains survey type information.
type Tag ¶
type Tag struct { Entity // The account to which the tag is tied. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // Account the tag belongs to. AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // Unique identifier for a tag. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Indicates whether a tag is internal. Internal *int `json:"internal,omitempty" xmlrpc:"internal,omitempty"` // Name of the tag. The characters permitted are A-Z, 0-9, whitespace, Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // A count of references that tie object to the tag. ReferenceCount *uint `json:"referenceCount,omitempty" xmlrpc:"referenceCount,omitempty"` // References that tie object to the tag. References []Tag_Reference `json:"references,omitempty" xmlrpc:"references,omitempty"` }
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.
type Tag_Reference ¶
type Tag_Reference struct { Entity // no documentation yet Customer *User_Customer `json:"customer,omitempty" xmlrpc:"customer,omitempty"` // no documentation yet EmpRecordId *int `json:"empRecordId,omitempty" xmlrpc:"empRecordId,omitempty"` // no documentation yet Employee *User_Employee `json:"employee,omitempty" xmlrpc:"employee,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet ResourceTableId *int `json:"resourceTableId,omitempty" xmlrpc:"resourceTableId,omitempty"` // no documentation yet Tag *Tag `json:"tag,omitempty" xmlrpc:"tag,omitempty"` // no documentation yet TagId *int `json:"tagId,omitempty" xmlrpc:"tagId,omitempty"` // no documentation yet TagType *Tag_Type `json:"tagType,omitempty" xmlrpc:"tagType,omitempty"` // no documentation yet TagTypeId *int `json:"tagTypeId,omitempty" xmlrpc:"tagTypeId,omitempty"` // no documentation yet UsrRecordId *int `json:"usrRecordId,omitempty" xmlrpc:"usrRecordId,omitempty"` }
no documentation yet
type Tag_Reference_Hardware ¶
type Tag_Reference_Hardware struct { Tag_Reference // no documentation yet Resource *Hardware `json:"resource,omitempty" xmlrpc:"resource,omitempty"` }
no documentation yet
type Tag_Reference_Network_Application_Delivery_Controller ¶
type Tag_Reference_Network_Application_Delivery_Controller struct { Tag_Reference // no documentation yet Resource *Network_Application_Delivery_Controller `json:"resource,omitempty" xmlrpc:"resource,omitempty"` }
no documentation yet
type Tag_Reference_Network_Vlan ¶
type Tag_Reference_Network_Vlan struct { Tag_Reference // no documentation yet Resource *Network_Vlan `json:"resource,omitempty" xmlrpc:"resource,omitempty"` }
no documentation yet
type Tag_Reference_Network_Vlan_Firewall ¶
type Tag_Reference_Network_Vlan_Firewall struct { Tag_Reference // no documentation yet Resource *Network_Vlan_Firewall `json:"resource,omitempty" xmlrpc:"resource,omitempty"` }
no documentation yet
type Tag_Reference_Resource_Group ¶
type Tag_Reference_Resource_Group struct { Tag_Reference // no documentation yet Resource *Resource_Group `json:"resource,omitempty" xmlrpc:"resource,omitempty"` }
no documentation yet
type Tag_Reference_Virtual_DedicatedHost ¶
type Tag_Reference_Virtual_DedicatedHost struct { Tag_Reference // no documentation yet Resource *Virtual_DedicatedHost `json:"resource,omitempty" xmlrpc:"resource,omitempty"` }
no documentation yet
type Tag_Reference_Virtual_Guest ¶
type Tag_Reference_Virtual_Guest struct { Tag_Reference // no documentation yet Resource *Virtual_Guest `json:"resource,omitempty" xmlrpc:"resource,omitempty"` }
no documentation yet
type Tag_Reference_Virtual_Guest_Block_Device_Template_Group ¶
type Tag_Reference_Virtual_Guest_Block_Device_Template_Group struct { Tag_Reference // no documentation yet Resource *Virtual_Guest_Block_Device_Template_Group `json:"resource,omitempty" xmlrpc:"resource,omitempty"` }
no documentation yet
type Tag_Type ¶
type Tag_Type struct { Entity // no documentation yet Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // no documentation yet KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` }
no documentation yet
type Ticket ¶
type Ticket struct { Entity // The SoftLayer customer account associated with a ticket. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // An internal identifier of the SoftLayer customer account that a ticket is associated with. AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // A count of AssignedAgentCount *uint `json:"assignedAgentCount,omitempty" xmlrpc:"assignedAgentCount,omitempty"` // no documentation yet AssignedAgents []User_Customer `json:"assignedAgents,omitempty" xmlrpc:"assignedAgents,omitempty"` // The portal user that a ticket is assigned to. AssignedUser *User_Customer `json:"assignedUser,omitempty" xmlrpc:"assignedUser,omitempty"` // An internal identifier of the portal user that a ticket is assigned to. AssignedUserId *int `json:"assignedUserId,omitempty" xmlrpc:"assignedUserId,omitempty"` // A count of the list of additional emails to notify when a ticket update is made. AttachedAdditionalEmailCount *uint `json:"attachedAdditionalEmailCount,omitempty" xmlrpc:"attachedAdditionalEmailCount,omitempty"` // The list of additional emails to notify when a ticket update is made. AttachedAdditionalEmails []User_Customer_AdditionalEmail `json:"attachedAdditionalEmails,omitempty" xmlrpc:"attachedAdditionalEmails,omitempty"` // 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. AttachedDedicatedHostCount *uint `json:"attachedDedicatedHostCount,omitempty" xmlrpc:"attachedDedicatedHostCount,omitempty"` // The Dedicated Hosts associated with a ticket. This is used in cases where a ticket is directly associated with one or more Dedicated Hosts. AttachedDedicatedHosts []Virtual_DedicatedHost `json:"attachedDedicatedHosts,omitempty" xmlrpc:"attachedDedicatedHosts,omitempty"` // A count of the files attached to a ticket. AttachedFileCount *uint `json:"attachedFileCount,omitempty" xmlrpc:"attachedFileCount,omitempty"` // The files attached to a ticket. AttachedFiles []Ticket_Attachment_File `json:"attachedFiles,omitempty" xmlrpc:"attachedFiles,omitempty"` // The hardware associated with a ticket. This is used in cases where a ticket is directly associated with one or more pieces of hardware. AttachedHardware []Hardware `json:"attachedHardware,omitempty" xmlrpc:"attachedHardware,omitempty"` // no documentation yet AttachedHardwareCount *uint `json:"attachedHardwareCount,omitempty" xmlrpc:"attachedHardwareCount,omitempty"` // A count of AttachedResourceCount *uint `json:"attachedResourceCount,omitempty" xmlrpc:"attachedResourceCount,omitempty"` // no documentation yet AttachedResources []Ticket_Attachment `json:"attachedResources,omitempty" xmlrpc:"attachedResources,omitempty"` // 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. AttachedVirtualGuestCount *uint `json:"attachedVirtualGuestCount,omitempty" xmlrpc:"attachedVirtualGuestCount,omitempty"` // 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. AttachedVirtualGuests []Virtual_Guest `json:"attachedVirtualGuests,omitempty" xmlrpc:"attachedVirtualGuests,omitempty"` // Ticket is waiting on a response from a customer flag. AwaitingUserResponseFlag *bool `json:"awaitingUserResponseFlag,omitempty" xmlrpc:"awaitingUserResponseFlag,omitempty"` // Whether a ticket has a one-time charge associated with it. Standard tickets are free while administrative tickets typically cost $3 USD. BillableFlag *bool `json:"billableFlag,omitempty" xmlrpc:"billableFlag,omitempty"` // A ticket's associated BNPP compliant record BnppSupportedFlag *bool `json:"bnppSupportedFlag,omitempty" xmlrpc:"bnppSupportedFlag,omitempty"` // no documentation yet BnppSupportedLocationId *int `json:"bnppSupportedLocationId,omitempty" xmlrpc:"bnppSupportedLocationId,omitempty"` // A service cancellation request. CancellationRequest *Billing_Item_Cancellation_Request `json:"cancellationRequest,omitempty" xmlrpc:"cancellationRequest,omitempty"` // no documentation yet ChangeOwnerFlag *bool `json:"changeOwnerFlag,omitempty" xmlrpc:"changeOwnerFlag,omitempty"` // The date that a ticket was created. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // A count of EmployeeAttachmentCount *uint `json:"employeeAttachmentCount,omitempty" xmlrpc:"employeeAttachmentCount,omitempty"` // no documentation yet EmployeeAttachments []User_Employee `json:"employeeAttachments,omitempty" xmlrpc:"employeeAttachments,omitempty"` // A ticket's associated EU compliant record EuSupportedFlag *bool `json:"euSupportedFlag,omitempty" xmlrpc:"euSupportedFlag,omitempty"` // no documentation yet EuSupportedLocationId *int `json:"euSupportedLocationId,omitempty" xmlrpc:"euSupportedLocationId,omitempty"` // Feedback left by a portal or API user on their experiences in a ticket. Final comments may be created after a ticket is closed. FinalComments *string `json:"finalComments,omitempty" xmlrpc:"finalComments,omitempty"` // The first physical or virtual server attached to a ticket. FirstAttachedResource *Ticket_Attachment `json:"firstAttachedResource,omitempty" xmlrpc:"firstAttachedResource,omitempty"` // The first update made to a ticket. This is typically the contents of a ticket when it's created. FirstUpdate *Ticket_Update `json:"firstUpdate,omitempty" xmlrpc:"firstUpdate,omitempty"` // A ticket's associated FSBOA compliant record FsboaSupportedFlag *bool `json:"fsboaSupportedFlag,omitempty" xmlrpc:"fsboaSupportedFlag,omitempty"` // The SoftLayer department that a ticket is assigned to. Group *Ticket_Group `json:"group,omitempty" xmlrpc:"group,omitempty"` // The internal identifier of the SoftLayer department that a ticket is assigned to. GroupId *int `json:"groupId,omitempty" xmlrpc:"groupId,omitempty"` // A ticket's internal identifier. Each ticket is defined by a unique identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // 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. InvoiceItemCount *uint `json:"invoiceItemCount,omitempty" xmlrpc:"invoiceItemCount,omitempty"` // The invoice items associated with a ticket. Ticket based invoice items only exist when a ticket incurs a fee that has been invoiced. InvoiceItems []Billing_Invoice_Item `json:"invoiceItems,omitempty" xmlrpc:"invoiceItems,omitempty"` // no documentation yet LastActivity *Ticket_Activity `json:"lastActivity,omitempty" xmlrpc:"lastActivity,omitempty"` // The date that a ticket was last modified. A modification does not necessarily mean that an update was added. LastEditDate *Time `json:"lastEditDate,omitempty" xmlrpc:"lastEditDate,omitempty"` // The type of user who last edited or updated a ticket. This is either "EMPLOYEE" or "USER". LastEditType *string `json:"lastEditType,omitempty" xmlrpc:"lastEditType,omitempty"` // no documentation yet LastEditor *User_Interface `json:"lastEditor,omitempty" xmlrpc:"lastEditor,omitempty"` // The date that the last ticket update was made LastResponseDate *Time `json:"lastResponseDate,omitempty" xmlrpc:"lastResponseDate,omitempty"` // The last update made to a ticket. LastUpdate *Ticket_Update `json:"lastUpdate,omitempty" xmlrpc:"lastUpdate,omitempty"` // A ticket's associated location within the SoftLayer location hierarchy. Location *Location `json:"location,omitempty" xmlrpc:"location,omitempty"` // The internal identifier of the location associated with a ticket. LocationId *int `json:"locationId,omitempty" xmlrpc:"locationId,omitempty"` // The date that a ticket was last updated. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // True if there are new, unread updates to this ticket for the current user, False otherwise. NewUpdatesFlag *bool `json:"newUpdatesFlag,omitempty" xmlrpc:"newUpdatesFlag,omitempty"` // Whether or not the user who owns a ticket is notified via email when a ticket is updated. NotifyUserOnUpdateFlag *bool `json:"notifyUserOnUpdateFlag,omitempty" xmlrpc:"notifyUserOnUpdateFlag,omitempty"` // The IP address of the user who opened a ticket. OriginatingIpAddress *string `json:"originatingIpAddress,omitempty" xmlrpc:"originatingIpAddress,omitempty"` // no documentation yet Priority *int `json:"priority,omitempty" xmlrpc:"priority,omitempty"` // no documentation yet ResponsibleBrandId *int `json:"responsibleBrandId,omitempty" xmlrpc:"responsibleBrandId,omitempty"` // A count of ScheduledActionCount *uint `json:"scheduledActionCount,omitempty" xmlrpc:"scheduledActionCount,omitempty"` // no documentation yet ScheduledActions []Provisioning_Version1_Transaction `json:"scheduledActions,omitempty" xmlrpc:"scheduledActions,omitempty"` // 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. ServerAdministrationBillingAmount *int `json:"serverAdministrationBillingAmount,omitempty" xmlrpc:"serverAdministrationBillingAmount,omitempty"` // The invoice associated with a ticket. Only tickets with an associated administrative charge have an invoice. ServerAdministrationBillingInvoice *Billing_Invoice `json:"serverAdministrationBillingInvoice,omitempty" xmlrpc:"serverAdministrationBillingInvoice,omitempty"` // The internal identifier of the invoice associated with a ticket's administrative charge. Only tickets with an administrative charge have an associated invoice. ServerAdministrationBillingInvoiceId *int `json:"serverAdministrationBillingInvoiceId,omitempty" xmlrpc:"serverAdministrationBillingInvoiceId,omitempty"` // Whether a ticket is a standard or an administrative support ticket. Administrative support tickets typically incur a $3 USD charge. ServerAdministrationFlag *int `json:"serverAdministrationFlag,omitempty" xmlrpc:"serverAdministrationFlag,omitempty"` // The refund invoice associated with a ticket. Only tickets with a refund applied in them have an associated refund invoice. ServerAdministrationRefundInvoice *Billing_Invoice `json:"serverAdministrationRefundInvoice,omitempty" xmlrpc:"serverAdministrationRefundInvoice,omitempty"` // 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. ServerAdministrationRefundInvoiceId *int `json:"serverAdministrationRefundInvoiceId,omitempty" xmlrpc:"serverAdministrationRefundInvoiceId,omitempty"` // no documentation yet ServiceProvider *Service_Provider `json:"serviceProvider,omitempty" xmlrpc:"serviceProvider,omitempty"` // no documentation yet ServiceProviderId *int `json:"serviceProviderId,omitempty" xmlrpc:"serviceProviderId,omitempty"` // A ticket's internal identifier at its service provider. Each ticket is defined by a unique identifier. ServiceProviderResourceId *string `json:"serviceProviderResourceId,omitempty" xmlrpc:"serviceProviderResourceId,omitempty"` // no documentation yet State []Ticket_State `json:"state,omitempty" xmlrpc:"state,omitempty"` // A count of StateCount *uint `json:"stateCount,omitempty" xmlrpc:"stateCount,omitempty"` // A ticket's status. Status *Ticket_Status `json:"status,omitempty" xmlrpc:"status,omitempty"` // A ticket status' internal identifier. StatusId *int `json:"statusId,omitempty" xmlrpc:"statusId,omitempty"` // 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. Subject *Ticket_Subject `json:"subject,omitempty" xmlrpc:"subject,omitempty"` // 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. SubjectId *int `json:"subjectId,omitempty" xmlrpc:"subjectId,omitempty"` // A count of TagReferenceCount *uint `json:"tagReferenceCount,omitempty" xmlrpc:"tagReferenceCount,omitempty"` // no documentation yet TagReferences []Tag_Reference `json:"tagReferences,omitempty" xmlrpc:"tagReferences,omitempty"` // A ticket's title. This is typically a brief summary of the issue described in the ticket. Title *string `json:"title,omitempty" xmlrpc:"title,omitempty"` // no documentation yet TotalUpdateCount *int `json:"totalUpdateCount,omitempty" xmlrpc:"totalUpdateCount,omitempty"` // A count of a ticket's updates. UpdateCount *uint `json:"updateCount,omitempty" xmlrpc:"updateCount,omitempty"` // Whether employees' updates of this ticket could be rated by customer UpdateRatingFlag *bool `json:"updateRatingFlag,omitempty" xmlrpc:"updateRatingFlag,omitempty"` // A ticket's updates. Updates []Ticket_Update `json:"updates,omitempty" xmlrpc:"updates,omitempty"` // Whether a user is able to update a ticket. UserEditableFlag *bool `json:"userEditableFlag,omitempty" xmlrpc:"userEditableFlag,omitempty"` }
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|createStandardTicket]] or [[SoftLayer_Ticket::createAdministrativeTicket|createAdministrativeTicket]] methods in the SoftLayer_Ticket service. To create an upgrade ticket for the SoftLayer sales group execute the [[SoftLayer_Ticket::createUpgradeTicket|createUpgradeTicket]].
type Ticket_Activity ¶
type Ticket_Activity struct { Entity // no documentation yet CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // no documentation yet CreateTimestamp *Time `json:"createTimestamp,omitempty" xmlrpc:"createTimestamp,omitempty"` // no documentation yet Editor *User_Interface `json:"editor,omitempty" xmlrpc:"editor,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet Ticket *Ticket `json:"ticket,omitempty" xmlrpc:"ticket,omitempty"` // no documentation yet TicketUpdate *Ticket_Update `json:"ticketUpdate,omitempty" xmlrpc:"ticketUpdate,omitempty"` // no documentation yet Value *string `json:"value,omitempty" xmlrpc:"value,omitempty"` }
no documentation yet
type Ticket_Attachment ¶
type Ticket_Attachment struct { Entity // The internal identifier of an item that is attached to a ticket. AttachmentId *int `json:"attachmentId,omitempty" xmlrpc:"attachmentId,omitempty"` // The date that an item was attached to a ticket. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // A ticket attachment's internal identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The ticket that an item is attached to. Ticket *Ticket `json:"ticket,omitempty" xmlrpc:"ticket,omitempty"` // The internal identifier of the ticket that an item is attached to. TicketId *int `json:"ticketId,omitempty" xmlrpc:"ticketId,omitempty"` }
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.
type Ticket_Attachment_Assigned_Agent ¶
type Ticket_Attachment_Assigned_Agent struct { Ticket_Attachment // no documentation yet AssignedAgent *User_Customer `json:"assignedAgent,omitempty" xmlrpc:"assignedAgent,omitempty"` // The internal identifier of an assigned Agent that is attached to a ticket. AssignedAgentId *int `json:"assignedAgentId,omitempty" xmlrpc:"assignedAgentId,omitempty"` // no documentation yet Resource *User_Customer `json:"resource,omitempty" xmlrpc:"resource,omitempty"` }
no documentation yet
type Ticket_Attachment_CardChangeRequest ¶
type Ticket_Attachment_CardChangeRequest struct { Ticket_Attachment // The card change request that is attached to a ticket. Resource *Billing_Payment_Card_ChangeRequest `json:"resource,omitempty" xmlrpc:"resource,omitempty"` }
This datatype contains tickets referenced from card change request
type Ticket_Attachment_Dedicated_Host ¶
type Ticket_Attachment_Dedicated_Host struct { Ticket_Attachment // The dedicated dost that is attached to a ticket. DedicatedHost *Virtual_DedicatedHost `json:"dedicatedHost,omitempty" xmlrpc:"dedicatedHost,omitempty"` // The internal identifier of the Dedicated Host that is attached to a ticket. DedicatedHostId *int `json:"dedicatedHostId,omitempty" xmlrpc:"dedicatedHostId,omitempty"` // The Dedicated Host that is attached to a ticket. Resource *Virtual_DedicatedHost `json:"resource,omitempty" xmlrpc:"resource,omitempty"` }
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.
type Ticket_Attachment_File ¶
type Ticket_Attachment_File struct { Entity // The date a file was originally attached to a ticket. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // The name of a file attached to a ticket. FileName *string `json:"fileName,omitempty" xmlrpc:"fileName,omitempty"` // The size of a file attached to a ticket, measured in bytes. FileSize *string `json:"fileSize,omitempty" xmlrpc:"fileSize,omitempty"` // A ticket file attachment's internal identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The date that a file attachment record was last modified. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // no documentation yet Ticket *Ticket `json:"ticket,omitempty" xmlrpc:"ticket,omitempty"` // The internal identifier of the ticket that a file is attached to. TicketId *int `json:"ticketId,omitempty" xmlrpc:"ticketId,omitempty"` // The ticket that a file is attached to. Update *Ticket_Update `json:"update,omitempty" xmlrpc:"update,omitempty"` // The internal identifier of the ticket update the attached file is associated with. UpdateId *int `json:"updateId,omitempty" xmlrpc:"updateId,omitempty"` // 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". UploaderId *string `json:"uploaderId,omitempty" xmlrpc:"uploaderId,omitempty"` // 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. UploaderType *string `json:"uploaderType,omitempty" xmlrpc:"uploaderType,omitempty"` }
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.
type Ticket_Attachment_File_ServiceNow ¶
type Ticket_Attachment_File_ServiceNow struct {
Ticket_Attachment_File
}
no documentation yet
type Ticket_Attachment_Hardware ¶
type Ticket_Attachment_Hardware struct { Ticket_Attachment // The hardware that is attached to a ticket. Hardware *Hardware `json:"hardware,omitempty" xmlrpc:"hardware,omitempty"` // The internal identifier of a piece of hardware that is attached to a ticket. HardwareId *int `json:"hardwareId,omitempty" xmlrpc:"hardwareId,omitempty"` // The hardware that is attached to a ticket. Resource *Hardware `json:"resource,omitempty" xmlrpc:"resource,omitempty"` }
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.
type Ticket_Attachment_Manual_Payment ¶
type Ticket_Attachment_Manual_Payment struct { Ticket_Attachment // The manual payment that is attached to a ticket. Resource *Billing_Payment_Card_ManualPayment `json:"resource,omitempty" xmlrpc:"resource,omitempty"` }
This datatype contains tickets referenced from manual payments
type Ticket_Attachment_Network_Storage_Mass_Data_Migration ¶
type Ticket_Attachment_Network_Storage_Mass_Data_Migration struct { Ticket_Attachment // The Mass Data Migration request that is attached to a ticket. Request *Network_Storage_MassDataMigration_Request `json:"request,omitempty" xmlrpc:"request,omitempty"` // no documentation yet RequestId *int `json:"requestId,omitempty" xmlrpc:"requestId,omitempty"` // The Mass Data Migration request that is attached to a ticket. Resource *Network_Storage_MassDataMigration_Request `json:"resource,omitempty" xmlrpc:"resource,omitempty"` }
no documentation yet
type Ticket_Attachment_Scheduled_Action ¶
type Ticket_Attachment_Scheduled_Action struct { Ticket_Attachment // no documentation yet Resource *Provisioning_Version1_Transaction `json:"resource,omitempty" xmlrpc:"resource,omitempty"` // The internal identifier of a scheduled action transaction that is attached to a ticket. RunDate *Time `json:"runDate,omitempty" xmlrpc:"runDate,omitempty"` // no documentation yet ScheduledAction *Provisioning_Version1_Transaction `json:"scheduledAction,omitempty" xmlrpc:"scheduledAction,omitempty"` // no documentation yet Transaction *Provisioning_Version1_Transaction `json:"transaction,omitempty" xmlrpc:"transaction,omitempty"` // The internal identifier of a scheduled action transaction that is attached to a ticket. TransactionId *int `json:"transactionId,omitempty" xmlrpc:"transactionId,omitempty"` }
no documentation yet
type Ticket_Attachment_Virtual_Guest ¶
type Ticket_Attachment_Virtual_Guest struct { Ticket_Attachment // The virtualized guest or CloudLayer Computing Instance that is attached to a ticket. Resource *Virtual_Guest `json:"resource,omitempty" xmlrpc:"resource,omitempty"` // The virtualized guest or CloudLayer Computing Instance that is attached to a ticket. VirtualGuest *Virtual_Guest `json:"virtualGuest,omitempty" xmlrpc:"virtualGuest,omitempty"` // The internal identifier of the virtualized guest or CloudLayer Computing Instance that is attached to a ticket. VirtualGuestId *int `json:"virtualGuestId,omitempty" xmlrpc:"virtualGuestId,omitempty"` }
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.
type Ticket_Chat ¶
type Ticket_Chat struct { Entity // no documentation yet Agent *User_Employee `json:"agent,omitempty" xmlrpc:"agent,omitempty"` // no documentation yet Customer *User_Customer `json:"customer,omitempty" xmlrpc:"customer,omitempty"` // no documentation yet CustomerId *int `json:"customerId,omitempty" xmlrpc:"customerId,omitempty"` // no documentation yet EndDate *Time `json:"endDate,omitempty" xmlrpc:"endDate,omitempty"` // no documentation yet StartDate *Time `json:"startDate,omitempty" xmlrpc:"startDate,omitempty"` // no documentation yet TicketUpdate *Ticket_Update_Chat `json:"ticketUpdate,omitempty" xmlrpc:"ticketUpdate,omitempty"` // no documentation yet Transcript *string `json:"transcript,omitempty" xmlrpc:"transcript,omitempty"` }
no documentation yet
type Ticket_Chat_Liveperson ¶
type Ticket_Chat_Liveperson struct {
Ticket_Chat
}
no documentation yet
type Ticket_Chat_TranscriptLine ¶
type Ticket_Chat_TranscriptLine struct { Entity // no documentation yet Speaker *User_Interface `json:"speaker,omitempty" xmlrpc:"speaker,omitempty"` }
no documentation yet
type Ticket_Chat_TranscriptLine_Customer ¶
type Ticket_Chat_TranscriptLine_Customer struct {
Ticket_Chat_TranscriptLine
}
no documentation yet
type Ticket_Chat_TranscriptLine_Employee ¶
type Ticket_Chat_TranscriptLine_Employee struct {
Ticket_Chat_TranscriptLine
}
no documentation yet
type Ticket_EuCompliance ¶
type Ticket_EuCompliance struct { Entity // no documentation yet Datacenter *Location `json:"datacenter,omitempty" xmlrpc:"datacenter,omitempty"` // no documentation yet SecurityLevel *Security_Level `json:"securityLevel,omitempty" xmlrpc:"securityLevel,omitempty"` // no documentation yet Ticket *Ticket `json:"ticket,omitempty" xmlrpc:"ticket,omitempty"` }
no documentation yet
type Ticket_Group ¶
type Ticket_Group struct { Entity // The category that a ticket group belongs to. Category *Ticket_Group_Category `json:"category,omitempty" xmlrpc:"category,omitempty"` // A ticket group's internal identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A ticket group's name. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // The internal identifier for the category that a ticket group belongs to.. TicketGroupCategoryId *int `json:"ticketGroupCategoryId,omitempty" xmlrpc:"ticketGroupCategoryId,omitempty"` }
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.
type Ticket_Group_Category ¶
type Ticket_Group_Category struct { Entity // A ticket group category's unique identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A ticket group category's name. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
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.
type Ticket_State ¶
type Ticket_State struct { Entity // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet StateType *Ticket_State_Type `json:"stateType,omitempty" xmlrpc:"stateType,omitempty"` // no documentation yet StateTypeId *int `json:"stateTypeId,omitempty" xmlrpc:"stateTypeId,omitempty"` // no documentation yet Ticket *Ticket `json:"ticket,omitempty" xmlrpc:"ticket,omitempty"` // no documentation yet TicketId *int `json:"ticketId,omitempty" xmlrpc:"ticketId,omitempty"` }
no documentation yet
type Ticket_State_Type ¶
type Ticket_State_Type struct { Entity // no documentation yet Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
no documentation yet
type Ticket_Status ¶
type Ticket_Status struct { Entity // A ticket status' internal identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A ticket status' name. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
The SoftLayer_Ticket_Status data type models the state of a ticket as it is worked by SoftLayer and its customers. Tickets exist in one of three states: *”'OPEN”': Open tickets are considered unresolved issues by SoftLayer and can be assigned to a SoftLayer employee for work. Tickets created by portal or API users are created in the Open state. *”'ASSIGNED”': Assigned tickets are identical to open tickets, but are assigned to an individual SoftLayer employee. An assigned ticket is actively being worked by SoftLayer. *”'CLOSED”': Tickets are closed when the issue at hand is considered resolved. A SoftLayer employee can change a ticket's status from Closed to Open or Assigned if the need arises.
A ticket usually goes from the Open to Assigned to Closed states during its life cycle. If a ticket is forwarded from one department to another it may change from the Assigned state back to Open until it is assigned to a member of the new department.
type Ticket_Subject ¶
type Ticket_Subject struct { Entity // no documentation yet Category *Ticket_Subject_Category `json:"category,omitempty" xmlrpc:"category,omitempty"` // The subject category id that this ticket subject belongs to. CategoryId *int `json:"categoryId,omitempty" xmlrpc:"categoryId,omitempty"` // A child subject Children []Ticket_Subject `json:"children,omitempty" xmlrpc:"children,omitempty"` // A count of a child subject ChildrenCount *uint `json:"childrenCount,omitempty" xmlrpc:"childrenCount,omitempty"` // no documentation yet Group *Ticket_Group `json:"group,omitempty" xmlrpc:"group,omitempty"` // A ticket subject's internal identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A ticket subject's name. This name is used for a standard support ticket's title. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // A parent subject Parent *Ticket_Subject `json:"parent,omitempty" xmlrpc:"parent,omitempty"` // Specifies the parent subject id. ParentId *int `json:"parentId,omitempty" xmlrpc:"parentId,omitempty"` }
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.
type Ticket_Subject_Category ¶
type Ticket_Subject_Category struct { Entity // A unique identifier of a ticket subject category. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A ticket subject category name. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // A count of SubjectCount *uint `json:"subjectCount,omitempty" xmlrpc:"subjectCount,omitempty"` // no documentation yet Subjects []Ticket_Subject `json:"subjects,omitempty" xmlrpc:"subjects,omitempty"` }
SoftLayer_Ticket_Subject_Category groups ticket subjects into logical group.
type Ticket_Type ¶
type Ticket_Type struct { Entity // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` }
no documentation yet
type Ticket_Update ¶
type Ticket_Update struct { Entity // no documentation yet ChangeOwnerActivity *string `json:"changeOwnerActivity,omitempty" xmlrpc:"changeOwnerActivity,omitempty"` // The chat between the Customer and Agent Chat *Ticket_Chat_Liveperson `json:"chat,omitempty" xmlrpc:"chat,omitempty"` // The data a ticket update was created. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // The user or SoftLayer employee who created a ticket update. Editor *User_Interface `json:"editor,omitempty" xmlrpc:"editor,omitempty"` // 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". EditorId *int `json:"editorId,omitempty" xmlrpc:"editorId,omitempty"` // 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. EditorType *string `json:"editorType,omitempty" xmlrpc:"editorType,omitempty"` // The contents of a ticket update. Entry *string `json:"entry,omitempty" xmlrpc:"entry,omitempty"` // The files attached to a ticket update. FileAttachment []Ticket_Attachment_File `json:"fileAttachment,omitempty" xmlrpc:"fileAttachment,omitempty"` // A count of the files attached to a ticket update. FileAttachmentCount *uint `json:"fileAttachmentCount,omitempty" xmlrpc:"fileAttachmentCount,omitempty"` // A ticket update's internal identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The ticket that a ticket update belongs to. Ticket *Ticket `json:"ticket,omitempty" xmlrpc:"ticket,omitempty"` // The internal identifier of the ticket that a ticket update belongs to. TicketId *int `json:"ticketId,omitempty" xmlrpc:"ticketId,omitempty"` // The Type of update to this ticket Type *Ticket_Update_Type `json:"type,omitempty" xmlrpc:"type,omitempty"` }
The SoftLayer_Ticket_Update type relates to a single update to a ticket, either by a customer or an employee.
type Ticket_Update_Agent ¶
type Ticket_Update_Agent struct {
Ticket_Update
}
A SoftLayer_Ticket_Update_Agent type models an update to a ticket made by an agent.
type Ticket_Update_Chat ¶
type Ticket_Update_Chat struct {
Ticket_Update
}
A SoftLayer_Ticket_Update_Chat is a chat between a customer and a customer service representative relating to a ticket.
type Ticket_Update_Customer ¶
type Ticket_Update_Customer struct {
Ticket_Update
}
A SoftLayer_Ticket_Update_Customer is a single update made by a customer to a ticket.
type Ticket_Update_Employee ¶
type Ticket_Update_Employee struct { Ticket_Update // 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". ResponseRating *int `json:"responseRating,omitempty" xmlrpc:"responseRating,omitempty"` }
The SoftLayer_Ticket_Update_Employee data type models an update to a ticket made by a SoftLayer employee.
type Ticket_Update_Type ¶
type Ticket_Update_Type struct { Entity // no documentation yet Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // no documentation yet KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // no documentation yet Ticket *Ticket_Update `json:"ticket,omitempty" xmlrpc:"ticket,omitempty"` }
no documentation yet
type Time ¶
Time type overrides the default json marshaler with the SoftLayer custom format
func (Time) MarshalJSON ¶
MarshalJSON returns the json encoding of the datatypes.Time receiver. This override is necessary to ensure datetimes are formatted in the way SoftLayer expects - that is, using the RFC3339 format, without nanoseconds.
func (Time) MarshalText ¶
MarshalText returns a text encoding of the datatypes.Time receiver. This is mainly provided to complete what might be expected of a type that implements the Marshaler interface.
type Trellix_Epolicy_Orchestrator_Version51_Agent_Details ¶ added in v1.0.6
type Trellix_Epolicy_Orchestrator_Version51_Agent_Details struct { Entity // Version number of the anti-virus scan agent. AgentVersion *string `json:"agentVersion,omitempty" xmlrpc:"agentVersion,omitempty"` // The date of the last time the anti-virus agent checked in. LastUpdate *Time `json:"lastUpdate,omitempty" xmlrpc:"lastUpdate,omitempty"` }
The Trellix_Epolicy_Orchestrator_Version51_Agent_Details data type represents a virus scan agent and contains details about its version.
type Trellix_Epolicy_Orchestrator_Version51_Policy_Object ¶ added in v1.0.6
type Trellix_Epolicy_Orchestrator_Version51_Policy_Object struct { Entity // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
The Trellix_Epolicy_Orchestrator_Version51_Policy_Object data type represents a virus scan agent and contains details about its version.
type Trellix_Epolicy_Orchestrator_Version51_Product_Properties ¶ added in v1.0.6
type Trellix_Epolicy_Orchestrator_Version51_Product_Properties struct { Entity // no documentation yet DatVersion *string `json:"datVersion,omitempty" xmlrpc:"datVersion,omitempty"` }
The Trellix_Epolicy_Orchestrator_Version51_Product_Properties data type represents the version of the virus data file
type User_Access_Facility_Log ¶
type User_Access_Facility_Log struct { Entity // 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. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // 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. AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // This is the location of the facility. Datacenter *Location `json:"datacenter,omitempty" xmlrpc:"datacenter,omitempty"` // This is a short description of why the person is at the location. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // This is the colocation hardware that was visited. Hardware *Hardware `json:"hardware,omitempty" xmlrpc:"hardware,omitempty"` // no documentation yet HardwareId *int `json:"hardwareId,omitempty" xmlrpc:"hardwareId,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet LocationId *int `json:"locationId,omitempty" xmlrpc:"locationId,omitempty"` // This is the type of person entering the facility. LogType *User_Access_Facility_Log_Type `json:"logType,omitempty" xmlrpc:"logType,omitempty"` // This is the date and time the person arrived. TimeIn *Time `json:"timeIn,omitempty" xmlrpc:"timeIn,omitempty"` // no documentation yet TimeOut *Time `json:"timeOut,omitempty" xmlrpc:"timeOut,omitempty"` // no documentation yet Visitor *Entity `json:"visitor,omitempty" xmlrpc:"visitor,omitempty"` }
This class represents a login/logout sheet for facility visitors.
type User_Access_Facility_Log_Type ¶
type User_Access_Facility_Log_Type struct { Entity // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
no documentation yet
type User_Access_Facility_Visitor ¶
type User_Access_Facility_Visitor struct { Entity // no documentation yet CompanyName *string `json:"companyName,omitempty" xmlrpc:"companyName,omitempty"` // no documentation yet FirstName *string `json:"firstName,omitempty" xmlrpc:"firstName,omitempty"` // no documentation yet LastName *string `json:"lastName,omitempty" xmlrpc:"lastName,omitempty"` // no documentation yet TypeId *int `json:"typeId,omitempty" xmlrpc:"typeId,omitempty"` // no documentation yet VisitorType *User_Access_Facility_Visitor_Type `json:"visitorType,omitempty" xmlrpc:"visitorType,omitempty"` }
This class represents a facility visitor that is not an active employee or customer.
type User_Access_Facility_Visitor_Type ¶
type User_Access_Facility_Visitor_Type struct { Entity // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
no documentation yet
type User_Customer ¶
type User_Customer struct { User_Interface // The customer account that a user belongs to. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // A portal user's associated [[SoftLayer_Account|customer account]] id. AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // A count of ActionCount *uint `json:"actionCount,omitempty" xmlrpc:"actionCount,omitempty"` // no documentation yet Actions []User_Permission_Action `json:"actions,omitempty" xmlrpc:"actions,omitempty"` // A count of a portal user's additional email addresses. These email addresses are contacted when updates are made to support tickets. AdditionalEmailCount *uint `json:"additionalEmailCount,omitempty" xmlrpc:"additionalEmailCount,omitempty"` // A portal user's additional email addresses. These email addresses are contacted when updates are made to support tickets. AdditionalEmails []User_Customer_AdditionalEmail `json:"additionalEmails,omitempty" xmlrpc:"additionalEmails,omitempty"` // The first line of the mailing address belonging to a portal user. Address1 *string `json:"address1,omitempty" xmlrpc:"address1,omitempty"` // The second line of the mailing address belonging to a portal user. Address2 *string `json:"address2,omitempty" xmlrpc:"address2,omitempty"` // A portal user's AOL Instant Messenger screen name. Aim *string `json:"aim,omitempty" xmlrpc:"aim,omitempty"` // A portal user's secondary phone number. AlternatePhone *string `json:"alternatePhone,omitempty" xmlrpc:"alternatePhone,omitempty"` // A count of a portal user's API Authentication keys. There is a max limit of one API key per user. ApiAuthenticationKeyCount *uint `json:"apiAuthenticationKeyCount,omitempty" xmlrpc:"apiAuthenticationKeyCount,omitempty"` // A portal user's API Authentication keys. There is a max limit of one API key per user. ApiAuthenticationKeys []User_Customer_ApiAuthentication `json:"apiAuthenticationKeys,omitempty" xmlrpc:"apiAuthenticationKeys,omitempty"` // The authentication token used for logging into the SoftLayer customer portal. AuthenticationToken *Container_User_Authentication_Token `json:"authenticationToken,omitempty" xmlrpc:"authenticationToken,omitempty"` // A count of a portal user's child users. Some portal users may not have child users. ChildUserCount *uint `json:"childUserCount,omitempty" xmlrpc:"childUserCount,omitempty"` // A portal user's child users. Some portal users may not have child users. ChildUsers []User_Customer `json:"childUsers,omitempty" xmlrpc:"childUsers,omitempty"` // The city of the mailing address belonging to a portal user. City *string `json:"city,omitempty" xmlrpc:"city,omitempty"` // A count of an user's associated closed tickets. ClosedTicketCount *uint `json:"closedTicketCount,omitempty" xmlrpc:"closedTicketCount,omitempty"` // An user's associated closed tickets. ClosedTickets []Ticket `json:"closedTickets,omitempty" xmlrpc:"closedTickets,omitempty"` // A portal user's associated company. This may not be the same company as the customer that owns this portal user. CompanyName *string `json:"companyName,omitempty" xmlrpc:"companyName,omitempty"` // A two-letter abbreviation of the country in the mailing address belonging to a portal user. Country *string `json:"country,omitempty" xmlrpc:"country,omitempty"` // The date a portal user's record was created. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // Whether a portal user's time zone is affected by Daylight Savings Time. DaylightSavingsTimeFlag *bool `json:"daylightSavingsTimeFlag,omitempty" xmlrpc:"daylightSavingsTimeFlag,omitempty"` // A count of the dedicated hosts to which the user has been granted access. DedicatedHostCount *uint `json:"dedicatedHostCount,omitempty" xmlrpc:"dedicatedHostCount,omitempty"` // The dedicated hosts to which the user has been granted access. DedicatedHosts []Virtual_DedicatedHost `json:"dedicatedHosts,omitempty" xmlrpc:"dedicatedHosts,omitempty"` // Flag used to deny access to all hardware and cloud computing instances upon user creation. DenyAllResourceAccessOnCreateFlag *bool `json:"denyAllResourceAccessOnCreateFlag,omitempty" xmlrpc:"denyAllResourceAccessOnCreateFlag,omitempty"` // no documentation yet DisplayName *string `json:"displayName,omitempty" xmlrpc:"displayName,omitempty"` // A portal user's email address. Email *string `json:"email,omitempty" xmlrpc:"email,omitempty"` // A count of the external authentication bindings that link an external identifier to a SoftLayer user. ExternalBindingCount *uint `json:"externalBindingCount,omitempty" xmlrpc:"externalBindingCount,omitempty"` // The external authentication bindings that link an external identifier to a SoftLayer user. ExternalBindings []User_External_Binding `json:"externalBindings,omitempty" xmlrpc:"externalBindings,omitempty"` // A portal user's first name. FirstName *string `json:"firstName,omitempty" xmlrpc:"firstName,omitempty"` // A user's password for the SoftLayer forums, hashed for auto-login capability from the SoftLayer customer portal // Deprecated: This function has been marked as deprecated. ForumPasswordHash *string `json:"forumPasswordHash,omitempty" xmlrpc:"forumPasswordHash,omitempty"` // A portal user's accessible hardware. These permissions control which hardware a user has access to in the SoftLayer customer portal. Hardware []Hardware `json:"hardware,omitempty" xmlrpc:"hardware,omitempty"` // A count of a portal user's accessible hardware. These permissions control which hardware a user has access to in the SoftLayer customer portal. HardwareCount *uint `json:"hardwareCount,omitempty" xmlrpc:"hardwareCount,omitempty"` // 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'. HardwareNotificationCount *uint `json:"hardwareNotificationCount,omitempty" xmlrpc:"hardwareNotificationCount,omitempty"` // 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'. HardwareNotifications []User_Customer_Notification_Hardware `json:"hardwareNotifications,omitempty" xmlrpc:"hardwareNotifications,omitempty"` // Whether or not a user has acknowledged the support policy. HasAcknowledgedSupportPolicyFlag *bool `json:"hasAcknowledgedSupportPolicyFlag,omitempty" xmlrpc:"hasAcknowledgedSupportPolicyFlag,omitempty"` // Permission granting the user access to all Dedicated Host devices on the account. HasFullDedicatedHostAccessFlag *bool `json:"hasFullDedicatedHostAccessFlag,omitempty" xmlrpc:"hasFullDedicatedHostAccessFlag,omitempty"` // Whether or not a portal user has access to all hardware on their account. HasFullHardwareAccessFlag *bool `json:"hasFullHardwareAccessFlag,omitempty" xmlrpc:"hasFullHardwareAccessFlag,omitempty"` // Whether or not a portal user has access to all virtual guests on their account. HasFullVirtualGuestAccessFlag *bool `json:"hasFullVirtualGuestAccessFlag,omitempty" xmlrpc:"hasFullVirtualGuestAccessFlag,omitempty"` // no documentation yet IamAuthorizationStatus *int `json:"iamAuthorizationStatus,omitempty" xmlrpc:"iamAuthorizationStatus,omitempty"` // The IAMid (realm-identifier) of the user being created by PaaS IamId *string `json:"iamId,omitempty" xmlrpc:"iamId,omitempty"` // Specifically relating the Customer instance to an IBMid. A Customer instance may or may not have an IBMid link. IbmIdLink *User_Customer_Link `json:"ibmIdLink,omitempty" xmlrpc:"ibmIdLink,omitempty"` // A portal user's ICQ UIN. Icq *string `json:"icq,omitempty" xmlrpc:"icq,omitempty"` // A portal user's internal identifying number. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // 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. IpAddressRestriction *string `json:"ipAddressRestriction,omitempty" xmlrpc:"ipAddressRestriction,omitempty"` // no documentation yet IsMasterUserFlag *bool `json:"isMasterUserFlag,omitempty" xmlrpc:"isMasterUserFlag,omitempty"` // A portal user's last name. LastName *string `json:"lastName,omitempty" xmlrpc:"lastName,omitempty"` // A count of contains the definition of the layout profile. LayoutProfileCount *uint `json:"layoutProfileCount,omitempty" xmlrpc:"layoutProfileCount,omitempty"` // Contains the definition of the layout profile. LayoutProfiles []Layout_Profile `json:"layoutProfiles,omitempty" xmlrpc:"layoutProfiles,omitempty"` // The linked account integration mode LinkedAccountIntegrationMode *string `json:"linkedAccountIntegrationMode,omitempty" xmlrpc:"linkedAccountIntegrationMode,omitempty"` // A user's locale. Locale holds user's language and region information. Locale *Locale `json:"locale,omitempty" xmlrpc:"locale,omitempty"` // A portal user's associated [[SoftLayer_Locale|locale]] id. LocaleId *int `json:"localeId,omitempty" xmlrpc:"localeId,omitempty"` // A count of a user's attempts to log into the SoftLayer customer portal. LoginAttemptCount *uint `json:"loginAttemptCount,omitempty" xmlrpc:"loginAttemptCount,omitempty"` // A user's attempts to log into the SoftLayer customer portal. LoginAttempts []User_Customer_Access_Authentication `json:"loginAttempts,omitempty" xmlrpc:"loginAttempts,omitempty"` // Determines if this portal user is managed by SAML federation. ManagedByFederationFlag *bool `json:"managedByFederationFlag,omitempty" xmlrpc:"managedByFederationFlag,omitempty"` // Determines if this portal user is managed by IBMid federation. ManagedByOpenIdConnectFlag *bool `json:"managedByOpenIdConnectFlag,omitempty" xmlrpc:"managedByOpenIdConnectFlag,omitempty"` // The minimum number of hours that must pass between password resets. MinimumPasswordLifeHours *int `json:"minimumPasswordLifeHours,omitempty" xmlrpc:"minimumPasswordLifeHours,omitempty"` // The date a portal user's record was last modified. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // A portal user's MSN address. Msn *string `json:"msn,omitempty" xmlrpc:"msn,omitempty"` // no documentation yet NameId *string `json:"nameId,omitempty" xmlrpc:"nameId,omitempty"` // A count of notification subscription records for the user. NotificationSubscriberCount *uint `json:"notificationSubscriberCount,omitempty" xmlrpc:"notificationSubscriberCount,omitempty"` // Notification subscription records for the user. NotificationSubscribers []Notification_Subscriber `json:"notificationSubscribers,omitempty" xmlrpc:"notificationSubscribers,omitempty"` // A portal user's office phone number. OfficePhone *string `json:"officePhone,omitempty" xmlrpc:"officePhone,omitempty"` // The BlueID username associated to with this user, if the account is managed by OpenIDConnect / BlueID federation OpenIdConnectUserName *string `json:"openIdConnectUserName,omitempty" xmlrpc:"openIdConnectUserName,omitempty"` // A count of an user's associated open tickets. OpenTicketCount *uint `json:"openTicketCount,omitempty" xmlrpc:"openTicketCount,omitempty"` // An user's associated open tickets. OpenTickets []Ticket `json:"openTickets,omitempty" xmlrpc:"openTickets,omitempty"` // A count of a portal user's vpn accessible subnets. OverrideCount *uint `json:"overrideCount,omitempty" xmlrpc:"overrideCount,omitempty"` // A portal user's vpn accessible subnets. Overrides []Network_Service_Vpn_Overrides `json:"overrides,omitempty" xmlrpc:"overrides,omitempty"` // A portal user's parent user. If a SoftLayer_User_Customer has a null parentId property then it doesn't have a parent user. Parent *User_Customer `json:"parent,omitempty" xmlrpc:"parent,omitempty"` // A portal user's parent user. Id a users parentId is ”null” then it doesn't have a parent user in the customer portal. ParentId *int `json:"parentId,omitempty" xmlrpc:"parentId,omitempty"` // The expiration date for the user's password PasswordExpireDate *Time `json:"passwordExpireDate,omitempty" xmlrpc:"passwordExpireDate,omitempty"` // no documentation yet PermissionCheckLikeMasterUserFlag *int `json:"permissionCheckLikeMasterUserFlag,omitempty" xmlrpc:"permissionCheckLikeMasterUserFlag,omitempty"` // A count of a portal user's permissions. These permissions control that user's access to functions within the SoftLayer customer portal and API. PermissionCount *uint `json:"permissionCount,omitempty" xmlrpc:"permissionCount,omitempty"` // A portal user's permissions. These permissions control that user's access to functions within the SoftLayer customer portal and API. Permissions []User_Customer_CustomerPermission_Permission `json:"permissions,omitempty" xmlrpc:"permissions,omitempty"` // The postal code of the mailing address belonging to an portal user. PostalCode *string `json:"postalCode,omitempty" xmlrpc:"postalCode,omitempty"` // Whether a portal user may connect to the SoftLayer private network via PPTP VPN or not. // Deprecated: This function has been marked as deprecated. PptpVpnAllowedFlag *bool `json:"pptpVpnAllowedFlag,omitempty" xmlrpc:"pptpVpnAllowedFlag,omitempty"` // A count of data type contains a single user preference to a specific preference type. PreferenceCount *uint `json:"preferenceCount,omitempty" xmlrpc:"preferenceCount,omitempty"` // Data type contains a single user preference to a specific preference type. Preferences []User_Preference `json:"preferences,omitempty" xmlrpc:"preferences,omitempty"` // no documentation yet PreventPreviousPasswords *int `json:"preventPreviousPasswords,omitempty" xmlrpc:"preventPreviousPasswords,omitempty"` // A count of RoleCount *uint `json:"roleCount,omitempty" xmlrpc:"roleCount,omitempty"` // no documentation yet Roles []User_Permission_Role `json:"roles,omitempty" xmlrpc:"roles,omitempty"` // no documentation yet SavedId *string `json:"savedId,omitempty" xmlrpc:"savedId,omitempty"` // 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. SecondaryLoginManagementFlag *bool `json:"secondaryLoginManagementFlag,omitempty" xmlrpc:"secondaryLoginManagementFlag,omitempty"` // Whether a user is required to answer a security question when logging into the SoftLayer customer portal. SecondaryLoginRequiredFlag *bool `json:"secondaryLoginRequiredFlag,omitempty" xmlrpc:"secondaryLoginRequiredFlag,omitempty"` // The date when a user's password was last updated. SecondaryPasswordModifyDate *Time `json:"secondaryPasswordModifyDate,omitempty" xmlrpc:"secondaryPasswordModifyDate,omitempty"` // The number of days for which a user's password is active. SecondaryPasswordTimeoutDays *int `json:"secondaryPasswordTimeoutDays,omitempty" xmlrpc:"secondaryPasswordTimeoutDays,omitempty"` // 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. SecurityAnswerCount *uint `json:"securityAnswerCount,omitempty" xmlrpc:"securityAnswerCount,omitempty"` // 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. SecurityAnswers []User_Customer_Security_Answer `json:"securityAnswers,omitempty" xmlrpc:"securityAnswers,omitempty"` // A phone number that can receive SMS text messages for this portal user. Sms *string `json:"sms,omitempty" xmlrpc:"sms,omitempty"` // Whether a portal user may connect to the SoftLayer private network via SSL VPN or not. SslVpnAllowedFlag *bool `json:"sslVpnAllowedFlag,omitempty" xmlrpc:"sslVpnAllowedFlag,omitempty"` // 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. State *string `json:"state,omitempty" xmlrpc:"state,omitempty"` // The date a portal users record's last status change. StatusDate *Time `json:"statusDate,omitempty" xmlrpc:"statusDate,omitempty"` // A count of a user's notification subscription records. SubscriberCount *uint `json:"subscriberCount,omitempty" xmlrpc:"subscriberCount,omitempty"` // A user's notification subscription records. Subscribers []Notification_User_Subscriber `json:"subscribers,omitempty" xmlrpc:"subscribers,omitempty"` // A count of a user's successful attempts to log into the SoftLayer customer portal. SuccessfulLoginCount *uint `json:"successfulLoginCount,omitempty" xmlrpc:"successfulLoginCount,omitempty"` // A user's successful attempts to log into the SoftLayer customer portal. SuccessfulLogins []User_Customer_Access_Authentication `json:"successfulLogins,omitempty" xmlrpc:"successfulLogins,omitempty"` // Whether or not a user is required to acknowledge the support policy for portal access. SupportPolicyAcknowledgementRequiredFlag *int `json:"supportPolicyAcknowledgementRequiredFlag,omitempty" xmlrpc:"supportPolicyAcknowledgementRequiredFlag,omitempty"` // A count of the surveys that a user has taken in the SoftLayer customer portal. SurveyCount *uint `json:"surveyCount,omitempty" xmlrpc:"surveyCount,omitempty"` // Whether or not a user must take a brief survey the next time they log into the SoftLayer customer portal. SurveyRequiredFlag *bool `json:"surveyRequiredFlag,omitempty" xmlrpc:"surveyRequiredFlag,omitempty"` // The surveys that a user has taken in the SoftLayer customer portal. Surveys []Survey `json:"surveys,omitempty" xmlrpc:"surveys,omitempty"` // A count of an user's associated tickets. TicketCount *uint `json:"ticketCount,omitempty" xmlrpc:"ticketCount,omitempty"` // An user's associated tickets. Tickets []Ticket `json:"tickets,omitempty" xmlrpc:"tickets,omitempty"` // A portal user's time zone. Timezone *Locale_Timezone `json:"timezone,omitempty" xmlrpc:"timezone,omitempty"` // A portal user's time zone. TimezoneId *int `json:"timezoneId,omitempty" xmlrpc:"timezoneId,omitempty"` // A count of a user's unsuccessful attempts to log into the SoftLayer customer portal. UnsuccessfulLoginCount *uint `json:"unsuccessfulLoginCount,omitempty" xmlrpc:"unsuccessfulLoginCount,omitempty"` // A user's unsuccessful attempts to log into the SoftLayer customer portal. UnsuccessfulLogins []User_Customer_Access_Authentication `json:"unsuccessfulLogins,omitempty" xmlrpc:"unsuccessfulLogins,omitempty"` // A count of user customer link with IBMid and IAMid. UserLinkCount *uint `json:"userLinkCount,omitempty" xmlrpc:"userLinkCount,omitempty"` // User customer link with IBMid and IAMid. UserLinks []User_Customer_Link `json:"userLinks,omitempty" xmlrpc:"userLinks,omitempty"` // A portal user's status, which controls overall access to the SoftLayer customer portal and VPN access to the private network. UserStatus *User_Customer_Status `json:"userStatus,omitempty" xmlrpc:"userStatus,omitempty"` // A number reflecting the state of a portal user. UserStatusId *int `json:"userStatusId,omitempty" xmlrpc:"userStatusId,omitempty"` // A portal user's username. Username *string `json:"username,omitempty" xmlrpc:"username,omitempty"` // The verification code from Bluemix BSS to save in the invitation VerificationCode *string `json:"verificationCode,omitempty" xmlrpc:"verificationCode,omitempty"` // 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. VirtualGuestCount *uint `json:"virtualGuestCount,omitempty" xmlrpc:"virtualGuestCount,omitempty"` // 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. VirtualGuests []Virtual_Guest `json:"virtualGuests,omitempty" xmlrpc:"virtualGuests,omitempty"` // Whether a portal user vpn subnets have been manual configured. VpnManualConfig *bool `json:"vpnManualConfig,omitempty" xmlrpc:"vpnManualConfig,omitempty"` // A portal user's Yahoo! Chat name. Yahoo *string `json:"yahoo,omitempty" xmlrpc:"yahoo,omitempty"` }
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.
type User_Customer_Access_Authentication ¶
type User_Customer_Access_Authentication struct { Entity // The date of an attempt to log into the SoftLayer customer portal. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // The IP address of the user who attempted to log into the SoftLayer customer portal. IpAddress *string `json:"ipAddress,omitempty" xmlrpc:"ipAddress,omitempty"` // Whether an attempt to log into the SoftLayer customer portal was successful or not. SuccessFlag *bool `json:"successFlag,omitempty" xmlrpc:"successFlag,omitempty"` // The user who has attempted to log into the SoftLayer customer portal. User *User_Customer `json:"user,omitempty" xmlrpc:"user,omitempty"` // The internal identifier of the user who attempted to log into the SoftLayer customer portal. UserId *int `json:"userId,omitempty" xmlrpc:"userId,omitempty"` // The username used when attempting to log into the SoftLayer customer portal Username *string `json:"username,omitempty" xmlrpc:"username,omitempty"` }
SoftLayer_User_Customer_Access_Authentication models a single attempt to log into the SoftLayer customer portal. A SoftLayer_User_Customer_Access_Authentication record is created every time a user attempts to log into the portal. Use this service to audit your users' portal activity and diagnose potential security breaches of your SoftLayer portal accounts.
Unsuccessful login attempts can be caused by an incorrect password, failing to answer or not answering a login security question if the user has them configured, or attempting to log in from an IP address outside of the user's IP address restriction list.
SoftLayer employees periodically log into our customer portal as users to diagnose portal issues, verify settings and configuration, and to perform maintenance on your account or services. SoftLayer employees only log into customer accounts from the following IP ranges: * 2607:f0d0:1000::/48 * 2607:f0d0:2000::/48 * 2607:f0d0:3000::/48 * 66.228.118.67/32 * 66.228.118.86/32
type User_Customer_Access_Authentication_TokenValidation ¶ added in v1.0.5
type User_Customer_Access_Authentication_TokenValidation struct {
User_Customer_Access_Authentication
}
SoftLayer_User_Customer_Access_Authentication_TokenValidation is for logging token validations from IAM, as something distinct from a traditional "login". A single login to IBM Cloud/IAM as perceived by the end user, may result in many token validation calls to IMS.
This is a very shallow subclass of SoftLayer_User_Customer_Access_Authentication
type User_Customer_AdditionalEmail ¶
type User_Customer_AdditionalEmail struct { Entity // Email assigned to user for use in ticket update notifications. Email *string `json:"email,omitempty" xmlrpc:"email,omitempty"` // The portal user that owns this additional email address. User *User_Customer `json:"user,omitempty" xmlrpc:"user,omitempty"` // An internal identifier for the portal user who this additional email belongs to. UserId *int `json:"userId,omitempty" xmlrpc:"userId,omitempty"` }
The SoftLayer_User_Customer_AdditionalEmail data type contains the additional email for use in ticket update notifications.
type User_Customer_ApiAuthentication ¶
type User_Customer_ApiAuthentication struct { Entity // The user's authentication key for API access. AuthenticationKey *string `json:"authenticationKey,omitempty" xmlrpc:"authenticationKey,omitempty"` // The user's API authentication identifying number. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // 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. IpAddressRestriction *string `json:"ipAddressRestriction,omitempty" xmlrpc:"ipAddressRestriction,omitempty"` // The user's authentication key modification date. TimestampKey *int `json:"timestampKey,omitempty" xmlrpc:"timestampKey,omitempty"` // The user who owns the api authentication key. User *User_Customer `json:"user,omitempty" xmlrpc:"user,omitempty"` // The user's identifying number. UserId *int `json:"userId,omitempty" xmlrpc:"userId,omitempty"` }
The SoftLayer_User_Customer_ApiAuthentication type contains user's authentication key(s).
type User_Customer_CustomerPermission_Permission ¶
type User_Customer_CustomerPermission_Permission struct { Entity // A user permission's short name. Key *string `json:"key,omitempty" xmlrpc:"key,omitempty"` // A user permission's key name. KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // A user permission's name. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
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.
type User_Customer_External_Binding ¶
type User_Customer_External_Binding struct { User_External_Binding // The SoftLayer user that the external authentication binding belongs to. User *User_Customer `json:"user,omitempty" xmlrpc:"user,omitempty"` }
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.
type User_Customer_External_Binding_Attribute ¶
type User_Customer_External_Binding_Attribute struct {
User_External_Binding_Attribute
}
The SoftLayer_User_Customer_External_Binding_Attribute data type contains the value for a single attribute associated with an external binding. External binding attributes contain additional information about an external binding. An attribute can be generic or specific to a 3rd party vendor. For example these attributes relate to Verisign: *Credential Type *Credential State *Credential Expiration Date *Credential Last Update Date
type User_Customer_External_Binding_Totp ¶
type User_Customer_External_Binding_Totp struct {
User_Customer_External_Binding
}
The SoftLayer_User_Customer_External_Binding_Totp data type contains information about a single time-based one time password external binding. The external binding information is used when a SoftLayer customer logs into the SoftLayer customer portal to authenticate them.
The information provided by this external binding data type includes: * The type of credential * The current state of the credential ** Active ** Inactive
SoftLayer users with an active external binding will be prohibited from using the API for security reasons.
type User_Customer_External_Binding_Type ¶
type User_Customer_External_Binding_Type struct {
User_External_Binding_Type
}
The SoftLayer_User_Customer_External_Binding_Type data type contains information relating to a type of external authentication binding. It contains a user friendly name as well as a unique key name.
type User_Customer_External_Binding_Vendor ¶
type User_Customer_External_Binding_Vendor struct {
User_External_Binding_Vendor
}
The SoftLayer_User_Customer_External_Binding_Vendor data type contains information for a single external binding vendor. This information includes a user friendly vendor name, a unique version of the vendor name, and a unique internal identifier that can be used when creating a new external binding.
type User_Customer_External_Binding_Verisign ¶
type User_Customer_External_Binding_Verisign struct { User_Customer_External_Binding // The date that a VeriSign credential expires. CredentialExpirationDate *string `json:"credentialExpirationDate,omitempty" xmlrpc:"credentialExpirationDate,omitempty"` // The last time a VeriSign credential was updated. CredentialLastUpdateDate *string `json:"credentialLastUpdateDate,omitempty" xmlrpc:"credentialLastUpdateDate,omitempty"` // The current state of a VeriSign credential. This can be 'Enabled', 'Disabled', or 'Locked'. CredentialState *string `json:"credentialState,omitempty" xmlrpc:"credentialState,omitempty"` // The type of VeriSign credential. This can be either 'Hardware' or 'Software'. CredentialType *string `json:"credentialType,omitempty" xmlrpc:"credentialType,omitempty"` }
The SoftLayer_User_Customer_External_Binding_Verisign data type contains information about a single VeriSign external binding. The external binding information is used when a SoftLayer customer logs into the SoftLayer customer portal to authenticate them against a 3rd party, in this case VeriSign.
The information provided by the VeriSign external binding data type includes: * The type of credential * The current state of the credential ** Enabled ** Disabled ** Locked * The credential's expiration date * The last time the credential was updated
SoftLayer users with an active external binding will be prohibited from using the API for security reasons.
type User_Customer_Invitation ¶
type User_Customer_Invitation struct { Entity // no documentation yet Code *string `json:"code,omitempty" xmlrpc:"code,omitempty"` // no documentation yet CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // no documentation yet CreatorId *int `json:"creatorId,omitempty" xmlrpc:"creatorId,omitempty"` // no documentation yet CreatorType *string `json:"creatorType,omitempty" xmlrpc:"creatorType,omitempty"` // no documentation yet Email *string `json:"email,omitempty" xmlrpc:"email,omitempty"` // no documentation yet ExistingBlueIdFlag *int `json:"existingBlueIdFlag,omitempty" xmlrpc:"existingBlueIdFlag,omitempty"` // no documentation yet ExpirationDate *Time `json:"expirationDate,omitempty" xmlrpc:"expirationDate,omitempty"` // no documentation yet IbmIdUsername *string `json:"ibmIdUsername,omitempty" xmlrpc:"ibmIdUsername,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet IsFederatedEmailDomainFlag *int `json:"isFederatedEmailDomainFlag,omitempty" xmlrpc:"isFederatedEmailDomainFlag,omitempty"` // no documentation yet ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // no documentation yet ResponseDate *Time `json:"responseDate,omitempty" xmlrpc:"responseDate,omitempty"` // no documentation yet StatusId *int `json:"statusId,omitempty" xmlrpc:"statusId,omitempty"` // no documentation yet User *User_Customer `json:"user,omitempty" xmlrpc:"user,omitempty"` // no documentation yet UserId *int `json:"userId,omitempty" xmlrpc:"userId,omitempty"` }
no documentation yet
type User_Customer_Link ¶
type User_Customer_Link struct { Entity // no documentation yet CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // no documentation yet DefaultFlag *int `json:"defaultFlag,omitempty" xmlrpc:"defaultFlag,omitempty"` // no documentation yet DestinationUserAlphanumericId *string `json:"destinationUserAlphanumericId,omitempty" xmlrpc:"destinationUserAlphanumericId,omitempty"` // no documentation yet // Deprecated: This function has been marked as deprecated. DestinationUserId *int `json:"destinationUserId,omitempty" xmlrpc:"destinationUserId,omitempty"` // no documentation yet IamIdVerificationFlag *int `json:"iamIdVerificationFlag,omitempty" xmlrpc:"iamIdVerificationFlag,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The realm of the IAMid unique identifier. Realm *string `json:"realm,omitempty" xmlrpc:"realm,omitempty"` // no documentation yet ServiceProvider *Service_Provider `json:"serviceProvider,omitempty" xmlrpc:"serviceProvider,omitempty"` // no documentation yet ServiceProviderId *int `json:"serviceProviderId,omitempty" xmlrpc:"serviceProviderId,omitempty"` // The IAMid Unique Identifier formed in the format of "realm-uniqueIdentifier" UniqueIdentifier *string `json:"uniqueIdentifier,omitempty" xmlrpc:"uniqueIdentifier,omitempty"` // no documentation yet User *User_Customer `json:"user,omitempty" xmlrpc:"user,omitempty"` // no documentation yet UserId *int `json:"userId,omitempty" xmlrpc:"userId,omitempty"` }
no documentation yet
type User_Customer_Link_TrustedProfile ¶ added in v1.0.4
type User_Customer_Link_TrustedProfile struct {
User_Customer_Link
}
no documentation yet
type User_Customer_Link_VerifiedIamIdLinkCollection ¶
type User_Customer_Link_VerifiedIamIdLinkCollection struct { Entity // no documentation yet BadLinksDifferentIUI []User_Customer_Link `json:"badLinksDifferentIUI,omitempty" xmlrpc:"badLinksDifferentIUI,omitempty"` // no documentation yet BadLinksDifferentUsername []User_Customer_Link `json:"badLinksDifferentUsername,omitempty" xmlrpc:"badLinksDifferentUsername,omitempty"` // no documentation yet GoodLinks []User_Customer_Link `json:"goodLinks,omitempty" xmlrpc:"goodLinks,omitempty"` }
no documentation yet
type User_Customer_Notification_Hardware ¶
type User_Customer_Notification_Hardware struct { Entity // The hardware object that will be monitored. Hardware *Hardware `json:"hardware,omitempty" xmlrpc:"hardware,omitempty"` // The ID of the Hardware object that is to be monitored. HardwareId *int `json:"hardwareId,omitempty" xmlrpc:"hardwareId,omitempty"` // The unique identifier for this object Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The user that will be notified when the associated hardware object fails a monitoring instance. User *User_Customer `json:"user,omitempty" xmlrpc:"user,omitempty"` // The ID of the SoftLayer_User_Customer object that represents the user to be notified on monitoring failure. UserId *int `json:"userId,omitempty" xmlrpc:"userId,omitempty"` }
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.
type User_Customer_Notification_Virtual_Guest ¶
type User_Customer_Notification_Virtual_Guest struct { Entity // The virtual guest object that will be monitored. Guest *Virtual_Guest `json:"guest,omitempty" xmlrpc:"guest,omitempty"` // The ID of the virtual guest object that is to be monitored. GuestId *int `json:"guestId,omitempty" xmlrpc:"guestId,omitempty"` // The unique identifier for this object Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The user that will be notified when the associated virtual guest object fails a monitoring instance. User *User_Customer `json:"user,omitempty" xmlrpc:"user,omitempty"` // The ID of the SoftLayer_User_Customer object that represents the user to be notified on monitoring failure. UserId *int `json:"userId,omitempty" xmlrpc:"userId,omitempty"` }
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.
type User_Customer_OpenIdConnect ¶
type User_Customer_OpenIdConnect struct {
User_Customer
}
no documentation yet
type User_Customer_OpenIdConnect_TrustedProfile ¶ added in v1.0.4
type User_Customer_OpenIdConnect_TrustedProfile struct {
User_Customer_OpenIdConnect
}
no documentation yet
type User_Customer_Profile_Event_HyperWarp ¶
type User_Customer_Profile_Event_HyperWarp struct {
Entity
}
no documentation yet
type User_Customer_Prospect ¶
type User_Customer_Prospect struct { Entity // no documentation yet Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // A count of AssignedEmployeeCount *uint `json:"assignedEmployeeCount,omitempty" xmlrpc:"assignedEmployeeCount,omitempty"` // no documentation yet AssignedEmployees []User_Employee `json:"assignedEmployees,omitempty" xmlrpc:"assignedEmployees,omitempty"` // A count of QuoteCount *uint `json:"quoteCount,omitempty" xmlrpc:"quoteCount,omitempty"` // no documentation yet Quotes []Billing_Order_Quote `json:"quotes,omitempty" xmlrpc:"quotes,omitempty"` // no documentation yet Type *User_Customer_Prospect_Type `json:"type,omitempty" xmlrpc:"type,omitempty"` }
no documentation yet
type User_Customer_Prospect_ServiceProvider_EnrollRequest ¶
type User_Customer_Prospect_ServiceProvider_EnrollRequest struct { Entity // Flag indicating whether or not applicant has accepted all current SSP agreements. AcceptAllAgreementsFlag *bool `json:"acceptAllAgreementsFlag,omitempty" xmlrpc:"acceptAllAgreementsFlag,omitempty"` // accountId of existing SoftLayer Customer AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // Service provider address1 Address1 *string `json:"address1,omitempty" xmlrpc:"address1,omitempty"` // Service provider address2 Address2 *string `json:"address2,omitempty" xmlrpc:"address2,omitempty"` // Credit card account number CardAccountNumber *string `json:"cardAccountNumber,omitempty" xmlrpc:"cardAccountNumber,omitempty"` // Credit card expiration month CardExpirationMonth *string `json:"cardExpirationMonth,omitempty" xmlrpc:"cardExpirationMonth,omitempty"` // Credit card expiration year CardExpirationYear *string `json:"cardExpirationYear,omitempty" xmlrpc:"cardExpirationYear,omitempty"` // Type of credit card being used CardType *string `json:"cardType,omitempty" xmlrpc:"cardType,omitempty"` // Credit card verification number CardVerificationNumber *string `json:"cardVerificationNumber,omitempty" xmlrpc:"cardVerificationNumber,omitempty"` // Service provider city City *string `json:"city,omitempty" xmlrpc:"city,omitempty"` // Service provider company name CompanyName *string `json:"companyName,omitempty" xmlrpc:"companyName,omitempty"` // Catalyst company types. CompanyType *Catalyst_Company_Type `json:"companyType,omitempty" xmlrpc:"companyType,omitempty"` // Id of the company type which best describes applicant's company CompanyTypeId *int `json:"companyTypeId,omitempty" xmlrpc:"companyTypeId,omitempty"` // Service provider company url CompanyUrl *string `json:"companyUrl,omitempty" xmlrpc:"companyUrl,omitempty"` // Service provider contact's email ContactEmail *string `json:"contactEmail,omitempty" xmlrpc:"contactEmail,omitempty"` // Service provider contact's first name ContactFirstName *string `json:"contactFirstName,omitempty" xmlrpc:"contactFirstName,omitempty"` // Service provider contact's last name ContactLastName *string `json:"contactLastName,omitempty" xmlrpc:"contactLastName,omitempty"` // Service provider contact's Phone ContactPhone *string `json:"contactPhone,omitempty" xmlrpc:"contactPhone,omitempty"` // Service provider country Country *string `json:"country,omitempty" xmlrpc:"country,omitempty"` // Customer Prospect id CustomerProspectId *int `json:"customerProspectId,omitempty" xmlrpc:"customerProspectId,omitempty"` // Id of the device fingerprint DeviceFingerprintId *string `json:"deviceFingerprintId,omitempty" xmlrpc:"deviceFingerprintId,omitempty"` // Service provider email Email *string `json:"email,omitempty" xmlrpc:"email,omitempty"` // Indicates if customer has an existing SoftLayer account ExistingCustomerFlag *bool `json:"existingCustomerFlag,omitempty" xmlrpc:"existingCustomerFlag,omitempty"` // Service provider first name FirstName *string `json:"firstName,omitempty" xmlrpc:"firstName,omitempty"` // Service provider IBMid username, if different than the email. IbmIdUsername *string `json:"ibmIdUsername,omitempty" xmlrpc:"ibmIdUsername,omitempty"` // IBM partner world id IbmPartnerWorldId *string `json:"ibmPartnerWorldId,omitempty" xmlrpc:"ibmPartnerWorldId,omitempty"` // Indicates if the customer is IBM partner world member IbmPartnerWorldMemberFlag *bool `json:"ibmPartnerWorldMemberFlag,omitempty" xmlrpc:"ibmPartnerWorldMemberFlag,omitempty"` // Service provider last name LastName *string `json:"lastName,omitempty" xmlrpc:"lastName,omitempty"` // Flag indicating whether or not applicant acknowledged MSA MasterAgreementCompleteFlag *bool `json:"masterAgreementCompleteFlag,omitempty" xmlrpc:"masterAgreementCompleteFlag,omitempty"` // Service provider office phone OfficePhone *string `json:"officePhone,omitempty" xmlrpc:"officePhone,omitempty"` // Service provider postalCode PostalCode *string `json:"postalCode,omitempty" xmlrpc:"postalCode,omitempty"` // Flag indicating whether or not applicant acknowledged service provider addendum ServiceProviderAddendumFlag *bool `json:"serviceProviderAddendumFlag,omitempty" xmlrpc:"serviceProviderAddendumFlag,omitempty"` // Service provider state State *string `json:"state,omitempty" xmlrpc:"state,omitempty"` // Survey responses SurveyResponses []Survey_Response `json:"surveyResponses,omitempty" xmlrpc:"surveyResponses,omitempty"` // Applicant's VAT id, if one exists VatId *string `json:"vatId,omitempty" xmlrpc:"vatId,omitempty"` }
Contains user information for Service Provider Enrollment.
type User_Customer_Prospect_Type ¶
type User_Customer_Prospect_Type struct { Entity // no documentation yet CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // no documentation yet Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // no documentation yet ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
no documentation yet
type User_Customer_Security_Answer ¶
type User_Customer_Security_Answer struct { Entity // A user's answer. Answer *string `json:"answer,omitempty" xmlrpc:"answer,omitempty"` // A user's answer identifying number. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The question the security answer is associated with. Question *User_Security_Question `json:"question,omitempty" xmlrpc:"question,omitempty"` // A user's question identifying number. QuestionId *int `json:"questionId,omitempty" xmlrpc:"questionId,omitempty"` // The user who the security answer belongs to. User *User_Customer `json:"user,omitempty" xmlrpc:"user,omitempty"` // A user's identifying number. UserId *int `json:"userId,omitempty" xmlrpc:"userId,omitempty"` }
The SoftLayer_User_Customer_Security_Answer type contains user's answers to security questions.
type User_Customer_Status ¶
type User_Customer_Status struct { Entity // A user's status identifying number. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A user's status keyname KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // 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. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
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.
type User_Employee ¶
type User_Employee struct { User_Interface // no documentation yet ChatTranscript []Ticket_Chat `json:"chatTranscript,omitempty" xmlrpc:"chatTranscript,omitempty"` // A count of ChatTranscriptCount *uint `json:"chatTranscriptCount,omitempty" xmlrpc:"chatTranscriptCount,omitempty"` // no documentation yet DisplayName *string `json:"displayName,omitempty" xmlrpc:"displayName,omitempty"` // A SoftLayer employee's email address. Email addresses are only visible to [[SoftLayer_Account|SoftLayer Accounts]] that are assigned to an employee Email *string `json:"email,omitempty" xmlrpc:"email,omitempty"` // The department that a SoftLayer employee belongs to. EmployeeDepartment *User_Employee_Department `json:"employeeDepartment,omitempty" xmlrpc:"employeeDepartment,omitempty"` // A SoftLayer employee's [[SoftLayer_User_Employee_Department|department]] id. EmployeeDepartmentId *int `json:"employeeDepartmentId,omitempty" xmlrpc:"employeeDepartmentId,omitempty"` // A SoftLayer employee's first name. First names are only visible to [[SoftLayer_Account|SoftLayer Accounts]] that are assigned to an employee FirstName *string `json:"firstName,omitempty" xmlrpc:"firstName,omitempty"` // A SoftLayer employee's last name. Last names are only visible to [[SoftLayer_Account|SoftLayer Accounts]] that are assigned to an employee LastName *string `json:"lastName,omitempty" xmlrpc:"lastName,omitempty"` // A count of LayoutProfileCount *uint `json:"layoutProfileCount,omitempty" xmlrpc:"layoutProfileCount,omitempty"` // no documentation yet LayoutProfiles []Layout_Profile `json:"layoutProfiles,omitempty" xmlrpc:"layoutProfiles,omitempty"` // no documentation yet TicketActivities []Ticket_Activity `json:"ticketActivities,omitempty" xmlrpc:"ticketActivities,omitempty"` // A count of TicketActivityCount *uint `json:"ticketActivityCount,omitempty" xmlrpc:"ticketActivityCount,omitempty"` // A count of TicketAttachmentReferenceCount *uint `json:"ticketAttachmentReferenceCount,omitempty" xmlrpc:"ticketAttachmentReferenceCount,omitempty"` // no documentation yet TicketAttachmentReferences []Ticket_Attachment `json:"ticketAttachmentReferences,omitempty" xmlrpc:"ticketAttachmentReferences,omitempty"` // A representation of a SoftLayer employee's username. Username *string `json:"username,omitempty" xmlrpc:"username,omitempty"` }
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.
type User_Employee_Department ¶
type User_Employee_Department struct { Entity // The name of one of SoftLayer's employee departments. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
SoftLayer_User_Employee_Department models a department within SoftLayer's internal employee hierarchy. Common departments include Support, Sales, Accounting, Development, Systems, and Networking.
type User_External_Binding ¶
type User_External_Binding struct { Entity // The flag that determines whether the external binding is active will be used for authentication or not. Active *bool `json:"active,omitempty" xmlrpc:"active,omitempty"` // A count of attributes of an external authentication binding. AttributeCount *uint `json:"attributeCount,omitempty" xmlrpc:"attributeCount,omitempty"` // Attributes of an external authentication binding. Attributes []User_External_Binding_Attribute `json:"attributes,omitempty" xmlrpc:"attributes,omitempty"` // Information regarding the billing item for external authentication. BillingItem *Billing_Item `json:"billingItem,omitempty" xmlrpc:"billingItem,omitempty"` // The date that the external authentication binding was created. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // The identifier used to identify this binding to an external authentication source. ExternalId *string `json:"externalId,omitempty" xmlrpc:"externalId,omitempty"` // An external authentication binding's internal identifier. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // An optional note for identifying the external binding. Note *string `json:"note,omitempty" xmlrpc:"note,omitempty"` // The password used to authenticate the external id at an external authentication source. Password *string `json:"password,omitempty" xmlrpc:"password,omitempty"` // The type of external authentication binding. Type *User_External_Binding_Type `json:"type,omitempty" xmlrpc:"type,omitempty"` // The [[SoftLayer_User_External_Binding_Type|type]] identifier of an external authentication binding. TypeId *int `json:"typeId,omitempty" xmlrpc:"typeId,omitempty"` // An external authentication binding's associated [[SoftLayer_User_Customer|user account]] id. UserId *int `json:"userId,omitempty" xmlrpc:"userId,omitempty"` // The vendor of an external authentication binding. Vendor *User_External_Binding_Vendor `json:"vendor,omitempty" xmlrpc:"vendor,omitempty"` // The [[SoftLayer_User_External_Binding_Vendor|vendor]] identifier of an external authentication binding. VendorId *int `json:"vendorId,omitempty" xmlrpc:"vendorId,omitempty"` }
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.
type User_External_Binding_Attribute ¶
type User_External_Binding_Attribute struct { Entity // The external authentication binding an attribute belongs to. ExternalBinding *User_External_Binding `json:"externalBinding,omitempty" xmlrpc:"externalBinding,omitempty"` // The value of an external binding attribute. Value *string `json:"value,omitempty" xmlrpc:"value,omitempty"` }
The SoftLayer_User_External_Binding_Attribute data type contains the value for a single attribute associated with an external binding. External binding attributes contain additional information about an external binding. An attribute can be generic or specific to a 3rd party vendor. For example these attributes relate to Verisign: *Credential Type *Credential State *Credential Expiration Date *Credential Last Update Date
type User_External_Binding_Type ¶
type User_External_Binding_Type struct { Entity // The unique name used to identify a type of external authentication binding. KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // The user friendly name of a type of external authentication binding. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
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.
type User_External_Binding_Vendor ¶
type User_External_Binding_Vendor struct { Entity // The unique identifier for an external binding vendor. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A unique version of the name property. KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // The user friendly name of an external binding vendor. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
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.
type User_Interface ¶
type User_Interface struct {
Entity
}
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.
type User_Permission_Action ¶
type User_Permission_Action struct { Entity // no documentation yet CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // no documentation yet Department *User_Permission_Department `json:"department,omitempty" xmlrpc:"department,omitempty"` // no documentation yet DepartmentId *int `json:"departmentId,omitempty" xmlrpc:"departmentId,omitempty"` // no documentation yet Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet // Deprecated: This function has been marked as deprecated. Key *string `json:"key,omitempty" xmlrpc:"key,omitempty"` // no documentation yet KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // no documentation yet ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
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.
type User_Permission_Department ¶ added in v1.1.5
type User_Permission_Department struct { Entity // Department description Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // Department primary identifier Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Department key name KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // Department readable name Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // A count of PermissionCount *uint `json:"permissionCount,omitempty" xmlrpc:"permissionCount,omitempty"` // no documentation yet Permissions []User_Permission_Action `json:"permissions,omitempty" xmlrpc:"permissions,omitempty"` }
no documentation yet
type User_Permission_Group ¶
type User_Permission_Group struct { Entity // no documentation yet Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // A permission groups associated [[SoftLayer_Account|customer account]] id. AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // A count of ActionCount *uint `json:"actionCount,omitempty" xmlrpc:"actionCount,omitempty"` // no documentation yet Actions []User_Permission_Action `json:"actions,omitempty" xmlrpc:"actions,omitempty"` // The date the permission group record was created. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // The description of the permission group. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // The date the group will be destroyed. ExpirationDate *Time `json:"expirationDate,omitempty" xmlrpc:"expirationDate,omitempty"` // A permission groups internal identifying number. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The date the permission group record was last modified. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // The name of the permission group. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // A count of RoleCount *uint `json:"roleCount,omitempty" xmlrpc:"roleCount,omitempty"` // no documentation yet Roles []User_Permission_Role `json:"roles,omitempty" xmlrpc:"roles,omitempty"` // The type of the permission group. Type *User_Permission_Group_Type `json:"type,omitempty" xmlrpc:"type,omitempty"` // The type of permission group. TypeId *int `json:"typeId,omitempty" xmlrpc:"typeId,omitempty"` }
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.
type User_Permission_Group_Type ¶
type User_Permission_Group_Type struct { Entity // A count of the groups that are of this type. GroupCount *uint `json:"groupCount,omitempty" xmlrpc:"groupCount,omitempty"` // The groups that are of this type. Groups []User_Permission_Group `json:"groups,omitempty" xmlrpc:"groups,omitempty"` // Unique Record ID. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The keyname for the group type. KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // A descriptive name for the group type. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
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]].
type User_Permission_Resource_Type ¶ added in v1.0.3
type User_Permission_Resource_Type struct { Entity // The associated IMS class name for a resource type. ClassName *string `json:"className,omitempty" xmlrpc:"className,omitempty"` // Resource Type record ID. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Descriptive Identifier for a Resource Type. A key name contains no spaces, but may use underscores. KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // A name for the resource type. It is the most descriptive variable of the resource type and can include spaces. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
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]].
type User_Permission_Role ¶
type User_Permission_Role struct { Entity // no documentation yet Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // Id of a [[SoftLayer_Account]] to which this role belongs. AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // A count of ActionCount *uint `json:"actionCount,omitempty" xmlrpc:"actionCount,omitempty"` // no documentation yet Actions []User_Permission_Action `json:"actions,omitempty" xmlrpc:"actions,omitempty"` // The date the permission role record was created. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // The description of the permission role. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // A count of GroupCount *uint `json:"groupCount,omitempty" xmlrpc:"groupCount,omitempty"` // no documentation yet Groups []User_Permission_Group `json:"groups,omitempty" xmlrpc:"groups,omitempty"` // A permission roles internal identifying number. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The date the permission role record was last modified. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // The name of the permission role. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // A flag showing if new users should be automatically added to this role. NewUserDefaultFlag *int `json:"newUserDefaultFlag,omitempty" xmlrpc:"newUserDefaultFlag,omitempty"` // 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. SystemFlag *int `json:"systemFlag,omitempty" xmlrpc:"systemFlag,omitempty"` // A count of UserCount *uint `json:"userCount,omitempty" xmlrpc:"userCount,omitempty"` // no documentation yet Users []User_Customer `json:"users,omitempty" xmlrpc:"users,omitempty"` }
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.
type User_Preference ¶
type User_Preference struct { Entity // Description of the user preference Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // Type of user preference Type *User_Preference_Type `json:"type,omitempty" xmlrpc:"type,omitempty"` // The users current preference value Value *string `json:"value,omitempty" xmlrpc:"value,omitempty"` }
The SoftLayer_User_Preference data type contains a single user preference to a specific preference type.
type User_Preference_Type ¶
type User_Preference_Type struct { Entity // A description of the preference type Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // no documentation yet KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // The name of the preference type Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // An example of accepted preference values ValueExample *string `json:"valueExample,omitempty" xmlrpc:"valueExample,omitempty"` }
The SoftLayer_User_Preference_Type data type contains a single preference type including the accepted values.
type User_Security_Question ¶
type User_Security_Question struct { Entity // A security question's display order. DisplayOrder *int `json:"displayOrder,omitempty" xmlrpc:"displayOrder,omitempty"` // A security question's internal identifying number. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A security question's question. Question *string `json:"question,omitempty" xmlrpc:"question,omitempty"` // A security question's viewable flag. Viewable *int `json:"viewable,omitempty" xmlrpc:"viewable,omitempty"` }
The SoftLayer_User_Security_Question data type contains questions.
type Utility_ObjectFilter_Operation ¶
type Utility_ObjectFilter_Operation struct {
Entity
}
no documentation yet
type Utility_ObjectFilter_Operation_Option ¶
type Utility_ObjectFilter_Operation_Option struct {
Entity
}
no documentation yet
type Vendor_Type ¶ added in v1.0.4
type Vendor_Type struct { Entity // no documentation yet Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` }
no documentation yet
type Verify_Api_HttpObj ¶ added in v1.1.3
type Verify_Api_HttpObj struct { Entity // no documentation yet CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // no documentation yet TestString *string `json:"testString,omitempty" xmlrpc:"testString,omitempty"` }
no documentation yet
type Verify_Api_HttpsObj ¶ added in v1.1.3
type Verify_Api_HttpsObj struct { Entity // no documentation yet CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // no documentation yet TestString *string `json:"testString,omitempty" xmlrpc:"testString,omitempty"` }
no documentation yet
type Virtual_BrowserConsoleAccessLog ¶ added in v1.0.4
type Virtual_BrowserConsoleAccessLog struct { Entity // Date created CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // The event type that was triggered EventType *string `json:"eventType,omitempty" xmlrpc:"eventType,omitempty"` // Unique ID for a console log event instance. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The message for the event Message *string `json:"message,omitempty" xmlrpc:"message,omitempty"` // Date modified ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // The IP address of the client that triggered the event SourceIp *string `json:"sourceIp,omitempty" xmlrpc:"sourceIp,omitempty"` // The IP port of the client that triggered the event SourcePort *int `json:"sourcePort,omitempty" xmlrpc:"sourcePort,omitempty"` // The user id that triggered the event UserId *int `json:"userId,omitempty" xmlrpc:"userId,omitempty"` // The user type that triggered the event UserType *string `json:"userType,omitempty" xmlrpc:"userType,omitempty"` // The username of the user that triggered the event Username *string `json:"username,omitempty" xmlrpc:"username,omitempty"` }
The SoftLayer_Virtual_BrowserConsoleAccessLog data type presents the data for events associated with accessing a VSIs console via the browser interface.
type Virtual_DedicatedHost ¶
type Virtual_DedicatedHost struct { Entity // The account that the dedicated host belongs to. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // The dedicated host's associated account id. AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // The container that represents allocations on the dedicated host. AllocationStatus *Container_Virtual_DedicatedHost_AllocationStatus `json:"allocationStatus,omitempty" xmlrpc:"allocationStatus,omitempty"` // The backend router behind dedicated host's pool of resources. BackendRouter *Hardware_Router_Backend `json:"backendRouter,omitempty" xmlrpc:"backendRouter,omitempty"` // The billing item for the dedicated host. BillingItem *Billing_Item_Virtual_DedicatedHost `json:"billingItem,omitempty" xmlrpc:"billingItem,omitempty"` // The capacity that the dedicated host's CPU allocation is restricted to. CpuCount *int `json:"cpuCount,omitempty" xmlrpc:"cpuCount,omitempty"` // The date that the dedicated host was created. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // The datacenter that the dedicated host resides in. Datacenter *Location `json:"datacenter,omitempty" xmlrpc:"datacenter,omitempty"` // The capacity that the dedicated host's disk allocation is restricted to. DiskCapacity *int `json:"diskCapacity,omitempty" xmlrpc:"diskCapacity,omitempty"` // A count of the guests associated with the dedicated host. GuestCount *uint `json:"guestCount,omitempty" xmlrpc:"guestCount,omitempty"` // The guests associated with the dedicated host. Guests []Virtual_Guest `json:"guests,omitempty" xmlrpc:"guests,omitempty"` // The dedicated host's associated unique id. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A count of InternalTagReferenceCount *uint `json:"internalTagReferenceCount,omitempty" xmlrpc:"internalTagReferenceCount,omitempty"` // no documentation yet InternalTagReferences []Tag_Reference `json:"internalTagReferences,omitempty" xmlrpc:"internalTagReferences,omitempty"` // The capacity that the dedicated host's memory allocation is restricted to. MemoryCapacity *int `json:"memoryCapacity,omitempty" xmlrpc:"memoryCapacity,omitempty"` // The date that the dedicated host was last modified. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // The dedicated host's name. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // A note of up to 1,000 characters about a dedicated host. Notes *string `json:"notes,omitempty" xmlrpc:"notes,omitempty"` // The container that represents PCI device allocations on the dedicated host. PciDeviceAllocationStatus *Container_Virtual_DedicatedHost_Pci_Device_AllocationStatus `json:"pciDeviceAllocationStatus,omitempty" xmlrpc:"pciDeviceAllocationStatus,omitempty"` // A count of a collection of SoftLayer_Virtual_Host_PciDevice objects on the host. PciDeviceCount *uint `json:"pciDeviceCount,omitempty" xmlrpc:"pciDeviceCount,omitempty"` // A collection of SoftLayer_Virtual_Host_PciDevice objects on the host. PciDevices []Virtual_Host_PciDevice `json:"pciDevices,omitempty" xmlrpc:"pciDevices,omitempty"` // A count of TagReferenceCount *uint `json:"tagReferenceCount,omitempty" xmlrpc:"tagReferenceCount,omitempty"` // no documentation yet TagReferences []Tag_Reference `json:"tagReferences,omitempty" xmlrpc:"tagReferences,omitempty"` }
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.
type Virtual_Disk_Image ¶
type Virtual_Disk_Image struct { Entity // The billing item for a virtual disk image. BillingItem *Billing_Item_Virtual_Disk_Image `json:"billingItem,omitempty" xmlrpc:"billingItem,omitempty"` // A count of the block devices that a disk image is attached to. Block devices connect computing instances to disk images. BlockDeviceCount *uint `json:"blockDeviceCount,omitempty" xmlrpc:"blockDeviceCount,omitempty"` // The block devices that a disk image is attached to. Block devices connect computing instances to disk images. BlockDevices []Virtual_Guest_Block_Device `json:"blockDevices,omitempty" xmlrpc:"blockDevices,omitempty"` // no documentation yet BootableVolumeFlag *bool `json:"bootableVolumeFlag,omitempty" xmlrpc:"bootableVolumeFlag,omitempty"` // A disk image's size measured in gigabytes. Capacity *int `json:"capacity,omitempty" xmlrpc:"capacity,omitempty"` // A disk image's unique md5 checksum. Checksum *string `json:"checksum,omitempty" xmlrpc:"checksum,omitempty"` // A column to save the Algorithm being used to store the checksum. ChecksumAlgorithm *string `json:"checksumAlgorithm,omitempty" xmlrpc:"checksumAlgorithm,omitempty"` // Check if cloud-init is enabled. CloudInitFlag *bool `json:"cloudInitFlag,omitempty" xmlrpc:"cloudInitFlag,omitempty"` // A count of CoalescedDiskImageCount *uint `json:"coalescedDiskImageCount,omitempty" xmlrpc:"coalescedDiskImageCount,omitempty"` // no documentation yet CoalescedDiskImages []Virtual_Disk_Image `json:"coalescedDiskImages,omitempty" xmlrpc:"coalescedDiskImages,omitempty"` // no documentation yet CopyOnWriteFlag *bool `json:"copyOnWriteFlag,omitempty" xmlrpc:"copyOnWriteFlag,omitempty"` // The date a disk image was created. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // A brief description of a virtual disk image. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // Return disk file extension DiskFileExtension *string `json:"diskFileExtension,omitempty" xmlrpc:"diskFileExtension,omitempty"` // no documentation yet DiskImageStorageGroup *Configuration_Storage_Group `json:"diskImageStorageGroup,omitempty" xmlrpc:"diskImageStorageGroup,omitempty"` // A disk image's unique ID. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Return imported disk type ImportedDiskType *string `json:"importedDiskType,omitempty" xmlrpc:"importedDiskType,omitempty"` // Return if image is encrypted IsEncrypted *bool `json:"isEncrypted,omitempty" xmlrpc:"isEncrypted,omitempty"` // no documentation yet LocalDiskFlag *bool `json:"localDiskFlag,omitempty" xmlrpc:"localDiskFlag,omitempty"` // Whether this disk image is meant for storage of custom user data supplied with a Cloud Computing Instance order. MetadataFlag *bool `json:"metadataFlag,omitempty" xmlrpc:"metadataFlag,omitempty"` // The date a disk image was last modified. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // A descriptive name used to identify a disk image to a user. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // The ID of the the disk image that this disk image is based on, if applicable. ParentId *int `json:"parentId,omitempty" xmlrpc:"parentId,omitempty"` // A count of references to the software that resides on a disk image. SoftwareReferenceCount *uint `json:"softwareReferenceCount,omitempty" xmlrpc:"softwareReferenceCount,omitempty"` // References to the software that resides on a disk image. SoftwareReferences []Virtual_Disk_Image_Software `json:"softwareReferences,omitempty" xmlrpc:"softwareReferences,omitempty"` // The original disk image that the current disk image was cloned from. SourceDiskImage *Virtual_Disk_Image `json:"sourceDiskImage,omitempty" xmlrpc:"sourceDiskImage,omitempty"` // A count of the storage group for a virtual disk image. StorageGroupCount *uint `json:"storageGroupCount,omitempty" xmlrpc:"storageGroupCount,omitempty"` // Return storage group details for symantec disk StorageGroupDetails *Container_Image_StorageGroupDetails `json:"storageGroupDetails,omitempty" xmlrpc:"storageGroupDetails,omitempty"` // The storage group for a virtual disk image. StorageGroups []Configuration_Storage_Group `json:"storageGroups,omitempty" xmlrpc:"storageGroups,omitempty"` // The storage repository that a disk image resides in. StorageRepository *Virtual_Storage_Repository `json:"storageRepository,omitempty" xmlrpc:"storageRepository,omitempty"` // The [[SoftLayer_Virtual_Storage_Repository|storage repository]] that a disk image is in. StorageRepositoryId *int `json:"storageRepositoryId,omitempty" xmlrpc:"storageRepositoryId,omitempty"` // The type of storage repository that a disk image resides in. StorageRepositoryType *Virtual_Storage_Repository_Type `json:"storageRepositoryType,omitempty" xmlrpc:"storageRepositoryType,omitempty"` // Return supported hardware component IDs for symantec disk SupportedHardware *string `json:"supportedHardware,omitempty" xmlrpc:"supportedHardware,omitempty"` // The template that attaches a disk image to a [[SoftLayer_Virtual_Guest_Block_Device_Template_Group|archive]]. TemplateBlockDevice *Virtual_Guest_Block_Device_Template `json:"templateBlockDevice,omitempty" xmlrpc:"templateBlockDevice,omitempty"` // A virtual disk image's type. Type *Virtual_Disk_Image_Type `json:"type,omitempty" xmlrpc:"type,omitempty"` // A disk image's [[SoftLayer_Virtual_Disk_Image_Type|type]] ID TypeId *int `json:"typeId,omitempty" xmlrpc:"typeId,omitempty"` // The unit of storage in which the size of the image is measured. Defaults to "GB" for gigabytes. Units *string `json:"units,omitempty" xmlrpc:"units,omitempty"` // A disk image's unique ID on a virtualization platform. Uuid *string `json:"uuid,omitempty" xmlrpc:"uuid,omitempty"` }
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.
type Virtual_Disk_Image_Software ¶
type Virtual_Disk_Image_Software struct { Entity // The virtual disk image that is associated with software. DiskImage *Virtual_Disk_Image `json:"diskImage,omitempty" xmlrpc:"diskImage,omitempty"` // The unique identifier of a virtual disk image to software relationship. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A count of username/Password pairs used for access to a Software Installation. PasswordCount *uint `json:"passwordCount,omitempty" xmlrpc:"passwordCount,omitempty"` // Username/Password pairs used for access to a Software Installation. Passwords []Virtual_Disk_Image_Software_Password `json:"passwords,omitempty" xmlrpc:"passwords,omitempty"` // The software associated with a virtual disk image. SoftwareDescription *Software_Description `json:"softwareDescription,omitempty" xmlrpc:"softwareDescription,omitempty"` // The unique identifier of the software that a virtual disk image is associated with. SoftwareDescriptionId *int `json:"softwareDescriptionId,omitempty" xmlrpc:"softwareDescriptionId,omitempty"` }
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.
type Virtual_Disk_Image_Software_Password ¶
type Virtual_Disk_Image_Software_Password struct { Entity // A virtual disk images' password. Password *string `json:"password,omitempty" xmlrpc:"password,omitempty"` // The instance that this username/password pair is valid for. Software *Virtual_Disk_Image_Software `json:"software,omitempty" xmlrpc:"software,omitempty"` // A virtual disk images' username. Username *string `json:"username,omitempty" xmlrpc:"username,omitempty"` }
This SoftLayer_Virtual_Disk_Image_Software_Password data type contains a password for a specific virtual disk image software instance.
type Virtual_Disk_Image_Type ¶
type Virtual_Disk_Image_Type struct { Entity // A brief description of a virtual disk image type's function. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // A virtual disk image type's key name. KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // A virtual disk image type's name. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
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.
type Virtual_Guest ¶
type Virtual_Guest struct { Entity // The account that a virtual guest belongs to. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // A computing instance's associated [[SoftLayer_Account|account]] id AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // no documentation yet AccountOwnedPoolFlag *bool `json:"accountOwnedPoolFlag,omitempty" xmlrpc:"accountOwnedPoolFlag,omitempty"` // A virtual guest's currently active network monitoring incidents. ActiveNetworkMonitorIncident []Network_Monitor_Version1_Incident `json:"activeNetworkMonitorIncident,omitempty" xmlrpc:"activeNetworkMonitorIncident,omitempty"` // A count of a virtual guest's currently active network monitoring incidents. ActiveNetworkMonitorIncidentCount *uint `json:"activeNetworkMonitorIncidentCount,omitempty" xmlrpc:"activeNetworkMonitorIncidentCount,omitempty"` // A count of ActiveTicketCount *uint `json:"activeTicketCount,omitempty" xmlrpc:"activeTicketCount,omitempty"` // no documentation yet ActiveTickets []Ticket `json:"activeTickets,omitempty" xmlrpc:"activeTickets,omitempty"` // A transaction that is still be performed on a cloud server. ActiveTransaction *Provisioning_Version1_Transaction `json:"activeTransaction,omitempty" xmlrpc:"activeTransaction,omitempty"` // A count of any active transaction(s) that are currently running for the server (example: os reload). ActiveTransactionCount *uint `json:"activeTransactionCount,omitempty" xmlrpc:"activeTransactionCount,omitempty"` // Any active transaction(s) that are currently running for the server (example: os reload). ActiveTransactions []Provisioning_Version1_Transaction `json:"activeTransactions,omitempty" xmlrpc:"activeTransactions,omitempty"` // The SoftLayer_Network_Storage_Allowed_Host information to connect this Virtual Guest to Network Storage volumes that require access control lists. AllowedHost *Network_Storage_Allowed_Host `json:"allowedHost,omitempty" xmlrpc:"allowedHost,omitempty"` // The SoftLayer_Network_Storage objects that this SoftLayer_Virtual_Guest has access to. AllowedNetworkStorage []Network_Storage `json:"allowedNetworkStorage,omitempty" xmlrpc:"allowedNetworkStorage,omitempty"` // A count of the SoftLayer_Network_Storage objects that this SoftLayer_Virtual_Guest has access to. AllowedNetworkStorageCount *uint `json:"allowedNetworkStorageCount,omitempty" xmlrpc:"allowedNetworkStorageCount,omitempty"` // A count of the SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Virtual_Guest has access to. AllowedNetworkStorageReplicaCount *uint `json:"allowedNetworkStorageReplicaCount,omitempty" xmlrpc:"allowedNetworkStorageReplicaCount,omitempty"` // The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Virtual_Guest has access to. AllowedNetworkStorageReplicas []Network_Storage `json:"allowedNetworkStorageReplicas,omitempty" xmlrpc:"allowedNetworkStorageReplicas,omitempty"` // A antivirus / spyware software component object. AntivirusSpywareSoftwareComponent *Software_Component `json:"antivirusSpywareSoftwareComponent,omitempty" xmlrpc:"antivirusSpywareSoftwareComponent,omitempty"` // no documentation yet ApplicationDeliveryController *Network_Application_Delivery_Controller `json:"applicationDeliveryController,omitempty" xmlrpc:"applicationDeliveryController,omitempty"` // A count of AttributeCount *uint `json:"attributeCount,omitempty" xmlrpc:"attributeCount,omitempty"` // no documentation yet Attributes []Virtual_Guest_Attribute `json:"attributes,omitempty" xmlrpc:"attributes,omitempty"` // An object that stores the maximum level for the monitoring query types and response types. AvailableMonitoring []Network_Monitor_Version1_Query_Host_Stratum `json:"availableMonitoring,omitempty" xmlrpc:"availableMonitoring,omitempty"` // A count of an object that stores the maximum level for the monitoring query types and response types. AvailableMonitoringCount *uint `json:"availableMonitoringCount,omitempty" xmlrpc:"availableMonitoringCount,omitempty"` // The average daily private bandwidth usage for the current billing cycle. AverageDailyPrivateBandwidthUsage *Float64 `json:"averageDailyPrivateBandwidthUsage,omitempty" xmlrpc:"averageDailyPrivateBandwidthUsage,omitempty"` // The average daily public bandwidth usage for the current billing cycle. AverageDailyPublicBandwidthUsage *Float64 `json:"averageDailyPublicBandwidthUsage,omitempty" xmlrpc:"averageDailyPublicBandwidthUsage,omitempty"` // A count of a guests's backend network components. BackendNetworkComponentCount *uint `json:"backendNetworkComponentCount,omitempty" xmlrpc:"backendNetworkComponentCount,omitempty"` // A guests's backend network components. BackendNetworkComponents []Virtual_Guest_Network_Component `json:"backendNetworkComponents,omitempty" xmlrpc:"backendNetworkComponents,omitempty"` // A count of a guest's backend or private router. BackendRouterCount *uint `json:"backendRouterCount,omitempty" xmlrpc:"backendRouterCount,omitempty"` // A guest's backend or private router. BackendRouters []Hardware `json:"backendRouters,omitempty" xmlrpc:"backendRouters,omitempty"` // A computing instance's allotted bandwidth (measured in GB). BandwidthAllocation *Float64 `json:"bandwidthAllocation,omitempty" xmlrpc:"bandwidthAllocation,omitempty"` // A computing instance's allotted detail record. Allotment details link bandwidth allocation with allotments. BandwidthAllotmentDetail *Network_Bandwidth_Version1_Allotment_Detail `json:"bandwidthAllotmentDetail,omitempty" xmlrpc:"bandwidthAllotmentDetail,omitempty"` // The raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to. BillingCycleBandwidthUsage []Network_Bandwidth_Usage `json:"billingCycleBandwidthUsage,omitempty" xmlrpc:"billingCycleBandwidthUsage,omitempty"` // 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. BillingCycleBandwidthUsageCount *uint `json:"billingCycleBandwidthUsageCount,omitempty" xmlrpc:"billingCycleBandwidthUsageCount,omitempty"` // The raw private bandwidth usage data for the current billing cycle. BillingCyclePrivateBandwidthUsage *Network_Bandwidth_Usage `json:"billingCyclePrivateBandwidthUsage,omitempty" xmlrpc:"billingCyclePrivateBandwidthUsage,omitempty"` // The raw public bandwidth usage data for the current billing cycle. BillingCyclePublicBandwidthUsage *Network_Bandwidth_Usage `json:"billingCyclePublicBandwidthUsage,omitempty" xmlrpc:"billingCyclePublicBandwidthUsage,omitempty"` // The billing item for a CloudLayer Compute Instance. BillingItem *Billing_Item_Virtual_Guest `json:"billingItem,omitempty" xmlrpc:"billingItem,omitempty"` // Determines whether the instance is ineligible for cancellation because it is disconnected. BlockCancelBecauseDisconnectedFlag *bool `json:"blockCancelBecauseDisconnectedFlag,omitempty" xmlrpc:"blockCancelBecauseDisconnectedFlag,omitempty"` // A count of a computing instance's block devices. Block devices link [[SoftLayer_Virtual_Disk_Image|disk images]] to computing instances. BlockDeviceCount *uint `json:"blockDeviceCount,omitempty" xmlrpc:"blockDeviceCount,omitempty"` // The global identifier for the image template that was used to provision or reload a guest. BlockDeviceTemplateGroup *Virtual_Guest_Block_Device_Template_Group `json:"blockDeviceTemplateGroup,omitempty" xmlrpc:"blockDeviceTemplateGroup,omitempty"` // A computing instance's block devices. Block devices link [[SoftLayer_Virtual_Disk_Image|disk images]] to computing instances. BlockDevices []Virtual_Guest_Block_Device `json:"blockDevices,omitempty" xmlrpc:"blockDevices,omitempty"` // A count of a virtual guest's browser access logs. BrowserConsoleAccessLogCount *uint `json:"browserConsoleAccessLogCount,omitempty" xmlrpc:"browserConsoleAccessLogCount,omitempty"` // A virtual guest's browser access logs. BrowserConsoleAccessLogs []Virtual_BrowserConsoleAccessLog `json:"browserConsoleAccessLogs,omitempty" xmlrpc:"browserConsoleAccessLogs,omitempty"` // A container for a guest's console data ConsoleData *Container_Virtual_ConsoleData `json:"consoleData,omitempty" xmlrpc:"consoleData,omitempty"` // [DEPRECATED] A flag indicating a computing instance's console IP address is assigned. // Deprecated: This function has been marked as deprecated. ConsoleIpAddressFlag *bool `json:"consoleIpAddressFlag,omitempty" xmlrpc:"consoleIpAddressFlag,omitempty"` // [DEPRECATED] A record containing information about a computing instance's console IP and port number. // Deprecated: This function has been marked as deprecated. ConsoleIpAddressRecord *Virtual_Guest_Network_Component_IpAddress `json:"consoleIpAddressRecord,omitempty" xmlrpc:"consoleIpAddressRecord,omitempty"` // A continuous data protection software component object. ContinuousDataProtectionSoftwareComponent *Software_Component `json:"continuousDataProtectionSoftwareComponent,omitempty" xmlrpc:"continuousDataProtectionSoftwareComponent,omitempty"` // A guest's control panel. ControlPanel *Software_Component `json:"controlPanel,omitempty" xmlrpc:"controlPanel,omitempty"` // The date a virtual computing instance was created. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // An object that provides commonly used bandwidth summary components for the current billing cycle. CurrentBandwidthSummary *Metric_Tracking_Object_Bandwidth_Summary `json:"currentBandwidthSummary,omitempty" xmlrpc:"currentBandwidthSummary,omitempty"` // The datacenter that a virtual guest resides in. Datacenter *Location `json:"datacenter,omitempty" xmlrpc:"datacenter,omitempty"` // When true this flag specifies that a compute instance is to run on hosts that only have guests from the same account. DedicatedAccountHostOnlyFlag *bool `json:"dedicatedAccountHostOnlyFlag,omitempty" xmlrpc:"dedicatedAccountHostOnlyFlag,omitempty"` // The dedicated host associated with this guest. DedicatedHost *Virtual_DedicatedHost `json:"dedicatedHost,omitempty" xmlrpc:"dedicatedHost,omitempty"` // The device status of this virtual guest. DeviceStatus *Device_Status `json:"deviceStatus,omitempty" xmlrpc:"deviceStatus,omitempty"` // The device status ID of the virtual guest. DeviceStatusId *int `json:"deviceStatusId,omitempty" xmlrpc:"deviceStatusId,omitempty"` // A computing instance's domain name Domain *string `json:"domain,omitempty" xmlrpc:"domain,omitempty"` // A guest's associated EVault network storage service account. EvaultNetworkStorage []Network_Storage `json:"evaultNetworkStorage,omitempty" xmlrpc:"evaultNetworkStorage,omitempty"` // A count of a guest's associated EVault network storage service account. EvaultNetworkStorageCount *uint `json:"evaultNetworkStorageCount,omitempty" xmlrpc:"evaultNetworkStorageCount,omitempty"` // A computing instance's hardware firewall services. FirewallServiceComponent *Network_Component_Firewall `json:"firewallServiceComponent,omitempty" xmlrpc:"firewallServiceComponent,omitempty"` // A count of a guest's frontend network components. FrontendNetworkComponentCount *uint `json:"frontendNetworkComponentCount,omitempty" xmlrpc:"frontendNetworkComponentCount,omitempty"` // A guest's frontend network components. FrontendNetworkComponents []Virtual_Guest_Network_Component `json:"frontendNetworkComponents,omitempty" xmlrpc:"frontendNetworkComponents,omitempty"` // A guest's frontend or public router. FrontendRouters *Hardware `json:"frontendRouters,omitempty" xmlrpc:"frontendRouters,omitempty"` // A name reflecting the hostname and domain of the computing instance. FullyQualifiedDomainName *string `json:"fullyQualifiedDomainName,omitempty" xmlrpc:"fullyQualifiedDomainName,omitempty"` // A guest's universally unique identifier. GlobalIdentifier *string `json:"globalIdentifier,omitempty" xmlrpc:"globalIdentifier,omitempty"` // The number of GPUs attached to the guest. GpuCount *int `json:"gpuCount,omitempty" xmlrpc:"gpuCount,omitempty"` // The name of the GPU type attached to the guest. GpuType *string `json:"gpuType,omitempty" xmlrpc:"gpuType,omitempty"` // no documentation yet GuestBootParameter *Virtual_Guest_Boot_Parameter `json:"guestBootParameter,omitempty" xmlrpc:"guestBootParameter,omitempty"` // The object's function. HardwareFunctionDescription *string `json:"hardwareFunctionDescription,omitempty" xmlrpc:"hardwareFunctionDescription,omitempty"` // The virtual host on which a virtual guest resides (available only on private clouds). Host *Virtual_Host `json:"host,omitempty" xmlrpc:"host,omitempty"` // A host IPS software component object. HostIpsSoftwareComponent *Software_Component `json:"hostIpsSoftwareComponent,omitempty" xmlrpc:"hostIpsSoftwareComponent,omitempty"` // A virtual computing instance's hostname Hostname *string `json:"hostname,omitempty" xmlrpc:"hostname,omitempty"` // A guest's hourly billing status. HourlyBillingFlag *bool `json:"hourlyBillingFlag,omitempty" xmlrpc:"hourlyBillingFlag,omitempty"` // Unique ID for a computing instance. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The total private inbound bandwidth for this computing instance for the current billing cycle. InboundPrivateBandwidthUsage *Float64 `json:"inboundPrivateBandwidthUsage,omitempty" xmlrpc:"inboundPrivateBandwidthUsage,omitempty"` // The total public inbound bandwidth for this computing instance for the current billing cycle. InboundPublicBandwidthUsage *Float64 `json:"inboundPublicBandwidthUsage,omitempty" xmlrpc:"inboundPublicBandwidthUsage,omitempty"` // A count of InternalTagReferenceCount *uint `json:"internalTagReferenceCount,omitempty" xmlrpc:"internalTagReferenceCount,omitempty"` // no documentation yet InternalTagReferences []Tag_Reference `json:"internalTagReferences,omitempty" xmlrpc:"internalTagReferences,omitempty"` // The last known power state of a virtual guest in the event the guest is turned off outside of IMS or has gone offline. LastKnownPowerState *Virtual_Guest_Power_State `json:"lastKnownPowerState,omitempty" xmlrpc:"lastKnownPowerState,omitempty"` // The last transaction that a cloud server's operating system was loaded. LastOperatingSystemReload *Provisioning_Version1_Transaction `json:"lastOperatingSystemReload,omitempty" xmlrpc:"lastOperatingSystemReload,omitempty"` // no documentation yet LastPowerStateId *int `json:"lastPowerStateId,omitempty" xmlrpc:"lastPowerStateId,omitempty"` // The last transaction a cloud server had performed. LastTransaction *Provisioning_Version1_Transaction `json:"lastTransaction,omitempty" xmlrpc:"lastTransaction,omitempty"` // The last timestamp of when the guest was verified as a resident virtual machine on the host's hypervisor platform. LastVerifiedDate *Time `json:"lastVerifiedDate,omitempty" xmlrpc:"lastVerifiedDate,omitempty"` // A virtual guest's latest network monitoring incident. LatestNetworkMonitorIncident *Network_Monitor_Version1_Incident `json:"latestNetworkMonitorIncident,omitempty" xmlrpc:"latestNetworkMonitorIncident,omitempty"` // 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. LocalDiskFlag *bool `json:"localDiskFlag,omitempty" xmlrpc:"localDiskFlag,omitempty"` // Where guest is located within SoftLayer's location hierarchy. Location *Location `json:"location,omitempty" xmlrpc:"location,omitempty"` // A flag indicating that the virtual guest is a managed resource. ManagedResourceFlag *bool `json:"managedResourceFlag,omitempty" xmlrpc:"managedResourceFlag,omitempty"` // The maximum amount of CPU resources a computing instance may utilize. MaxCpu *int `json:"maxCpu,omitempty" xmlrpc:"maxCpu,omitempty"` // The unit of the maximum amount of CPU resources a computing instance may utilize. MaxCpuUnits *string `json:"maxCpuUnits,omitempty" xmlrpc:"maxCpuUnits,omitempty"` // The maximum amount of memory a computing instance may utilize. MaxMemory *int `json:"maxMemory,omitempty" xmlrpc:"maxMemory,omitempty"` // The date of the most recent metric tracking poll performed. MetricPollDate *Time `json:"metricPollDate,omitempty" xmlrpc:"metricPollDate,omitempty"` // A guest's metric tracking object. MetricTrackingObject *Metric_Tracking_Object `json:"metricTrackingObject,omitempty" xmlrpc:"metricTrackingObject,omitempty"` // The metric tracking object id for this guest. MetricTrackingObjectId *int `json:"metricTrackingObjectId,omitempty" xmlrpc:"metricTrackingObjectId,omitempty"` // The date a virtual computing instance was last modified. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // no documentation yet MonitoringRobot *Monitoring_Robot `json:"monitoringRobot,omitempty" xmlrpc:"monitoringRobot,omitempty"` // A virtual guest's network monitoring services. MonitoringServiceComponent *Network_Monitor_Version1_Query_Host_Stratum `json:"monitoringServiceComponent,omitempty" xmlrpc:"monitoringServiceComponent,omitempty"` // no documentation yet MonitoringServiceEligibilityFlag *bool `json:"monitoringServiceEligibilityFlag,omitempty" xmlrpc:"monitoringServiceEligibilityFlag,omitempty"` // 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 MonitoringUserNotification []User_Customer_Notification_Virtual_Guest `json:"monitoringUserNotification,omitempty" xmlrpc:"monitoringUserNotification,omitempty"` // 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 MonitoringUserNotificationCount *uint `json:"monitoringUserNotificationCount,omitempty" xmlrpc:"monitoringUserNotificationCount,omitempty"` // A count of a guests's network components. NetworkComponentCount *uint `json:"networkComponentCount,omitempty" xmlrpc:"networkComponentCount,omitempty"` // A guests's network components. NetworkComponents []Virtual_Guest_Network_Component `json:"networkComponents,omitempty" xmlrpc:"networkComponents,omitempty"` // A count of a guests's network monitors. NetworkMonitorCount *uint `json:"networkMonitorCount,omitempty" xmlrpc:"networkMonitorCount,omitempty"` // A count of all of a virtual guest's network monitoring incidents. NetworkMonitorIncidentCount *uint `json:"networkMonitorIncidentCount,omitempty" xmlrpc:"networkMonitorIncidentCount,omitempty"` // All of a virtual guest's network monitoring incidents. NetworkMonitorIncidents []Network_Monitor_Version1_Incident `json:"networkMonitorIncidents,omitempty" xmlrpc:"networkMonitorIncidents,omitempty"` // A guests's network monitors. NetworkMonitors []Network_Monitor_Version1_Query_Host `json:"networkMonitors,omitempty" xmlrpc:"networkMonitors,omitempty"` // A guest's associated network storage accounts. NetworkStorage []Network_Storage `json:"networkStorage,omitempty" xmlrpc:"networkStorage,omitempty"` // A count of a guest's associated network storage accounts. NetworkStorageCount *uint `json:"networkStorageCount,omitempty" xmlrpc:"networkStorageCount,omitempty"` // A count of the network Vlans that a guest's network components are associated with. NetworkVlanCount *uint `json:"networkVlanCount,omitempty" xmlrpc:"networkVlanCount,omitempty"` // The network Vlans that a guest's network components are associated with. NetworkVlans []Network_Vlan `json:"networkVlans,omitempty" xmlrpc:"networkVlans,omitempty"` // A note of up to 1,000 characters about a virtual server. Notes *string `json:"notes,omitempty" xmlrpc:"notes,omitempty"` // An open ticket requesting cancellation of this server, if one exists. OpenCancellationTicket *Ticket `json:"openCancellationTicket,omitempty" xmlrpc:"openCancellationTicket,omitempty"` // A guest's operating system. OperatingSystem *Software_Component_OperatingSystem `json:"operatingSystem,omitempty" xmlrpc:"operatingSystem,omitempty"` // A guest's operating system software description. OperatingSystemReferenceCode *string `json:"operatingSystemReferenceCode,omitempty" xmlrpc:"operatingSystemReferenceCode,omitempty"` // The original package id provided with the order for a Cloud Computing Instance. OrderedPackageId *string `json:"orderedPackageId,omitempty" xmlrpc:"orderedPackageId,omitempty"` // The total private outbound bandwidth for this computing instance for the current billing cycle. OutboundPrivateBandwidthUsage *Float64 `json:"outboundPrivateBandwidthUsage,omitempty" xmlrpc:"outboundPrivateBandwidthUsage,omitempty"` // The total public outbound bandwidth for this computing instance for the current billing cycle. OutboundPublicBandwidthUsage *Float64 `json:"outboundPublicBandwidthUsage,omitempty" xmlrpc:"outboundPublicBandwidthUsage,omitempty"` // Whether the bandwidth usage for this computing instance for the current billing cycle exceeds the allocation. OverBandwidthAllocationFlag *int `json:"overBandwidthAllocationFlag,omitempty" xmlrpc:"overBandwidthAllocationFlag,omitempty"` // When true this virtual guest must be migrated using SoftLayer_Virtual_Guest::migrate. PendingMigrationFlag *bool `json:"pendingMigrationFlag,omitempty" xmlrpc:"pendingMigrationFlag,omitempty"` // The placement group that a virtual guest belongs to. PlacementGroup *Virtual_PlacementGroup `json:"placementGroup,omitempty" xmlrpc:"placementGroup,omitempty"` // The placement group ID that the virtual guest belongs to. PlacementGroupId *int `json:"placementGroupId,omitempty" xmlrpc:"placementGroupId,omitempty"` // URI of the script to be downloaded and executed after installation is complete. This is deprecated in favor of supplementalCreateObjectOptions' postInstallScriptUri. // Deprecated: This function has been marked as deprecated. PostInstallScriptUri *string `json:"postInstallScriptUri,omitempty" xmlrpc:"postInstallScriptUri,omitempty"` // The current power state of a virtual guest. PowerState *Virtual_Guest_Power_State `json:"powerState,omitempty" xmlrpc:"powerState,omitempty"` // A guest's primary private IP address. PrimaryBackendIpAddress *string `json:"primaryBackendIpAddress,omitempty" xmlrpc:"primaryBackendIpAddress,omitempty"` // A guest's primary backend network component. PrimaryBackendNetworkComponent *Virtual_Guest_Network_Component `json:"primaryBackendNetworkComponent,omitempty" xmlrpc:"primaryBackendNetworkComponent,omitempty"` // The guest's primary public IP address. PrimaryIpAddress *string `json:"primaryIpAddress,omitempty" xmlrpc:"primaryIpAddress,omitempty"` // A guest's primary public network component. PrimaryNetworkComponent *Virtual_Guest_Network_Component `json:"primaryNetworkComponent,omitempty" xmlrpc:"primaryNetworkComponent,omitempty"` // Whether the computing instance only has access to the private network. PrivateNetworkOnlyFlag *bool `json:"privateNetworkOnlyFlag,omitempty" xmlrpc:"privateNetworkOnlyFlag,omitempty"` // Whether the bandwidth usage for this computing instance for the current billing cycle is projected to exceed the allocation. ProjectedOverBandwidthAllocationFlag *int `json:"projectedOverBandwidthAllocationFlag,omitempty" xmlrpc:"projectedOverBandwidthAllocationFlag,omitempty"` // The projected public outbound bandwidth for this computing instance for the current billing cycle. ProjectedPublicBandwidthUsage *Float64 `json:"projectedPublicBandwidthUsage,omitempty" xmlrpc:"projectedPublicBandwidthUsage,omitempty"` // no documentation yet ProvisionDate *Time `json:"provisionDate,omitempty" xmlrpc:"provisionDate,omitempty"` // A count of recent events that impact this computing instance. RecentEventCount *uint `json:"recentEventCount,omitempty" xmlrpc:"recentEventCount,omitempty"` // Recent events that impact this computing instance. RecentEvents []Notification_Occurrence_Event `json:"recentEvents,omitempty" xmlrpc:"recentEvents,omitempty"` // no documentation yet ReclaimDate *Time `json:"reclaimDate,omitempty" xmlrpc:"reclaimDate,omitempty"` // The regional group this guest is in. RegionalGroup *Location_Group_Regional `json:"regionalGroup,omitempty" xmlrpc:"regionalGroup,omitempty"` // no documentation yet RegionalInternetRegistry *Network_Regional_Internet_Registry `json:"regionalInternetRegistry,omitempty" xmlrpc:"regionalInternetRegistry,omitempty"` // The reserved capacity group the guest is associated with. ReservedCapacityGroup *Virtual_ReservedCapacityGroup `json:"reservedCapacityGroup,omitempty" xmlrpc:"reservedCapacityGroup,omitempty"` // Flag to indicate whether or not a guest is part of a reserved capacity group. ReservedCapacityGroupFlag *bool `json:"reservedCapacityGroupFlag,omitempty" xmlrpc:"reservedCapacityGroupFlag,omitempty"` // The reserved capacity group instance the guest is associated with. ReservedCapacityGroupInstance *Virtual_ReservedCapacityGroup_Instance `json:"reservedCapacityGroupInstance,omitempty" xmlrpc:"reservedCapacityGroupInstance,omitempty"` // A count of a guest's vulnerability scan requests. SecurityScanRequestCount *uint `json:"securityScanRequestCount,omitempty" xmlrpc:"securityScanRequestCount,omitempty"` // A guest's vulnerability scan requests. SecurityScanRequests []Network_Security_Scanner_Request `json:"securityScanRequests,omitempty" xmlrpc:"securityScanRequests,omitempty"` // The server room that a guest is located at. There may be more than one server room for every data center. ServerRoom *Location `json:"serverRoom,omitempty" xmlrpc:"serverRoom,omitempty"` // A count of a guest's installed software. SoftwareComponentCount *uint `json:"softwareComponentCount,omitempty" xmlrpc:"softwareComponentCount,omitempty"` // A guest's installed software. SoftwareComponents []Software_Component `json:"softwareComponents,omitempty" xmlrpc:"softwareComponents,omitempty"` // A count of sSH keys to be installed on the server during provisioning or an OS reload. SshKeyCount *uint `json:"sshKeyCount,omitempty" xmlrpc:"sshKeyCount,omitempty"` // SSH keys to be installed on the server during provisioning or an OS reload. SshKeys []Security_Ssh_Key `json:"sshKeys,omitempty" xmlrpc:"sshKeys,omitempty"` // The number of CPUs available to a computing instance upon startup. StartCpus *int `json:"startCpus,omitempty" xmlrpc:"startCpus,omitempty"` // A computing instance's status. Status *Virtual_Guest_Status `json:"status,omitempty" xmlrpc:"status,omitempty"` // A computing instances [[SoftLayer_Virtual_Guest_Status|status]] ID StatusId *int `json:"statusId,omitempty" xmlrpc:"statusId,omitempty"` // Extra options needed for [[SoftLayer_Virtual_Guest/createObject|createObject]] and [[SoftLayer_Virtual_Guest/createObjects|createObjects]]. SupplementalCreateObjectOptions *Virtual_Guest_SupplementalCreateObjectOptions `json:"supplementalCreateObjectOptions,omitempty" xmlrpc:"supplementalCreateObjectOptions,omitempty"` // A count of TagReferenceCount *uint `json:"tagReferenceCount,omitempty" xmlrpc:"tagReferenceCount,omitempty"` // no documentation yet TagReferences []Tag_Reference `json:"tagReferences,omitempty" xmlrpc:"tagReferences,omitempty"` // Whether or not a computing instance is a Transient Instance. TransientGuestFlag *bool `json:"transientGuestFlag,omitempty" xmlrpc:"transientGuestFlag,omitempty"` // The endpoint used to notify customers their transient guest is terminating. TransientWebhookURI *Virtual_Guest_Attribute `json:"transientWebhookURI,omitempty" xmlrpc:"transientWebhookURI,omitempty"` // The type of this virtual guest. Type *Virtual_Guest_Type `json:"type,omitempty" xmlrpc:"type,omitempty"` // Gives the type of guest categorized as PUBLIC, DEDICATED or PRIVATE. TypeId *int `json:"typeId,omitempty" xmlrpc:"typeId,omitempty"` // A computing instance's associated upgrade request object if any. UpgradeRequest *Product_Upgrade_Request `json:"upgradeRequest,omitempty" xmlrpc:"upgradeRequest,omitempty"` // A count of a list of users that have access to this computing instance. UserCount *uint `json:"userCount,omitempty" xmlrpc:"userCount,omitempty"` // A base64 encoded string containing custom user data for a Cloud Computing Instance order. UserData []Virtual_Guest_Attribute `json:"userData,omitempty" xmlrpc:"userData,omitempty"` // A count of a base64 encoded string containing custom user data for a Cloud Computing Instance order. UserDataCount *uint `json:"userDataCount,omitempty" xmlrpc:"userDataCount,omitempty"` // A list of users that have access to this computing instance. Users []User_Customer `json:"users,omitempty" xmlrpc:"users,omitempty"` // Unique ID for a computing instance's record on a virtualization platform. Uuid *string `json:"uuid,omitempty" xmlrpc:"uuid,omitempty"` // The name of the bandwidth allotment that a hardware belongs too. VirtualRack *Network_Bandwidth_Version1_Allotment `json:"virtualRack,omitempty" xmlrpc:"virtualRack,omitempty"` // The id of the bandwidth allotment that a computing instance belongs too. VirtualRackId *int `json:"virtualRackId,omitempty" xmlrpc:"virtualRackId,omitempty"` // The name of the bandwidth allotment that a computing instance belongs too. VirtualRackName *string `json:"virtualRackName,omitempty" xmlrpc:"virtualRackName,omitempty"` }
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.
type Virtual_Guest_Attribute ¶
type Virtual_Guest_Attribute struct { Entity // no documentation yet Guest *Virtual_Guest `json:"guest,omitempty" xmlrpc:"guest,omitempty"` // no documentation yet Type *Virtual_Guest_Attribute_Type `json:"type,omitempty" xmlrpc:"type,omitempty"` // A guest attribute's value. Value *string `json:"value,omitempty" xmlrpc:"value,omitempty"` }
no documentation yet
type Virtual_Guest_Attribute_Type ¶
type Virtual_Guest_Attribute_Type struct { Entity // no documentation yet Keyname *string `json:"keyname,omitempty" xmlrpc:"keyname,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
no documentation yet
type Virtual_Guest_Attribute_UserData ¶
type Virtual_Guest_Attribute_UserData struct {
Virtual_Guest_Attribute
}
no documentation yet
type Virtual_Guest_Block_Device ¶
type Virtual_Guest_Block_Device struct { Entity // A flag indicating if a block device can be booted from. BootableFlag *int `json:"bootableFlag,omitempty" xmlrpc:"bootableFlag,omitempty"` // The date a block device was created. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // A name used to identify a block device. Device *string `json:"device,omitempty" xmlrpc:"device,omitempty"` // The disk image that a block device connects to in a computing instance. DiskImage *Virtual_Disk_Image `json:"diskImage,omitempty" xmlrpc:"diskImage,omitempty"` // A block device [[SoftLayer_Virtual_Disk_Image|disk image]]'s unique ID. DiskImageId *int `json:"diskImageId,omitempty" xmlrpc:"diskImageId,omitempty"` // The computing instance that this block device is attached to. Guest *Virtual_Guest `json:"guest,omitempty" xmlrpc:"guest,omitempty"` // The [[SoftLayer_Virtual_Guest|computing instance]] that a block device is associated with. GuestId *int `json:"guestId,omitempty" xmlrpc:"guestId,omitempty"` // A flag indicating if a block device can be plugged into a computing instance without having to shut down the instance. HotPlugFlag *int `json:"hotPlugFlag,omitempty" xmlrpc:"hotPlugFlag,omitempty"` // A computing instance block device's unique ID. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The data a block device was last modified. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // The writing mode that a virtual block device is mounted as, either "RO" for read-only mode or "RW" for read and write mode. MountMode *string `json:"mountMode,omitempty" xmlrpc:"mountMode,omitempty"` // 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.. MountType *string `json:"mountType,omitempty" xmlrpc:"mountType,omitempty"` // no documentation yet Status *Virtual_Guest_Block_Device_Status `json:"status,omitempty" xmlrpc:"status,omitempty"` // The status of the device, either disconnected or connected StatusId *int `json:"statusId,omitempty" xmlrpc:"statusId,omitempty"` // A block device's unique ID on a virtualization platform. Uuid *string `json:"uuid,omitempty" xmlrpc:"uuid,omitempty"` }
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.
type Virtual_Guest_Block_Device_Status ¶
type Virtual_Guest_Block_Device_Status struct { Entity // no documentation yet KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
no documentation yet
type Virtual_Guest_Block_Device_Template ¶
type Virtual_Guest_Block_Device_Template struct { Entity // A name that identifies a block device template. Device *string `json:"device,omitempty" xmlrpc:"device,omitempty"` // A block device template's disk image. DiskImage *Virtual_Disk_Image `json:"diskImage,omitempty" xmlrpc:"diskImage,omitempty"` // A block device template's [[SoftLayer_Virtual_Disk_Image|disk image]] ID. DiskImageId *int `json:"diskImageId,omitempty" xmlrpc:"diskImageId,omitempty"` // The amount of disk space that a block device template is using. Use this number along with the units property to obtain the correct space used. DiskSpace *Float64 `json:"diskSpace,omitempty" xmlrpc:"diskSpace,omitempty"` // A block device template's group. Several block device templates can be combined together into a group for archiving purposes. Group *Virtual_Guest_Block_Device_Template_Group `json:"group,omitempty" xmlrpc:"group,omitempty"` // A block device template's [[SoftLayer_Virtual_Guest_Block_Device_Template_Group|group]] ID. GroupId *int `json:"groupId,omitempty" xmlrpc:"groupId,omitempty"` // A block device template's unique ID. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The units that will be used with the disk space property to identify the amount of disk space used. Units *string `json:"units,omitempty" xmlrpc:"units,omitempty"` }
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.
type Virtual_Guest_Block_Device_Template_Group ¶
type Virtual_Guest_Block_Device_Template_Group struct { Entity // A block device template group's [[SoftLayer_Account|account]]. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // A count of AccountContactCount *uint `json:"accountContactCount,omitempty" xmlrpc:"accountContactCount,omitempty"` // no documentation yet AccountContacts []Account_Contact `json:"accountContacts,omitempty" xmlrpc:"accountContacts,omitempty"` // A block device template group's [[SoftLayer_Account|account]] ID AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // 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. AccountReferenceCount *uint `json:"accountReferenceCount,omitempty" xmlrpc:"accountReferenceCount,omitempty"` // The accounts which may have read-only access to an image template group. Will only be populated for parent template group objects. AccountReferences []Virtual_Guest_Block_Device_Template_Group_Accounts `json:"accountReferences,omitempty" xmlrpc:"accountReferences,omitempty"` // A count of the block devices that are part of an image template group BlockDeviceCount *uint `json:"blockDeviceCount,omitempty" xmlrpc:"blockDeviceCount,omitempty"` // The block devices that are part of an image template group BlockDevices []Virtual_Guest_Block_Device_Template `json:"blockDevices,omitempty" xmlrpc:"blockDevices,omitempty"` // The total disk space of all images in a image template group. BlockDevicesDiskSpaceTotal *Float64 `json:"blockDevicesDiskSpaceTotal,omitempty" xmlrpc:"blockDevicesDiskSpaceTotal,omitempty"` // A flag indicating that customer is providing the software licenses. ByolFlag *bool `json:"byolFlag,omitempty" xmlrpc:"byolFlag,omitempty"` // The image template groups that are clones of an image template group. Children []Virtual_Guest_Block_Device_Template_Group `json:"children,omitempty" xmlrpc:"children,omitempty"` // A count of the image template groups that are clones of an image template group. ChildrenCount *uint `json:"childrenCount,omitempty" xmlrpc:"childrenCount,omitempty"` // The date a block device template group was created. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // The location containing this image template group. Will only be populated for child template group objects. Datacenter *Location `json:"datacenter,omitempty" xmlrpc:"datacenter,omitempty"` // A count of a collection of locations containing a copy of this image template group. Will only be populated for parent template group objects. DatacenterCount *uint `json:"datacenterCount,omitempty" xmlrpc:"datacenterCount,omitempty"` // A collection of locations containing a copy of this image template group. Will only be populated for parent template group objects. Datacenters []Location `json:"datacenters,omitempty" xmlrpc:"datacenters,omitempty"` // The first clone of the image template group FirstChild *Virtual_Guest_Block_Device_Template_Group `json:"firstChild,omitempty" xmlrpc:"firstChild,omitempty"` // A flag indicating if this is a flex image. FlexImageFlag *bool `json:"flexImageFlag,omitempty" xmlrpc:"flexImageFlag,omitempty"` // An image template's universally unique identifier. GlobalIdentifier *string `json:"globalIdentifier,omitempty" xmlrpc:"globalIdentifier,omitempty"` // A block device template group's unique ID. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The virtual disk image type of this template. Value will be populated on parent and child, but only supports object filtering on the parent. ImageType *Virtual_Disk_Image_Type `json:"imageType,omitempty" xmlrpc:"imageType,omitempty"` // 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. ImageTypeKeyName *string `json:"imageTypeKeyName,omitempty" xmlrpc:"imageTypeKeyName,omitempty"` // A user definable and optional name of a block device template group. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // A flag indicating if this is a next generation image. NextGenFlag *bool `json:"nextGenFlag,omitempty" xmlrpc:"nextGenFlag,omitempty"` // A block device template group's user defined note. Note *string `json:"note,omitempty" xmlrpc:"note,omitempty"` // The image template group that another image template group was cloned from. Parent *Virtual_Guest_Block_Device_Template_Group `json:"parent,omitempty" xmlrpc:"parent,omitempty"` // A block device template group's [[SoftLayer_Virtual_Guest_Block_Device_Template_Group|parent]] ID. This will only be set when a template group is created from a previously existing template group ParentId *int `json:"parentId,omitempty" xmlrpc:"parentId,omitempty"` // no documentation yet PublicFlag *int `json:"publicFlag,omitempty" xmlrpc:"publicFlag,omitempty"` // no documentation yet Region *Network_Service_Resource `json:"region,omitempty" xmlrpc:"region,omitempty"` // A count of RegionCount *uint `json:"regionCount,omitempty" xmlrpc:"regionCount,omitempty"` // no documentation yet Regions []Network_Service_Resource `json:"regions,omitempty" xmlrpc:"regions,omitempty"` // A count of the ssh keys to be implemented on the server when provisioned or reloaded from an image template group. SshKeyCount *uint `json:"sshKeyCount,omitempty" xmlrpc:"sshKeyCount,omitempty"` // The ssh keys to be implemented on the server when provisioned or reloaded from an image template group. SshKeys []Security_Ssh_Key `json:"sshKeys,omitempty" xmlrpc:"sshKeys,omitempty"` // A template group's status. Status *Virtual_Guest_Block_Device_Template_Group_Status `json:"status,omitempty" xmlrpc:"status,omitempty"` // A block device template group's [[SoftLayer_Virtual_Guest_Block_Device_Template_Group_Status|status]] ID StatusId *int `json:"statusId,omitempty" xmlrpc:"statusId,omitempty"` // The storage repository that an image template group resides on. StorageRepository *Virtual_Storage_Repository `json:"storageRepository,omitempty" xmlrpc:"storageRepository,omitempty"` // A block device template group's user defined summary. Summary *string `json:"summary,omitempty" xmlrpc:"summary,omitempty"` // A count of the tags associated with this image template group. TagReferenceCount *uint `json:"tagReferenceCount,omitempty" xmlrpc:"tagReferenceCount,omitempty"` // The tags associated with this image template group. TagReferences []Tag_Reference `json:"tagReferences,omitempty" xmlrpc:"tagReferences,omitempty"` // A transaction that is being performed on a image template group. Transaction *Provisioning_Version1_Transaction `json:"transaction,omitempty" xmlrpc:"transaction,omitempty"` // A block device template group's [[SoftLayer_Provisioning_Version1_Transaction|transaction]] ID. This will only be set when there is a transaction being performed on the block device template group. TransactionId *int `json:"transactionId,omitempty" xmlrpc:"transactionId,omitempty"` // A block device template group's [[SoftLayer_User_Customer]] ID UserRecordId *int `json:"userRecordId,omitempty" xmlrpc:"userRecordId,omitempty"` }
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.
type Virtual_Guest_Block_Device_Template_Group_Accounts ¶
type Virtual_Guest_Block_Device_Template_Group_Accounts struct { Entity // The [[SoftLayer_Account|account]] that an image template group is shared with. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // The [[SoftLayer_Account|account]] ID which will have access to an image. AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // The date access was granted to an account. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // The [[SoftLayer_Virtual_Guest_Block_Device_Template_Group|image template group]] that is shared with an account. Group *Virtual_Guest_Block_Device_Template_Group `json:"group,omitempty" xmlrpc:"group,omitempty"` // The [[SoftLayer_Virtual_Guest_Block_Device_Template_Group|group]] ID which access will be granted to. GroupId *int `json:"groupId,omitempty" xmlrpc:"groupId,omitempty"` }
The SoftLayer_Virtual_Guest_Block_Device_Template_Group_Accounts data type represents the SoftLayer customer accounts which have access to provision CloudLayer Computing Instances from an image template group.
All accounts other than the image template group owner have read-only access to that image template group.
It is important to note that this data type should only exist to give accounts access to the parent template group object, not the child. All image template sharing between accounts should occur on the parent object.
type Virtual_Guest_Block_Device_Template_Group_Status ¶
type Virtual_Guest_Block_Device_Template_Group_Status struct { Entity // no documentation yet Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // no documentation yet KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
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'
type Virtual_Guest_Boot_Parameter ¶
type Virtual_Guest_Boot_Parameter struct { Entity // no documentation yet CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // no documentation yet Guest *Virtual_Guest `json:"guest,omitempty" xmlrpc:"guest,omitempty"` // no documentation yet GuestBootParameterType *Virtual_Guest_Boot_Parameter_Type `json:"guestBootParameterType,omitempty" xmlrpc:"guestBootParameterType,omitempty"` // no documentation yet GuestBootParameterTypeId *int `json:"guestBootParameterTypeId,omitempty" xmlrpc:"guestBootParameterTypeId,omitempty"` // no documentation yet GuestId *int `json:"guestId,omitempty" xmlrpc:"guestId,omitempty"` // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` }
no documentation yet
type Virtual_Guest_Boot_Parameter_Type ¶
type Virtual_Guest_Boot_Parameter_Type struct { Entity // Available boot options. BootOption *string `json:"bootOption,omitempty" xmlrpc:"bootOption,omitempty"` // no documentation yet CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // A description of the boot parameter Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // Indentifier for record. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The key name of the boot parameter. KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // no documentation yet ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // The common name of the boot parameter. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // The virtual machine arguments Value *string `json:"value,omitempty" xmlrpc:"value,omitempty"` }
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.
type Virtual_Guest_Network_Component ¶
type Virtual_Guest_Network_Component struct { Entity // The date a computing instance's network component was created. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // The computing instance that this network component exists on. Guest *Virtual_Guest `json:"guest,omitempty" xmlrpc:"guest,omitempty"` // The unique ID of the [[SoftLayer_Virtual_Guest|computing instance]] that this network component belongs to. GuestId *int `json:"guestId,omitempty" xmlrpc:"guestId,omitempty"` // no documentation yet HighAvailabilityFirewallFlag *bool `json:"highAvailabilityFirewallFlag,omitempty" xmlrpc:"highAvailabilityFirewallFlag,omitempty"` // no documentation yet IcpBinding *Virtual_Guest_Network_Component_IcpBinding `json:"icpBinding,omitempty" xmlrpc:"icpBinding,omitempty"` // A computing instance's network component's unique ID. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A count of the records of all IP addresses bound to a computing instance's network component. IpAddressBindingCount *uint `json:"ipAddressBindingCount,omitempty" xmlrpc:"ipAddressBindingCount,omitempty"` // The records of all IP addresses bound to a computing instance's network component. IpAddressBindings []Virtual_Guest_Network_Component_IpAddress `json:"ipAddressBindings,omitempty" xmlrpc:"ipAddressBindings,omitempty"` // A computing instance network component's unique MAC address. MacAddress *string `json:"macAddress,omitempty" xmlrpc:"macAddress,omitempty"` // 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. MaxSpeed *int `json:"maxSpeed,omitempty" xmlrpc:"maxSpeed,omitempty"` // The date a computing instance's network component was last modified. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // 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. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // The upstream network component firewall. NetworkComponentFirewall *Network_Component_Firewall `json:"networkComponentFirewall,omitempty" xmlrpc:"networkComponentFirewall,omitempty"` // A computing instance's network component's [[SoftLayer_Virtual_Network|network]] ID NetworkId *int `json:"networkId,omitempty" xmlrpc:"networkId,omitempty"` // The VLAN that a computing instance network component's subnet is associated with. NetworkVlan *Network_Vlan `json:"networkVlan,omitempty" xmlrpc:"networkVlan,omitempty"` // A computing instance network component's port number. Most computing instances have 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. Port *int `json:"port,omitempty" xmlrpc:"port,omitempty"` // A computing instance network component's primary IP address. PrimaryIpAddress *string `json:"primaryIpAddress,omitempty" xmlrpc:"primaryIpAddress,omitempty"` // no documentation yet PrimaryIpAddressRecord *Network_Subnet_IpAddress `json:"primaryIpAddressRecord,omitempty" xmlrpc:"primaryIpAddressRecord,omitempty"` // A network component's subnet for its primary IP address PrimarySubnet *Network_Subnet `json:"primarySubnet,omitempty" xmlrpc:"primarySubnet,omitempty"` // A network component's primary IPv6 IP address record. PrimaryVersion6IpAddressRecord *Network_Subnet_IpAddress `json:"primaryVersion6IpAddressRecord,omitempty" xmlrpc:"primaryVersion6IpAddressRecord,omitempty"` // A network component's routers. Router *Hardware_Router `json:"router,omitempty" xmlrpc:"router,omitempty"` // A count of the bindings associating security groups to this network component SecurityGroupBindingCount *uint `json:"securityGroupBindingCount,omitempty" xmlrpc:"securityGroupBindingCount,omitempty"` // The bindings associating security groups to this network component SecurityGroupBindings []Virtual_Network_SecurityGroup_NetworkComponentBinding `json:"securityGroupBindings,omitempty" xmlrpc:"securityGroupBindings,omitempty"` // A computing instance network component's speed, measured in Mbit per second. Speed *int `json:"speed,omitempty" xmlrpc:"speed,omitempty"` // 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. Status *string `json:"status,omitempty" xmlrpc:"status,omitempty"` // A count of a network component's subnets. A subnet is a group of IP addresses SubnetCount *uint `json:"subnetCount,omitempty" xmlrpc:"subnetCount,omitempty"` // A network component's subnets. A subnet is a group of IP addresses Subnets []Network_Subnet `json:"subnets,omitempty" xmlrpc:"subnets,omitempty"` // A computing instance's network component's unique ID on a virtualization platform. Uuid *string `json:"uuid,omitempty" xmlrpc:"uuid,omitempty"` }
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.
type Virtual_Guest_Network_Component_IcpBinding ¶
type Virtual_Guest_Network_Component_IcpBinding struct { Entity // no documentation yet InterfaceId *string `json:"interfaceId,omitempty" xmlrpc:"interfaceId,omitempty"` // no documentation yet IpAllocationId *string `json:"ipAllocationId,omitempty" xmlrpc:"ipAllocationId,omitempty"` // The network component associated with this object. NetworkComponent *Virtual_Guest_Network_Component `json:"networkComponent,omitempty" xmlrpc:"networkComponent,omitempty"` // The type of IP that this IP allocation id record references. Set to PRIMARY for the first servic port. Type *string `json:"type,omitempty" xmlrpc:"type,omitempty"` // no documentation yet VpcId *string `json:"vpcId,omitempty" xmlrpc:"vpcId,omitempty"` }
no documentation yet
type Virtual_Guest_Network_Component_IpAddress ¶
type Virtual_Guest_Network_Component_IpAddress struct { Entity // The IP address associated with this object's network component. IpAddress *Network_Subnet_IpAddress `json:"ipAddress,omitempty" xmlrpc:"ipAddress,omitempty"` // The unique ID of the [[SoftLayer_Network_Subnet_ipAddress|ip address]] this virtual IP address is associated with. IpAddressId *int `json:"ipAddressId,omitempty" xmlrpc:"ipAddressId,omitempty"` // The network component associated with this object's IP address. NetworkComponent *Virtual_Guest_Network_Component `json:"networkComponent,omitempty" xmlrpc:"networkComponent,omitempty"` // The port that a network component has reserved. This field is only required for some IP address types. Port *int `json:"port,omitempty" xmlrpc:"port,omitempty"` // 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 `json:"type,omitempty" xmlrpc:"type,omitempty"` }
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.
type Virtual_Guest_Power_State ¶
type Virtual_Guest_Power_State struct { Entity // The description of a power state Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // The key name of a power state KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // The name of a power state Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
The power state class provides a common set of values for which a guest's power state will be presented in the SoftLayer API.
type Virtual_Guest_Status ¶
type Virtual_Guest_Status struct { Entity // no documentation yet KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
no documentation yet
type Virtual_Guest_SupplementalCreateObjectOptions ¶
type Virtual_Guest_SupplementalCreateObjectOptions struct { Entity // The mode used to boot the [[SoftLayer_Virtual_Guest]]. Supported values are 'PV' and 'HVM'. BootMode *string `json:"bootMode,omitempty" xmlrpc:"bootMode,omitempty"` // When set the startCpus and maxMemory are defined by the flavor. If the flavor includes local storage blockDevice 0 is also defined by the flavor. When startCpus, maxMemory, or blockDevice 0 are also provided on the template object they are validated against the flavor provided. FlavorKeyName *string `json:"flavorKeyName,omitempty" xmlrpc:"flavorKeyName,omitempty"` // 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|createObjects]], this value must be the exact same for every item. ImmediateApprovalOnlyFlag *bool `json:"immediateApprovalOnlyFlag,omitempty" xmlrpc:"immediateApprovalOnlyFlag,omitempty"` // 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|createObjects]]. PostInstallScriptUri *string `json:"postInstallScriptUri,omitempty" xmlrpc:"postInstallScriptUri,omitempty"` }
no documentation yet
type Virtual_Guest_Type ¶
type Virtual_Guest_Type struct { Entity // no documentation yet Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // no documentation yet Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
SoftLayer_Virtual_Guest_Type models the type of a [[SoftLayer_Virtual_Guest]] (PUBLIC | DEDICATED | PRIVATE)
type Virtual_Guest_Vpc_IpAllocation ¶
type Virtual_Guest_Vpc_IpAllocation struct {
Entity
}
no documentation yet
type Virtual_Guest_Vpc_Subnet ¶
type Virtual_Guest_Vpc_Subnet struct {
Entity
}
no documentation yet
type Virtual_Host ¶
type Virtual_Host struct { Entity // The account which a virtual host belongs to. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // A virtual host's associated account id AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // The date a virtual host was created. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // A virtual host's description. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // The enabled flag specifies whether a virtual host can run guests. EnabledFlag *int `json:"enabledFlag,omitempty" xmlrpc:"enabledFlag,omitempty"` // The hardware record which a virtual host resides on. Hardware *Hardware_Server `json:"hardware,omitempty" xmlrpc:"hardware,omitempty"` // A hardware device which a virtual host resides. HardwareId *int `json:"hardwareId,omitempty" xmlrpc:"hardwareId,omitempty"` // Unique ID for a virtual host. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The metric tracking object for this virtual host. MetricTrackingObject *Metric_Tracking_Object `json:"metricTrackingObject,omitempty" xmlrpc:"metricTrackingObject,omitempty"` // The date a virtual host was last modified. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // A virtual host's name. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // A count of PciDeviceCount *uint `json:"pciDeviceCount,omitempty" xmlrpc:"pciDeviceCount,omitempty"` // no documentation yet PciDevices []Virtual_Host_PciDevice `json:"pciDevices,omitempty" xmlrpc:"pciDevices,omitempty"` // The amount of memory physically available for a virtual host. PhysicalMemoryCapacity *int `json:"physicalMemoryCapacity,omitempty" xmlrpc:"physicalMemoryCapacity,omitempty"` // Unique ID for a virtual host's record on a virtualization platform. Uuid *string `json:"uuid,omitempty" xmlrpc:"uuid,omitempty"` }
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.
type Virtual_Host_PciDevice ¶
type Virtual_Host_PciDevice struct { Entity // no documentation yet HardwareComponentModel *Hardware_Component_Model `json:"hardwareComponentModel,omitempty" xmlrpc:"hardwareComponentModel,omitempty"` // no documentation yet Host *Virtual_Host `json:"host,omitempty" xmlrpc:"host,omitempty"` // ID of the PCI device. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The unique id of the PCI device's record on a virtualization platform. Uuid *string `json:"uuid,omitempty" xmlrpc:"uuid,omitempty"` // The BDF (Domain:Bus:Device.Function) id of the PCI device in XenServer. XenPciId *string `json:"xenPciId,omitempty" xmlrpc:"xenPciId,omitempty"` }
This type represents a PCI device on a host.
type Virtual_Network_SecurityGroup_NetworkComponentBinding ¶
type Virtual_Network_SecurityGroup_NetworkComponentBinding struct { Entity // The unique ID for a binding. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet NetworkComponent *Virtual_Guest_Network_Component `json:"networkComponent,omitempty" xmlrpc:"networkComponent,omitempty"` // The ID of the network component. NetworkComponentId *int `json:"networkComponentId,omitempty" xmlrpc:"networkComponentId,omitempty"` // no documentation yet SecurityGroup *Network_SecurityGroup `json:"securityGroup,omitempty" xmlrpc:"securityGroup,omitempty"` // The ID of the security group. SecurityGroupId *int `json:"securityGroupId,omitempty" xmlrpc:"securityGroupId,omitempty"` }
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]].
type Virtual_PlacementGroup ¶
type Virtual_PlacementGroup struct { Entity // The account that the placement group is implemented on. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // The unique ID of the account that created the placement group. AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // The router the placement group is implemented on. BackendRouter *Hardware_Router_Backend `json:"backendRouter,omitempty" xmlrpc:"backendRouter,omitempty"` // The placement group's backend router's associated unique ID. BackendRouterId *int `json:"backendRouterId,omitempty" xmlrpc:"backendRouterId,omitempty"` // The placement group's date of creation. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // A count of the virtual guests that are members of the placement group. GuestCount *uint `json:"guestCount,omitempty" xmlrpc:"guestCount,omitempty"` // The virtual guests that are members of the placement group. Guests []Virtual_Guest `json:"guests,omitempty" xmlrpc:"guests,omitempty"` // The placement group's associated unique ID. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The placement group's date of most recent modification. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // The placement group's name. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // The placement rule that the placement group is implementing. Rule *Virtual_PlacementGroup_Rule `json:"rule,omitempty" xmlrpc:"rule,omitempty"` // The associated unique ID of the placement group's rule. RuleId *int `json:"ruleId,omitempty" xmlrpc:"ruleId,omitempty"` }
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.
type Virtual_PlacementGroup_Rule ¶
type Virtual_PlacementGroup_Rule struct { Entity // The placement group rule's associated unique ID. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The placement group rule's key name. KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // The placement group rule's name. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
This data type presents the structure of a virtual guest placement group rule.
type Virtual_ReservedCapacityGroup ¶
type Virtual_ReservedCapacityGroup struct { Entity // The account that the reserved capacity group is implemented on. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // The unique ID of the account that created the reserved capacity group. AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // A count of the instances available for guest provisions on this reserved capacity group. AvailableInstanceCount *uint `json:"availableInstanceCount,omitempty" xmlrpc:"availableInstanceCount,omitempty"` // The instances available for guest provisions on this reserved capacity group. AvailableInstances []Virtual_ReservedCapacityGroup_Instance `json:"availableInstances,omitempty" xmlrpc:"availableInstances,omitempty"` // The router the reserved capacity group is implemented on. BackendRouter *Hardware_Router_Backend `json:"backendRouter,omitempty" xmlrpc:"backendRouter,omitempty"` // The reserved capacity group's backend router's associated unique ID. BackendRouterId *int `json:"backendRouterId,omitempty" xmlrpc:"backendRouterId,omitempty"` // The date that the reserved capacity group was created. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // The reserved capacity group's associated unique ID. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // A count of the guest instances that are members of this reserved capacity group. InstanceCount *uint `json:"instanceCount,omitempty" xmlrpc:"instanceCount,omitempty"` // The guest instances that are members of this reserved capacity group. Instances []Virtual_ReservedCapacityGroup_Instance `json:"instances,omitempty" xmlrpc:"instances,omitempty"` // The number of instances that are members of this reserved capacity group. InstancesCount *uint `json:"instancesCount,omitempty" xmlrpc:"instancesCount,omitempty"` // The date that the reserved capacity group was last modified. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // The reserved capacity group's name. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // A count of the instances already occupied by a guest on this reserved capacity group. OccupiedInstanceCount *uint `json:"occupiedInstanceCount,omitempty" xmlrpc:"occupiedInstanceCount,omitempty"` // The instances already occupied by a guest on this reserved capacity group. OccupiedInstances []Virtual_ReservedCapacityGroup_Instance `json:"occupiedInstances,omitempty" xmlrpc:"occupiedInstances,omitempty"` }
This data type presents the structure for a virtual reserved capacity group.
type Virtual_ReservedCapacityGroup_Instance ¶
type Virtual_ReservedCapacityGroup_Instance struct { Entity // Flag to indecate whether or not the reserved instance is available or not. AvailableFlag *bool `json:"availableFlag,omitempty" xmlrpc:"availableFlag,omitempty"` // The billing item for the reserved capacity group instance. BillingItem *Billing_Item `json:"billingItem,omitempty" xmlrpc:"billingItem,omitempty"` // The date that the reserved capacity group instance was created. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // The virtual guest associated with this reserved capacity group instance. Guest *Virtual_Guest `json:"guest,omitempty" xmlrpc:"guest,omitempty"` // The virtual guest ID associated with this reserved capacity group instance. GuestId *int `json:"guestId,omitempty" xmlrpc:"guestId,omitempty"` // The reserved capacity group instance's associated unique ID. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The date that the reserved capacity group instance was last modified. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // The reserved instances that are members of this reserved capacity group. ReservedCapacityGroup *Virtual_ReservedCapacityGroup `json:"reservedCapacityGroup,omitempty" xmlrpc:"reservedCapacityGroup,omitempty"` // The ID of the reserved capacity group this instance is associated with. ReservedCapacityGroupId *int `json:"reservedCapacityGroupId,omitempty" xmlrpc:"reservedCapacityGroupId,omitempty"` }
This data type presents the structure for a virtual reserved capacity group instance.
type Virtual_Storage_Repository ¶
type Virtual_Storage_Repository struct { Entity // The [[SoftLayer_Account|account]] that a storage repository belongs to. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // The current billing item for a storage repository. BillingItem *Billing_Item `json:"billingItem,omitempty" xmlrpc:"billingItem,omitempty"` // A storage repositories capacity measured in Giga-Bytes (GB) Capacity *Float64 `json:"capacity,omitempty" xmlrpc:"capacity,omitempty"` // The datacenter that a virtual storage repository resides in. Datacenter *Location `json:"datacenter,omitempty" xmlrpc:"datacenter,omitempty"` // A storage repositories description that describes its purpose or contents Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // A count of the [[SoftLayer_Virtual_Disk_Image|disk images]] that are in a storage repository. Disk images are the virtual hard drives for a virtual guest. DiskImageCount *uint `json:"diskImageCount,omitempty" xmlrpc:"diskImageCount,omitempty"` // The [[SoftLayer_Virtual_Disk_Image|disk images]] that are in a storage repository. Disk images are the virtual hard drives for a virtual guest. DiskImages []Virtual_Disk_Image `json:"diskImages,omitempty" xmlrpc:"diskImages,omitempty"` // A count of the computing instances that have disk images in a storage repository. GuestCount *uint `json:"guestCount,omitempty" xmlrpc:"guestCount,omitempty"` // The computing instances that have disk images in a storage repository. Guests []Virtual_Guest `json:"guests,omitempty" xmlrpc:"guests,omitempty"` // Unique ID for a storage repository. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // no documentation yet MetricTrackingObject *Metric_Tracking_Object_Virtual_Storage_Repository `json:"metricTrackingObject,omitempty" xmlrpc:"metricTrackingObject,omitempty"` // A storage repositories name that describes its purpose or contents Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // no documentation yet PublicFlag *int `json:"publicFlag,omitempty" xmlrpc:"publicFlag,omitempty"` // The current billing item for a public storage repository. PublicImageBillingItem *Billing_Item `json:"publicImageBillingItem,omitempty" xmlrpc:"publicImageBillingItem,omitempty"` // A storage repository's [[SoftLayer_Virtual_Storage_Repository_Type|type]]. Type *Virtual_Storage_Repository_Type `json:"type,omitempty" xmlrpc:"type,omitempty"` // A storage repositories [[SoftLayer_Virtual_Storage_Repository_Type|type]] ID TypeId *int `json:"typeId,omitempty" xmlrpc:"typeId,omitempty"` }
The SoftLayer_Virtual_Storage_Repository represents a web based storage system that can be accessed through many types of devices, interfaces, and other resources.
type Virtual_Storage_Repository_Type ¶
type Virtual_Storage_Repository_Type struct { Entity // A brief description os a storage repository type. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // A storage repository type's name. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // The storage repositories on a SoftLayer customer account that belong to this type. StorageRepositories []Virtual_Storage_Repository `json:"storageRepositories,omitempty" xmlrpc:"storageRepositories,omitempty"` // A count of the storage repositories on a SoftLayer customer account that belong to this type. StorageRepositoryCount *uint `json:"storageRepositoryCount,omitempty" xmlrpc:"storageRepositoryCount,omitempty"` }
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.
type Workload_Citrix_Client ¶ added in v1.0.2
type Workload_Citrix_Client struct {
Entity
}
no documentation yet
type Workload_Citrix_Client_Response ¶ added in v1.0.2
type Workload_Citrix_Client_Response struct { Entity // messageId of Citrix account validation response. MessageId *string `json:"messageId,omitempty" xmlrpc:"messageId,omitempty"` // status of Citrix account validation. Status *string `json:"status,omitempty" xmlrpc:"status,omitempty"` // status message of Citrix account validation. StatusMessage *string `json:"statusMessage,omitempty" xmlrpc:"statusMessage,omitempty"` }
no documentation yet
type Workload_Citrix_Client_Response_ResourceLocations ¶ added in v1.0.2
type Workload_Citrix_Client_Response_ResourceLocations struct { Workload_Citrix_Client_Response // no documentation yet ResourceLocations []string `json:"resourceLocations,omitempty" xmlrpc:"resourceLocations,omitempty"` }
no documentation yet
type Workload_Citrix_Deployment ¶ added in v1.0.4
type Workload_Citrix_Deployment struct { Entity // The [[SoftLayer_Account]] to which the deployment belongs. Account *Account `json:"account,omitempty" xmlrpc:"account,omitempty"` // The account ID to which the deployment belongs. AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // Topology used for the Citrix Virtual Apps And Desktop deployment. ActiveDirectoryTopology *string `json:"activeDirectoryTopology,omitempty" xmlrpc:"activeDirectoryTopology,omitempty"` // The date when this record was created. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // DataCenter of the deployment. DataCenter *string `json:"dataCenter,omitempty" xmlrpc:"dataCenter,omitempty"` // It is the unique identifier for the deployment. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The date when this record was last modified. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // Name of the deployment. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // A count of it contains a collection of items under the CVAD deployment. ResourceCount *uint `json:"resourceCount,omitempty" xmlrpc:"resourceCount,omitempty"` // It contains a collection of items under the CVAD deployment. Resources []Workload_Citrix_Deployment_Resource `json:"resources,omitempty" xmlrpc:"resources,omitempty"` // Current Status of the CVAD deployment. Status *Workload_Citrix_Deployment_Status `json:"status,omitempty" xmlrpc:"status,omitempty"` // The [[SoftLayer_Workload_Citrix_Deployment_Status]] of the deployment. StatusId *int `json:"statusId,omitempty" xmlrpc:"statusId,omitempty"` // It shows if the deployment is for Citrix Hypervisor or VMware. Type *Workload_Citrix_Deployment_Type `json:"type,omitempty" xmlrpc:"type,omitempty"` // The [[SoftLayer_Workload_Citrix_Deployment_Type]] of the deployment. TypeId *int `json:"typeId,omitempty" xmlrpc:"typeId,omitempty"` // It is the [[SoftLayer_User_Customer]] who placed the order for CVAD. User *User_Customer `json:"user,omitempty" xmlrpc:"user,omitempty"` // The identifier for the customer who placed the CVAD order. UserRecordId *int `json:"userRecordId,omitempty" xmlrpc:"userRecordId,omitempty"` // It is the VLAN resource for the CVAD deployment. Vlan *Network_Vlan `json:"vlan,omitempty" xmlrpc:"vlan,omitempty"` // VLAN ID of the deployment. VlanId *int `json:"vlanId,omitempty" xmlrpc:"vlanId,omitempty"` // It is an internal identifier for the VMware solution. It gets set if the CVAD order is for VMware. VmwareOrderId *string `json:"vmwareOrderId,omitempty" xmlrpc:"vmwareOrderId,omitempty"` }
no documentation yet
type Workload_Citrix_Deployment_Resource ¶ added in v1.0.4
type Workload_Citrix_Deployment_Resource struct { Entity // no documentation yet BillingItem *Billing_Item `json:"billingItem,omitempty" xmlrpc:"billingItem,omitempty"` // Billing item ID of the resource BillingItemId *int `json:"billingItemId,omitempty" xmlrpc:"billingItemId,omitempty"` // The point in time at which the resource was ordered. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // no documentation yet Deployment *Workload_Citrix_Deployment `json:"deployment,omitempty" xmlrpc:"deployment,omitempty"` // CVAD Deployment ID of the resource DeploymentId *int `json:"deploymentId,omitempty" xmlrpc:"deploymentId,omitempty"` // Unique Identifier of the CVAD Deployment Resource Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The last time when the resource was modified. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // no documentation yet Order *Billing_Order `json:"order,omitempty" xmlrpc:"order,omitempty"` // Billing Order ID of the resource OrderId *int `json:"orderId,omitempty" xmlrpc:"orderId,omitempty"` // 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. OrderedByCvad *bool `json:"orderedByCvad,omitempty" xmlrpc:"orderedByCvad,omitempty"` // no documentation yet Role *Workload_Citrix_Deployment_Resource_Role `json:"role,omitempty" xmlrpc:"role,omitempty"` // Role of the resource within the CVAD deployment. For example, a VSI can have different roles such as Proxy Server or DHCP Server. RoleId *int `json:"roleId,omitempty" xmlrpc:"roleId,omitempty"` }
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.
type Workload_Citrix_Deployment_Resource_Response ¶ added in v1.0.4
type Workload_Citrix_Deployment_Resource_Response struct { Entity // Represents the hardware resource of the CVAD deployment. Hardware *Hardware `json:"hardware,omitempty" xmlrpc:"hardware,omitempty"` // It is a flag for internal usage that represents if the underlying resource is ordered by another system of the same infrastructure provider. IsDeploymentOwned *bool `json:"isDeploymentOwned,omitempty" xmlrpc:"isDeploymentOwned,omitempty"` // It represents the role of a VSI resource in the CVAD deployment, e.g., a proxy server, DHCP server, cloud connector. Role *Workload_Citrix_Deployment_Resource_Role `json:"role,omitempty" xmlrpc:"role,omitempty"` // Storage resource for the CVAD deployment. Storage *Network_Storage `json:"storage,omitempty" xmlrpc:"storage,omitempty"` // Represents the subnet resource of the CVAD deployment. Subnet *Network_Subnet `json:"subnet,omitempty" xmlrpc:"subnet,omitempty"` // It contains the category of the item which is set for the current response. Type *string `json:"type,omitempty" xmlrpc:"type,omitempty"` // VSI resource for the CVAD deployment. VirtualGuest *Virtual_Guest `json:"virtualGuest,omitempty" xmlrpc:"virtualGuest,omitempty"` // Represents the VLAN resource of the CVAD deployment. Vlan *Network_Vlan `json:"vlan,omitempty" xmlrpc:"vlan,omitempty"` }
The SoftLayer_Workload_Citrix_Deployment_Resource_Response constructs a response object for [[SoftLayer_Workload_Citrix_Deployment_Resource_Response]] for the CVAD resource.
type Workload_Citrix_Deployment_Resource_Role ¶ added in v1.0.4
type Workload_Citrix_Deployment_Resource_Role struct { Entity // Description of the resource role Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // ID of the role Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // Unique keyName of the role KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // Name of the role Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
SoftLayer_Workload_Citrix_Deployment_Resource_Role contains the role and its description of any resource of Citrix Virtual Apps & Desktops deployment.
type Workload_Citrix_Deployment_Response ¶ added in v1.0.4
type Workload_Citrix_Deployment_Response struct { Entity // The account ID to which the deployment belongs. AccountId *int `json:"accountId,omitempty" xmlrpc:"accountId,omitempty"` // Topology used for the CVAD deployment ActiveDirectoryTopology *string `json:"activeDirectoryTopology,omitempty" xmlrpc:"activeDirectoryTopology,omitempty"` // The date when this deployment was created. CreateDate *Time `json:"createDate,omitempty" xmlrpc:"createDate,omitempty"` // Location name of the deployment. DataCenter *string `json:"dataCenter,omitempty" xmlrpc:"dataCenter,omitempty"` // ID of the CVAD deployment. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The date when this deployment was modified. ModifyDate *Time `json:"modifyDate,omitempty" xmlrpc:"modifyDate,omitempty"` // Name of the deployment. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // It is a collection of objects representing deployment resources such as VLAN, subnet, bare metal, proxy, DHCP, cloud connectors. Resources []Workload_Citrix_Deployment_Resource_Response `json:"resources,omitempty" xmlrpc:"resources,omitempty"` // Status of the deployment. Status *Workload_Citrix_Deployment_Status `json:"status,omitempty" xmlrpc:"status,omitempty"` // Represents if the deployment is for Citrix Hypervisor or VMware Type *Workload_Citrix_Deployment_Type `json:"type,omitempty" xmlrpc:"type,omitempty"` // The identifier for the customer who placed the CVAD order. UserRecordId *int `json:"userRecordId,omitempty" xmlrpc:"userRecordId,omitempty"` // VLAN ID of the deployment. VlanId *int `json:"vlanId,omitempty" xmlrpc:"vlanId,omitempty"` // It is an internal identifier for the VMware solution. It gets set if the CVAD order is for VMware. VmwareOrderId *string `json:"vmwareOrderId,omitempty" xmlrpc:"vmwareOrderId,omitempty"` }
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]].
type Workload_Citrix_Deployment_Status ¶ added in v1.0.5
type Workload_Citrix_Deployment_Status struct { Entity // The description of the deployment status. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // The ID of the deployment status. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // The keyName of the deployment status. KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // The title of the deployment status. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
The SoftLayer_Workload_Citrix_Deployment_Status shows the status of Citrix Virtual Apps and Desktop deployment. The deployment can be in one of the following statuses at a given point in time: - PROVISIONING: The resources are being provisioned for the deployment. - ACTIVE: All the resources for the deployment are ready. - CANCELLING: Resources of the deployment are being cancelled. - CANCELLED: All the resources of the deployment are cancelled.
type Workload_Citrix_Deployment_Type ¶ added in v1.0.4
type Workload_Citrix_Deployment_Type struct { Entity // Description of the deployment type. Description *string `json:"description,omitempty" xmlrpc:"description,omitempty"` // The identifer of the deployment type. Id *int `json:"id,omitempty" xmlrpc:"id,omitempty"` // KeyName of the deployment type. KeyName *string `json:"keyName,omitempty" xmlrpc:"keyName,omitempty"` // Name of the deployment type. Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` }
no documentation yet
type Workload_Citrix_Request ¶ added in v1.0.2
type Workload_Citrix_Request struct { Entity // no documentation yet ClientId *string `json:"clientId,omitempty" xmlrpc:"clientId,omitempty"` // no documentation yet ClientSecret *string `json:"clientSecret,omitempty" xmlrpc:"clientSecret,omitempty"` // no documentation yet CustomerId *string `json:"customerId,omitempty" xmlrpc:"customerId,omitempty"` }
no documentation yet
type Workload_Citrix_Request_CreateResourceLocation ¶ added in v1.0.2
type Workload_Citrix_Request_CreateResourceLocation struct { Workload_Citrix_Request // no documentation yet ResourceLocationName *string `json:"resourceLocationName,omitempty" xmlrpc:"resourceLocationName,omitempty"` }
no documentation yet
type Workload_Citrix_Workspace_Order ¶ added in v1.0.2
type Workload_Citrix_Workspace_Order struct {
Entity
}
no documentation yet
type Workload_Citrix_Workspace_Order_Container ¶ added in v1.0.2
type Workload_Citrix_Workspace_Order_Container struct { Entity // The active directory domain name ActiveDirectoryDomainName *string `json:"activeDirectoryDomainName,omitempty" xmlrpc:"activeDirectoryDomainName,omitempty"` // The active directory netbios name (optional) ActiveDirectoryNetbiosName *string `json:"activeDirectoryNetbiosName,omitempty" xmlrpc:"activeDirectoryNetbiosName,omitempty"` // The active directory safe mode password ActiveDirectorySafeModePassword *string `json:"activeDirectorySafeModePassword,omitempty" xmlrpc:"activeDirectorySafeModePassword,omitempty"` // The active directory topology ActiveDirectoryTopology *string `json:"activeDirectoryTopology,omitempty" xmlrpc:"activeDirectoryTopology,omitempty"` // The Citrix API Client Id CitrixAPIClientId *string `json:"citrixAPIClientId,omitempty" xmlrpc:"citrixAPIClientId,omitempty"` // The Citrix API Client Secret CitrixAPIClientSecret *string `json:"citrixAPIClientSecret,omitempty" xmlrpc:"citrixAPIClientSecret,omitempty"` // The Citrix customer id CitrixCustomerId *string `json:"citrixCustomerId,omitempty" xmlrpc:"citrixCustomerId,omitempty"` // The Citrix resource location name CitrixResourceLocationName *string `json:"citrixResourceLocationName,omitempty" xmlrpc:"citrixResourceLocationName,omitempty"` // The default domain to be used for all server orders where the domain is not specified. Domain *string `json:"domain,omitempty" xmlrpc:"domain,omitempty"` // The specific [[SoftLayer_Location_Datacenter]] id where the order should be provisioned. Location *string `json:"location,omitempty" xmlrpc:"location,omitempty"` // There should be one child orderContainer for each component ordered. The containerIdentifier should be set on each and have these exact values: proxy server, bare metal server with hypervisor, dhcp server, citrix connector servers, active directory server, vlan, subnet, storage OrderContainers []Container_Product_Order `json:"orderContainers,omitempty" xmlrpc:"orderContainers,omitempty"` // Set this value to order IBM Cloud for VMware Solutions servers as part of your Citrix Virtual Apps and Desktops order VmwareContainer *Workload_Citrix_Workspace_Order_VMwareContainer `json:"vmwareContainer,omitempty" xmlrpc:"vmwareContainer,omitempty"` }
This is the datatype that needs to be populated and sent to SoftLayer_Workload_Citrix_Workspace_Order::placeWorkspaceOrder.
type Workload_Citrix_Workspace_Order_LicenseKey ¶ added in v1.0.2
type Workload_Citrix_Workspace_Order_LicenseKey struct { Entity // The license key Key *string `json:"key,omitempty" xmlrpc:"key,omitempty"` // The name of the product (e.g. vcenter, nsx, vsphere, vsan) Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // The license type Type *string `json:"type,omitempty" xmlrpc:"type,omitempty"` }
This is the datatype that can be populated by the customer to provide license key information for VMware orders.
type Workload_Citrix_Workspace_Order_SharedStorage ¶ added in v1.0.2
type Workload_Citrix_Workspace_Order_SharedStorage struct { string `json:"iops,omitempty" xmlrpc:"iops,omitempty"` Quantity *int `json:"quantity,omitempty" xmlrpc:"quantity,omitempty"` Size *string `json:"size,omitempty" xmlrpc:"size,omitempty"` Volume *int `json:"volume,omitempty" xmlrpc:"volume,omitempty"` }Iops *
This is the datatype that can be populated by the customer to provide NFS shared storage information for VMware orders.
type Workload_Citrix_Workspace_Order_VMwareContainer ¶ added in v1.0.2
type Workload_Citrix_Workspace_Order_VMwareContainer struct { Entity // The bare metal disks Disks []string `json:"disks,omitempty" xmlrpc:"disks,omitempty"` // The domain for the ordered hosts (e.g. example.org) Domain *string `json:"domain,omitempty" xmlrpc:"domain,omitempty"` // Customer provided license keys (optional) LicenseKeys []Workload_Citrix_Workspace_Order_LicenseKey `json:"licenseKeys,omitempty" xmlrpc:"licenseKeys,omitempty"` // The datacenter location Location *string `json:"location,omitempty" xmlrpc:"location,omitempty"` // The name associated with the order Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // The nickname for the vSRX service Nickname *string `json:"nickname,omitempty" xmlrpc:"nickname,omitempty"` // The number of instances to order Quantity *int `json:"quantity,omitempty" xmlrpc:"quantity,omitempty"` // The bare metal ram type Ram *string `json:"ram,omitempty" xmlrpc:"ram,omitempty"` // The bare metal server type Server *string `json:"server,omitempty" xmlrpc:"server,omitempty"` SharedStorage []Workload_Citrix_Workspace_Order_SharedStorage `json:"sharedStorage,omitempty" xmlrpc:"sharedStorage,omitempty"` // The subdomain for the ordered hosts (e.g. corp). Subdomain *string `json:"subdomain,omitempty" xmlrpc:"subdomain,omitempty"` // The vSphere version. Valid values are: "6.7" and "7.0" VSphereVersion *string `json:"vSphereVersion,omitempty" xmlrpc:"vSphereVersion,omitempty"` // The bare metal vsan cache disks (optional) VsanCacheDisks []string `json:"vsanCacheDisks,omitempty" xmlrpc:"vsanCacheDisks,omitempty"` }
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.
type Workload_Citrix_Workspace_Response ¶ added in v1.0.2
type Workload_Citrix_Workspace_Response struct { Entity // messageId associated with any error MessageId *string `json:"messageId,omitempty" xmlrpc:"messageId,omitempty"` // status of service methods Status *string `json:"status,omitempty" xmlrpc:"status,omitempty"` // status message StatusMessage *string `json:"statusMessage,omitempty" xmlrpc:"statusMessage,omitempty"` }
no documentation yet
type Workload_Citrix_Workspace_Response_Item ¶ added in v1.0.2
type Workload_Citrix_Workspace_Response_Item struct { Workload_Citrix_Workspace_Response // the id of the resource (HARDWARE, GUEST, VLAN, SUBNET, VMWARE) Id *string `json:"id,omitempty" xmlrpc:"id,omitempty"` // the name associated with the resource (e.g. name, hostname) Name *string `json:"name,omitempty" xmlrpc:"name,omitempty"` // the type of resource (HARDWARE, GUEST, NETWORK_VLAN, SUBNET) TypeName *string `json:"typeName,omitempty" xmlrpc:"typeName,omitempty"` }
no documentation yet
type Workload_Citrix_Workspace_Response_Result ¶ added in v1.0.2
type Workload_Citrix_Workspace_Response_Result struct { Workload_Citrix_Workspace_Response // identification and operation result for each item Items []Workload_Citrix_Workspace_Response `json:"items,omitempty" xmlrpc:"items,omitempty"` }
no documentation yet
Source Files ¶
- abuse.go
- account.go
- auxiliary.go
- billing.go
- bms.go
- brand.go
- business.go
- catalyst.go
- compliance.go
- configuration.go
- container.go
- device.go
- dns.go
- email.go
- entity.go
- event.go
- exception.go
- flexiblecredit.go
- hardware.go
- layout.go
- legal.go
- locale.go
- location.go
- marketplace.go
- mcafee.go
- metric.go
- monitoring.go
- network.go
- notification.go
- policy.go
- product.go
- provisioning.go
- resource.go
- sales.go
- scale.go
- search.go
- security.go
- service.go
- softlayer.go
- software.go
- sprint.go
- survey.go
- tag.go
- ticket.go
- trellix.go
- user.go
- utility.go
- vendor.go
- verify.go
- virtual.go
- workload.go