services

package
v1.2.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 12, 2025 License: Apache-2.0 Imports: 5 Imported by: 74

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Account 

type Account struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetAccountService 

func GetAccountService(sess session.SLSession) Account

GetAccountService returns an instance of the Account SoftLayer service

func (Account) ActivatePartner 

func (r Account) ActivatePartner(accountId *string, hashCode *string) (resp datatypes.Account, err error)

no documentation yet

func (Account) AddAchInformation 

func (r Account) AddAchInformation(achInformation *datatypes.Container_Billing_Info_Ach) (resp bool, err error)

no documentation yet

func (Account) AddReferralPartnerPaymentOption 

func (r Account) AddReferralPartnerPaymentOption(paymentOption *datatypes.Container_Referral_Partner_Payment_Option) (resp bool, err error)

no documentation yet

func (Account) AreVdrUpdatesBlockedForBilling 

func (r Account) AreVdrUpdatesBlockedForBilling() (resp bool, err error)

This method indicates whether or not Bandwidth Pooling updates are blocked for the account so the billing cycle can run. Generally, accounts are restricted from moving servers in or out of Bandwidth Pools from 12:00 CST on the day prior to billing, until the billing batch completes, sometime after midnight the day of actual billing for the account.

func (Account) CancelPayPalTransaction 

func (r Account) CancelPayPalTransaction(token *string, payerId *string) (resp bool, err error)

no documentation yet Deprecated: This function has been marked as deprecated.

func (Account) CompletePayPalTransaction 

func (r Account) CompletePayPalTransaction(token *string, payerId *string) (resp string, err error)

no documentation yet Deprecated: This function has been marked as deprecated.

func (Account) CountHourlyInstances 

func (r Account) CountHourlyInstances() (resp int, err error)

Retrieve the number of hourly services on an account that are active, plus any pending orders with hourly services attached.

func (Account) CreateUser 

func (r Account) CreateUser(templateObject *datatypes.User_Customer, password *string, vpnPassword *string, silentlyCreateFlag *bool) (resp datatypes.User_Customer, err error)

Create a new Customer user record in the SoftLayer customer portal. This is a wrapper around the Customer::createObject call, please see the documentation of that API. This wrapper adds the feature of the "silentlyCreate" option, which bypasses the IBMid invitation email process. False (the default) goes through the IBMid invitation email process, which creates the IBMid/SoftLayer Single-Sign-On (SSO) user link when the invitation is accepted (meaning the email has been received, opened, and the link(s) inside the email have been clicked to complete the process). True will silently (no email) create the IBMid/SoftLayer user SSO link immediately. Either case will use the value in the template object 'email' field to indicate the IBMid to use. This can be the username or, if unique, the email address of an IBMid. In the silent case, the IBMid must already exist. In the non-silent invitation email case, the IBMid can be created during this flow, by specifying an email address to be used to create the IBMid.All the features and restrictions of createObject apply to this API as well. In addition, note that the "silentlyCreate" flag is ONLY valid for IBMid-authenticated accounts.

func (Account) DisableEuSupport 

func (r Account) DisableEuSupport() (err error)

<p style="color:red"><strong>Warning</strong>: If you remove the EU Supported account flag, you are removing the restriction that limits Processing activities to EU personnel.</p>

func (Account) DisableVpnConfigRequiresVpnManageAttribute added in v1.0.4 

func (r Account) DisableVpnConfigRequiresVpnManageAttribute() (err error)

Disables the VPN_CONFIG_REQUIRES_VPN_MANAGE attribute on the account. If the attribute does not exist for the account, it will be created and set to false.

func (Account) EditAccount 

func (r Account) EditAccount(modifiedAccountInformation *datatypes.Account) (resp datatypes.Container_Account_Update_Response, err error)

This method will edit the account's information. Pass in a SoftLayer_Account template with the fields to be modified. Certain changes to the account will automatically create a ticket for manual review. This will be returned with the SoftLayer_Container_Account_Update_Response.<br> <br> The following fields are editable:<br> <br> <ul> <li>companyName</li> <li>firstName</li> <li>lastName</li> <li>address1</li> <li>address2</li> <li>city</li> <li>state</li> <li>country</li> <li>postalCode</li> <li>email</li> <li>officePhone</li> <li>alternatePhone</li> <li>faxPhone</li> <li>abuseEmails.email</li> <li>billingInfo.vatId</li> </ul>

func (Account) EnableEuSupport 

func (r Account) EnableEuSupport() (err error)

<p> If you select the EU Supported option, the most common Support issues will be limited to IBM Cloud staff located in the EU. In the event your issue requires non-EU expert assistance, it will be reviewed and approval given prior to any non-EU intervention. Additionally, in order to support and update the services, cross-border Processing of your data may still occur. Please ensure you take the necessary actions to allow this Processing, as detailed in the <strong><a href="http://www-03.ibm.com/software/sla/sladb.nsf/sla/bm-6605-12">Cloud Service Terms</a></strong>. A standard Data Processing Addendum is available <strong><a href="https://www-05.ibm.com/support/operations/zz/en/dpa.html">here</a></strong>. </p>

<p> <strong>Important note (you will only see this once):</strong> Orders using the API will proceed without additional notifications. The terms related to selecting products, services, or locations outside the EU apply to API orders. Users you create and API keys you generate will have the ability to order products, services, and locations outside of the EU. It is your responsibility to educate anyone you grant access to your account on the consequences and requirements if they make a selection that is not in the EU Supported option. In order to meet EU Supported requirements, the current PPTP VPN solution will no longer be offered or supported. </p>

<p> If PPTP has been selected as an option for any users in your account by itself (or in combination with another VPN offering), you will need to disable PPTP before selecting the EU Supported account feature. For more information on VPN changes, click <strong><a href="http://knowledgelayer.softlayer.com/procedure/activate-or-deactivate-pptp-vpn-access-user"> here</a></strong>. </p>

func (Account) EnableVpnConfigRequiresVpnManageAttribute added in v1.0.4 

func (r Account) EnableVpnConfigRequiresVpnManageAttribute() (err error)

Enables the VPN_CONFIG_REQUIRES_VPN_MANAGE attribute on the account. If the attribute does not exist for the account, it will be created and set to true.

func (Account) Filter 

func (r Account) Filter(filter string) Account

func (Account) GetAbuseEmail 

func (r Account) GetAbuseEmail() (resp string, err error)

Retrieve An email address that is responsible for abuse and legal inquiries on behalf of an account. For instance, new legal and abuse tickets are sent to this address.

func (Account) GetAbuseEmails 

func (r Account) GetAbuseEmails() (resp []datatypes.Account_AbuseEmail, err error)

Retrieve Email addresses that are responsible for abuse and legal inquiries on behalf of an account. For instance, new legal and abuse tickets are sent to these addresses.

func (Account) GetAccountBackupHistory 

func (r Account) GetAccountBackupHistory(startDate *datatypes.Time, endDate *datatypes.Time, backupStatus *string) (resp []datatypes.Container_Network_Storage_Evault_WebCc_JobDetails, err error)

This method returns an array of SoftLayer_Container_Network_Storage_Evault_WebCc_JobDetails objects for the given start and end dates. Start and end dates should be be valid ISO 8601 dates. The backupStatus can be one of null, 'success', 'failed', or 'conflict'. The 'success' backupStatus returns jobs with a status of 'COMPLETED', the 'failed' backupStatus returns jobs with a status of 'FAILED', while the 'conflict' backupStatus will return jobs that are not 'COMPLETED' or 'FAILED'.

func (Account) GetAccountContacts 

func (r Account) GetAccountContacts() (resp []datatypes.Account_Contact, err error)

Retrieve The account contacts on an account.

func (Account) GetAccountLicenses 

func (r Account) GetAccountLicenses() (resp []datatypes.Software_AccountLicense, err error)

Retrieve The account software licenses owned by an account 

func (r Account) GetAccountLinks() (resp []datatypes.Account_Link, err error)

Retrieve

func (Account) GetAccountStatus 

func (r Account) GetAccountStatus() (resp datatypes.Account_Status, err error)

Retrieve An account's status presented in a more detailed data type.

func (Account) GetAccountTraitValue 

func (r Account) GetAccountTraitValue(keyName *string) (resp string, err error)

This method pulls an account trait by its key.

func (Account) GetActiveAccountDiscountBillingItem 

func (r Account) GetActiveAccountDiscountBillingItem() (resp datatypes.Billing_Item, err error)

Retrieve The billing item associated with an account's monthly discount.

func (Account) GetActiveAccountLicenses 

func (r Account) GetActiveAccountLicenses() (resp []datatypes.Software_AccountLicense, err error)

Retrieve The active account software licenses owned by an account

func (Account) GetActiveAddresses 

func (r Account) GetActiveAddresses() (resp []datatypes.Account_Address, err error)

Retrieve The active address(es) that belong to an account.

func (Account) GetActiveAgreements 

func (r Account) GetActiveAgreements() (resp []datatypes.Account_Agreement, err error)

Retrieve All active agreements for an account

func (Account) GetActiveBillingAgreements 

func (r Account) GetActiveBillingAgreements() (resp []datatypes.Account_Agreement, err error)

Retrieve All billing agreements for an account

func (Account) GetActiveCatalystEnrollment 

func (r Account) GetActiveCatalystEnrollment() (resp datatypes.Catalyst_Enrollment, err error)

Retrieve

func (Account) GetActiveColocationContainers 

func (r Account) GetActiveColocationContainers() (resp []datatypes.Billing_Item, err error)

Retrieve Deprecated.

func (Account) GetActiveFlexibleCreditEnrollment 

func (r Account) GetActiveFlexibleCreditEnrollment() (resp datatypes.FlexibleCredit_Enrollment, err error)

Retrieve [Deprecated] Please use SoftLayer_Account::activeFlexibleCreditEnrollments.

func (Account) GetActiveFlexibleCreditEnrollments 

func (r Account) GetActiveFlexibleCreditEnrollments() (resp []datatypes.FlexibleCredit_Enrollment, err error)

Retrieve

func (Account) GetActiveNotificationSubscribers 

func (r Account) GetActiveNotificationSubscribers() (resp []datatypes.Notification_Subscriber, err error)

Retrieve

func (Account) GetActiveOutletPackages 

func (r Account) GetActiveOutletPackages() (resp []datatypes.Product_Package, err error)

This is deprecated and will not return any results. Deprecated: This function has been marked as deprecated.

func (Account) GetActivePackages 

func (r Account) GetActivePackages() (resp []datatypes.Product_Package, err error)

This method will return the [[SoftLayer_Product_Package]] objects from which you can order a bare metal server, virtual server, service (such as CDN or Object Storage) or other software. Once you have the package you want to order from, you may query one of various endpoints from that package to get specific information about its products and pricing. See [[SoftLayer_Product_Package/getCategories|getCategories]] or [[SoftLayer_Product_Package/getItems|getItems]] for more information.

Packages that have been retired will not appear in this result set.

func (Account) GetActivePackagesByAttribute 

func (r Account) GetActivePackagesByAttribute(attributeKeyName *string) (resp []datatypes.Product_Package, err error)

<strong>This method is deprecated and should not be used in production code.</strong>

This method will return the [[SoftLayer_Product_Package]] objects from which you can order a bare metal server, virtual server, service (such as CDN or Object Storage) or other software filtered by an attribute type associated with the package. Once you have the package you want to order from, you may query one of various endpoints from that package to get specific information about its products and pricing. See [[SoftLayer_Product_Package/getCategories|getCategories]] or [[SoftLayer_Product_Package/getItems|getItems]] for more information. Deprecated: This function has been marked as deprecated.

func (Account) GetActivePrivateHostedCloudPackages 

func (r Account) GetActivePrivateHostedCloudPackages() (resp []datatypes.Product_Package, err error)

[DEPRECATED] This method pulls all the active private hosted cloud packages. This will give you a basic description of the packages that are currently active and from which you can order private hosted cloud configurations. Deprecated: This function has been marked as deprecated.

func (Account) GetActiveQuotes 

func (r Account) GetActiveQuotes() (resp []datatypes.Billing_Order_Quote, err error)

Retrieve An account's non-expired quotes.

func (Account) GetActiveReservedCapacityAgreements 

func (r Account) GetActiveReservedCapacityAgreements() (resp []datatypes.Account_Agreement, err error)

Retrieve Active reserved capacity agreements for an account

func (Account) GetActiveVirtualLicenses 

func (r Account) GetActiveVirtualLicenses() (resp []datatypes.Software_VirtualLicense, err error)

Retrieve The virtual software licenses controlled by an account

func (Account) GetAdcLoadBalancers 

func (r Account) GetAdcLoadBalancers() (resp []datatypes.Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress, err error)

Retrieve An account's associated load balancers.

func (Account) GetAddresses 

func (r Account) GetAddresses() (resp []datatypes.Account_Address, err error)

Retrieve All the address(es) that belong to an account.

func (Account) GetAffiliateId 

func (r Account) GetAffiliateId() (resp string, err error)

Retrieve An affiliate identifier associated with the customer account.

func (Account) GetAllBillingItems 

func (r Account) GetAllBillingItems() (resp []datatypes.Billing_Item, err error)

Retrieve The billing items that will be on an account's next invoice.

func (Account) GetAllCommissionBillingItems 

func (r Account) GetAllCommissionBillingItems() (resp []datatypes.Billing_Item, err error)

Retrieve The billing items that will be on an account's next invoice.

func (Account) GetAllRecurringTopLevelBillingItems 

func (r Account) GetAllRecurringTopLevelBillingItems() (resp []datatypes.Billing_Item, err error)

Retrieve The billing items that will be on an account's next invoice.

func (Account) GetAllRecurringTopLevelBillingItemsUnfiltered 

func (r Account) GetAllRecurringTopLevelBillingItemsUnfiltered() (resp []datatypes.Billing_Item, err error)

Retrieve The billing items that will be on an account's next invoice. Does not consider associated items.

func (Account) GetAllSubnetBillingItems 

func (r Account) GetAllSubnetBillingItems() (resp []datatypes.Billing_Item, err error)

Retrieve The billing items that will be on an account's next invoice.

func (Account) GetAllTopLevelBillingItems 

func (r Account) GetAllTopLevelBillingItems() (resp []datatypes.Billing_Item, err error)

Retrieve All billing items of an account.

func (Account) GetAllTopLevelBillingItemsUnfiltered 

func (r Account) GetAllTopLevelBillingItemsUnfiltered() (resp []datatypes.Billing_Item, err error)

Retrieve The billing items that will be on an account's next invoice. Does not consider associated items.

func (Account) GetAllowIbmIdSilentMigrationFlag 

func (r Account) GetAllowIbmIdSilentMigrationFlag() (resp bool, err error)

Retrieve Indicates whether this account is allowed to silently migrate to use IBMid Authentication.

func (Account) GetAllowsBluemixAccountLinkingFlag 

func (r Account) GetAllowsBluemixAccountLinkingFlag() (resp bool, err error)

Retrieve Flag indicating if this account can be linked with Bluemix.

func (Account) GetAlternateCreditCardData 

func (r Account) GetAlternateCreditCardData() (resp datatypes.Container_Account_Payment_Method_CreditCard, err error)

no documentation yet

func (Account) GetApplicationDeliveryControllers 

func (r Account) GetApplicationDeliveryControllers() (resp []datatypes.Network_Application_Delivery_Controller, err error)

Retrieve An account's associated application delivery controller records.

func (Account) GetAttributeByType 

func (r Account) GetAttributeByType(attributeType *string) (resp datatypes.Account_Attribute, err error)

Retrieve a single [[SoftLayer_Account_Attribute]] record by its [[SoftLayer_Account_Attribute_Type|types's]] key name.

func (Account) GetAttributes 

func (r Account) GetAttributes() (resp []datatypes.Account_Attribute, err error)

Retrieve The account attribute values for a SoftLayer customer account.

func (Account) GetAuxiliaryNotifications 

func (r Account) GetAuxiliaryNotifications() (resp []datatypes.Container_Utility_Message, err error)

no documentation yet

func (Account) GetAvailablePublicNetworkVlans 

func (r Account) GetAvailablePublicNetworkVlans() (resp []datatypes.Network_Vlan, err error)

Retrieve The public network VLANs assigned to an account.

func (Account) GetBalance 

func (r Account) GetBalance() (resp datatypes.Float64, err error)

Retrieve The account balance of a SoftLayer customer account. An account's balance is the amount of money owed to SoftLayer by the account holder, returned as a floating point number with two decimal places, measured in US Dollars ($USD). A negative account balance means the account holder has overpaid and is owed money by SoftLayer.

func (Account) GetBandwidthAllotments 

func (r Account) GetBandwidthAllotments() (resp []datatypes.Network_Bandwidth_Version1_Allotment, err error)

Retrieve The bandwidth allotments for an account.

func (Account) GetBandwidthAllotmentsOverAllocation 

func (r Account) GetBandwidthAllotmentsOverAllocation() (resp []datatypes.Network_Bandwidth_Version1_Allotment, err error)

Retrieve The bandwidth allotments for an account currently over allocation.

func (Account) GetBandwidthAllotmentsProjectedOverAllocation 

func (r Account) GetBandwidthAllotmentsProjectedOverAllocation() (resp []datatypes.Network_Bandwidth_Version1_Allotment, err error)

Retrieve The bandwidth allotments for an account projected to go over allocation.

func (Account) GetBandwidthList added in v1.0.1 

func (r Account) GetBandwidthList(networkType *string, direction *string, startDate *string, endDate *string, serverIds []int) (resp []datatypes.Container_Bandwidth_Usage, err error)

no documentation yet

func (Account) GetBareMetalInstances 

func (r Account) GetBareMetalInstances() (resp []datatypes.Hardware, err error)

Retrieve An account's associated bare metal server objects.

func (Account) GetBillingAgreements 

func (r Account) GetBillingAgreements() (resp []datatypes.Account_Agreement, err error)

Retrieve All billing agreements for an account

func (Account) GetBillingInfo 

func (r Account) GetBillingInfo() (resp datatypes.Billing_Info, err error)

Retrieve An account's billing information.

func (Account) GetBlockDeviceTemplateGroups 

func (r Account) GetBlockDeviceTemplateGroups() (resp []datatypes.Virtual_Guest_Block_Device_Template_Group, err error)

Retrieve Private template group objects (parent and children) and the shared template group objects (parent only) for an account.

func (Account) GetBlockSelfServiceBrandMigration added in v1.1.4 

func (r Account) GetBlockSelfServiceBrandMigration() (resp bool, err error)

Retrieve Flag indicating whether this account is restricted from performing a self-service brand migration by updating their credit card details.

func (Account) GetBluemixAccountId added in v1.1.3 

func (r Account) GetBluemixAccountId() (resp string, err error)

Retrieve 

func (r Account) GetBluemixAccountLink() (resp datatypes.Account_Link_Bluemix, err error)

Retrieve The Platform account link associated with this SoftLayer account, if one exists.

func (Account) GetBluemixLinkedFlag 

func (r Account) GetBluemixLinkedFlag() (resp bool, err error)

Retrieve Returns true if this account is linked to IBM Bluemix, false if not.

func (Account) GetBrand 

func (r Account) GetBrand() (resp datatypes.Brand, err error)

Retrieve

func (Account) GetBrandAccountFlag 

func (r Account) GetBrandAccountFlag() (resp bool, err error)

Retrieve

func (Account) GetBrandKeyName 

func (r Account) GetBrandKeyName() (resp string, err error)

Retrieve The brand keyName.

func (Account) GetBusinessPartner 

func (r Account) GetBusinessPartner() (resp datatypes.Account_Business_Partner, err error)

Retrieve The Business Partner details for the account. Country Enterprise Code, Channel, Segment, Reseller Level.

func (Account) GetCanOrderAdditionalVlansFlag 

func (r Account) GetCanOrderAdditionalVlansFlag() (resp bool, err error)

Retrieve [DEPRECATED] All accounts may order VLANs.

func (Account) GetCarts 

func (r Account) GetCarts() (resp []datatypes.Billing_Order_Quote, err error)

Retrieve An account's active carts.

func (Account) GetCatalystEnrollments 

func (r Account) GetCatalystEnrollments() (resp []datatypes.Catalyst_Enrollment, err error)

Retrieve

func (Account) GetClosedTickets 

func (r Account) GetClosedTickets() (resp []datatypes.Ticket, err error)

Retrieve All closed tickets associated with an account.

func (Account) GetCurrentUser 

func (r Account) GetCurrentUser() (resp datatypes.User_Customer, err error)

Retrieve the user record of the user calling the SoftLayer API.

func (Account) GetDatacentersWithSubnetAllocations 

func (r Account) GetDatacentersWithSubnetAllocations() (resp []datatypes.Location, err error)

Retrieve [DEPRECATED] Datacenters which contain subnets that the account has access to route.

func (Account) GetDedicatedHosts 

func (r Account) GetDedicatedHosts() (resp []datatypes.Virtual_DedicatedHost, err error)

Retrieve An account's associated virtual dedicated host objects.

func (Account) GetDedicatedHostsForImageTemplate 

func (r Account) GetDedicatedHostsForImageTemplate(imageTemplateId *int) (resp []datatypes.Virtual_DedicatedHost, err error)

This returns a collection of dedicated hosts that are valid for a given image template.

func (Account) GetDisablePaymentProcessingFlag 

func (r Account) GetDisablePaymentProcessingFlag() (resp bool, err error)

Retrieve A flag indicating whether payments are processed for this account.

func (Account) GetDisplaySupportRepresentativeAssignments 

func (r Account) GetDisplaySupportRepresentativeAssignments() (resp []datatypes.Account_Attachment_Employee, err error)

Retrieve The SoftLayer employees that an account is assigned to.

func (Account) GetDomains 

func (r Account) GetDomains() (resp []datatypes.Dns_Domain, err error)

Retrieve The DNS domains associated with an account.

func (Account) GetDomainsWithoutSecondaryDnsRecords 

func (r Account) GetDomainsWithoutSecondaryDnsRecords() (resp []datatypes.Dns_Domain, err error)

Retrieve The DNS domains associated with an account that were not created as a result of a secondary DNS zone transfer.

func (Account) GetEuSupportedFlag 

func (r Account) GetEuSupportedFlag() (resp bool, err error)

Retrieve Boolean flag dictating whether or not this account has the EU Supported flag. This flag indicates that this account uses IBM Cloud services to process EU citizen's personal data.

func (Account) GetEvaultCapacityGB 

func (r Account) GetEvaultCapacityGB() (resp uint, err error)

Retrieve The total capacity of Legacy EVault Volumes on an account, in GB.

func (Account) GetEvaultMasterUsers 

func (r Account) GetEvaultMasterUsers() (resp []datatypes.Account_Password, err error)

Retrieve An account's master EVault user. This is only used when an account has EVault service.

func (Account) GetEvaultNetworkStorage 

func (r Account) GetEvaultNetworkStorage() (resp []datatypes.Network_Storage, err error)

Retrieve An account's associated EVault storage volumes.

func (Account) GetExpiredSecurityCertificates 

func (r Account) GetExpiredSecurityCertificates() (resp []datatypes.Security_Certificate, err error)

Retrieve Stored security certificates that are expired (ie. SSL)

func (Account) GetFacilityLogs 

func (r Account) GetFacilityLogs() (resp []datatypes.User_Access_Facility_Log, err error)

Retrieve Logs of who entered a colocation area which is assigned to this account, or when a user under this account enters a datacenter.

func (Account) GetFileBlockBetaAccessFlag 

func (r Account) GetFileBlockBetaAccessFlag() (resp bool, err error)

Retrieve

func (Account) GetFlexibleCreditEnrollments 

func (r Account) GetFlexibleCreditEnrollments() (resp []datatypes.FlexibleCredit_Enrollment, err error)

Retrieve All of the account's current and former Flexible Credit enrollments.

func (Account) GetFlexibleCreditProgramInfo 

func (r Account) GetFlexibleCreditProgramInfo(forNextBillCycle *bool) (resp datatypes.Container_Account_Discount_Program, err error)

[DEPRECATED] Please use SoftLayer_Account::getFlexibleCreditProgramsInfo.

This method will return a [[SoftLayer_Container_Account_Discount_Program]] object containing the Flexible Credit Program information for this account. To be considered an active participant, the account must have an enrollment record with a monthly credit amount set and the current date must be within the range defined by the enrollment and graduation date. The forNextBillCycle parameter can be set to true to return a SoftLayer_Container_Account_Discount_Program object with information with relation to the next bill cycle. The forNextBillCycle parameter defaults to false. Please note that all discount amount entries are reported as pre-tax amounts and the legacy tax fields in the [[SoftLayer_Container_Account_Discount_Program]] are deprecated. Deprecated: This function has been marked as deprecated.

func (Account) GetFlexibleCreditProgramsInfo 

func (r Account) GetFlexibleCreditProgramsInfo(nextBillingCycleFlag *bool) (resp datatypes.Container_Account_Discount_Program_Collection, err error)

This method will return a [[SoftLayer_Container_Account_Discount_Program_Collection]] object containing information on all of the Flexible Credit Programs your account is enrolled in. To be considered an active participant, the account must have at least one enrollment record with a monthly credit amount set and the current date must be within the range defined by the enrollment and graduation date. The forNextBillCycle parameter can be set to true to return a SoftLayer_Container_Account_Discount_Program_Collection object with information with relation to the next bill cycle. The forNextBillCycle parameter defaults to false. Please note that all discount amount entries are reported as pre-tax amounts.

func (Account) GetForcePaasAccountLinkDate 

func (r Account) GetForcePaasAccountLinkDate() (resp string, err error)

Retrieve Timestamp representing the point in time when an account is required to link with PaaS.

func (Account) GetGlobalIpRecords 

func (r Account) GetGlobalIpRecords() (resp []datatypes.Network_Subnet_IpAddress_Global, err error)

Retrieve

func (Account) GetGlobalIpv4Records 

func (r Account) GetGlobalIpv4Records() (resp []datatypes.Network_Subnet_IpAddress_Global, err error)

Retrieve

func (Account) GetGlobalIpv6Records 

func (r Account) GetGlobalIpv6Records() (resp []datatypes.Network_Subnet_IpAddress_Global, err error)

Retrieve

func (Account) GetHardware 

func (r Account) GetHardware() (resp []datatypes.Hardware, err error)

Retrieve An account's associated hardware objects.

func (Account) GetHardwareOverBandwidthAllocation 

func (r Account) GetHardwareOverBandwidthAllocation() (resp []datatypes.Hardware, err error)

Retrieve An account's associated hardware objects currently over bandwidth allocation.

func (Account) GetHardwarePools 

func (r Account) GetHardwarePools() (resp []datatypes.Container_Hardware_Pool_Details, err error)

Return a collection of managed hardware pools.

func (Account) GetHardwareProjectedOverBandwidthAllocation 

func (r Account) GetHardwareProjectedOverBandwidthAllocation() (resp []datatypes.Hardware, err error)

Retrieve An account's associated hardware objects projected to go over bandwidth allocation.

func (Account) GetHardwareWithCpanel 

func (r Account) GetHardwareWithCpanel() (resp []datatypes.Hardware, err error)

Retrieve All hardware associated with an account that has the cPanel web hosting control panel installed.

func (Account) GetHardwareWithHelm 

func (r Account) GetHardwareWithHelm() (resp []datatypes.Hardware, err error)

Retrieve All hardware associated with an account that has the Helm web hosting control panel installed.

func (Account) GetHardwareWithMcafee 

func (r Account) GetHardwareWithMcafee() (resp []datatypes.Hardware, err error)

Retrieve All hardware associated with an account that has McAfee Secure software components.

func (Account) GetHardwareWithMcafeeAntivirusRedhat 

func (r Account) GetHardwareWithMcafeeAntivirusRedhat() (resp []datatypes.Hardware, err error)

Retrieve All hardware associated with an account that has McAfee Secure AntiVirus for Redhat software components.

func (Account) GetHardwareWithMcafeeAntivirusWindows 

func (r Account) GetHardwareWithMcafeeAntivirusWindows() (resp []datatypes.Hardware, err error)

Retrieve All hardware associated with an account that has McAfee Secure AntiVirus for Windows software components.

func (Account) GetHardwareWithMcafeeIntrusionDetectionSystem 

func (r Account) GetHardwareWithMcafeeIntrusionDetectionSystem() (resp []datatypes.Hardware, err error)

Retrieve All hardware associated with an account that has McAfee Secure Intrusion Detection System software components.

func (Account) GetHardwareWithPlesk 

func (r Account) GetHardwareWithPlesk() (resp []datatypes.Hardware, err error)

Retrieve All hardware associated with an account that has the Plesk web hosting control panel installed.

func (Account) GetHardwareWithQuantastor 

func (r Account) GetHardwareWithQuantastor() (resp []datatypes.Hardware, err error)

Retrieve All hardware associated with an account that has the QuantaStor storage system installed.

func (Account) GetHardwareWithUrchin 

func (r Account) GetHardwareWithUrchin() (resp []datatypes.Hardware, err error)

Retrieve All hardware associated with an account that has the Urchin web traffic analytics package installed.

func (Account) GetHardwareWithWindows 

func (r Account) GetHardwareWithWindows() (resp []datatypes.Hardware, err error)

Retrieve All hardware associated with an account that is running a version of the Microsoft Windows operating system.

func (Account) GetHasEvaultBareMetalRestorePluginFlag 

func (r Account) GetHasEvaultBareMetalRestorePluginFlag() (resp bool, err error)

Retrieve Return 1 if one of the account's hardware has the EVault Bare Metal Server Restore Plugin otherwise 0.

func (Account) GetHasIderaBareMetalRestorePluginFlag 

func (r Account) GetHasIderaBareMetalRestorePluginFlag() (resp bool, err error)

Retrieve Return 1 if one of the account's hardware has an installation of Idera Server Backup otherwise 0.

func (Account) GetHasPendingOrder 

func (r Account) GetHasPendingOrder() (resp uint, err error)

Retrieve The number of orders in a PENDING status for a SoftLayer customer account.

func (Account) GetHasR1softBareMetalRestorePluginFlag 

func (r Account) GetHasR1softBareMetalRestorePluginFlag() (resp bool, err error)

Retrieve Return 1 if one of the account's hardware has an installation of R1Soft CDP otherwise 0.

func (Account) GetHourlyBareMetalInstances 

func (r Account) GetHourlyBareMetalInstances() (resp []datatypes.Hardware, err error)

Retrieve An account's associated hourly bare metal server objects.

func (Account) GetHourlyServiceBillingItems 

func (r Account) GetHourlyServiceBillingItems() (resp []datatypes.Billing_Item, err error)

Retrieve Hourly service billing items that will be on an account's next invoice.

func (Account) GetHourlyVirtualGuests 

func (r Account) GetHourlyVirtualGuests() (resp []datatypes.Virtual_Guest, err error)

Retrieve An account's associated hourly virtual guest objects.

func (Account) GetHubNetworkStorage 

func (r Account) GetHubNetworkStorage() (resp []datatypes.Network_Storage, err error)

Retrieve An account's associated Virtual Storage volumes.

func (Account) GetIbmCustomerNumber 

func (r Account) GetIbmCustomerNumber() (resp string, err error)

Retrieve Unique identifier for a customer used throughout IBM.

func (Account) GetIbmIdAuthenticationRequiredFlag 

func (r Account) GetIbmIdAuthenticationRequiredFlag() (resp bool, err error)

Retrieve Indicates whether this account requires IBMid authentication.

func (Account) GetIbmIdMigrationExpirationTimestamp 

func (r Account) GetIbmIdMigrationExpirationTimestamp() (resp string, err error)

Retrieve This key is deprecated and should not be used.

func (Account) GetInProgressExternalAccountSetup 

func (r Account) GetInProgressExternalAccountSetup() (resp datatypes.Account_External_Setup, err error)

Retrieve An in progress request to switch billing systems.

func (Account) GetInternalCciHostAccountFlag added in v1.1.2 

func (r Account) GetInternalCciHostAccountFlag() (resp bool, err error)

Retrieve Account attribute flag indicating internal cci host account.

func (Account) GetInternalImageTemplateCreationFlag added in v1.1.2 

func (r Account) GetInternalImageTemplateCreationFlag() (resp bool, err error)

Retrieve Account attribute flag indicating account creates internal image templates.

func (Account) GetInternalNotes 

func (r Account) GetInternalNotes() (resp []datatypes.Account_Note, err error)

Retrieve

func (Account) GetInternalRestrictionFlag added in v1.1.2 

func (r Account) GetInternalRestrictionFlag() (resp bool, err error)

Retrieve Account attribute flag indicating restricted account.

func (Account) GetInvoices 

func (r Account) GetInvoices() (resp []datatypes.Billing_Invoice, err error)

Retrieve An account's associated billing invoices.

func (Account) GetIpAddresses 

func (r Account) GetIpAddresses() (resp []datatypes.Network_Subnet_IpAddress, err error)

Retrieve

func (Account) GetIscsiIsolationDisabled 

func (r Account) GetIscsiIsolationDisabled() (resp bool, err error)

Retrieve

func (Account) GetIscsiNetworkStorage 

func (r Account) GetIscsiNetworkStorage() (resp []datatypes.Network_Storage, err error)

Retrieve An account's associated iSCSI storage volumes.

func (Account) GetLastCanceledBillingItem 

func (r Account) GetLastCanceledBillingItem() (resp datatypes.Billing_Item, err error)

Retrieve The most recently canceled billing item.

func (Account) GetLastCancelledServerBillingItem 

func (r Account) GetLastCancelledServerBillingItem() (resp datatypes.Billing_Item, err error)

Retrieve The most recent cancelled server billing item.

func (Account) GetLastFiveClosedAbuseTickets 

func (r Account) GetLastFiveClosedAbuseTickets() (resp []datatypes.Ticket, err error)

Retrieve The five most recently closed abuse tickets associated with an account.

func (Account) GetLastFiveClosedAccountingTickets 

func (r Account) GetLastFiveClosedAccountingTickets() (resp []datatypes.Ticket, err error)

Retrieve The five most recently closed accounting tickets associated with an account.

func (Account) GetLastFiveClosedOtherTickets 

func (r Account) GetLastFiveClosedOtherTickets() (resp []datatypes.Ticket, err error)

Retrieve The five most recently closed tickets that do not belong to the abuse, accounting, sales, or support groups associated with an account.

func (Account) GetLastFiveClosedSalesTickets 

func (r Account) GetLastFiveClosedSalesTickets() (resp []datatypes.Ticket, err error)

Retrieve The five most recently closed sales tickets associated with an account.

func (Account) GetLastFiveClosedSupportTickets 

func (r Account) GetLastFiveClosedSupportTickets() (resp []datatypes.Ticket, err error)

Retrieve The five most recently closed support tickets associated with an account.

func (Account) GetLastFiveClosedTickets 

func (r Account) GetLastFiveClosedTickets() (resp []datatypes.Ticket, err error)

Retrieve The five most recently closed tickets associated with an account.

func (Account) GetLatestBillDate 

func (r Account) GetLatestBillDate() (resp datatypes.Time, err error)

Retrieve An account's most recent billing date.

func (Account) GetLatestRecurringInvoice 

func (r Account) GetLatestRecurringInvoice() (resp datatypes.Billing_Invoice, err error)

Retrieve An account's latest recurring invoice.

func (Account) GetLatestRecurringPendingInvoice 

func (r Account) GetLatestRecurringPendingInvoice() (resp datatypes.Billing_Invoice, err error)

Retrieve An account's latest recurring pending invoice.

func (Account) GetLegacyIscsiCapacityGB 

func (r Account) GetLegacyIscsiCapacityGB() (resp uint, err error)

Retrieve The total capacity of Legacy iSCSI Volumes on an account, in GB.

func (Account) GetLoadBalancers 

func (r Account) GetLoadBalancers() (resp []datatypes.Network_LoadBalancer_VirtualIpAddress, err error)

Retrieve An account's associated load balancers.

func (Account) GetLockboxCapacityGB 

func (r Account) GetLockboxCapacityGB() (resp uint, err error)

Retrieve The total capacity of Legacy lockbox Volumes on an account, in GB.

func (Account) GetLockboxNetworkStorage 

func (r Account) GetLockboxNetworkStorage() (resp []datatypes.Network_Storage, err error)

Retrieve An account's associated Lockbox storage volumes.

func (Account) GetManualPaymentsUnderReview 

func (r Account) GetManualPaymentsUnderReview() (resp []datatypes.Billing_Payment_Card_ManualPayment, err error)

Retrieve

func (Account) GetMasterUser 

func (r Account) GetMasterUser() (resp datatypes.User_Customer, err error)

Retrieve An account's master user.

func (Account) GetMediaDataTransferRequests 

func (r Account) GetMediaDataTransferRequests() (resp []datatypes.Account_Media_Data_Transfer_Request, err error)

Retrieve An account's media transfer service requests.

func (Account) GetMigratedToIbmCloudPortalFlag 

func (r Account) GetMigratedToIbmCloudPortalFlag() (resp bool, err error)

Retrieve Flag indicating whether this account is restricted to the IBM Cloud portal.

func (Account) GetMonthlyBareMetalInstances 

func (r Account) GetMonthlyBareMetalInstances() (resp []datatypes.Hardware, err error)

Retrieve An account's associated monthly bare metal server objects.

func (Account) GetMonthlyVirtualGuests 

func (r Account) GetMonthlyVirtualGuests() (resp []datatypes.Virtual_Guest, err error)

Retrieve An account's associated monthly virtual guest objects.

func (Account) GetNasNetworkStorage 

func (r Account) GetNasNetworkStorage() (resp []datatypes.Network_Storage, err error)

Retrieve An account's associated NAS storage volumes.

func (Account) GetNetAppActiveAccountLicenseKeys 

func (r Account) GetNetAppActiveAccountLicenseKeys() (resp []string, err error)

This returns a collection of active NetApp software account license keys.

func (Account) GetNetworkCreationFlag 

func (r Account) GetNetworkCreationFlag() (resp bool, err error)

Retrieve [Deprecated] Whether or not this account can define their own networks.

func (Account) GetNetworkGateways 

func (r Account) GetNetworkGateways() (resp []datatypes.Network_Gateway, err error)

Retrieve All network gateway devices on this account.

func (Account) GetNetworkHardware 

func (r Account) GetNetworkHardware() (resp []datatypes.Hardware, err error)

Retrieve An account's associated network hardware.

func (Account) GetNetworkMessageDeliveryAccounts 

func (r Account) GetNetworkMessageDeliveryAccounts() (resp []datatypes.Network_Message_Delivery, err error)

Retrieve

func (Account) GetNetworkMonitorDownHardware 

func (r Account) GetNetworkMonitorDownHardware() (resp []datatypes.Hardware, err error)

Retrieve Hardware which is currently experiencing a service failure.

func (Account) GetNetworkMonitorDownVirtualGuests 

func (r Account) GetNetworkMonitorDownVirtualGuests() (resp []datatypes.Virtual_Guest, err error)

Retrieve Virtual guest which is currently experiencing a service failure.

func (Account) GetNetworkMonitorRecoveringHardware 

func (r Account) GetNetworkMonitorRecoveringHardware() (resp []datatypes.Hardware, err error)

Retrieve Hardware which is currently recovering from a service failure.

func (Account) GetNetworkMonitorRecoveringVirtualGuests 

func (r Account) GetNetworkMonitorRecoveringVirtualGuests() (resp []datatypes.Virtual_Guest, err error)

Retrieve Virtual guest which is currently recovering from a service failure.

func (Account) GetNetworkMonitorUpHardware 

func (r Account) GetNetworkMonitorUpHardware() (resp []datatypes.Hardware, err error)

Retrieve Hardware which is currently online.

func (Account) GetNetworkMonitorUpVirtualGuests 

func (r Account) GetNetworkMonitorUpVirtualGuests() (resp []datatypes.Virtual_Guest, err error)

Retrieve Virtual guest which is currently online.

func (Account) GetNetworkStorage 

func (r Account) GetNetworkStorage() (resp []datatypes.Network_Storage, err error)

Retrieve An account's associated storage volumes. This includes Lockbox, NAS, EVault, and iSCSI volumes.

func (Account) GetNetworkStorageGroups 

func (r Account) GetNetworkStorageGroups() (resp []datatypes.Network_Storage_Group, err error)

Retrieve An account's Network Storage groups.

func (Account) GetNetworkTunnelContexts 

func (r Account) GetNetworkTunnelContexts() (resp []datatypes.Network_Tunnel_Module_Context, err error)

Retrieve IPSec network tunnels for an account.

func (Account) GetNetworkVlanSpan 

func (r Account) GetNetworkVlanSpan() (resp datatypes.Account_Network_Vlan_Span, err error)

Retrieve Whether or not an account has automatic private VLAN spanning enabled.

func (Account) GetNetworkVlans 

func (r Account) GetNetworkVlans() (resp []datatypes.Network_Vlan, err error)

Retrieve All network VLANs assigned to an account.

func (Account) GetNextInvoiceExcel 

func (r Account) GetNextInvoiceExcel(documentCreateDate *datatypes.Time) (resp []byte, err error)

Return an account's next invoice in a Microsoft excel format. The "next invoice" is what a customer will be billed on their next invoice, assuming no changes are made. Currently this does not include Bandwidth Pooling charges.

func (Account) GetNextInvoiceIncubatorExemptTotal 

func (r Account) GetNextInvoiceIncubatorExemptTotal() (resp datatypes.Float64, err error)

Retrieve The pre-tax total amount exempt from incubator credit for the account's next invoice. This field is now deprecated and will soon be removed. Please update all references to instead use nextInvoiceTotalAmount

func (Account) GetNextInvoicePdf 

func (r Account) GetNextInvoicePdf(documentCreateDate *datatypes.Time) (resp []byte, err error)

Return an account's next invoice in PDF format. The "next invoice" is what a customer will be billed on their next invoice, assuming no changes are made. Currently this does not include Bandwidth Pooling charges.

func (Account) GetNextInvoicePdfDetailed 

func (r Account) GetNextInvoicePdfDetailed(documentCreateDate *datatypes.Time) (resp []byte, err error)

Return an account's next invoice detailed portion in PDF format. The "next invoice" is what a customer will be billed on their next invoice, assuming no changes are made. Currently this does not include Bandwidth Pooling charges.

func (Account) GetNextInvoicePlatformServicesTotalAmount added in v1.1.6 

func (r Account) GetNextInvoicePlatformServicesTotalAmount() (resp datatypes.Float64, err error)

Retrieve The pre-tax platform services total amount of an account's next invoice.

func (Account) GetNextInvoiceRecurringAmountEligibleForAccountDiscount 

func (r Account) GetNextInvoiceRecurringAmountEligibleForAccountDiscount() (resp datatypes.Float64, err error)

Retrieve The total recurring charge amount of an account's next invoice eligible for account discount measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing.

func (Account) GetNextInvoiceTopLevelBillingItems 

func (r Account) GetNextInvoiceTopLevelBillingItems() (resp []datatypes.Billing_Item, err error)

Retrieve The billing items that will be on an account's next invoice.

func (Account) GetNextInvoiceTotalAmount 

func (r Account) GetNextInvoiceTotalAmount() (resp datatypes.Float64, err error)

Retrieve The pre-tax total amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing.

func (Account) GetNextInvoiceTotalOneTimeAmount 

func (r Account) GetNextInvoiceTotalOneTimeAmount() (resp datatypes.Float64, err error)

Retrieve The total one-time charge amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing.

func (Account) GetNextInvoiceTotalOneTimeTaxAmount 

func (r Account) GetNextInvoiceTotalOneTimeTaxAmount() (resp datatypes.Float64, err error)

Retrieve The total one-time tax amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing.

func (Account) GetNextInvoiceTotalRecurringAmount 

func (r Account) GetNextInvoiceTotalRecurringAmount() (resp datatypes.Float64, err error)

Retrieve The total recurring charge amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing.

func (Account) GetNextInvoiceTotalRecurringAmountBeforeAccountDiscount 

func (r Account) GetNextInvoiceTotalRecurringAmountBeforeAccountDiscount() (resp datatypes.Float64, err error)

Retrieve The total recurring charge amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing.

func (Account) GetNextInvoiceTotalRecurringTaxAmount 

func (r Account) GetNextInvoiceTotalRecurringTaxAmount() (resp datatypes.Float64, err error)

Retrieve The total recurring tax amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing.

func (Account) GetNextInvoiceTotalTaxableRecurringAmount 

func (r Account) GetNextInvoiceTotalTaxableRecurringAmount() (resp datatypes.Float64, err error)

Retrieve The total recurring charge amount of an account's next invoice measured in US Dollars ($USD), assuming no changes or charges occur between now and time of billing.

func (Account) GetNextInvoiceZeroFeeItemCounts 

func (r Account) GetNextInvoiceZeroFeeItemCounts() (resp []datatypes.Container_Product_Item_Category_ZeroFee_Count, err error)

no documentation yet

func (Account) GetNotificationSubscribers 

func (r Account) GetNotificationSubscribers() (resp []datatypes.Notification_Subscriber, err error)

Retrieve

func (Account) GetObject 

func (r Account) GetObject() (resp datatypes.Account, err error)

getObject retrieves the SoftLayer_Account object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Account service. You can only retrieve the account that your portal user is assigned to.

func (Account) GetOpenAbuseTickets 

func (r Account) GetOpenAbuseTickets() (resp []datatypes.Ticket, err error)

Retrieve The open abuse tickets associated with an account.

func (Account) GetOpenAccountingTickets 

func (r Account) GetOpenAccountingTickets() (resp []datatypes.Ticket, err error)

Retrieve The open accounting tickets associated with an account.

func (Account) GetOpenBillingTickets 

func (r Account) GetOpenBillingTickets() (resp []datatypes.Ticket, err error)

Retrieve The open billing tickets associated with an account.

func (Account) GetOpenCancellationRequests 

func (r Account) GetOpenCancellationRequests() (resp []datatypes.Billing_Item_Cancellation_Request, err error)

Retrieve An open ticket requesting cancellation of this server, if one exists.

func (Account) GetOpenOtherTickets 

func (r Account) GetOpenOtherTickets() (resp []datatypes.Ticket, err error)

Retrieve The open tickets that do not belong to the abuse, accounting, sales, or support groups associated with an account.

func (Account) GetOpenRecurringInvoices 

func (r Account) GetOpenRecurringInvoices() (resp []datatypes.Billing_Invoice, err error)

Retrieve An account's recurring invoices.

func (Account) GetOpenSalesTickets 

func (r Account) GetOpenSalesTickets() (resp []datatypes.Ticket, err error)

Retrieve The open sales tickets associated with an account.

func (Account) GetOpenStackObjectStorage 

func (r Account) GetOpenStackObjectStorage() (resp []datatypes.Network_Storage, err error)

Retrieve An account's associated Openstack related Object Storage accounts.

func (Account) GetOpenSupportTickets 

func (r Account) GetOpenSupportTickets() (resp []datatypes.Ticket, err error)

Retrieve The open support tickets associated with an account.

func (Account) GetOpenTickets 

func (r Account) GetOpenTickets() (resp []datatypes.Ticket, err error)

Retrieve All open tickets associated with an account.

func (Account) GetOpenTicketsWaitingOnCustomer 

func (r Account) GetOpenTicketsWaitingOnCustomer() (resp []datatypes.Ticket, err error)

Retrieve All open tickets associated with an account last edited by an employee.

func (Account) GetOrders 

func (r Account) GetOrders() (resp []datatypes.Billing_Order, err error)

Retrieve An account's associated billing orders excluding upgrades.

func (Account) GetOrphanBillingItems 

func (r Account) GetOrphanBillingItems() (resp []datatypes.Billing_Item, err error)

Retrieve The billing items that have no parent billing item. These are items that don't necessarily belong to a single server.

func (Account) GetOwnedBrands 

func (r Account) GetOwnedBrands() (resp []datatypes.Brand, err error)

Retrieve

func (Account) GetOwnedHardwareGenericComponentModels 

func (r Account) GetOwnedHardwareGenericComponentModels() (resp []datatypes.Hardware_Component_Model_Generic, err error)

Retrieve

func (Account) GetPaymentProcessors 

func (r Account) GetPaymentProcessors() (resp []datatypes.Billing_Payment_Processor, err error)

Retrieve

func (Account) GetPendingCreditCardChangeRequestData 

func (r Account) GetPendingCreditCardChangeRequestData() (resp []datatypes.Container_Account_Payment_Method_CreditCard, err error)

Before being approved for general use, a credit card must be approved by a SoftLayer agent. Once a credit card change request has been either approved or denied, the change request will no longer appear in the list of pending change requests. This method will return a list of all pending change requests as well as a portion of the data from the original request.

func (Account) GetPendingEvents 

func (r Account) GetPendingEvents() (resp []datatypes.Notification_Occurrence_Event, err error)

Retrieve

func (Account) GetPendingInvoice 

func (r Account) GetPendingInvoice() (resp datatypes.Billing_Invoice, err error)

Retrieve An account's latest open (pending) invoice.

func (Account) GetPendingInvoiceTopLevelItems 

func (r Account) GetPendingInvoiceTopLevelItems() (resp []datatypes.Billing_Invoice_Item, err error)

Retrieve A list of top-level invoice items that are on an account's currently pending invoice.

func (Account) GetPendingInvoiceTotalAmount 

func (r Account) GetPendingInvoiceTotalAmount() (resp datatypes.Float64, err error)

Retrieve The total amount of an account's pending invoice, if one exists.

func (Account) GetPendingInvoiceTotalOneTimeAmount 

func (r Account) GetPendingInvoiceTotalOneTimeAmount() (resp datatypes.Float64, err error)

Retrieve The total one-time charges for an account's pending invoice, if one exists. In other words, it is the sum of one-time charges, setup fees, and labor fees. It does not include taxes.

func (Account) GetPendingInvoiceTotalOneTimeTaxAmount 

func (r Account) GetPendingInvoiceTotalOneTimeTaxAmount() (resp datatypes.Float64, err error)

Retrieve The sum of all the taxes related to one time charges for an account's pending invoice, if one exists.

func (Account) GetPendingInvoiceTotalRecurringAmount 

func (r Account) GetPendingInvoiceTotalRecurringAmount() (resp datatypes.Float64, err error)

Retrieve The total recurring amount of an account's pending invoice, if one exists.

func (Account) GetPendingInvoiceTotalRecurringTaxAmount 

func (r Account) GetPendingInvoiceTotalRecurringTaxAmount() (resp datatypes.Float64, err error)

Retrieve The total amount of the recurring taxes on an account's pending invoice, if one exists.

func (Account) GetPermissionGroups 

func (r Account) GetPermissionGroups() (resp []datatypes.User_Permission_Group, err error)

Retrieve An account's permission groups.

func (Account) GetPermissionRoles 

func (r Account) GetPermissionRoles() (resp []datatypes.User_Permission_Role, err error)

Retrieve An account's user roles.

func (Account) GetPlacementGroups 

func (r Account) GetPlacementGroups() (resp []datatypes.Virtual_PlacementGroup, err error)

Retrieve An account's associated virtual placement groups.

func (Account) GetPortableStorageVolumes 

func (r Account) GetPortableStorageVolumes() (resp []datatypes.Virtual_Disk_Image, err error)

Retrieve

func (Account) GetPostProvisioningHooks 

func (r Account) GetPostProvisioningHooks() (resp []datatypes.Provisioning_Hook, err error)

Retrieve Customer specified URIs that are downloaded onto a newly provisioned or reloaded server. If the URI is sent over https it will be executed directly on the server.

func (Account) GetPptpVpnAllowedFlag 

func (r Account) GetPptpVpnAllowedFlag() (resp bool, err error)

Retrieve (Deprecated) Boolean flag dictating whether or not this account supports PPTP VPN Access.

func (Account) GetPptpVpnUsers 

func (r Account) GetPptpVpnUsers() (resp []datatypes.User_Customer, err error)

Retrieve An account's associated portal users with PPTP VPN access. (Deprecated)

func (Account) GetPreOpenRecurringInvoices added in v1.1.6 

func (r Account) GetPreOpenRecurringInvoices() (resp []datatypes.Billing_Invoice, err error)

Retrieve An account's invoices in the PRE_OPEN status.

func (Account) GetPreviousRecurringRevenue 

func (r Account) GetPreviousRecurringRevenue() (resp datatypes.Float64, err error)

Retrieve The total recurring amount for an accounts previous revenue.

func (Account) GetPriceRestrictions 

func (r Account) GetPriceRestrictions() (resp []datatypes.Product_Item_Price_Account_Restriction, err error)

Retrieve The item price that an account is restricted to.

func (Account) GetPriorityOneTickets 

func (r Account) GetPriorityOneTickets() (resp []datatypes.Ticket, err error)

Retrieve All priority one tickets associated with an account.

func (Account) GetPrivateBlockDeviceTemplateGroups 

func (r Account) GetPrivateBlockDeviceTemplateGroups() (resp []datatypes.Virtual_Guest_Block_Device_Template_Group, err error)

Retrieve Private and shared template group objects (parent only) for an account.

func (Account) GetPrivateIpAddresses 

func (r Account) GetPrivateIpAddresses() (resp []datatypes.Network_Subnet_IpAddress, err error)

Retrieve

func (Account) GetPrivateNetworkVlans 

func (r Account) GetPrivateNetworkVlans() (resp []datatypes.Network_Vlan, err error)

Retrieve The private network VLANs assigned to an account.

func (Account) GetPrivateSubnets 

func (r Account) GetPrivateSubnets() (resp []datatypes.Network_Subnet, err error)

Retrieve All private subnets associated with an account.

func (Account) GetProofOfConceptAccountFlag 

func (r Account) GetProofOfConceptAccountFlag() (resp bool, err error)

Retrieve Boolean flag indicating whether or not this account is a Proof of Concept account.

func (Account) GetPublicIpAddresses 

func (r Account) GetPublicIpAddresses() (resp []datatypes.Network_Subnet_IpAddress, err error)

Retrieve

func (Account) GetPublicNetworkVlans 

func (r Account) GetPublicNetworkVlans() (resp []datatypes.Network_Vlan, err error)

Retrieve The public network VLANs assigned to an account.

func (Account) GetPublicSubnets 

func (r Account) GetPublicSubnets() (resp []datatypes.Network_Subnet, err error)

Retrieve All public network subnets associated with an account.

func (Account) GetQuotes 

func (r Account) GetQuotes() (resp []datatypes.Billing_Order_Quote, err error)

Retrieve An account's quotes.

func (Account) GetRecentEvents 

func (r Account) GetRecentEvents() (resp []datatypes.Notification_Occurrence_Event, err error)

Retrieve

func (Account) GetReferralPartner 

func (r Account) GetReferralPartner() (resp datatypes.Account, err error)

Retrieve The Referral Partner for this account, if any.

func (Account) GetReferralPartnerCommissionForecast 

func (r Account) GetReferralPartnerCommissionForecast() (resp []datatypes.Container_Referral_Partner_Commission, err error)

no documentation yet

func (Account) GetReferralPartnerCommissionHistory 

func (r Account) GetReferralPartnerCommissionHistory() (resp []datatypes.Container_Referral_Partner_Commission, err error)

no documentation yet

func (Account) GetReferralPartnerCommissionPending 

func (r Account) GetReferralPartnerCommissionPending() (resp []datatypes.Container_Referral_Partner_Commission, err error)

no documentation yet

func (Account) GetReferredAccountFlag added in v1.1.2 

func (r Account) GetReferredAccountFlag() (resp bool, err error)

Retrieve Flag indicating if the account was referred.

func (Account) GetReferredAccounts 

func (r Account) GetReferredAccounts() (resp []datatypes.Account, err error)

Retrieve If this is a account is a referral partner, the accounts this referral partner has referred

func (Account) GetRegulatedWorkloads 

func (r Account) GetRegulatedWorkloads() (resp []datatypes.Legal_RegulatedWorkload, err error)

Retrieve

func (Account) GetRemoteManagementCommandRequests 

func (r Account) GetRemoteManagementCommandRequests() (resp []datatypes.Hardware_Component_RemoteManagement_Command_Request, err error)

Retrieve Remote management command requests for an account

func (Account) GetReplicationEvents 

func (r Account) GetReplicationEvents() (resp []datatypes.Network_Storage_Event, err error)

Retrieve The Replication events for all Network Storage volumes on an account.

func (Account) GetRequireSilentIBMidUserCreation 

func (r Account) GetRequireSilentIBMidUserCreation() (resp bool, err error)

Retrieve Indicates whether newly created users under this account will be associated with IBMid via an email requiring a response, or not.

func (Account) GetReservedCapacityAgreements 

func (r Account) GetReservedCapacityAgreements() (resp []datatypes.Account_Agreement, err error)

Retrieve All reserved capacity agreements for an account

func (Account) GetReservedCapacityGroups 

func (r Account) GetReservedCapacityGroups() (resp []datatypes.Virtual_ReservedCapacityGroup, err error)

Retrieve The reserved capacity groups owned by this account.

func (Account) GetRouters 

func (r Account) GetRouters() (resp []datatypes.Hardware, err error)

Retrieve All Routers that an accounts VLANs reside on

func (Account) GetSamlAuthentication 

func (r Account) GetSamlAuthentication() (resp datatypes.Account_Authentication_Saml, err error)

Retrieve The SAML configuration for this account.

func (Account) GetSecondaryDomains 

func (r Account) GetSecondaryDomains() (resp []datatypes.Dns_Secondary, err error)

Retrieve The secondary DNS records for a SoftLayer customer account.

func (Account) GetSecurityCertificates 

func (r Account) GetSecurityCertificates() (resp []datatypes.Security_Certificate, err error)

Retrieve Stored security certificates (ie. SSL)

func (Account) GetSecurityGroups 

func (r Account) GetSecurityGroups() (resp []datatypes.Network_SecurityGroup, err error)

Retrieve The security groups belonging to this account.

func (Account) GetSecurityLevel 

func (r Account) GetSecurityLevel() (resp datatypes.Security_Level, err error)

Retrieve

func (Account) GetSecurityScanRequests 

func (r Account) GetSecurityScanRequests() (resp []datatypes.Network_Security_Scanner_Request, err error)

Retrieve An account's vulnerability scan requests.

func (Account) GetServiceBillingItems 

func (r Account) GetServiceBillingItems() (resp []datatypes.Billing_Item, err error)

Retrieve The service billing items that will be on an account's next invoice.

func (Account) GetSharedBlockDeviceTemplateGroups 

func (r Account) GetSharedBlockDeviceTemplateGroups() (resp []datatypes.Virtual_Guest_Block_Device_Template_Group, err error)

This method returns the [[SoftLayer_Virtual_Guest_Block_Device_Template_Group]] objects that have been shared with this account

func (Account) GetShipments 

func (r Account) GetShipments() (resp []datatypes.Account_Shipment, err error)

Retrieve Shipments that belong to the customer's account.

func (Account) GetSshKeys 

func (r Account) GetSshKeys() (resp []datatypes.Security_Ssh_Key, err error)

Retrieve Customer specified SSH keys that can be implemented onto a newly provisioned or reloaded server.

func (Account) GetSslVpnUsers 

func (r Account) GetSslVpnUsers() (resp []datatypes.User_Customer, err error)

Retrieve An account's associated portal users with SSL VPN access.

func (Account) GetStandardPoolVirtualGuests 

func (r Account) GetStandardPoolVirtualGuests() (resp []datatypes.Virtual_Guest, err error)

Retrieve An account's virtual guest objects that are hosted on a user provisioned hypervisor.

func (Account) GetSubnets 

func (r Account) GetSubnets() (resp []datatypes.Network_Subnet, err error)

Retrieve All network subnets associated with an account.

func (Account) GetSupportRepresentatives 

func (r Account) GetSupportRepresentatives() (resp []datatypes.User_Employee, err error)

Retrieve The SoftLayer employees that an account is assigned to.

func (Account) GetSupportSubscriptions 

func (r Account) GetSupportSubscriptions() (resp []datatypes.Billing_Item, err error)

Retrieve The active support subscriptions for this account.

func (Account) GetSupportTier 

func (r Account) GetSupportTier() (resp string, err error)

Retrieve

func (Account) GetSuppressInvoicesFlag 

func (r Account) GetSuppressInvoicesFlag() (resp bool, err error)

Retrieve A flag indicating to suppress invoices.

func (Account) GetTags 

func (r Account) GetTags() (resp []datatypes.Tag, err error)

Retrieve

func (Account) GetTechIncubatorProgramInfo 

func (r Account) GetTechIncubatorProgramInfo(forNextBillCycle *bool) (resp datatypes.Container_Account_Discount_Program, err error)

This method will return a SoftLayer_Container_Account_Discount_Program object containing the Technology Incubator Program information for this account. To be considered an active participant, the account must have an enrollment record with a monthly credit amount set and the current date must be within the range defined by the enrollment and graduation date. The forNextBillCycle parameter can be set to true to return a SoftLayer_Container_Account_Discount_Program object with information with relation to the next bill cycle. The forNextBillCycle parameter defaults to false.

func (Account) GetTestAccountAttributeFlag added in v1.1.2 

func (r Account) GetTestAccountAttributeFlag() (resp bool, err error)

Retrieve Account attribute flag indicating test account.

func (Account) GetThirdPartyPoliciesAcceptanceStatus 

func (r Account) GetThirdPartyPoliciesAcceptanceStatus() (resp []datatypes.Container_Policy_Acceptance, err error)

Returns multiple [[SoftLayer_Container_Policy_Acceptance]] that represent the acceptance status of the applicable third-party policies for this account.

func (Account) GetTickets 

func (r Account) GetTickets() (resp []datatypes.Ticket, err error)

Retrieve An account's associated tickets.

func (Account) GetTicketsClosedInTheLastThreeDays 

func (r Account) GetTicketsClosedInTheLastThreeDays() (resp []datatypes.Ticket, err error)

Retrieve Tickets closed within the last 72 hours or last 10 tickets, whichever is less, associated with an account.

func (Account) GetTicketsClosedToday 

func (r Account) GetTicketsClosedToday() (resp []datatypes.Ticket, err error)

Retrieve Tickets closed today associated with an account.

func (Account) GetUpgradeRequests 

func (r Account) GetUpgradeRequests() (resp []datatypes.Product_Upgrade_Request, err error)

Retrieve An account's associated upgrade requests.

func (Account) GetUsers 

func (r Account) GetUsers() (resp []datatypes.User_Customer, err error)

Retrieve An account's portal users.

func (Account) GetValidSecurityCertificateEntries 

func (r Account) GetValidSecurityCertificateEntries() (resp []datatypes.Security_Certificate_Entry, err error)

Retrieve a list of valid (non-expired) security certificates without the sensitive certificate information. This allows non-privileged users to view and select security certificates when configuring associated services.

func (Account) GetValidSecurityCertificates 

func (r Account) GetValidSecurityCertificates() (resp []datatypes.Security_Certificate, err error)

Retrieve Stored security certificates that are not expired (ie. SSL)

func (Account) GetVirtualDedicatedRacks 

func (r Account) GetVirtualDedicatedRacks() (resp []datatypes.Network_Bandwidth_Version1_Allotment, err error)

Retrieve The bandwidth pooling for this account.

func (Account) GetVirtualDiskImages 

func (r Account) GetVirtualDiskImages() (resp []datatypes.Virtual_Disk_Image, err error)

Retrieve An account's associated virtual server virtual disk images.

func (Account) GetVirtualGuests 

func (r Account) GetVirtualGuests() (resp []datatypes.Virtual_Guest, err error)

Retrieve An account's associated virtual guest objects.

func (Account) GetVirtualGuestsOverBandwidthAllocation 

func (r Account) GetVirtualGuestsOverBandwidthAllocation() (resp []datatypes.Virtual_Guest, err error)

Retrieve An account's associated virtual guest objects currently over bandwidth allocation.

func (Account) GetVirtualGuestsProjectedOverBandwidthAllocation 

func (r Account) GetVirtualGuestsProjectedOverBandwidthAllocation() (resp []datatypes.Virtual_Guest, err error)

Retrieve An account's associated virtual guest objects currently over bandwidth allocation.

func (Account) GetVirtualGuestsWithCpanel 

func (r Account) GetVirtualGuestsWithCpanel() (resp []datatypes.Virtual_Guest, err error)

Retrieve All virtual guests associated with an account that has the cPanel web hosting control panel installed.

func (Account) GetVirtualGuestsWithMcafee 

func (r Account) GetVirtualGuestsWithMcafee() (resp []datatypes.Virtual_Guest, err error)

Retrieve All virtual guests associated with an account that have McAfee Secure software components.

func (Account) GetVirtualGuestsWithMcafeeAntivirusRedhat 

func (r Account) GetVirtualGuestsWithMcafeeAntivirusRedhat() (resp []datatypes.Virtual_Guest, err error)

Retrieve All virtual guests associated with an account that have McAfee Secure AntiVirus for Redhat software components.

func (Account) GetVirtualGuestsWithMcafeeAntivirusWindows 

func (r Account) GetVirtualGuestsWithMcafeeAntivirusWindows() (resp []datatypes.Virtual_Guest, err error)

Retrieve All virtual guests associated with an account that has McAfee Secure AntiVirus for Windows software components.

func (Account) GetVirtualGuestsWithMcafeeIntrusionDetectionSystem 

func (r Account) GetVirtualGuestsWithMcafeeIntrusionDetectionSystem() (resp []datatypes.Virtual_Guest, err error)

Retrieve All virtual guests associated with an account that has McAfee Secure Intrusion Detection System software components.

func (Account) GetVirtualGuestsWithPlesk 

func (r Account) GetVirtualGuestsWithPlesk() (resp []datatypes.Virtual_Guest, err error)

Retrieve All virtual guests associated with an account that has the Plesk web hosting control panel installed.

func (Account) GetVirtualGuestsWithQuantastor 

func (r Account) GetVirtualGuestsWithQuantastor() (resp []datatypes.Virtual_Guest, err error)

Retrieve All virtual guests associated with an account that have the QuantaStor storage system installed.

func (Account) GetVirtualGuestsWithUrchin 

func (r Account) GetVirtualGuestsWithUrchin() (resp []datatypes.Virtual_Guest, err error)

Retrieve All virtual guests associated with an account that has the Urchin web traffic analytics package installed.

func (Account) GetVirtualPrivateRack 

func (r Account) GetVirtualPrivateRack() (resp datatypes.Network_Bandwidth_Version1_Allotment, err error)

Retrieve The bandwidth pooling for this account.

func (Account) GetVirtualStorageArchiveRepositories 

func (r Account) GetVirtualStorageArchiveRepositories() (resp []datatypes.Virtual_Storage_Repository, err error)

Retrieve An account's associated virtual server archived storage repositories.

func (Account) GetVirtualStoragePublicRepositories 

func (r Account) GetVirtualStoragePublicRepositories() (resp []datatypes.Virtual_Storage_Repository, err error)

Retrieve An account's associated virtual server public storage repositories.

func (Account) GetVmWareActiveAccountLicenseKeys 

func (r Account) GetVmWareActiveAccountLicenseKeys() (resp []string, err error)

This returns a collection of active VMware software account license keys.

func (Account) GetVpcVirtualGuests 

func (r Account) GetVpcVirtualGuests() (resp []datatypes.Virtual_Guest, err error)

Retrieve An account's associated VPC configured virtual guest objects.

func (Account) GetVpnConfigRequiresVPNManageFlag added in v1.0.4 

func (r Account) GetVpnConfigRequiresVPNManageFlag() (resp bool, err error)

Retrieve

func (Account) GetWindowsUpdateStatus 

func (r Account) GetWindowsUpdateStatus() (resp []datatypes.Container_Utility_Microsoft_Windows_UpdateServices_Status, err error)

Retrieve a list of an account's hardware's Windows Update status. This list includes which servers have available updates, which servers require rebooting due to updates, which servers have failed retrieving updates, and which servers have failed to communicate with the SoftLayer private Windows Software Update Services server.

func (Account) HasAttribute 

func (r Account) HasAttribute(attributeType *string) (resp bool, err error)

Determine if an account has an [[SoftLayer_Account_Attribute|attribute]] associated with it. hasAttribute() returns false if the attribute does not exist or if it does not have a value.

func (Account) HourlyInstanceLimit 

func (r Account) HourlyInstanceLimit() (resp int, err error)

This method will return the limit (number) of hourly services the account is allowed to have.

func (Account) HourlyServerLimit 

func (r Account) HourlyServerLimit() (resp int, err error)

This method will return the limit (number) of hourly bare metal servers the account is allowed to have.

func (Account) Id 

func (r Account) Id(id int) Account

func (Account) InitiatePayerAuthentication added in v1.1.2 

func (r Account) InitiatePayerAuthentication(setupInformation *datatypes.Billing_Payment_Card_PayerAuthentication_Setup_Information) (resp datatypes.Billing_Payment_Card_PayerAuthentication_Setup, err error)

Initiates Payer Authentication and provides data that is required for payer authentication enrollment and device data collection.

func (Account) IsActiveVmwareCustomer 

func (r Account) IsActiveVmwareCustomer() (resp bool, err error)

no documentation yet

func (Account) IsEligibleForLocalCurrencyProgram 

func (r Account) IsEligibleForLocalCurrencyProgram() (resp bool, err error)

Returns true if this account is eligible for the local currency program, false otherwise.

func (Account) IsEligibleToLinkWithPaas 

func (r Account) IsEligibleToLinkWithPaas() (resp bool, err error)

Returns true if this account is eligible to link with PaaS. False otherwise.

func (Account) Limit 

func (r Account) Limit(limit int) Account

func (Account) LinkExternalAccount 

func (r Account) LinkExternalAccount(externalAccountId *string, authorizationToken *string, externalServiceProviderKey *string) (err error)

This method will link this SoftLayer account with the provided external account.

func (Account) Mask 

func (r Account) Mask(mask string) Account

func (Account) Offset 

func (r Account) Offset(offset int) Account

func (Account) RemoveAlternateCreditCard 

func (r Account) RemoveAlternateCreditCard() (resp bool, err error)

no documentation yet

func (Account) RequestCreditCardChange 

func (r Account) RequestCreditCardChange(request *datatypes.Billing_Payment_Card_ChangeRequest, vatId *string, paymentRoleName *string, onlyChangeNicknameFlag *bool) (resp datatypes.Billing_Payment_Card_ChangeRequest, err error)

Retrieve the record data associated with the submission of a Credit Card Change Request. Softlayer customers are permitted to request a change in Credit Card information. Part of the process calls for an attempt by SoftLayer to submit at $1.00 charge to the financial institution backing the credit card as a means of verifying that the information provided in the change request is valid. The data associated with this change request returned to the calling function.

If the onlyChangeNicknameFlag parameter is set to true, the nickname of the credit card will be changed immediately without requiring approval by an agent. To change the nickname of the active payment method, pass the empty string for paymentRoleName. To change the nickname for the alternate credit card, pass ALTERNATE_CREDIT_CARD as the paymentRoleName. vatId must be set, but the value will not be used and the empty string is acceptable.

func (Account) RequestManualPayment 

func (r Account) RequestManualPayment(request *datatypes.Billing_Payment_Card_ManualPayment) (resp datatypes.Billing_Payment_Card_ManualPayment, err error)

Retrieve the record data associated with the submission of a Manual Payment Request. Softlayer customers are permitted to request a manual one-time payment at a minimum amount of $2.00. Customers may submit a Credit Card Payment (Mastercard, Visa, American Express) or a PayPal payment. For Credit Card Payments, SoftLayer engages the credit card financial institution to submit the payment request. The financial institution's response and other data associated with the transaction are returned to the calling function. In the case of PayPal Payments, SoftLayer engages the PayPal system to initiate the PayPal payment sequence. The applicable data generated during the request is returned to the calling function.

func (Account) RequestManualPaymentUsingCreditCardOnFile 

func (r Account) RequestManualPaymentUsingCreditCardOnFile(amount *string, payWithAlternateCardFlag *bool, note *string) (resp datatypes.Billing_Payment_Card_ManualPayment, err error)

Retrieve the record data associated with the submission of a Manual Payment Request for a manual payment using a credit card which is on file and does not require an approval process. Softlayer customers are permitted to request a manual one-time payment at a minimum amount of $2.00. Customers may use an existing Credit Card on file (Mastercard, Visa, American Express). SoftLayer engages the credit card financial institution to submit the payment request. The financial institution's response and other data associated with the transaction are returned to the calling function. The applicable data generated during the request is returned to the calling function.

func (Account) SaveInternalCostRecovery added in v1.1.3 

func (r Account) SaveInternalCostRecovery(costRecoveryContainer *datatypes.Container_Account_Internal_Ibm_CostRecovery) (err error)

no documentation yet

func (Account) SetAbuseEmails 

func (r Account) SetAbuseEmails(emails []string) (resp bool, err error)

Set this account's abuse emails. Takes an array of email addresses as strings.

func (Account) SetManagedPoolQuantity 

func (r Account) SetManagedPoolQuantity(poolKeyName *string, backendRouter *string, quantity *int) (resp int, err error)

Set the total number of servers that are to be maintained in the given pool. When a server is ordered a new server will be put in the pool to replace the server that was removed to fill an order to maintain the desired pool availability quantity.

func (Account) SetVlanSpan 

func (r Account) SetVlanSpan(enabled *bool) (resp bool, err error)

Set the flag that enables or disables automatic private network VLAN spanning for a SoftLayer customer account. Enabling VLAN spanning allows an account's servers to talk on the same broadcast domain even if they reside within different private vlans.

func (Account) SwapCreditCards 

func (r Account) SwapCreditCards() (resp bool, err error)

no documentation yet

func (Account) SyncCurrentUserPopulationWithPaas 

func (r Account) SyncCurrentUserPopulationWithPaas() (err error)

no documentation yet

func (Account) UpdateVpnUsersForResource 

func (r Account) UpdateVpnUsersForResource(objectId *int, objectType *string) (resp bool, err error)

[DEPRECATED] This method has been deprecated and will simply return false. Deprecated: This function has been marked as deprecated.

func (Account) Validate 

func (r Account) Validate(account *datatypes.Account) (resp []string, err error)

This method will validate the following account fields. Included are the allowed characters for each field.<br> <strong>Company Name (required):</strong> alphabet, numbers, space, period, dash, octothorpe, forward slash, comma, colon, at sign, ampersand, underscore, apostrophe, parenthesis, exclamation point. Maximum length: 100 characters. (Note: may not contain an email address)<br> <strong>First Name (required):</strong> alphabet, space, period, dash, comma, apostrophe. Maximum length: 30 characters.<br> <strong>Last Name (required):</strong> alphabet, space, period, dash, comma, apostrophe. Maximum length: 30 characters.<br> <strong>Email (required):</strong> Validates e-mail addresses against the syntax in RFC 822.<br> <strong>Address 1 (required):</strong> alphabet, numbers, space, period, dash, octothorpe, forward slash, comma, colon, at sign, ampersand, underscore, apostrophe, parentheses. Maximum length: 100 characters. (Note: may not contain an email address)<br> <strong>Address 2:</strong> alphabet, numbers, space, period, dash, octothorpe, forward slash, comma, colon, at sign, ampersand, underscore, apostrophe, parentheses. Maximum length: 100 characters. (Note: may not contain an email address)<br> <strong>City (required):</strong> alphabet, numbers, space, period, dash, apostrophe, forward slash, comma, parenthesis. Maximum length: 100 characters.<br> <strong>State (required if country is US, Brazil, Canada or India):</strong> Must be valid Alpha-2 ISO 3166-1 state code for that country.<br> <strong>Postal Code (required if country is US or Canada):</strong> Accepted characters are alphabet, numbers, dash, space. Maximum length: 50 characters.<br> <strong>Country (required):</strong> alphabet, numbers. Must be valid Alpha-2 ISO 3166-1 country code.<br> <strong>Office Phone (required):</strong> alphabet, numbers, space, period, dash, parenthesis, plus sign. Maximum length: 100 characters.<br> <strong>Alternate Phone:</strong> alphabet, numbers, space, period, dash, parenthesis, plus sign. Maximum length: 100 characters.<br> <strong>Fax Phone:</strong> alphabet, numbers, space, period, dash, parenthesis, plus sign. Maximum length: 20 characters.<br>

func (Account) ValidateManualPaymentAmount 

func (r Account) ValidateManualPaymentAmount(amount *string) (resp bool, err error)

This method checks global and account specific requirements and returns true if the dollar amount entered is acceptable for this account and false otherwise. Please note the dollar amount is in USD.

type Account_Address 

type Account_Address struct {
	Session session.SLSession
	Options sl.Options
}

The SoftLayer_Account_Address data type contains information on an address associated with a SoftLayer account.

func GetAccountAddressService 

func GetAccountAddressService(sess session.SLSession) Account_Address

GetAccountAddressService returns an instance of the Account_Address SoftLayer service

func (Account_Address) CreateObject 

func (r Account_Address) CreateObject(templateObject *datatypes.Account_Address) (resp datatypes.Account_Address, err error)

Create a new address record. The ”typeId”, ”accountId”, ”description”, ”address1”, ”city”, ”state”, ”country”, and ”postalCode” properties in the templateObject parameter are required properties and may not be null or empty. Users will be restricted to creating addresses for their account.

func (Account_Address) EditObject 

func (r Account_Address) EditObject(templateObject *datatypes.Account_Address) (resp bool, err error)

Edit the properties of an address record by passing in a modified instance of a SoftLayer_Account_Address object. Users will be restricted to modifying addresses for their account.

func (Account_Address) Filter 

func (r Account_Address) Filter(filter string) Account_Address

func (Account_Address) GetAccount 

func (r Account_Address) GetAccount() (resp datatypes.Account, err error)

Retrieve The account to which this address belongs.

func (Account_Address) GetAllDataCenters 

func (r Account_Address) GetAllDataCenters() (resp []datatypes.Account_Address, err error)

Retrieve a list of SoftLayer datacenter addresses.

func (Account_Address) GetCreateUser 

func (r Account_Address) GetCreateUser() (resp datatypes.User_Customer, err error)

Retrieve The customer user who created this address.

func (Account_Address) GetLocation 

func (r Account_Address) GetLocation() (resp datatypes.Location, err error)

Retrieve The location of this address.

func (Account_Address) GetModifyEmployee 

func (r Account_Address) GetModifyEmployee() (resp datatypes.User_Employee, err error)

Retrieve The employee who last modified this address.

func (Account_Address) GetModifyUser 

func (r Account_Address) GetModifyUser() (resp datatypes.User_Customer, err error)

Retrieve The customer user who last modified this address.

func (Account_Address) GetNetworkAddress 

func (r Account_Address) GetNetworkAddress(name *string) (resp []datatypes.Account_Address, err error)

Retrieve a list of SoftLayer datacenter addresses.

func (Account_Address) GetObject 

func (r Account_Address) GetObject() (resp datatypes.Account_Address, err error)

no documentation yet

func (Account_Address) GetType 

func (r Account_Address) GetType() (resp datatypes.Account_Address_Type, err error)

Retrieve An account address' type.

func (Account_Address) Id 

func (r Account_Address) Id(id int) Account_Address

func (Account_Address) Limit 

func (r Account_Address) Limit(limit int) Account_Address

func (Account_Address) Mask 

func (r Account_Address) Mask(mask string) Account_Address

func (Account_Address) Offset 

func (r Account_Address) Offset(offset int) Account_Address

type Account_Address_Type 

type Account_Address_Type struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetAccountAddressTypeService 

func GetAccountAddressTypeService(sess session.SLSession) Account_Address_Type

GetAccountAddressTypeService returns an instance of the Account_Address_Type SoftLayer service

func (Account_Address_Type) Filter 

func (r Account_Address_Type) Filter(filter string) Account_Address_Type

func (Account_Address_Type) GetObject 

func (r Account_Address_Type) GetObject() (resp datatypes.Account_Address_Type, err error)

no documentation yet

func (Account_Address_Type) Id 

func (r Account_Address_Type) Id(id int) Account_Address_Type

func (Account_Address_Type) Limit 

func (r Account_Address_Type) Limit(limit int) Account_Address_Type

func (Account_Address_Type) Mask 

func (r Account_Address_Type) Mask(mask string) Account_Address_Type

func (Account_Address_Type) Offset 

func (r Account_Address_Type) Offset(offset int) Account_Address_Type

type Account_Affiliation 

type Account_Affiliation struct {
	Session session.SLSession
	Options sl.Options
}

This service allows for a unique identifier to be associated to an existing customer account.

func GetAccountAffiliationService 

func GetAccountAffiliationService(sess session.SLSession) Account_Affiliation

GetAccountAffiliationService returns an instance of the Account_Affiliation SoftLayer service

func (Account_Affiliation) CreateObject 

func (r Account_Affiliation) CreateObject(templateObject *datatypes.Account_Affiliation) (resp datatypes.Account_Affiliation, err error)

Create a new affiliation to associate with an existing account.

func (Account_Affiliation) DeleteObject 

func (r Account_Affiliation) DeleteObject() (resp bool, err error)

deleteObject permanently removes an account affiliation

func (Account_Affiliation) EditObject 

func (r Account_Affiliation) EditObject(templateObject *datatypes.Account_Affiliation) (resp bool, err error)

Edit an affiliation that is associated to an existing account.

func (Account_Affiliation) Filter 

func (r Account_Affiliation) Filter(filter string) Account_Affiliation

func (Account_Affiliation) GetAccount 

func (r Account_Affiliation) GetAccount() (resp datatypes.Account, err error)

Retrieve The account that an affiliation belongs to.

func (Account_Affiliation) GetAccountAffiliationsByAffiliateId 

func (r Account_Affiliation) GetAccountAffiliationsByAffiliateId(affiliateId *string) (resp []datatypes.Account_Affiliation, err error)

Get account affiliation information associated with affiliate id.

func (Account_Affiliation) GetObject 

func (r Account_Affiliation) GetObject() (resp datatypes.Account_Affiliation, err error)

no documentation yet

func (Account_Affiliation) Id 

func (r Account_Affiliation) Id(id int) Account_Affiliation

func (Account_Affiliation) Limit 

func (r Account_Affiliation) Limit(limit int) Account_Affiliation

func (Account_Affiliation) Mask 

func (r Account_Affiliation) Mask(mask string) Account_Affiliation

func (Account_Affiliation) Offset 

func (r Account_Affiliation) Offset(offset int) Account_Affiliation

type Account_Agreement 

type Account_Agreement struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetAccountAgreementService 

func GetAccountAgreementService(sess session.SLSession) Account_Agreement

GetAccountAgreementService returns an instance of the Account_Agreement SoftLayer service

func (Account_Agreement) Filter 

func (r Account_Agreement) Filter(filter string) Account_Agreement

func (Account_Agreement) GetAccount 

func (r Account_Agreement) GetAccount() (resp datatypes.Account, err error)

Retrieve

func (Account_Agreement) GetAgreementType 

func (r Account_Agreement) GetAgreementType() (resp datatypes.Account_Agreement_Type, err error)

Retrieve The type of agreement.

func (Account_Agreement) GetAttachedBillingAgreementFiles 

func (r Account_Agreement) GetAttachedBillingAgreementFiles() (resp []datatypes.Account_MasterServiceAgreement, err error)

Retrieve The files attached to an agreement.

func (Account_Agreement) GetBillingItems 

func (r Account_Agreement) GetBillingItems() (resp []datatypes.Billing_Item, err error)

Retrieve The billing items associated with an agreement.

func (Account_Agreement) GetObject 

func (r Account_Agreement) GetObject() (resp datatypes.Account_Agreement, err error)

no documentation yet

func (Account_Agreement) GetStatus 

func (r Account_Agreement) GetStatus() (resp datatypes.Account_Agreement_Status, err error)

Retrieve The status of the agreement.

func (Account_Agreement) GetTopLevelBillingItems 

func (r Account_Agreement) GetTopLevelBillingItems() (resp []datatypes.Billing_Item, err error)

Retrieve The top level billing item associated with an agreement.

func (Account_Agreement) Id 

func (r Account_Agreement) Id(id int) Account_Agreement

func (Account_Agreement) Limit 

func (r Account_Agreement) Limit(limit int) Account_Agreement

func (Account_Agreement) Mask 

func (r Account_Agreement) Mask(mask string) Account_Agreement

func (Account_Agreement) Offset 

func (r Account_Agreement) Offset(offset int) Account_Agreement

type Account_Authentication_Attribute 

type Account_Authentication_Attribute struct {
	Session session.SLSession
	Options sl.Options
}

Account authentication has many different settings that can be set. This class allows the customer or employee to set these settings.

func GetAccountAuthenticationAttributeService 

func GetAccountAuthenticationAttributeService(sess session.SLSession) Account_Authentication_Attribute

GetAccountAuthenticationAttributeService returns an instance of the Account_Authentication_Attribute SoftLayer service

func (Account_Authentication_Attribute) Filter 

func (r Account_Authentication_Attribute) Filter(filter string) Account_Authentication_Attribute

func (Account_Authentication_Attribute) GetAccount 

func (r Account_Authentication_Attribute) GetAccount() (resp datatypes.Account, err error)

Retrieve The SoftLayer customer account.

func (Account_Authentication_Attribute) GetAuthenticationRecord 

func (r Account_Authentication_Attribute) GetAuthenticationRecord() (resp datatypes.Account_Authentication_Saml, err error)

Retrieve The SoftLayer account authentication that has an attribute.

func (Account_Authentication_Attribute) GetObject 

func (r Account_Authentication_Attribute) GetObject() (resp datatypes.Account_Authentication_Attribute, err error)

no documentation yet

func (Account_Authentication_Attribute) GetType 

func (r Account_Authentication_Attribute) GetType() (resp datatypes.Account_Authentication_Attribute_Type, err error)

Retrieve The type of attribute assigned to a SoftLayer account authentication.

func (Account_Authentication_Attribute) Id 

func (r Account_Authentication_Attribute) Id(id int) Account_Authentication_Attribute

func (Account_Authentication_Attribute) Limit 

func (r Account_Authentication_Attribute) Limit(limit int) Account_Authentication_Attribute

func (Account_Authentication_Attribute) Mask 

func (r Account_Authentication_Attribute) Mask(mask string) Account_Authentication_Attribute

func (Account_Authentication_Attribute) Offset 

func (r Account_Authentication_Attribute) Offset(offset int) Account_Authentication_Attribute

type Account_Authentication_Attribute_Type 

type Account_Authentication_Attribute_Type struct {
	Session session.SLSession
	Options sl.Options
}

SoftLayer_Account_Authentication_Attribute_Type models the type of attribute that can be assigned to a SoftLayer customer account authentication.

func GetAccountAuthenticationAttributeTypeService 

func GetAccountAuthenticationAttributeTypeService(sess session.SLSession) Account_Authentication_Attribute_Type

GetAccountAuthenticationAttributeTypeService returns an instance of the Account_Authentication_Attribute_Type SoftLayer service

func (Account_Authentication_Attribute_Type) Filter 

func (r Account_Authentication_Attribute_Type) Filter(filter string) Account_Authentication_Attribute_Type

func (Account_Authentication_Attribute_Type) GetAllObjects 

func (r Account_Authentication_Attribute_Type) GetAllObjects() (resp []datatypes.Account_Attribute_Type, err error)

no documentation yet

func (Account_Authentication_Attribute_Type) GetObject 

func (r Account_Authentication_Attribute_Type) GetObject() (resp datatypes.Account_Authentication_Attribute_Type, err error)

no documentation yet

func (Account_Authentication_Attribute_Type) Id 

func (r Account_Authentication_Attribute_Type) Id(id int) Account_Authentication_Attribute_Type

func (Account_Authentication_Attribute_Type) Limit 

func (r Account_Authentication_Attribute_Type) Limit(limit int) Account_Authentication_Attribute_Type

func (Account_Authentication_Attribute_Type) Mask 

func (r Account_Authentication_Attribute_Type) Mask(mask string) Account_Authentication_Attribute_Type

func (Account_Authentication_Attribute_Type) Offset 

func (r Account_Authentication_Attribute_Type) Offset(offset int) Account_Authentication_Attribute_Type

type Account_Authentication_Saml 

type Account_Authentication_Saml struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetAccountAuthenticationSamlService 

func GetAccountAuthenticationSamlService(sess session.SLSession) Account_Authentication_Saml

GetAccountAuthenticationSamlService returns an instance of the Account_Authentication_Saml SoftLayer service

func (Account_Authentication_Saml) CreateObject 

func (r Account_Authentication_Saml) CreateObject(templateObject *datatypes.Account_Authentication_Saml) (resp datatypes.Account_Authentication_Saml, err error)

no documentation yet

func (Account_Authentication_Saml) DeleteObject 

func (r Account_Authentication_Saml) DeleteObject() (resp bool, err error)

no documentation yet

func (Account_Authentication_Saml) EditObject 

func (r Account_Authentication_Saml) EditObject(templateObject *datatypes.Account_Authentication_Saml) (resp bool, err error)

Edit the object by passing in a modified instance of the object

func (Account_Authentication_Saml) Filter 

func (r Account_Authentication_Saml) Filter(filter string) Account_Authentication_Saml

func (Account_Authentication_Saml) GetAccount 

func (r Account_Authentication_Saml) GetAccount() (resp datatypes.Account, err error)

Retrieve The account associated with this saml configuration.

func (Account_Authentication_Saml) GetAttributes 

func (r Account_Authentication_Saml) GetAttributes() (resp []datatypes.Account_Authentication_Attribute, err error)

Retrieve The saml attribute values for a SoftLayer customer account.

func (Account_Authentication_Saml) GetMetadata 

func (r Account_Authentication_Saml) GetMetadata() (resp string, err error)

This method will return the service provider metadata in XML format.

func (Account_Authentication_Saml) GetObject 

func (r Account_Authentication_Saml) GetObject() (resp datatypes.Account_Authentication_Saml, err error)

no documentation yet

func (Account_Authentication_Saml) Id 

func (r Account_Authentication_Saml) Id(id int) Account_Authentication_Saml

func (Account_Authentication_Saml) Limit 

func (r Account_Authentication_Saml) Limit(limit int) Account_Authentication_Saml

func (Account_Authentication_Saml) Mask 

func (r Account_Authentication_Saml) Mask(mask string) Account_Authentication_Saml

func (Account_Authentication_Saml) Offset 

func (r Account_Authentication_Saml) Offset(offset int) Account_Authentication_Saml

type Account_Brand_Migration_Request added in v1.1.3 

type Account_Brand_Migration_Request struct {
	Session session.SLSession
	Options sl.Options
}

Represents a request to migrate an account to the owned brand.

func GetAccountBrandMigrationRequestService added in v1.1.3 

func GetAccountBrandMigrationRequestService(sess session.SLSession) Account_Brand_Migration_Request

GetAccountBrandMigrationRequestService returns an instance of the Account_Brand_Migration_Request SoftLayer service

func (Account_Brand_Migration_Request) Filter added in v1.1.3 

func (r Account_Brand_Migration_Request) Filter(filter string) Account_Brand_Migration_Request

func (Account_Brand_Migration_Request) GetAccount added in v1.1.3 

func (r Account_Brand_Migration_Request) GetAccount() (resp datatypes.Account, err error)

Retrieve

func (Account_Brand_Migration_Request) GetDestinationBrand added in v1.1.3 

func (r Account_Brand_Migration_Request) GetDestinationBrand() (resp datatypes.Brand, err error)

Retrieve

func (Account_Brand_Migration_Request) GetObject added in v1.1.3 

func (r Account_Brand_Migration_Request) GetObject() (resp datatypes.Account_Brand_Migration_Request, err error)

no documentation yet

func (Account_Brand_Migration_Request) GetSourceBrand added in v1.1.3 

func (r Account_Brand_Migration_Request) GetSourceBrand() (resp datatypes.Brand, err error)

Retrieve

func (Account_Brand_Migration_Request) GetUser added in v1.1.3 

func (r Account_Brand_Migration_Request) GetUser() (resp datatypes.User_Customer, err error)

Retrieve

func (Account_Brand_Migration_Request) Id added in v1.1.3 

func (r Account_Brand_Migration_Request) Id(id int) Account_Brand_Migration_Request

func (Account_Brand_Migration_Request) Limit added in v1.1.3 

func (r Account_Brand_Migration_Request) Limit(limit int) Account_Brand_Migration_Request

func (Account_Brand_Migration_Request) Mask added in v1.1.3 

func (r Account_Brand_Migration_Request) Mask(mask string) Account_Brand_Migration_Request

func (Account_Brand_Migration_Request) Offset added in v1.1.3 

func (r Account_Brand_Migration_Request) Offset(offset int) Account_Brand_Migration_Request

type Account_Business_Partner 

type Account_Business_Partner struct {
	Session session.SLSession
	Options sl.Options
}

Contains business partner details associated with an account. Country Enterprise Identifier (CEID), Channel ID, Segment ID and Reseller Level.

func GetAccountBusinessPartnerService 

func GetAccountBusinessPartnerService(sess session.SLSession) Account_Business_Partner

GetAccountBusinessPartnerService returns an instance of the Account_Business_Partner SoftLayer service

func (Account_Business_Partner) Filter 

func (r Account_Business_Partner) Filter(filter string) Account_Business_Partner

func (Account_Business_Partner) GetAccount 

func (r Account_Business_Partner) GetAccount() (resp datatypes.Account, err error)

Retrieve Account associated with the business partner data

func (Account_Business_Partner) GetChannel 

func (r Account_Business_Partner) GetChannel() (resp datatypes.Business_Partner_Channel, err error)

Retrieve Channel indicator used to categorize business partner revenue.

func (Account_Business_Partner) GetObject 

func (r Account_Business_Partner) GetObject() (resp datatypes.Account_Business_Partner, err error)

no documentation yet

func (Account_Business_Partner) GetSegment 

func (r Account_Business_Partner) GetSegment() (resp datatypes.Business_Partner_Segment, err error)

Retrieve Segment indicator used to categorize business partner revenue.

func (Account_Business_Partner) Id 

func (r Account_Business_Partner) Id(id int) Account_Business_Partner

func (Account_Business_Partner) Limit 

func (r Account_Business_Partner) Limit(limit int) Account_Business_Partner

func (Account_Business_Partner) Mask 

func (r Account_Business_Partner) Mask(mask string) Account_Business_Partner

func (Account_Business_Partner) Offset 

func (r Account_Business_Partner) Offset(offset int) Account_Business_Partner

type Account_Contact 

type Account_Contact struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetAccountContactService 

func GetAccountContactService(sess session.SLSession) Account_Contact

GetAccountContactService returns an instance of the Account_Contact SoftLayer service

func (Account_Contact) CreateComplianceReportRequestorContact 

func (r Account_Contact) CreateComplianceReportRequestorContact(requestorTemplate *datatypes.Account_Contact) (resp datatypes.Account_Contact, err error)

<<EOT

func (Account_Contact) CreateObject 

func (r Account_Contact) CreateObject(templateObject *datatypes.Account_Contact) (resp datatypes.Account_Contact, err error)

This method creates an account contact. The accountId is fixed, other properties can be set during creation. The typeId indicates the SoftLayer_Account_Contact_Type for the contact. This method returns the SoftLayer_Account_Contact object that is created.

func (Account_Contact) DeleteObject 

func (r Account_Contact) DeleteObject() (resp bool, err error)

deleteObject permanently removes an account contact

func (Account_Contact) EditObject 

func (r Account_Contact) EditObject(templateObject *datatypes.Account_Contact) (resp bool, err error)

This method allows you to modify an account contact. Only master users are permitted to modify an account contact.

func (Account_Contact) Filter 

func (r Account_Contact) Filter(filter string) Account_Contact

func (Account_Contact) GetAccount 

func (r Account_Contact) GetAccount() (resp datatypes.Account, err error)

Retrieve

func (Account_Contact) GetAllContactTypes 

func (r Account_Contact) GetAllContactTypes() (resp []datatypes.Account_Contact_Type, err error)

This method will return an array of SoftLayer_Account_Contact_Type objects which can be used when creating or editing an account contact.

func (Account_Contact) GetObject 

func (r Account_Contact) GetObject() (resp datatypes.Account_Contact, err error)

no documentation yet

func (Account_Contact) GetType 

func (r Account_Contact) GetType() (resp datatypes.Account_Contact_Type, err error)

Retrieve

func (Account_Contact) Id 

func (r Account_Contact) Id(id int) Account_Contact

func (Account_Contact) Limit 

func (r Account_Contact) Limit(limit int) Account_Contact

func (Account_Contact) Mask 

func (r Account_Contact) Mask(mask string) Account_Contact

func (Account_Contact) Offset 

func (r Account_Contact) Offset(offset int) Account_Contact

type Account_External_Setup 

type Account_External_Setup struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetAccountExternalSetupService 

func GetAccountExternalSetupService(sess session.SLSession) Account_External_Setup

GetAccountExternalSetupService returns an instance of the Account_External_Setup SoftLayer service

func (Account_External_Setup) Filter 

func (r Account_External_Setup) Filter(filter string) Account_External_Setup

func (Account_External_Setup) FinalizeExternalBillingForAccount 

func (r Account_External_Setup) FinalizeExternalBillingForAccount(accountId *int) (resp datatypes.Container_Account_External_Setup_ProvisioningHoldLifted, err error)

Calling this method signals that the account with the provided account id is ready to be billed by the external billing system.

func (Account_External_Setup) GetObject 

func (r Account_External_Setup) GetObject() (resp datatypes.Account_External_Setup, err error)

no documentation yet

func (Account_External_Setup) GetVerifyCardTransaction 

func (r Account_External_Setup) GetVerifyCardTransaction() (resp datatypes.Billing_Payment_Card_Transaction, err error)

Retrieve The transaction information related to verifying the customer credit card.

func (Account_External_Setup) Id 

func (r Account_External_Setup) Id(id int) Account_External_Setup

func (Account_External_Setup) Limit 

func (r Account_External_Setup) Limit(limit int) Account_External_Setup

func (Account_External_Setup) Mask 

func (r Account_External_Setup) Mask(mask string) Account_External_Setup

func (Account_External_Setup) Offset 

func (r Account_External_Setup) Offset(offset int) Account_External_Setup

type Account_Internal_Ibm 

type Account_Internal_Ibm struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetAccountInternalIbmService 

func GetAccountInternalIbmService(sess session.SLSession) Account_Internal_Ibm

GetAccountInternalIbmService returns an instance of the Account_Internal_Ibm SoftLayer service

func (Account_Internal_Ibm) Filter 

func (r Account_Internal_Ibm) Filter(filter string) Account_Internal_Ibm

func (Account_Internal_Ibm) GetAccountTypes 

func (r Account_Internal_Ibm) GetAccountTypes() (resp []string, err error)

Validates request and, if the request is approved, returns a list of allowed uses for an automatically created IBMer IaaS account.

func (Account_Internal_Ibm) GetAuthorizationUrl 

func (r Account_Internal_Ibm) GetAuthorizationUrl(requestId *int) (resp string, err error)

Gets the URL used to perform manager validation.

func (Account_Internal_Ibm) GetBmsCountries added in v1.1.3 

func (r Account_Internal_Ibm) GetBmsCountries() (resp []datatypes.BMS_Container_Country, err error)

no documentation yet

func (Account_Internal_Ibm) GetBmsCountryList 

func (r Account_Internal_Ibm) GetBmsCountryList() (resp []string, err error)

no documentation yet

func (Account_Internal_Ibm) GetEmployeeAccessToken 

func (r Account_Internal_Ibm) GetEmployeeAccessToken(unverifiedAuthenticationCode *string) (resp string, err error)

Exchanges a code for a token during manager validation.

func (Account_Internal_Ibm) GetManagerPreview 

func (r Account_Internal_Ibm) GetManagerPreview(requestId *int, accessToken *string) (resp datatypes.Container_Account_Internal_Ibm_Request, err error)

After validating the requesting user through the access token, generates a container with the relevant request information and returns it.

func (Account_Internal_Ibm) HasExistingRequest 

func (r Account_Internal_Ibm) HasExistingRequest(employeeUid *string, managerUid *string) (resp bool, err error)

Checks for an existing request which would block an IBMer from submitting a new request. Such a request could be denied, approved, or awaiting manager action.

func (Account_Internal_Ibm) Id 

func (r Account_Internal_Ibm) Id(id int) Account_Internal_Ibm

func (Account_Internal_Ibm) Limit 

func (r Account_Internal_Ibm) Limit(limit int) Account_Internal_Ibm

func (Account_Internal_Ibm) ManagerApprove 

func (r Account_Internal_Ibm) ManagerApprove(requestId *int, accessToken *string) (err error)

Applies manager approval to a pending internal IBM account request. If cost recovery is already configured, this will create an account. If not, this will remind the internal team to configure cost recovery and create the account when possible.

func (Account_Internal_Ibm) ManagerDeny 

func (r Account_Internal_Ibm) ManagerDeny(requestId *int, accessToken *string) (err error)

Denies a pending request and prevents additional requests from the same applicant for as long as the manager remains the same.

func (Account_Internal_Ibm) Mask 

func (r Account_Internal_Ibm) Mask(mask string) Account_Internal_Ibm

func (Account_Internal_Ibm) Offset 

func (r Account_Internal_Ibm) Offset(offset int) Account_Internal_Ibm

func (Account_Internal_Ibm) RequestAccount 

func (r Account_Internal_Ibm) RequestAccount(requestContainer *datatypes.Container_Account_Internal_Ibm_Request) (err error)

Validates request and kicks off the approval process.

type Account_Internal_Ibm_CostRecovery_Validator added in v1.1.3 

type Account_Internal_Ibm_CostRecovery_Validator struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetAccountInternalIbmCostRecoveryValidatorService added in v1.1.3 

func GetAccountInternalIbmCostRecoveryValidatorService(sess session.SLSession) Account_Internal_Ibm_CostRecovery_Validator

GetAccountInternalIbmCostRecoveryValidatorService returns an instance of the Account_Internal_Ibm_CostRecovery_Validator SoftLayer service

func (Account_Internal_Ibm_CostRecovery_Validator) Filter added in v1.1.3 

func (r Account_Internal_Ibm_CostRecovery_Validator) Filter(filter string) Account_Internal_Ibm_CostRecovery_Validator

func (Account_Internal_Ibm_CostRecovery_Validator) GetSprintContainer added in v1.1.3 

func (r Account_Internal_Ibm_CostRecovery_Validator) GetSprintContainer(accountId *string, countryId *string) (resp datatypes.Sprint_Container_CostRecovery, err error)

Will return a container with information for a PACT or WBS account ID and BMS country ID.

func (Account_Internal_Ibm_CostRecovery_Validator) Id added in v1.1.3 

func (r Account_Internal_Ibm_CostRecovery_Validator) Id(id int) Account_Internal_Ibm_CostRecovery_Validator

func (Account_Internal_Ibm_CostRecovery_Validator) Limit added in v1.1.3 

func (r Account_Internal_Ibm_CostRecovery_Validator) Limit(limit int) Account_Internal_Ibm_CostRecovery_Validator

func (Account_Internal_Ibm_CostRecovery_Validator) Mask added in v1.1.3 

func (r Account_Internal_Ibm_CostRecovery_Validator) Mask(mask string) Account_Internal_Ibm_CostRecovery_Validator

func (Account_Internal_Ibm_CostRecovery_Validator) Offset added in v1.1.3 

func (r Account_Internal_Ibm_CostRecovery_Validator) Offset(offset int) Account_Internal_Ibm_CostRecovery_Validator

func (Account_Internal_Ibm_CostRecovery_Validator) ValidateByAccountAndCountryId added in v1.1.3 

func (r Account_Internal_Ibm_CostRecovery_Validator) ValidateByAccountAndCountryId(accountId *string, countryId *string) (resp datatypes.Sprint_Container_CostRecovery, err error)

Will validate a PACT or WBS account ID and BMS country ID. If the record is invalid, an exception is thrown. Otherwise, a container with account information is returned. 

type Account_Link_Bluemix struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetAccountLinkBluemixService 

func GetAccountLinkBluemixService(sess session.SLSession) Account_Link_Bluemix

GetAccountLinkBluemixService returns an instance of the Account_Link_Bluemix SoftLayer service 

func (r Account_Link_Bluemix) Filter(filter string) Account_Link_Bluemix
func (r Account_Link_Bluemix) GetObject() (resp datatypes.Account_Link_Bluemix, err error)

no documentation yet 

func (r Account_Link_Bluemix) GetSupportTierType() (resp string, err error)

no documentation yet 

func (r Account_Link_Bluemix) Id(id int) Account_Link_Bluemix
func (r Account_Link_Bluemix) Limit(limit int) Account_Link_Bluemix
func (r Account_Link_Bluemix) Mask(mask string) Account_Link_Bluemix
func (r Account_Link_Bluemix) Offset(offset int) Account_Link_Bluemix

type Account_Lockdown_Request 

type Account_Lockdown_Request struct {
	Session session.SLSession
	Options sl.Options
}

The SoftLayer_Account_Lockdown_Request data type holds information on API requests from brand customers.

func GetAccountLockdownRequestService 

func GetAccountLockdownRequestService(sess session.SLSession) Account_Lockdown_Request

GetAccountLockdownRequestService returns an instance of the Account_Lockdown_Request SoftLayer service

func (Account_Lockdown_Request) CancelRequest 

func (r Account_Lockdown_Request) CancelRequest() (err error)

Will cancel a lockdown request scheduled in the future. Once canceled, the lockdown request cannot be reconciled and new requests must be made for subsequent actions on the account.

func (Account_Lockdown_Request) DisableLockedAccount 

func (r Account_Lockdown_Request) DisableLockedAccount(disableDate *string, statusChangeReasonKeyName *string) (resp int, err error)

Takes the original lockdown request ID. The account will be disabled immediately. All hardware will be reclaimed and all accounts permanently disabled.

func (Account_Lockdown_Request) DisconnectCompute 

func (r Account_Lockdown_Request) DisconnectCompute(accountId *int, disconnectDate *string) (resp int, err error)

Takes an account ID. Note the disconnection will happen immediately. A brand account request ID will be returned and will then be updated when the disconnection occurs.

func (Account_Lockdown_Request) Filter 

func (r Account_Lockdown_Request) Filter(filter string) Account_Lockdown_Request

func (Account_Lockdown_Request) GetAccountHistory 

func (r Account_Lockdown_Request) GetAccountHistory(accountId *int) (resp []datatypes.Account_Lockdown_Request, err error)

Provides a history of an account's lockdown requests and their status.

func (Account_Lockdown_Request) GetObject 

func (r Account_Lockdown_Request) GetObject() (resp datatypes.Account_Lockdown_Request, err error)

no documentation yet

func (Account_Lockdown_Request) Id 

func (r Account_Lockdown_Request) Id(id int) Account_Lockdown_Request

func (Account_Lockdown_Request) Limit 

func (r Account_Lockdown_Request) Limit(limit int) Account_Lockdown_Request

func (Account_Lockdown_Request) Mask 

func (r Account_Lockdown_Request) Mask(mask string) Account_Lockdown_Request

func (Account_Lockdown_Request) Offset 

func (r Account_Lockdown_Request) Offset(offset int) Account_Lockdown_Request

func (Account_Lockdown_Request) ReconnectCompute 

func (r Account_Lockdown_Request) ReconnectCompute(reconnectDate *string) (resp int, err error)

Takes the original disconnected lockdown request ID. The account reconnection will happen immediately. The associated lockdown event will be unlocked and closed at that time.

type Account_MasterServiceAgreement 

type Account_MasterServiceAgreement struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetAccountMasterServiceAgreementService 

func GetAccountMasterServiceAgreementService(sess session.SLSession) Account_MasterServiceAgreement

GetAccountMasterServiceAgreementService returns an instance of the Account_MasterServiceAgreement SoftLayer service

func (Account_MasterServiceAgreement) Filter 

func (r Account_MasterServiceAgreement) Filter(filter string) Account_MasterServiceAgreement

func (Account_MasterServiceAgreement) GetAccount 

func (r Account_MasterServiceAgreement) GetAccount() (resp datatypes.Account, err error)

Retrieve

func (Account_MasterServiceAgreement) GetFile 

func (r Account_MasterServiceAgreement) GetFile() (resp datatypes.Container_Utility_File_Entity, err error)

Gets a File Entity container with the user's account's current MSA PDF. Gets a translation if one is available. Otherwise, gets the master document.

func (Account_MasterServiceAgreement) GetObject 

func (r Account_MasterServiceAgreement) GetObject() (resp datatypes.Account_MasterServiceAgreement, err error)

no documentation yet

func (Account_MasterServiceAgreement) Id 

func (r Account_MasterServiceAgreement) Id(id int) Account_MasterServiceAgreement

func (Account_MasterServiceAgreement) Limit 

func (r Account_MasterServiceAgreement) Limit(limit int) Account_MasterServiceAgreement

func (Account_MasterServiceAgreement) Mask 

func (r Account_MasterServiceAgreement) Mask(mask string) Account_MasterServiceAgreement

func (Account_MasterServiceAgreement) Offset 

func (r Account_MasterServiceAgreement) Offset(offset int) Account_MasterServiceAgreement

type Account_Media 

type Account_Media struct {
	Session session.SLSession
	Options sl.Options
}

The SoftLayer_Account_Media data type contains information on a single piece of media associated with a Data Transfer Service request.

func GetAccountMediaService 

func GetAccountMediaService(sess session.SLSession) Account_Media

GetAccountMediaService returns an instance of the Account_Media SoftLayer service

func (Account_Media) EditObject 

func (r Account_Media) EditObject(templateObject *datatypes.Account_Media) (resp bool, err error)

Edit the properties of a media record by passing in a modified instance of a SoftLayer_Account_Media object.

func (Account_Media) Filter 

func (r Account_Media) Filter(filter string) Account_Media

func (Account_Media) GetAccount 

func (r Account_Media) GetAccount() (resp datatypes.Account, err error)

Retrieve The account to which the media belongs.

func (Account_Media) GetAllMediaTypes 

func (r Account_Media) GetAllMediaTypes() (resp []datatypes.Account_Media_Type, err error)

Retrieve a list supported media types for SoftLayer's Data Transfer Service.

func (Account_Media) GetCreateUser 

func (r Account_Media) GetCreateUser() (resp datatypes.User_Customer, err error)

Retrieve The customer user who created the media object.

func (Account_Media) GetDatacenter 

func (r Account_Media) GetDatacenter() (resp datatypes.Location, err error)

Retrieve The datacenter where the media resides.

func (Account_Media) GetModifyEmployee 

func (r Account_Media) GetModifyEmployee() (resp datatypes.User_Employee, err error)

Retrieve The employee who last modified the media.

func (Account_Media) GetModifyUser 

func (r Account_Media) GetModifyUser() (resp datatypes.User_Customer, err error)

Retrieve The customer user who last modified the media.

func (Account_Media) GetObject 

func (r Account_Media) GetObject() (resp datatypes.Account_Media, err error)

no documentation yet

func (Account_Media) GetRequest 

func (r Account_Media) GetRequest() (resp datatypes.Account_Media_Data_Transfer_Request, err error)

Retrieve The request to which the media belongs.

func (Account_Media) GetType 

func (r Account_Media) GetType() (resp datatypes.Account_Media_Type, err error)

Retrieve The media's type.

func (Account_Media) GetVolume 

func (r Account_Media) GetVolume() (resp datatypes.Network_Storage, err error)

Retrieve A guest's associated EVault network storage service account.

func (Account_Media) Id 

func (r Account_Media) Id(id int) Account_Media

func (Account_Media) Limit 

func (r Account_Media) Limit(limit int) Account_Media

func (Account_Media) Mask 

func (r Account_Media) Mask(mask string) Account_Media

func (Account_Media) Offset 

func (r Account_Media) Offset(offset int) Account_Media

func (Account_Media) RemoveMediaFromList 

func (r Account_Media) RemoveMediaFromList(mediaTemplate *datatypes.Account_Media) (resp int, err error)

Remove a media from a SoftLayer account's list of media. The media record is not deleted.

type Account_Media_Data_Transfer_Request 

type Account_Media_Data_Transfer_Request struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetAccountMediaDataTransferRequestService 

func GetAccountMediaDataTransferRequestService(sess session.SLSession) Account_Media_Data_Transfer_Request

GetAccountMediaDataTransferRequestService returns an instance of the Account_Media_Data_Transfer_Request SoftLayer service

func (Account_Media_Data_Transfer_Request) EditObject 

func (r Account_Media_Data_Transfer_Request) EditObject(templateObject *datatypes.Account_Media_Data_Transfer_Request) (resp bool, err error)

Edit the properties of a data transfer request record by passing in a modified instance of a SoftLayer_Account_Media_Data_Transfer_Request object.

func (Account_Media_Data_Transfer_Request) Filter 

func (r Account_Media_Data_Transfer_Request) Filter(filter string) Account_Media_Data_Transfer_Request

func (Account_Media_Data_Transfer_Request) GetAccount 

func (r Account_Media_Data_Transfer_Request) GetAccount() (resp datatypes.Account, err error)

Retrieve The account to which the request belongs.

func (Account_Media_Data_Transfer_Request) GetActiveTickets 

func (r Account_Media_Data_Transfer_Request) GetActiveTickets() (resp []datatypes.Ticket, err error)

Retrieve The active tickets that are attached to the data transfer request.

func (Account_Media_Data_Transfer_Request) GetAllRequestStatuses 

func (r Account_Media_Data_Transfer_Request) GetAllRequestStatuses() (resp []datatypes.Account_Media_Data_Transfer_Request_Status, err error)

Retrieves a list of all the possible statuses to which a request may be set.

func (Account_Media_Data_Transfer_Request) GetBillingItem 

func (r Account_Media_Data_Transfer_Request) GetBillingItem() (resp datatypes.Billing_Item, err error)

Retrieve The billing item for the original request.

func (Account_Media_Data_Transfer_Request) GetCreateUser 

func (r Account_Media_Data_Transfer_Request) GetCreateUser() (resp datatypes.User_Customer, err error)

Retrieve The customer user who created the request.

func (Account_Media_Data_Transfer_Request) GetMedia 

func (r Account_Media_Data_Transfer_Request) GetMedia() (resp datatypes.Account_Media, err error)

Retrieve The media of the request.

func (Account_Media_Data_Transfer_Request) GetModifyEmployee 

func (r Account_Media_Data_Transfer_Request) GetModifyEmployee() (resp datatypes.User_Employee, err error)

Retrieve The employee who last modified the request.

func (Account_Media_Data_Transfer_Request) GetModifyUser 

func (r Account_Media_Data_Transfer_Request) GetModifyUser() (resp datatypes.User_Customer, err error)

Retrieve The customer user who last modified the request.

func (Account_Media_Data_Transfer_Request) GetObject 

func (r Account_Media_Data_Transfer_Request) GetObject() (resp datatypes.Account_Media_Data_Transfer_Request, err error)

no documentation yet

func (Account_Media_Data_Transfer_Request) GetShipments 

func (r Account_Media_Data_Transfer_Request) GetShipments() (resp []datatypes.Account_Shipment, err error)

Retrieve The shipments of the request.

func (Account_Media_Data_Transfer_Request) GetStatus 

func (r Account_Media_Data_Transfer_Request) GetStatus() (resp datatypes.Account_Media_Data_Transfer_Request_Status, err error)

Retrieve The status of the request.

func (Account_Media_Data_Transfer_Request) GetTickets 

func (r Account_Media_Data_Transfer_Request) GetTickets() (resp []datatypes.Ticket, err error)

Retrieve All tickets that are attached to the data transfer request.

func (Account_Media_Data_Transfer_Request) Id 

func (r Account_Media_Data_Transfer_Request) Id(id int) Account_Media_Data_Transfer_Request

func (Account_Media_Data_Transfer_Request) Limit 

func (r Account_Media_Data_Transfer_Request) Limit(limit int) Account_Media_Data_Transfer_Request

func (Account_Media_Data_Transfer_Request) Mask 

func (r Account_Media_Data_Transfer_Request) Mask(mask string) Account_Media_Data_Transfer_Request

func (Account_Media_Data_Transfer_Request) Offset 

func (r Account_Media_Data_Transfer_Request) Offset(offset int) Account_Media_Data_Transfer_Request

type Account_Note 

type Account_Note struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetAccountNoteService 

func GetAccountNoteService(sess session.SLSession) Account_Note

GetAccountNoteService returns an instance of the Account_Note SoftLayer service

func (Account_Note) CreateObject 

func (r Account_Note) CreateObject(templateObject *datatypes.Account_Note) (resp datatypes.Account_Note, err error)

no documentation yet

func (Account_Note) DeleteObject 

func (r Account_Note) DeleteObject() (resp bool, err error)

no documentation yet

func (Account_Note) EditObject 

func (r Account_Note) EditObject(templateObject *datatypes.Account_Note) (resp bool, err error)

no documentation yet

func (Account_Note) Filter 

func (r Account_Note) Filter(filter string) Account_Note

func (Account_Note) GetAccount 

func (r Account_Note) GetAccount() (resp datatypes.Account, err error)

Retrieve

func (Account_Note) GetCustomer 

func (r Account_Note) GetCustomer() (resp datatypes.User_Customer, err error)

Retrieve

func (Account_Note) GetNoteHistory 

func (r Account_Note) GetNoteHistory() (resp []datatypes.Account_Note_History, err error)

Retrieve

func (Account_Note) GetObject 

func (r Account_Note) GetObject() (resp datatypes.Account_Note, err error)

no documentation yet

func (Account_Note) Id 

func (r Account_Note) Id(id int) Account_Note

func (Account_Note) Limit 

func (r Account_Note) Limit(limit int) Account_Note

func (Account_Note) Mask 

func (r Account_Note) Mask(mask string) Account_Note

func (Account_Note) Offset 

func (r Account_Note) Offset(offset int) Account_Note

type Account_Partner_Referral_Prospect 

type Account_Partner_Referral_Prospect struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetAccountPartnerReferralProspectService 

func GetAccountPartnerReferralProspectService(sess session.SLSession) Account_Partner_Referral_Prospect

GetAccountPartnerReferralProspectService returns an instance of the Account_Partner_Referral_Prospect SoftLayer service

func (Account_Partner_Referral_Prospect) CreateProspect 

func (r Account_Partner_Referral_Prospect) CreateProspect(templateObject *datatypes.Container_Referral_Partner_Prospect, commit *bool) (resp datatypes.Account_Partner_Referral_Prospect, err error)

Create a new Referral Partner Prospect

func (Account_Partner_Referral_Prospect) Filter 

func (r Account_Partner_Referral_Prospect) Filter(filter string) Account_Partner_Referral_Prospect

func (Account_Partner_Referral_Prospect) GetObject 

func (r Account_Partner_Referral_Prospect) GetObject() (resp datatypes.Account_Partner_Referral_Prospect, err error)

no documentation yet

func (Account_Partner_Referral_Prospect) GetSurveyQuestions 

func (r Account_Partner_Referral_Prospect) GetSurveyQuestions() (resp []datatypes.Survey_Question, err error)

Retrieves Questions for a Referral Partner Survey

func (Account_Partner_Referral_Prospect) Id 

func (r Account_Partner_Referral_Prospect) Id(id int) Account_Partner_Referral_Prospect

func (Account_Partner_Referral_Prospect) Limit 

func (r Account_Partner_Referral_Prospect) Limit(limit int) Account_Partner_Referral_Prospect

func (Account_Partner_Referral_Prospect) Mask 

func (r Account_Partner_Referral_Prospect) Mask(mask string) Account_Partner_Referral_Prospect

func (Account_Partner_Referral_Prospect) Offset 

func (r Account_Partner_Referral_Prospect) Offset(offset int) Account_Partner_Referral_Prospect

type Account_Password 

type Account_Password struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetAccountPasswordService 

func GetAccountPasswordService(sess session.SLSession) Account_Password

GetAccountPasswordService returns an instance of the Account_Password SoftLayer service

func (Account_Password) EditObject 

func (r Account_Password) EditObject(templateObject *datatypes.Account_Password) (resp bool, err error)

The password and/or notes may be modified. Modifying the EVault passwords here will also update the password the Webcc interface will use.

func (Account_Password) Filter 

func (r Account_Password) Filter(filter string) Account_Password

func (Account_Password) GetAccount 

func (r Account_Password) GetAccount() (resp datatypes.Account, err error)

Retrieve

func (Account_Password) GetObject 

func (r Account_Password) GetObject() (resp datatypes.Account_Password, err error)

getObject retrieves the SoftLayer_Account_Password object whose ID corresponds to the ID number of the init parameter passed to the SoftLayer_Account_Password service.

func (Account_Password) GetType 

func (r Account_Password) GetType() (resp datatypes.Account_Password_Type, err error)

Retrieve The service that an account/password combination is tied to.

func (Account_Password) Id 

func (r Account_Password) Id(id int) Account_Password

func (Account_Password) Limit 

func (r Account_Password) Limit(limit int) Account_Password

func (Account_Password) Mask 

func (r Account_Password) Mask(mask string) Account_Password

func (Account_Password) Offset 

func (r Account_Password) Offset(offset int) Account_Password

type Account_ProofOfConcept 

type Account_ProofOfConcept struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetAccountProofOfConceptService 

func GetAccountProofOfConceptService(sess session.SLSession) Account_ProofOfConcept

GetAccountProofOfConceptService returns an instance of the Account_ProofOfConcept SoftLayer service

func (Account_ProofOfConcept) ApproveReview 

func (r Account_ProofOfConcept) ApproveReview(requestId *int, accessToken *string) (err error)

Allows a verified reviewer to approve a request

func (Account_ProofOfConcept) DenyReview 

func (r Account_ProofOfConcept) DenyReview(requestId *int, accessToken *string, reason *string) (err error)

Allows verified reviewer to deny a request

func (Account_ProofOfConcept) Filter 

func (r Account_ProofOfConcept) Filter(filter string) Account_ProofOfConcept

func (Account_ProofOfConcept) GetAuthenticationUrl 

func (r Account_ProofOfConcept) GetAuthenticationUrl(targetPage *string) (resp string, err error)

Returns URL used to authenticate reviewers

func (Account_ProofOfConcept) GetRequestsPendingIntegratedOfferingTeamReview 

func (r Account_ProofOfConcept) GetRequestsPendingIntegratedOfferingTeamReview(accessToken *string) (resp []datatypes.Container_Account_ProofOfConcept_Review_Summary, err error)

Retrieves a list of requests that are pending review in the specified regions

func (Account_ProofOfConcept) GetRequestsPendingOverThresholdReview 

func (r Account_ProofOfConcept) GetRequestsPendingOverThresholdReview(accessToken *string) (resp []datatypes.Container_Account_ProofOfConcept_Review_Summary, err error)

Retrieves a list of requests that are pending over threshold review

func (Account_ProofOfConcept) GetReviewerAccessToken 

func (r Account_ProofOfConcept) GetReviewerAccessToken(unverifiedAuthenticationCode *string) (resp string, err error)

Exchanges a code for a token during reviewer validation.

func (Account_ProofOfConcept) GetReviewerEmailFromAccessToken 

func (r Account_ProofOfConcept) GetReviewerEmailFromAccessToken(accessToken *string) (resp string, err error)

Finds a reviewer's email using the access token

func (Account_ProofOfConcept) GetSubmittedRequest 

func (r Account_ProofOfConcept) GetSubmittedRequest(requestId *int, email *string) (resp datatypes.Container_Account_ProofOfConcept_Review, err error)

Allows authorized IBMer to pull all the details of a single proof of concept account request.

func (Account_ProofOfConcept) GetSubmittedRequests 

func (r Account_ProofOfConcept) GetSubmittedRequests(email *string, sortOrder *string) (resp []datatypes.Container_Account_ProofOfConcept_Review_Summary, err error)

Allows authorized IBMer to retrieve a list summarizing all previously submitted proof of concept requests.

Note that the proof of concept system is for internal IBM employees only and is not applicable to users outside the IBM organization.

func (Account_ProofOfConcept) GetSupportEmailAddress 

func (r Account_ProofOfConcept) GetSupportEmailAddress() (resp string, err error)

Gets email address users can use to ask for help/support

func (Account_ProofOfConcept) GetTotalRequestsPendingIntegratedOfferingTeamReview 

func (r Account_ProofOfConcept) GetTotalRequestsPendingIntegratedOfferingTeamReview(accessToken *string) (resp int, err error)

no documentation yet

func (Account_ProofOfConcept) GetTotalRequestsPendingOverThresholdReviewCount 

func (r Account_ProofOfConcept) GetTotalRequestsPendingOverThresholdReviewCount() (resp int, err error)

no documentation yet

func (Account_ProofOfConcept) Id 

func (r Account_ProofOfConcept) Id(id int) Account_ProofOfConcept

func (Account_ProofOfConcept) IsCurrentReviewer 

func (r Account_ProofOfConcept) IsCurrentReviewer(requestId *int, accessToken *string) (resp bool, err error)

Determines if the user is one of the reviewers currently able to act

func (Account_ProofOfConcept) IsIntegratedOfferingTeamReviewer 

func (r Account_ProofOfConcept) IsIntegratedOfferingTeamReviewer(emailAddress *string) (resp bool, err error)

Indicates whether or not a reviewer belongs to the integrated offering team

func (Account_ProofOfConcept) IsOverThresholdReviewer 

func (r Account_ProofOfConcept) IsOverThresholdReviewer(emailAddress *string) (resp bool, err error)

Indicates whether or not a reviewer belongs to the threshold team.

func (Account_ProofOfConcept) Limit 

func (r Account_ProofOfConcept) Limit(limit int) Account_ProofOfConcept

func (Account_ProofOfConcept) Mask 

func (r Account_ProofOfConcept) Mask(mask string) Account_ProofOfConcept

func (Account_ProofOfConcept) Offset 

func (r Account_ProofOfConcept) Offset(offset int) Account_ProofOfConcept

func (Account_ProofOfConcept) RequestAccountTeamFundedAccount 

func (r Account_ProofOfConcept) RequestAccountTeamFundedAccount(request *datatypes.Container_Account_ProofOfConcept_Request_AccountFunded) (resp datatypes.Container_Account_ProofOfConcept_Review_Summary, err error)

Allows authorized IBMer's to apply for a proof of concept account using account team funding. Requests will be reviewed by multiple internal teams before an account is created.

Note that the proof of concept system is for internal IBM employees only and is not applicable to users outside the IBM organization.

func (Account_ProofOfConcept) RequestGlobalFundedAccount 

func (r Account_ProofOfConcept) RequestGlobalFundedAccount(request *datatypes.Container_Account_ProofOfConcept_Request_GlobalFunded) (resp datatypes.Container_Account_ProofOfConcept_Review_Summary, err error)

Allows authorized IBMer's to apply for a proof of concept account using global funding. Requests will be reviewed by multiple internal teams before an account is created.

Note that the proof of concept system is for internal IBM employees only and is not applicable to users outside the IBM organization.

func (Account_ProofOfConcept) VerifyReviewer 

func (r Account_ProofOfConcept) VerifyReviewer(requestId *int, reviewerEmailAddress *string) (err error)

Verifies that a potential reviewer is an approved internal IBM employee

type Account_ProofOfConcept_Approver 

type Account_ProofOfConcept_Approver struct {
	Session session.SLSession
	Options sl.Options
}

This class represents a Proof of Concept account approver.

func GetAccountProofOfConceptApproverService 

func GetAccountProofOfConceptApproverService(sess session.SLSession) Account_ProofOfConcept_Approver

GetAccountProofOfConceptApproverService returns an instance of the Account_ProofOfConcept_Approver SoftLayer service

func (Account_ProofOfConcept_Approver) Filter 

func (r Account_ProofOfConcept_Approver) Filter(filter string) Account_ProofOfConcept_Approver

func (Account_ProofOfConcept_Approver) GetAllObjects 

func (r Account_ProofOfConcept_Approver) GetAllObjects() (resp []datatypes.Account_ProofOfConcept_Approver, err error)

Retrieves a list of reviewers

func (Account_ProofOfConcept_Approver) GetObject 

func (r Account_ProofOfConcept_Approver) GetObject() (resp datatypes.Account_ProofOfConcept_Approver, err error)

no documentation yet

func (Account_ProofOfConcept_Approver) GetRole 

func (r Account_ProofOfConcept_Approver) GetRole() (resp datatypes.Account_ProofOfConcept_Approver_Role, err error)

Retrieve

func (Account_ProofOfConcept_Approver) GetType 

func (r Account_ProofOfConcept_Approver) GetType() (resp datatypes.Account_ProofOfConcept_Approver_Type, err error)

Retrieve

func (Account_ProofOfConcept_Approver) Id 

func (r Account_ProofOfConcept_Approver) Id(id int) Account_ProofOfConcept_Approver

func (Account_ProofOfConcept_Approver) Limit 

func (r Account_ProofOfConcept_Approver) Limit(limit int) Account_ProofOfConcept_Approver

func (Account_ProofOfConcept_Approver) Mask 

func (r Account_ProofOfConcept_Approver) Mask(mask string) Account_ProofOfConcept_Approver

func (Account_ProofOfConcept_Approver) Offset 

func (r Account_ProofOfConcept_Approver) Offset(offset int) Account_ProofOfConcept_Approver

type Account_ProofOfConcept_Approver_Role 

type Account_ProofOfConcept_Approver_Role struct {
	Session session.SLSession
	Options sl.Options
}

This class represents a Proof of Concept account approver type. The current roles are Primary and Backup approvers.

func GetAccountProofOfConceptApproverRoleService 

func GetAccountProofOfConceptApproverRoleService(sess session.SLSession) Account_ProofOfConcept_Approver_Role

GetAccountProofOfConceptApproverRoleService returns an instance of the Account_ProofOfConcept_Approver_Role SoftLayer service

func (Account_ProofOfConcept_Approver_Role) Filter 

func (r Account_ProofOfConcept_Approver_Role) Filter(filter string) Account_ProofOfConcept_Approver_Role

func (Account_ProofOfConcept_Approver_Role) GetObject 

func (r Account_ProofOfConcept_Approver_Role) GetObject() (resp datatypes.Account_ProofOfConcept_Approver_Role, err error)

no documentation yet

func (Account_ProofOfConcept_Approver_Role) Id 

func (r Account_ProofOfConcept_Approver_Role) Id(id int) Account_ProofOfConcept_Approver_Role

func (Account_ProofOfConcept_Approver_Role) Limit 

func (r Account_ProofOfConcept_Approver_Role) Limit(limit int) Account_ProofOfConcept_Approver_Role

func (Account_ProofOfConcept_Approver_Role) Mask 

func (r Account_ProofOfConcept_Approver_Role) Mask(mask string) Account_ProofOfConcept_Approver_Role

func (Account_ProofOfConcept_Approver_Role) Offset 

func (r Account_ProofOfConcept_Approver_Role) Offset(offset int) Account_ProofOfConcept_Approver_Role

type Account_ProofOfConcept_Approver_Type 

type Account_ProofOfConcept_Approver_Type struct {
	Session session.SLSession
	Options sl.Options
}

This class represents a Proof of Concept account approver type.

func GetAccountProofOfConceptApproverTypeService 

func GetAccountProofOfConceptApproverTypeService(sess session.SLSession) Account_ProofOfConcept_Approver_Type

GetAccountProofOfConceptApproverTypeService returns an instance of the Account_ProofOfConcept_Approver_Type SoftLayer service

func (Account_ProofOfConcept_Approver_Type) Filter 

func (r Account_ProofOfConcept_Approver_Type) Filter(filter string) Account_ProofOfConcept_Approver_Type

func (Account_ProofOfConcept_Approver_Type) GetApprovers 

func (r Account_ProofOfConcept_Approver_Type) GetApprovers() (resp []datatypes.Account_ProofOfConcept_Approver, err error)

Retrieve

func (Account_ProofOfConcept_Approver_Type) GetObject 

func (r Account_ProofOfConcept_Approver_Type) GetObject() (resp datatypes.Account_ProofOfConcept_Approver_Type, err error)

no documentation yet

func (Account_ProofOfConcept_Approver_Type) Id 

func (r Account_ProofOfConcept_Approver_Type) Id(id int) Account_ProofOfConcept_Approver_Type

func (Account_ProofOfConcept_Approver_Type) Limit 

func (r Account_ProofOfConcept_Approver_Type) Limit(limit int) Account_ProofOfConcept_Approver_Type

func (Account_ProofOfConcept_Approver_Type) Mask 

func (r Account_ProofOfConcept_Approver_Type) Mask(mask string) Account_ProofOfConcept_Approver_Type

func (Account_ProofOfConcept_Approver_Type) Offset 

func (r Account_ProofOfConcept_Approver_Type) Offset(offset int) Account_ProofOfConcept_Approver_Type

type Account_ProofOfConcept_Campaign_Code added in v1.0.2 

type Account_ProofOfConcept_Campaign_Code struct {
	Session session.SLSession
	Options sl.Options
}

A [SoftLayer_Account_ProofOfConcept_Campaign_Code] provides a `code` and an optional `description`.

func GetAccountProofOfConceptCampaignCodeService added in v1.0.2 

func GetAccountProofOfConceptCampaignCodeService(sess session.SLSession) Account_ProofOfConcept_Campaign_Code

GetAccountProofOfConceptCampaignCodeService returns an instance of the Account_ProofOfConcept_Campaign_Code SoftLayer service

func (Account_ProofOfConcept_Campaign_Code) Filter added in v1.0.2 

func (r Account_ProofOfConcept_Campaign_Code) Filter(filter string) Account_ProofOfConcept_Campaign_Code

func (Account_ProofOfConcept_Campaign_Code) GetAllObjects added in v1.0.2 

func (r Account_ProofOfConcept_Campaign_Code) GetAllObjects() (resp []datatypes.Account_ProofOfConcept_Campaign_Code, err error)

This method will retrieve all SoftLayer_Account_ProofOfConcept_Campaign_Code objects. Use the `code` field when submitting a request on the [[SoftLayer_Container_Account_ProofOfConcept_Request_Opportunity]] container.

func (Account_ProofOfConcept_Campaign_Code) GetObject added in v1.0.2 

func (r Account_ProofOfConcept_Campaign_Code) GetObject() (resp datatypes.Account_ProofOfConcept_Campaign_Code, err error)

no documentation yet

func (Account_ProofOfConcept_Campaign_Code) Id added in v1.0.2 

func (r Account_ProofOfConcept_Campaign_Code) Id(id int) Account_ProofOfConcept_Campaign_Code

func (Account_ProofOfConcept_Campaign_Code) Limit added in v1.0.2 

func (r Account_ProofOfConcept_Campaign_Code) Limit(limit int) Account_ProofOfConcept_Campaign_Code

func (Account_ProofOfConcept_Campaign_Code) Mask added in v1.0.2 

func (r Account_ProofOfConcept_Campaign_Code) Mask(mask string) Account_ProofOfConcept_Campaign_Code

func (Account_ProofOfConcept_Campaign_Code) Offset added in v1.0.2 

func (r Account_ProofOfConcept_Campaign_Code) Offset(offset int) Account_ProofOfConcept_Campaign_Code

type Account_ProofOfConcept_Funding_Type 

type Account_ProofOfConcept_Funding_Type struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetAccountProofOfConceptFundingTypeService 

func GetAccountProofOfConceptFundingTypeService(sess session.SLSession) Account_ProofOfConcept_Funding_Type

GetAccountProofOfConceptFundingTypeService returns an instance of the Account_ProofOfConcept_Funding_Type SoftLayer service

func (Account_ProofOfConcept_Funding_Type) Filter 

func (r Account_ProofOfConcept_Funding_Type) Filter(filter string) Account_ProofOfConcept_Funding_Type

func (Account_ProofOfConcept_Funding_Type) GetAllObjects 

func (r Account_ProofOfConcept_Funding_Type) GetAllObjects() (resp []datatypes.Account_ProofOfConcept_Funding_Type, err error)

no documentation yet

func (Account_ProofOfConcept_Funding_Type) GetApproverTypes 

func (r Account_ProofOfConcept_Funding_Type) GetApproverTypes() (resp []datatypes.Account_ProofOfConcept_Approver_Type, err error)

Retrieve

func (Account_ProofOfConcept_Funding_Type) GetApprovers 

func (r Account_ProofOfConcept_Funding_Type) GetApprovers() (resp []datatypes.Account_ProofOfConcept_Approver, err error)

Retrieve

func (Account_ProofOfConcept_Funding_Type) GetObject 

func (r Account_ProofOfConcept_Funding_Type) GetObject() (resp datatypes.Account_ProofOfConcept_Funding_Type, err error)

no documentation yet

func (Account_ProofOfConcept_Funding_Type) Id 

func (r Account_ProofOfConcept_Funding_Type) Id(id int) Account_ProofOfConcept_Funding_Type

func (Account_ProofOfConcept_Funding_Type) Limit 

func (r Account_ProofOfConcept_Funding_Type) Limit(limit int) Account_ProofOfConcept_Funding_Type

func (Account_ProofOfConcept_Funding_Type) Mask 

func (r Account_ProofOfConcept_Funding_Type) Mask(mask string) Account_ProofOfConcept_Funding_Type

func (Account_ProofOfConcept_Funding_Type) Offset 

func (r Account_ProofOfConcept_Funding_Type) Offset(offset int) Account_ProofOfConcept_Funding_Type

type Account_Reports_Request 

type Account_Reports_Request struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetAccountReportsRequestService 

func GetAccountReportsRequestService(sess session.SLSession) Account_Reports_Request

GetAccountReportsRequestService returns an instance of the Account_Reports_Request SoftLayer service

func (Account_Reports_Request) CreateRequest 

func (r Account_Reports_Request) CreateRequest(recipientContact *datatypes.Account_Contact, reason *string, reportType *string, requestorContact *datatypes.Account_Contact) (resp datatypes.Account_Reports_Request, err error)

no documentation yet

func (Account_Reports_Request) Filter 

func (r Account_Reports_Request) Filter(filter string) Account_Reports_Request

func (Account_Reports_Request) GetAccount 

func (r Account_Reports_Request) GetAccount() (resp datatypes.Account, err error)

Retrieve

func (Account_Reports_Request) GetAccountContact 

func (r Account_Reports_Request) GetAccountContact() (resp datatypes.Account_Contact, err error)

Retrieve A request's corresponding external contact, if one exists.

func (Account_Reports_Request) GetAllObjects 

func (r Account_Reports_Request) GetAllObjects() (resp datatypes.Account_Reports_Request, err error)

no documentation yet

func (Account_Reports_Request) GetObject 

func (r Account_Reports_Request) GetObject() (resp datatypes.Account_Reports_Request, err error)

no documentation yet

func (Account_Reports_Request) GetReportType 

func (r Account_Reports_Request) GetReportType() (resp datatypes.Compliance_Report_Type, err error)

Retrieve Type of the report customer is requesting for.

func (Account_Reports_Request) GetRequestByRequestKey 

func (r Account_Reports_Request) GetRequestByRequestKey(requestKey *string) (resp datatypes.Account_Reports_Request, err error)

no documentation yet

func (Account_Reports_Request) GetRequestorContact 

func (r Account_Reports_Request) GetRequestorContact() (resp datatypes.Account_Contact, err error)

Retrieve A request's corresponding requestor contact, if one exists.

func (Account_Reports_Request) GetTicket 

func (r Account_Reports_Request) GetTicket() (resp datatypes.Ticket, err error)

Retrieve

func (Account_Reports_Request) GetUser 

func (r Account_Reports_Request) GetUser() (resp datatypes.User_Customer, err error)

Retrieve The customer user that initiated a report request.

func (Account_Reports_Request) Id 

func (r Account_Reports_Request) Id(id int) Account_Reports_Request

func (Account_Reports_Request) Limit 

func (r Account_Reports_Request) Limit(limit int) Account_Reports_Request

func (Account_Reports_Request) Mask 

func (r Account_Reports_Request) Mask(mask string) Account_Reports_Request

func (Account_Reports_Request) Offset 

func (r Account_Reports_Request) Offset(offset int) Account_Reports_Request

func (Account_Reports_Request) SendReportEmail 

func (r Account_Reports_Request) SendReportEmail(request *datatypes.Account_Reports_Request) (resp bool, err error)

no documentation yet

func (Account_Reports_Request) UpdateTicketOnDecline 

func (r Account_Reports_Request) UpdateTicketOnDecline(request *datatypes.Account_Reports_Request) (resp bool, err error)

no documentation yet

type Account_Shipment 

type Account_Shipment struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetAccountShipmentService 

func GetAccountShipmentService(sess session.SLSession) Account_Shipment

GetAccountShipmentService returns an instance of the Account_Shipment SoftLayer service

func (Account_Shipment) EditObject 

func (r Account_Shipment) EditObject(templateObject *datatypes.Account_Shipment) (resp bool, err error)

Edit the properties of a shipment record by passing in a modified instance of a SoftLayer_Account_Shipment object.

func (Account_Shipment) Filter 

func (r Account_Shipment) Filter(filter string) Account_Shipment

func (Account_Shipment) GetAccount 

func (r Account_Shipment) GetAccount() (resp datatypes.Account, err error)

Retrieve The account to which the shipment belongs.

func (Account_Shipment) GetAllCouriers 

func (r Account_Shipment) GetAllCouriers() (resp []datatypes.Auxiliary_Shipping_Courier, err error)

Retrieve a list of available shipping couriers.

func (Account_Shipment) GetAllCouriersByType 

func (r Account_Shipment) GetAllCouriersByType(courierTypeKeyName *string) (resp []datatypes.Auxiliary_Shipping_Courier, err error)

Retrieve a list of available shipping couriers.

func (Account_Shipment) GetAllShipmentStatuses 

func (r Account_Shipment) GetAllShipmentStatuses() (resp []datatypes.Account_Shipment_Status, err error)

Retrieve a a list of shipment statuses.

func (Account_Shipment) GetAllShipmentTypes 

func (r Account_Shipment) GetAllShipmentTypes() (resp []datatypes.Account_Shipment_Type, err error)

Retrieve a a list of shipment types.

func (Account_Shipment) GetCourier 

func (r Account_Shipment) GetCourier() (resp datatypes.Auxiliary_Shipping_Courier, err error)

Retrieve The courier handling the shipment.

func (Account_Shipment) GetCreateEmployee 

func (r Account_Shipment) GetCreateEmployee() (resp datatypes.User_Employee, err error)

Retrieve The employee who created the shipment.

func (Account_Shipment) GetCreateUser 

func (r Account_Shipment) GetCreateUser() (resp datatypes.User_Customer, err error)

Retrieve The customer user who created the shipment.

func (Account_Shipment) GetCurrency 

func (r Account_Shipment) GetCurrency() (resp datatypes.Billing_Currency, err error)

Retrieve

func (Account_Shipment) GetDestinationAddress 

func (r Account_Shipment) GetDestinationAddress() (resp datatypes.Account_Address, err error)

Retrieve The address at which the shipment is received.

func (Account_Shipment) GetMasterTrackingData 

func (r Account_Shipment) GetMasterTrackingData() (resp datatypes.Account_Shipment_Tracking_Data, err error)

Retrieve The one master tracking data for the shipment.

func (Account_Shipment) GetModifyEmployee 

func (r Account_Shipment) GetModifyEmployee() (resp datatypes.User_Employee, err error)

Retrieve The employee who last modified the shipment.

func (Account_Shipment) GetModifyUser 

func (r Account_Shipment) GetModifyUser() (resp datatypes.User_Customer, err error)

Retrieve The customer user who last modified the shipment.

func (Account_Shipment) GetObject 

func (r Account_Shipment) GetObject() (resp datatypes.Account_Shipment, err error)

no documentation yet

func (Account_Shipment) GetOriginationAddress 

func (r Account_Shipment) GetOriginationAddress() (resp datatypes.Account_Address, err error)

Retrieve The address from which the shipment is sent.

func (Account_Shipment) GetShipmentItems 

func (r Account_Shipment) GetShipmentItems() (resp []datatypes.Account_Shipment_Item, err error)

Retrieve The items in the shipment.

func (Account_Shipment) GetStatus 

func (r Account_Shipment) GetStatus() (resp datatypes.Account_Shipment_Status, err error)

Retrieve The status of the shipment.

func (Account_Shipment) GetTrackingData 

func (r Account_Shipment) GetTrackingData() (resp []datatypes.Account_Shipment_Tracking_Data, err error)

Retrieve All tracking data for the shipment and packages.

func (Account_Shipment) GetType 

func (r Account_Shipment) GetType() (resp datatypes.Account_Shipment_Type, err error)

Retrieve The type of shipment (e.g. for Data Transfer Service or Colocation Service).

func (Account_Shipment) GetViaAddress 

func (r Account_Shipment) GetViaAddress() (resp datatypes.Account_Address, err error)

Retrieve The address at which the shipment is received.

func (Account_Shipment) Id 

func (r Account_Shipment) Id(id int) Account_Shipment

func (Account_Shipment) Limit 

func (r Account_Shipment) Limit(limit int) Account_Shipment

func (Account_Shipment) Mask 

func (r Account_Shipment) Mask(mask string) Account_Shipment

func (Account_Shipment) Offset 

func (r Account_Shipment) Offset(offset int) Account_Shipment

type Account_Shipment_Item 

type Account_Shipment_Item struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetAccountShipmentItemService 

func GetAccountShipmentItemService(sess session.SLSession) Account_Shipment_Item

GetAccountShipmentItemService returns an instance of the Account_Shipment_Item SoftLayer service

func (Account_Shipment_Item) EditObject 

func (r Account_Shipment_Item) EditObject(templateObject *datatypes.Account_Shipment_Item) (resp bool, err error)

Edit the properties of a shipment record by passing in a modified instance of a SoftLayer_Account_Shipment_Item object.

func (Account_Shipment_Item) Filter 

func (r Account_Shipment_Item) Filter(filter string) Account_Shipment_Item

func (Account_Shipment_Item) GetObject 

func (r Account_Shipment_Item) GetObject() (resp datatypes.Account_Shipment_Item, err error)

no documentation yet

func (Account_Shipment_Item) GetShipment 

func (r Account_Shipment_Item) GetShipment() (resp datatypes.Account_Shipment, err error)

Retrieve The shipment to which this item belongs.

func (Account_Shipment_Item) GetShipmentItemType 

func (r Account_Shipment_Item) GetShipmentItemType() (resp datatypes.Account_Shipment_Item_Type, err error)

Retrieve The type of this shipment item.

func (Account_Shipment_Item) Id 

func (r Account_Shipment_Item) Id(id int) Account_Shipment_Item

func (Account_Shipment_Item) Limit 

func (r Account_Shipment_Item) Limit(limit int) Account_Shipment_Item

func (Account_Shipment_Item) Mask 

func (r Account_Shipment_Item) Mask(mask string) Account_Shipment_Item

func (Account_Shipment_Item) Offset 

func (r Account_Shipment_Item) Offset(offset int) Account_Shipment_Item

type Account_Shipment_Item_Type 

type Account_Shipment_Item_Type struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetAccountShipmentItemTypeService 

func GetAccountShipmentItemTypeService(sess session.SLSession) Account_Shipment_Item_Type

GetAccountShipmentItemTypeService returns an instance of the Account_Shipment_Item_Type SoftLayer service

func (Account_Shipment_Item_Type) Filter 

func (r Account_Shipment_Item_Type) Filter(filter string) Account_Shipment_Item_Type

func (Account_Shipment_Item_Type) GetObject 

func (r Account_Shipment_Item_Type) GetObject() (resp datatypes.Account_Shipment_Item_Type, err error)

no documentation yet

func (Account_Shipment_Item_Type) Id 

func (r Account_Shipment_Item_Type) Id(id int) Account_Shipment_Item_Type

func (Account_Shipment_Item_Type) Limit 

func (r Account_Shipment_Item_Type) Limit(limit int) Account_Shipment_Item_Type

func (Account_Shipment_Item_Type) Mask 

func (r Account_Shipment_Item_Type) Mask(mask string) Account_Shipment_Item_Type

func (Account_Shipment_Item_Type) Offset 

func (r Account_Shipment_Item_Type) Offset(offset int) Account_Shipment_Item_Type

type Account_Shipment_Resource_Type 

type Account_Shipment_Resource_Type struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetAccountShipmentResourceTypeService 

func GetAccountShipmentResourceTypeService(sess session.SLSession) Account_Shipment_Resource_Type

GetAccountShipmentResourceTypeService returns an instance of the Account_Shipment_Resource_Type SoftLayer service

func (Account_Shipment_Resource_Type) Filter 

func (r Account_Shipment_Resource_Type) Filter(filter string) Account_Shipment_Resource_Type

func (Account_Shipment_Resource_Type) GetObject 

func (r Account_Shipment_Resource_Type) GetObject() (resp datatypes.Account_Shipment_Resource_Type, err error)

no documentation yet

func (Account_Shipment_Resource_Type) Id 

func (r Account_Shipment_Resource_Type) Id(id int) Account_Shipment_Resource_Type

func (Account_Shipment_Resource_Type) Limit 

func (r Account_Shipment_Resource_Type) Limit(limit int) Account_Shipment_Resource_Type

func (Account_Shipment_Resource_Type) Mask 

func (r Account_Shipment_Resource_Type) Mask(mask string) Account_Shipment_Resource_Type

func (Account_Shipment_Resource_Type) Offset 

func (r Account_Shipment_Resource_Type) Offset(offset int) Account_Shipment_Resource_Type

type Account_Shipment_Status 

type Account_Shipment_Status struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetAccountShipmentStatusService 

func GetAccountShipmentStatusService(sess session.SLSession) Account_Shipment_Status

GetAccountShipmentStatusService returns an instance of the Account_Shipment_Status SoftLayer service

func (Account_Shipment_Status) Filter 

func (r Account_Shipment_Status) Filter(filter string) Account_Shipment_Status

func (Account_Shipment_Status) GetObject 

func (r Account_Shipment_Status) GetObject() (resp datatypes.Account_Shipment_Status, err error)

no documentation yet

func (Account_Shipment_Status) Id 

func (r Account_Shipment_Status) Id(id int) Account_Shipment_Status

func (Account_Shipment_Status) Limit 

func (r Account_Shipment_Status) Limit(limit int) Account_Shipment_Status

func (Account_Shipment_Status) Mask 

func (r Account_Shipment_Status) Mask(mask string) Account_Shipment_Status

func (Account_Shipment_Status) Offset 

func (r Account_Shipment_Status) Offset(offset int) Account_Shipment_Status

type Account_Shipment_Tracking_Data 

type Account_Shipment_Tracking_Data struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetAccountShipmentTrackingDataService 

func GetAccountShipmentTrackingDataService(sess session.SLSession) Account_Shipment_Tracking_Data

GetAccountShipmentTrackingDataService returns an instance of the Account_Shipment_Tracking_Data SoftLayer service

func (Account_Shipment_Tracking_Data) CreateObject 

func (r Account_Shipment_Tracking_Data) CreateObject(templateObject *datatypes.Account_Shipment_Tracking_Data) (resp datatypes.Account_Shipment_Tracking_Data, err error)

Create a new shipment tracking data. The ”shipmentId”, ”sequence”, and ”trackingData” properties in the templateObject parameter are required parameters to create a tracking data record.

func (Account_Shipment_Tracking_Data) CreateObjects 

func (r Account_Shipment_Tracking_Data) CreateObjects(templateObjects []datatypes.Account_Shipment_Tracking_Data) (resp []datatypes.Account_Shipment_Tracking_Data, err error)

Create a new shipment tracking data. The ”shipmentId”, ”sequence”, and ”trackingData” properties of each templateObject in the templateObjects array are required parameters to create a tracking data record.

func (Account_Shipment_Tracking_Data) DeleteObject 

func (r Account_Shipment_Tracking_Data) DeleteObject() (resp bool, err error)

deleteObject permanently removes a shipment tracking datum (number)

func (Account_Shipment_Tracking_Data) EditObject 

func (r Account_Shipment_Tracking_Data) EditObject(templateObject *datatypes.Account_Shipment_Tracking_Data) (resp bool, err error)

Edit the properties of a tracking data record by passing in a modified instance of a SoftLayer_Account_Shipment_Tracking_Data object.

func (Account_Shipment_Tracking_Data) Filter 

func (r Account_Shipment_Tracking_Data) Filter(filter string) Account_Shipment_Tracking_Data

func (Account_Shipment_Tracking_Data) GetCreateEmployee 

func (r Account_Shipment_Tracking_Data) GetCreateEmployee() (resp datatypes.User_Employee, err error)

Retrieve The employee who created the tracking datum.

func (Account_Shipment_Tracking_Data) GetCreateUser 

func (r Account_Shipment_Tracking_Data) GetCreateUser() (resp datatypes.User_Customer, err error)

Retrieve The customer user who created the tracking datum.

func (Account_Shipment_Tracking_Data) GetModifyEmployee 

func (r Account_Shipment_Tracking_Data) GetModifyEmployee() (resp datatypes.User_Employee, err error)

Retrieve The employee who last modified the tracking datum.

func (Account_Shipment_Tracking_Data) GetModifyUser 

func (r Account_Shipment_Tracking_Data) GetModifyUser() (resp datatypes.User_Customer, err error)

Retrieve The customer user who last modified the tracking datum.

func (Account_Shipment_Tracking_Data) GetObject 

func (r Account_Shipment_Tracking_Data) GetObject() (resp datatypes.Account_Shipment_Tracking_Data, err error)

no documentation yet

func (Account_Shipment_Tracking_Data) GetShipment 

func (r Account_Shipment_Tracking_Data) GetShipment() (resp datatypes.Account_Shipment, err error)

Retrieve The shipment of the tracking datum.

func (Account_Shipment_Tracking_Data) Id 

func (r Account_Shipment_Tracking_Data) Id(id int) Account_Shipment_Tracking_Data

func (Account_Shipment_Tracking_Data) Limit 

func (r Account_Shipment_Tracking_Data) Limit(limit int) Account_Shipment_Tracking_Data

func (Account_Shipment_Tracking_Data) Mask 

func (r Account_Shipment_Tracking_Data) Mask(mask string) Account_Shipment_Tracking_Data

func (Account_Shipment_Tracking_Data) Offset 

func (r Account_Shipment_Tracking_Data) Offset(offset int) Account_Shipment_Tracking_Data

type Account_Shipment_Type 

type Account_Shipment_Type struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetAccountShipmentTypeService 

func GetAccountShipmentTypeService(sess session.SLSession) Account_Shipment_Type

GetAccountShipmentTypeService returns an instance of the Account_Shipment_Type SoftLayer service

func (Account_Shipment_Type) Filter 

func (r Account_Shipment_Type) Filter(filter string) Account_Shipment_Type

func (Account_Shipment_Type) GetObject 

func (r Account_Shipment_Type) GetObject() (resp datatypes.Account_Shipment_Type, err error)

no documentation yet

func (Account_Shipment_Type) Id 

func (r Account_Shipment_Type) Id(id int) Account_Shipment_Type

func (Account_Shipment_Type) Limit 

func (r Account_Shipment_Type) Limit(limit int) Account_Shipment_Type

func (Account_Shipment_Type) Mask 

func (r Account_Shipment_Type) Mask(mask string) Account_Shipment_Type

func (Account_Shipment_Type) Offset 

func (r Account_Shipment_Type) Offset(offset int) Account_Shipment_Type

type Account_Status_Change_Reason added in v1.1.4 

type Account_Status_Change_Reason struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetAccountStatusChangeReasonService added in v1.1.4 

func GetAccountStatusChangeReasonService(sess session.SLSession) Account_Status_Change_Reason

GetAccountStatusChangeReasonService returns an instance of the Account_Status_Change_Reason SoftLayer service

func (Account_Status_Change_Reason) Filter added in v1.1.4 

func (r Account_Status_Change_Reason) Filter(filter string) Account_Status_Change_Reason

func (Account_Status_Change_Reason) GetAllObjects added in v1.1.4 

func (r Account_Status_Change_Reason) GetAllObjects() (resp []datatypes.Account_Status_Change_Reason, err error)

no documentation yet

func (Account_Status_Change_Reason) GetObject added in v1.1.4 

func (r Account_Status_Change_Reason) GetObject() (resp datatypes.Account_Status_Change_Reason, err error)

no documentation yet

func (Account_Status_Change_Reason) Id added in v1.1.4 

func (r Account_Status_Change_Reason) Id(id int) Account_Status_Change_Reason

func (Account_Status_Change_Reason) Limit added in v1.1.4 

func (r Account_Status_Change_Reason) Limit(limit int) Account_Status_Change_Reason

func (Account_Status_Change_Reason) Mask added in v1.1.4 

func (r Account_Status_Change_Reason) Mask(mask string) Account_Status_Change_Reason

func (Account_Status_Change_Reason) Offset added in v1.1.4 

func (r Account_Status_Change_Reason) Offset(offset int) Account_Status_Change_Reason

type Auxiliary_Notification_Emergency 

type Auxiliary_Notification_Emergency struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetAuxiliaryNotificationEmergencyService 

func GetAuxiliaryNotificationEmergencyService(sess session.SLSession) Auxiliary_Notification_Emergency

GetAuxiliaryNotificationEmergencyService returns an instance of the Auxiliary_Notification_Emergency SoftLayer service

func (Auxiliary_Notification_Emergency) Filter 

func (r Auxiliary_Notification_Emergency) Filter(filter string) Auxiliary_Notification_Emergency

func (Auxiliary_Notification_Emergency) GetAllObjects 

func (r Auxiliary_Notification_Emergency) GetAllObjects() (resp []datatypes.Auxiliary_Notification_Emergency, err error)

Retrieve an array of SoftLayer_Auxiliary_Notification_Emergency data types, which contain all notification events regardless of status.

func (Auxiliary_Notification_Emergency) GetCurrentNotifications 

func (r Auxiliary_Notification_Emergency) GetCurrentNotifications() (resp []datatypes.Auxiliary_Notification_Emergency, err error)

Retrieve an array of SoftLayer_Auxiliary_Notification_Emergency data types, which contain all current notification events.

func (Auxiliary_Notification_Emergency) GetObject 

func (r Auxiliary_Notification_Emergency) GetObject() (resp datatypes.Auxiliary_Notification_Emergency, err error)

getObject retrieves the SoftLayer_Auxiliary_Notification_Emergency object, it can be used to check for current notifications being broadcast by SoftLayer.

func (Auxiliary_Notification_Emergency) GetSignature 

func (r Auxiliary_Notification_Emergency) GetSignature() (resp datatypes.Auxiliary_Notification_Emergency_Signature, err error)

Retrieve The signature of the SoftLayer employee department associated with this notification.

func (Auxiliary_Notification_Emergency) GetStatus 

func (r Auxiliary_Notification_Emergency) GetStatus() (resp datatypes.Auxiliary_Notification_Emergency_Status, err error)

Retrieve The status of this notification.

func (Auxiliary_Notification_Emergency) Id 

func (r Auxiliary_Notification_Emergency) Id(id int) Auxiliary_Notification_Emergency

func (Auxiliary_Notification_Emergency) Limit 

func (r Auxiliary_Notification_Emergency) Limit(limit int) Auxiliary_Notification_Emergency

func (Auxiliary_Notification_Emergency) Mask 

func (r Auxiliary_Notification_Emergency) Mask(mask string) Auxiliary_Notification_Emergency

func (Auxiliary_Notification_Emergency) Offset 

func (r Auxiliary_Notification_Emergency) Offset(offset int) Auxiliary_Notification_Emergency

type Auxiliary_Shipping_Courier_Type 

type Auxiliary_Shipping_Courier_Type struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetAuxiliaryShippingCourierTypeService 

func GetAuxiliaryShippingCourierTypeService(sess session.SLSession) Auxiliary_Shipping_Courier_Type

GetAuxiliaryShippingCourierTypeService returns an instance of the Auxiliary_Shipping_Courier_Type SoftLayer service

func (Auxiliary_Shipping_Courier_Type) Filter 

func (r Auxiliary_Shipping_Courier_Type) Filter(filter string) Auxiliary_Shipping_Courier_Type

func (Auxiliary_Shipping_Courier_Type) GetCourier 

func (r Auxiliary_Shipping_Courier_Type) GetCourier() (resp []datatypes.Auxiliary_Shipping_Courier, err error)

Retrieve

func (Auxiliary_Shipping_Courier_Type) GetObject 

func (r Auxiliary_Shipping_Courier_Type) GetObject() (resp datatypes.Auxiliary_Shipping_Courier_Type, err error)

no documentation yet

func (Auxiliary_Shipping_Courier_Type) GetTypeByKeyName 

func (r Auxiliary_Shipping_Courier_Type) GetTypeByKeyName(keyName *string) (resp datatypes.Auxiliary_Shipping_Courier_Type, err error)

no documentation yet

func (Auxiliary_Shipping_Courier_Type) Id 

func (r Auxiliary_Shipping_Courier_Type) Id(id int) Auxiliary_Shipping_Courier_Type

func (Auxiliary_Shipping_Courier_Type) Limit 

func (r Auxiliary_Shipping_Courier_Type) Limit(limit int) Auxiliary_Shipping_Courier_Type

func (Auxiliary_Shipping_Courier_Type) Mask 

func (r Auxiliary_Shipping_Courier_Type) Mask(mask string) Auxiliary_Shipping_Courier_Type

func (Auxiliary_Shipping_Courier_Type) Offset 

func (r Auxiliary_Shipping_Courier_Type) Offset(offset int) Auxiliary_Shipping_Courier_Type

type Billing_Currency 

type Billing_Currency struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetBillingCurrencyService 

func GetBillingCurrencyService(sess session.SLSession) Billing_Currency

GetBillingCurrencyService returns an instance of the Billing_Currency SoftLayer service

func (Billing_Currency) Filter 

func (r Billing_Currency) Filter(filter string) Billing_Currency

func (Billing_Currency) GetAllObjects 

func (r Billing_Currency) GetAllObjects() (resp []datatypes.Billing_Currency, err error)

no documentation yet

func (Billing_Currency) GetCurrentExchangeRate 

func (r Billing_Currency) GetCurrentExchangeRate() (resp datatypes.Billing_Currency_ExchangeRate, err error)

Retrieve The current exchange rate

func (Billing_Currency) GetObject 

func (r Billing_Currency) GetObject() (resp datatypes.Billing_Currency, err error)

no documentation yet

func (Billing_Currency) GetPrice 

func (r Billing_Currency) GetPrice(price *datatypes.Float64, formatOptions *datatypes.Container_Billing_Currency_Format) (resp string, err error)

no documentation yet

func (Billing_Currency) Id 

func (r Billing_Currency) Id(id int) Billing_Currency

func (Billing_Currency) Limit 

func (r Billing_Currency) Limit(limit int) Billing_Currency

func (Billing_Currency) Mask 

func (r Billing_Currency) Mask(mask string) Billing_Currency

func (Billing_Currency) Offset 

func (r Billing_Currency) Offset(offset int) Billing_Currency

type Billing_Currency_Country 

type Billing_Currency_Country struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetBillingCurrencyCountryService 

func GetBillingCurrencyCountryService(sess session.SLSession) Billing_Currency_Country

GetBillingCurrencyCountryService returns an instance of the Billing_Currency_Country SoftLayer service

func (Billing_Currency_Country) Filter 

func (r Billing_Currency_Country) Filter(filter string) Billing_Currency_Country

func (Billing_Currency_Country) GetCountriesWithListOfEligibleCurrencies 

func (r Billing_Currency_Country) GetCountriesWithListOfEligibleCurrencies() (resp []datatypes.Container_Billing_Currency_Country, err error)

no documentation yet

func (Billing_Currency_Country) GetObject 

func (r Billing_Currency_Country) GetObject() (resp datatypes.Billing_Currency_Country, err error)

no documentation yet

func (Billing_Currency_Country) Id 

func (r Billing_Currency_Country) Id(id int) Billing_Currency_Country

func (Billing_Currency_Country) Limit 

func (r Billing_Currency_Country) Limit(limit int) Billing_Currency_Country

func (Billing_Currency_Country) Mask 

func (r Billing_Currency_Country) Mask(mask string) Billing_Currency_Country

func (Billing_Currency_Country) Offset 

func (r Billing_Currency_Country) Offset(offset int) Billing_Currency_Country

type Billing_Currency_ExchangeRate 

type Billing_Currency_ExchangeRate struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetBillingCurrencyExchangeRateService 

func GetBillingCurrencyExchangeRateService(sess session.SLSession) Billing_Currency_ExchangeRate

GetBillingCurrencyExchangeRateService returns an instance of the Billing_Currency_ExchangeRate SoftLayer service

func (Billing_Currency_ExchangeRate) Filter 

func (r Billing_Currency_ExchangeRate) Filter(filter string) Billing_Currency_ExchangeRate

func (Billing_Currency_ExchangeRate) GetAllCurrencyExchangeRates 

func (r Billing_Currency_ExchangeRate) GetAllCurrencyExchangeRates(stringDate *string) (resp []datatypes.Billing_Currency_ExchangeRate, err error)

no documentation yet

func (Billing_Currency_ExchangeRate) GetCurrencies 

func (r Billing_Currency_ExchangeRate) GetCurrencies() (resp []datatypes.Billing_Currency, err error)

no documentation yet

func (Billing_Currency_ExchangeRate) GetExchangeRate 

func (r Billing_Currency_ExchangeRate) GetExchangeRate(to *string, from *string, effectiveDate *datatypes.Time) (resp datatypes.Billing_Currency_ExchangeRate, err error)

no documentation yet

func (Billing_Currency_ExchangeRate) GetFundingCurrency 

func (r Billing_Currency_ExchangeRate) GetFundingCurrency() (resp datatypes.Billing_Currency, err error)

Retrieve

func (Billing_Currency_ExchangeRate) GetLocalCurrency 

func (r Billing_Currency_ExchangeRate) GetLocalCurrency() (resp datatypes.Billing_Currency, err error)

Retrieve

func (Billing_Currency_ExchangeRate) GetObject 

func (r Billing_Currency_ExchangeRate) GetObject() (resp datatypes.Billing_Currency_ExchangeRate, err error)

no documentation yet

func (Billing_Currency_ExchangeRate) GetPrice 

func (r Billing_Currency_ExchangeRate) GetPrice(price *datatypes.Float64, formatOptions *datatypes.Container_Billing_Currency_Format) (resp string, err error)

no documentation yet

func (Billing_Currency_ExchangeRate) Id 

func (r Billing_Currency_ExchangeRate) Id(id int) Billing_Currency_ExchangeRate

func (Billing_Currency_ExchangeRate) Limit 

func (r Billing_Currency_ExchangeRate) Limit(limit int) Billing_Currency_ExchangeRate

func (Billing_Currency_ExchangeRate) Mask 

func (r Billing_Currency_ExchangeRate) Mask(mask string) Billing_Currency_ExchangeRate

func (Billing_Currency_ExchangeRate) Offset 

func (r Billing_Currency_ExchangeRate) Offset(offset int) Billing_Currency_ExchangeRate

type Billing_Info 

type Billing_Info struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetBillingInfoService 

func GetBillingInfoService(sess session.SLSession) Billing_Info

GetBillingInfoService returns an instance of the Billing_Info SoftLayer service

func (Billing_Info) Filter 

func (r Billing_Info) Filter(filter string) Billing_Info

func (Billing_Info) GetAccount 

func (r Billing_Info) GetAccount() (resp datatypes.Account, err error)

Retrieve The SoftLayer customer account associated with this billing information.

func (Billing_Info) GetAchInformation 

func (r Billing_Info) GetAchInformation() (resp []datatypes.Billing_Info_Ach, err error)

Retrieve

func (Billing_Info) GetCurrency 

func (r Billing_Info) GetCurrency() (resp datatypes.Billing_Currency, err error)

Retrieve Currency to be used by this customer account.

func (Billing_Info) GetCurrentBillingCycle 

func (r Billing_Info) GetCurrentBillingCycle() (resp datatypes.Billing_Info_Cycle, err error)

Retrieve Information related to an account's current and previous billing cycles.

func (Billing_Info) GetLastBillDate 

func (r Billing_Info) GetLastBillDate() (resp datatypes.Time, err error)

Retrieve The date on which an account was last billed.

func (Billing_Info) GetNextBillDate 

func (r Billing_Info) GetNextBillDate() (resp datatypes.Time, err error)

Retrieve The date on which an account will be billed next.

func (Billing_Info) GetObject 

func (r Billing_Info) GetObject() (resp datatypes.Billing_Info, err error)

getObject retrieves the SoftLayer_Billing_Info object whose data corresponds to the account to which your portal user is tied.

func (Billing_Info) Id 

func (r Billing_Info) Id(id int) Billing_Info

func (Billing_Info) Limit 

func (r Billing_Info) Limit(limit int) Billing_Info

func (Billing_Info) Mask 

func (r Billing_Info) Mask(mask string) Billing_Info

func (Billing_Info) Offset 

func (r Billing_Info) Offset(offset int) Billing_Info

type Billing_Invoice 

type Billing_Invoice struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetBillingInvoiceService 

func GetBillingInvoiceService(sess session.SLSession) Billing_Invoice

GetBillingInvoiceService returns an instance of the Billing_Invoice SoftLayer service

func (Billing_Invoice) EmailInvoices 

func (r Billing_Invoice) EmailInvoices(options *datatypes.Container_Billing_Invoice_Email) (err error)

Create a transaction to email PDF and/or Excel invoice links to the requesting user's email address. You must have a PDF reader installed in order to view these files.

func (Billing_Invoice) Filter 

func (r Billing_Invoice) Filter(filter string) Billing_Invoice

func (Billing_Invoice) GetAccount 

func (r Billing_Invoice) GetAccount() (resp datatypes.Account, err error)

Retrieve The account that an invoice belongs to.

func (Billing_Invoice) GetAmount 

func (r Billing_Invoice) GetAmount() (resp datatypes.Float64, err error)

Retrieve This is the amount of this invoice.

func (Billing_Invoice) GetBrandAtInvoiceCreation 

func (r Billing_Invoice) GetBrandAtInvoiceCreation() (resp datatypes.Brand, err error)

Retrieve

func (Billing_Invoice) GetChargebackType added in v1.1.2 

func (r Billing_Invoice) GetChargebackType() (resp datatypes.Billing_Chargeback_Type, err error)

Retrieve Chargeback type for invoice.

func (Billing_Invoice) GetDetailedPdfGeneratedFlag 

func (r Billing_Invoice) GetDetailedPdfGeneratedFlag() (resp bool, err error)

Retrieve A flag that will reflect whether the detailed version of the pdf has been generated.

func (Billing_Invoice) GetExcel 

func (r Billing_Invoice) GetExcel() (resp []byte, err error)

Retrieve a Microsoft Excel spreadsheet of a SoftLayer invoice. You must have a Microsoft Excel reader installed in order to view these invoice files.

func (Billing_Invoice) GetInvoiceTopLevelItems 

func (r Billing_Invoice) GetInvoiceTopLevelItems() (resp []datatypes.Billing_Invoice_Item, err error)

Retrieve A list of top-level invoice items that are on the currently pending invoice.

func (Billing_Invoice) GetInvoiceTotalAmount 

func (r Billing_Invoice) GetInvoiceTotalAmount() (resp datatypes.Float64, err error)

Retrieve The total amount of this invoice.

func (Billing_Invoice) GetInvoiceTotalOneTimeAmount 

func (r Billing_Invoice) GetInvoiceTotalOneTimeAmount() (resp datatypes.Float64, err error)

Retrieve The total one-time charges for this invoice. This is the sum of one-time charges + setup fees + labor fees. This does not include taxes.

func (Billing_Invoice) GetInvoiceTotalOneTimeTaxAmount 

func (r Billing_Invoice) GetInvoiceTotalOneTimeTaxAmount() (resp datatypes.Float64, err error)

Retrieve A sum of all the taxes related to one time charges for this invoice.

func (Billing_Invoice) GetInvoiceTotalPreTaxAmount 

func (r Billing_Invoice) GetInvoiceTotalPreTaxAmount() (resp datatypes.Float64, err error)

Retrieve The total amount of this invoice. This does not include taxes.

func (Billing_Invoice) GetInvoiceTotalRecurringAmount 

func (r Billing_Invoice) GetInvoiceTotalRecurringAmount() (resp datatypes.Float64, err error)

Retrieve The total Recurring amount of this invoice. This amount does not include taxes or one time charges.

func (Billing_Invoice) GetInvoiceTotalRecurringTaxAmount 

func (r Billing_Invoice) GetInvoiceTotalRecurringTaxAmount() (resp datatypes.Float64, err error)

Retrieve The total amount of the recurring taxes on this invoice.

func (Billing_Invoice) GetItems 

func (r Billing_Invoice) GetItems() (resp []datatypes.Billing_Invoice_Item, err error)

Retrieve The items that belong to this invoice.

func (Billing_Invoice) GetLocalCurrencyExchangeRate 

func (r Billing_Invoice) GetLocalCurrencyExchangeRate() (resp datatypes.Billing_Currency_ExchangeRate, err error)

Retrieve Exchange rate used for billing this invoice.

func (Billing_Invoice) GetObject 

func (r Billing_Invoice) GetObject() (resp datatypes.Billing_Invoice, err error)

getObject retrieves the SoftLayer_Billing_Invoice object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Billing_Invoice service. You can only retrieve invoices that are assigned to your portal user's account.

func (Billing_Invoice) GetPayment 

func (r Billing_Invoice) GetPayment() (resp datatypes.Float64, err error)

Retrieve This is the total payment made on this invoice.

func (Billing_Invoice) GetPayments 

func (r Billing_Invoice) GetPayments() (resp []datatypes.Billing_Invoice_Receivable_Payment, err error)

Retrieve The payments for the invoice.

func (Billing_Invoice) GetPdf 

func (r Billing_Invoice) GetPdf() (resp []byte, err error)

Retrieve a PDF record of a SoftLayer invoice. SoftLayer keeps PDF records of all closed invoices for customer retrieval from the portal and API. You must have a PDF reader installed in order to view these invoice files.

func (Billing_Invoice) GetPdfDetailed 

func (r Billing_Invoice) GetPdfDetailed() (resp []byte, err error)

Retrieve a PDF record of a SoftLayer detailed invoice summary. SoftLayer keeps PDF records of all closed invoices for customer retrieval from the portal and API. You must have a PDF reader installed in order to view these files.

func (Billing_Invoice) GetPdfDetailedFilename 

func (r Billing_Invoice) GetPdfDetailedFilename() (resp string, err error)

no documentation yet

func (Billing_Invoice) GetPdfFileSize 

func (r Billing_Invoice) GetPdfFileSize() (resp int, err error)

Retrieve the size of a PDF record of a SoftLayer invoice. SoftLayer keeps PDF records of all closed invoices for customer retrieval from the portal and API.

func (Billing_Invoice) GetPdfFilename 

func (r Billing_Invoice) GetPdfFilename() (resp string, err error)

no documentation yet

func (Billing_Invoice) GetPreliminaryExcel 

func (r Billing_Invoice) GetPreliminaryExcel() (resp []byte, err error)

Retrieve a Microsoft Excel record of a SoftLayer invoice. SoftLayer generates Microsoft Excel records of all closed invoices for customer retrieval from the portal and API. You must have a Microsoft Excel reader installed in order to view these invoice files.

func (Billing_Invoice) GetPreliminaryPdf 

func (r Billing_Invoice) GetPreliminaryPdf() (resp []byte, err error)

Retrieve a PDF record of a SoftLayer invoice. SoftLayer keeps PDF records of all closed invoices for customer retrieval from the portal and API. You must have a PDF reader installed in order to view these invoice files.

func (Billing_Invoice) GetPreliminaryPdfDetailed 

func (r Billing_Invoice) GetPreliminaryPdfDetailed() (resp []byte, err error)

Retrieve a PDF record of the detailed version of a SoftLayer invoice. SoftLayer keeps PDF records of all closed invoices for customer retrieval from the portal and API.

func (Billing_Invoice) GetSellerRegistration 

func (r Billing_Invoice) GetSellerRegistration() (resp string, err error)

Retrieve This is the seller's tax registration.

func (Billing_Invoice) GetTaxInfo 

func (r Billing_Invoice) GetTaxInfo() (resp datatypes.Billing_Invoice_Tax_Info, err error)

Retrieve This is the tax information that applies to tax auditing. This is the official tax record for this invoice.

func (Billing_Invoice) GetTaxInfoHistory 

func (r Billing_Invoice) GetTaxInfoHistory() (resp []datatypes.Billing_Invoice_Tax_Info, err error)

Retrieve This is the set of tax information for any tax calculation for this invoice. Note that not all of these are necessarily official, so use the taxInfo key to get the final information.

func (Billing_Invoice) GetTaxMessage 

func (r Billing_Invoice) GetTaxMessage() (resp string, err error)

Retrieve This is a message explaining the tax treatment for this invoice.

func (Billing_Invoice) GetTaxType 

func (r Billing_Invoice) GetTaxType() (resp datatypes.Billing_Invoice_Tax_Type, err error)

Retrieve This is the strategy used to calculate tax on this invoice.

func (Billing_Invoice) GetXlsFilename 

func (r Billing_Invoice) GetXlsFilename() (resp string, err error)

no documentation yet

func (Billing_Invoice) GetZeroFeeItemCounts 

func (r Billing_Invoice) GetZeroFeeItemCounts() (resp []datatypes.Container_Product_Item_Category_ZeroFee_Count, err error)

no documentation yet

func (Billing_Invoice) Id 

func (r Billing_Invoice) Id(id int) Billing_Invoice

func (Billing_Invoice) Limit 

func (r Billing_Invoice) Limit(limit int) Billing_Invoice

func (Billing_Invoice) Mask 

func (r Billing_Invoice) Mask(mask string) Billing_Invoice

func (Billing_Invoice) Offset 

func (r Billing_Invoice) Offset(offset int) Billing_Invoice

type Billing_Invoice_Item 

type Billing_Invoice_Item struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetBillingInvoiceItemService 

func GetBillingInvoiceItemService(sess session.SLSession) Billing_Invoice_Item

GetBillingInvoiceItemService returns an instance of the Billing_Invoice_Item SoftLayer service

func (Billing_Invoice_Item) Filter 

func (r Billing_Invoice_Item) Filter(filter string) Billing_Invoice_Item

func (Billing_Invoice_Item) GetAssociatedChildren 

func (r Billing_Invoice_Item) GetAssociatedChildren() (resp []datatypes.Billing_Invoice_Item, err error)

Retrieve An Invoice Item's associated child invoice items. Only parent invoice items have associated children. For instance, a server invoice item may have associated children.

func (Billing_Invoice_Item) GetAssociatedInvoiceItem 

func (r Billing_Invoice_Item) GetAssociatedInvoiceItem() (resp datatypes.Billing_Invoice_Item, err error)

Retrieve An Invoice Item's associated invoice item. If this is populated, it means this is an orphaned invoice item, but logically belongs to the associated invoice item.

func (Billing_Invoice_Item) GetBillingItem 

func (r Billing_Invoice_Item) GetBillingItem() (resp datatypes.Billing_Item, err error)

Retrieve An Invoice Item's billing item, from which this item was generated.

func (Billing_Invoice_Item) GetCategory 

func (r Billing_Invoice_Item) GetCategory() (resp datatypes.Product_Item_Category, err error)

Retrieve This invoice item's "item category".

func (Billing_Invoice_Item) GetChildren 

func (r Billing_Invoice_Item) GetChildren() (resp []datatypes.Billing_Invoice_Item, err error)

Retrieve An Invoice Item's child invoice items. Only parent invoice items have children. For instance, a server invoice item will have children.

func (Billing_Invoice_Item) GetDPart added in v1.1.3 

func (r Billing_Invoice_Item) GetDPart() (resp string, err error)

Retrieve This is the DPart for invoice item.

func (Billing_Invoice_Item) GetDiscountingInvoiceItemId added in v1.1.6 

func (r Billing_Invoice_Item) GetDiscountingInvoiceItemId() (resp int, err error)

Retrieve The invoice item ID from which the discount is derived.

func (Billing_Invoice_Item) GetFilteredAssociatedChildren 

func (r Billing_Invoice_Item) GetFilteredAssociatedChildren() (resp []datatypes.Billing_Invoice_Item, err error)

Retrieve An Invoice Item's associated child invoice items, excluding some items with a $0.00 recurring fee. Only parent invoice items have associated children. For instance, a server invoice item may have associated children.

func (Billing_Invoice_Item) GetHourlyFlag 

func (r Billing_Invoice_Item) GetHourlyFlag() (resp bool, err error)

Retrieve Indicating whether this invoice item is billed on an hourly basis.

func (Billing_Invoice_Item) GetInvoice 

func (r Billing_Invoice_Item) GetInvoice() (resp datatypes.Billing_Invoice, err error)

Retrieve The invoice to which this item belongs.

func (Billing_Invoice_Item) GetLocation 

func (r Billing_Invoice_Item) GetLocation() (resp datatypes.Location, err error)

Retrieve An invoice item's location, if one exists.'

func (Billing_Invoice_Item) GetNonZeroAssociatedChildren 

func (r Billing_Invoice_Item) GetNonZeroAssociatedChildren() (resp []datatypes.Billing_Invoice_Item, err error)

Retrieve An Invoice Item's associated child invoice items, excluding ALL items with a $0.00 recurring fee. Only parent invoice items have associated children. For instance, a server invoice item may have associated children.

func (Billing_Invoice_Item) GetObject 

func (r Billing_Invoice_Item) GetObject() (resp datatypes.Billing_Invoice_Item, err error)

getObject retrieves the SoftLayer_Billing_Invoice_Item object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Billing_Invoice_Item service. You can only retrieve the items tied to the account that your portal user is assigned to.

func (Billing_Invoice_Item) GetParent 

func (r Billing_Invoice_Item) GetParent() (resp datatypes.Billing_Invoice_Item, err error)

Retrieve Every item tied to a server should have a parent invoice item which is the server line item. This is how we associate items to a server.

func (Billing_Invoice_Item) GetProduct 

func (r Billing_Invoice_Item) GetProduct() (resp datatypes.Product_Item, err error)

Retrieve The entry in the product catalog that a invoice item is based upon.

func (Billing_Invoice_Item) GetTopLevelProductGroupName 

func (r Billing_Invoice_Item) GetTopLevelProductGroupName() (resp string, err error)

Retrieve A string representing the name of parent level product group of an invoice item.

func (Billing_Invoice_Item) GetTotalOneTimeAmount 

func (r Billing_Invoice_Item) GetTotalOneTimeAmount() (resp datatypes.Float64, err error)

Retrieve An invoice Item's total, including any child invoice items if they exist.

func (Billing_Invoice_Item) GetTotalOneTimeTaxAmount 

func (r Billing_Invoice_Item) GetTotalOneTimeTaxAmount() (resp datatypes.Float64, err error)

Retrieve An invoice Item's total, including any child invoice items if they exist.

func (Billing_Invoice_Item) GetTotalRecurringAmount 

func (r Billing_Invoice_Item) GetTotalRecurringAmount() (resp datatypes.Float64, err error)

Retrieve An invoice Item's total, including any child invoice items if they exist.

func (Billing_Invoice_Item) GetTotalRecurringTaxAmount 

func (r Billing_Invoice_Item) GetTotalRecurringTaxAmount() (resp datatypes.Float64, err error)

Retrieve A Billing Item's total, including any child billing items if they exist.'

func (Billing_Invoice_Item) GetUsageChargeFlag 

func (r Billing_Invoice_Item) GetUsageChargeFlag() (resp bool, err error)

Retrieve Indicating whether this invoice item is for the usage charge.

func (Billing_Invoice_Item) Id 

func (r Billing_Invoice_Item) Id(id int) Billing_Invoice_Item

func (Billing_Invoice_Item) Limit 

func (r Billing_Invoice_Item) Limit(limit int) Billing_Invoice_Item

func (Billing_Invoice_Item) Mask 

func (r Billing_Invoice_Item) Mask(mask string) Billing_Invoice_Item

func (Billing_Invoice_Item) Offset 

func (r Billing_Invoice_Item) Offset(offset int) Billing_Invoice_Item

type Billing_Invoice_Next 

type Billing_Invoice_Next struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetBillingInvoiceNextService 

func GetBillingInvoiceNextService(sess session.SLSession) Billing_Invoice_Next

GetBillingInvoiceNextService returns an instance of the Billing_Invoice_Next SoftLayer service

func (Billing_Invoice_Next) Filter 

func (r Billing_Invoice_Next) Filter(filter string) Billing_Invoice_Next

func (Billing_Invoice_Next) GetExcel 

func (r Billing_Invoice_Next) GetExcel(documentCreateDate *datatypes.Time) (resp []byte, err error)

Return an account's next invoice in a Microsoft excel format.

func (Billing_Invoice_Next) GetPdf 

func (r Billing_Invoice_Next) GetPdf(documentCreateDate *datatypes.Time) (resp []byte, err error)

Return an account's next invoice in PDF format.

func (Billing_Invoice_Next) GetPdfDetailed 

func (r Billing_Invoice_Next) GetPdfDetailed(documentCreateDate *datatypes.Time) (resp []byte, err error)

Return an account's next invoice detailed portion in PDF format.

func (Billing_Invoice_Next) Id 

func (r Billing_Invoice_Next) Id(id int) Billing_Invoice_Next

func (Billing_Invoice_Next) Limit 

func (r Billing_Invoice_Next) Limit(limit int) Billing_Invoice_Next

func (Billing_Invoice_Next) Mask 

func (r Billing_Invoice_Next) Mask(mask string) Billing_Invoice_Next

func (Billing_Invoice_Next) Offset 

func (r Billing_Invoice_Next) Offset(offset int) Billing_Invoice_Next

type Billing_Invoice_Tax_Status 

type Billing_Invoice_Tax_Status struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetBillingInvoiceTaxStatusService 

func GetBillingInvoiceTaxStatusService(sess session.SLSession) Billing_Invoice_Tax_Status

GetBillingInvoiceTaxStatusService returns an instance of the Billing_Invoice_Tax_Status SoftLayer service

func (Billing_Invoice_Tax_Status) Filter 

func (r Billing_Invoice_Tax_Status) Filter(filter string) Billing_Invoice_Tax_Status

func (Billing_Invoice_Tax_Status) GetAllObjects 

func (r Billing_Invoice_Tax_Status) GetAllObjects() (resp []datatypes.Billing_Invoice_Tax_Status, err error)

no documentation yet

func (Billing_Invoice_Tax_Status) GetObject 

func (r Billing_Invoice_Tax_Status) GetObject() (resp datatypes.Billing_Invoice_Tax_Status, err error)

no documentation yet

func (Billing_Invoice_Tax_Status) Id 

func (r Billing_Invoice_Tax_Status) Id(id int) Billing_Invoice_Tax_Status

func (Billing_Invoice_Tax_Status) Limit 

func (r Billing_Invoice_Tax_Status) Limit(limit int) Billing_Invoice_Tax_Status

func (Billing_Invoice_Tax_Status) Mask 

func (r Billing_Invoice_Tax_Status) Mask(mask string) Billing_Invoice_Tax_Status

func (Billing_Invoice_Tax_Status) Offset 

func (r Billing_Invoice_Tax_Status) Offset(offset int) Billing_Invoice_Tax_Status

type Billing_Invoice_Tax_Type 

type Billing_Invoice_Tax_Type struct {
	Session session.SLSession
	Options sl.Options
}

The invoice tax type data type models a single strategy for handling tax calculations.

func GetBillingInvoiceTaxTypeService 

func GetBillingInvoiceTaxTypeService(sess session.SLSession) Billing_Invoice_Tax_Type

GetBillingInvoiceTaxTypeService returns an instance of the Billing_Invoice_Tax_Type SoftLayer service

func (Billing_Invoice_Tax_Type) Filter 

func (r Billing_Invoice_Tax_Type) Filter(filter string) Billing_Invoice_Tax_Type

func (Billing_Invoice_Tax_Type) GetAllObjects 

func (r Billing_Invoice_Tax_Type) GetAllObjects() (resp []datatypes.Billing_Invoice_Tax_Type, err error)

no documentation yet

func (Billing_Invoice_Tax_Type) GetObject 

func (r Billing_Invoice_Tax_Type) GetObject() (resp datatypes.Billing_Invoice_Tax_Type, err error)

no documentation yet

func (Billing_Invoice_Tax_Type) Id 

func (r Billing_Invoice_Tax_Type) Id(id int) Billing_Invoice_Tax_Type

func (Billing_Invoice_Tax_Type) Limit 

func (r Billing_Invoice_Tax_Type) Limit(limit int) Billing_Invoice_Tax_Type

func (Billing_Invoice_Tax_Type) Mask 

func (r Billing_Invoice_Tax_Type) Mask(mask string) Billing_Invoice_Tax_Type

func (Billing_Invoice_Tax_Type) Offset 

func (r Billing_Invoice_Tax_Type) Offset(offset int) Billing_Invoice_Tax_Type

type Billing_Item 

type Billing_Item struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetBillingItemService 

func GetBillingItemService(sess session.SLSession) Billing_Item

GetBillingItemService returns an instance of the Billing_Item SoftLayer service

func (Billing_Item) CancelItem 

func (r Billing_Item) CancelItem(cancelImmediately *bool, cancelAssociatedBillingItems *bool, reason *string, customerNote *string) (resp bool, err error)

Cancel the resource or service for a billing Item. By default the billing item will be canceled on the next bill date and reclaim of the resource will begin shortly after the cancellation. Setting the "cancelImmediately" property to true will start the cancellation immediately if the item is eligible to be canceled immediately.

The reason parameter could be from the list below: * "No longer needed" * "Business closing down" * "Server / Upgrade Costs" * "Migrating to larger server" * "Migrating to smaller server" * "Migrating to a different SoftLayer datacenter" * "Network performance / latency" * "Support response / timing" * "Sales process / upgrades" * "Moving to competitor"

func (Billing_Item) CancelService 

func (r Billing_Item) CancelService() (resp bool, err error)

Cancel the resource or service (excluding bare metal servers) for a billing Item. The billing item will be cancelled immediately and reclaim of the resource will begin shortly.

func (Billing_Item) CancelServiceOnAnniversaryDate 

func (r Billing_Item) CancelServiceOnAnniversaryDate() (resp bool, err error)

Cancel the resource or service for a billing Item

func (Billing_Item) Filter 

func (r Billing_Item) Filter(filter string) Billing_Item

func (Billing_Item) GetAccount 

func (r Billing_Item) GetAccount() (resp datatypes.Account, err error)

Retrieve The account that a billing item belongs to.

func (Billing_Item) GetActiveAgreement 

func (r Billing_Item) GetActiveAgreement() (resp datatypes.Account_Agreement, err error)

Retrieve

func (Billing_Item) GetActiveAgreementFlag 

func (r Billing_Item) GetActiveAgreementFlag() (resp datatypes.Account_Agreement, err error)

Retrieve A flag indicating that the billing item is under an active agreement.

func (Billing_Item) GetActiveAssociatedChildren 

func (r Billing_Item) GetActiveAssociatedChildren() (resp []datatypes.Billing_Item, err error)

Retrieve A billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item.

func (Billing_Item) GetActiveAssociatedGuestDiskBillingItems 

func (r Billing_Item) GetActiveAssociatedGuestDiskBillingItems() (resp []datatypes.Billing_Item, err error)

Retrieve

func (Billing_Item) GetActiveBundledItems 

func (r Billing_Item) GetActiveBundledItems() (resp []datatypes.Billing_Item, err error)

Retrieve A Billing Item's active bundled billing items.

func (Billing_Item) GetActiveCancellationItem 

func (r Billing_Item) GetActiveCancellationItem() (resp datatypes.Billing_Item_Cancellation_Request_Item, err error)

Retrieve A service cancellation request item that corresponds to the billing item.

func (Billing_Item) GetActiveChildren 

func (r Billing_Item) GetActiveChildren() (resp []datatypes.Billing_Item, err error)

Retrieve A Billing Item's active child billing items.

func (Billing_Item) GetActiveFlag 

func (r Billing_Item) GetActiveFlag() (resp bool, err error)

Retrieve

func (Billing_Item) GetActiveSparePoolAssociatedGuestDiskBillingItems 

func (r Billing_Item) GetActiveSparePoolAssociatedGuestDiskBillingItems() (resp []datatypes.Billing_Item, err error)

Retrieve

func (Billing_Item) GetActiveSparePoolBundledItems 

func (r Billing_Item) GetActiveSparePoolBundledItems() (resp []datatypes.Billing_Item, err error)

Retrieve A Billing Item's spare pool bundled billing items.

func (Billing_Item) GetAssociatedBillingItem 

func (r Billing_Item) GetAssociatedBillingItem() (resp datatypes.Billing_Item, err error)

Retrieve A billing item's associated parent. This is to be used for billing items that are "floating", and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item.

func (Billing_Item) GetAssociatedBillingItemHistory 

func (r Billing_Item) GetAssociatedBillingItemHistory() (resp []datatypes.Billing_Item_Association_History, err error)

Retrieve A history of billing items which a billing item has been associated with.

func (Billing_Item) GetAssociatedChildren 

func (r Billing_Item) GetAssociatedChildren() (resp []datatypes.Billing_Item, err error)

Retrieve A Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item.

func (Billing_Item) GetAssociatedParent 

func (r Billing_Item) GetAssociatedParent() (resp []datatypes.Billing_Item, err error)

Retrieve A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set.

func (Billing_Item) GetAvailableMatchingVlans 

func (r Billing_Item) GetAvailableMatchingVlans() (resp []datatypes.Network_Vlan, err error)

Retrieve

func (Billing_Item) GetBandwidthAllocation 

func (r Billing_Item) GetBandwidthAllocation() (resp datatypes.Network_Bandwidth_Version1_Allocation, err error)

Retrieve The bandwidth allocation for a billing item.

func (Billing_Item) GetBillableChildren 

func (r Billing_Item) GetBillableChildren() (resp []datatypes.Billing_Item, err error)

Retrieve A billing item's recurring child items that have once been billed and are scheduled to be billed in the future.

func (Billing_Item) GetBundledItems 

func (r Billing_Item) GetBundledItems() (resp []datatypes.Billing_Item, err error)

Retrieve A Billing Item's bundled billing items.

func (Billing_Item) GetCanceledChildren 

func (r Billing_Item) GetCanceledChildren() (resp []datatypes.Billing_Item, err error)

Retrieve A Billing Item's active child billing items.

func (Billing_Item) GetCancellationReason 

func (r Billing_Item) GetCancellationReason() (resp datatypes.Billing_Item_Cancellation_Reason, err error)

Retrieve The billing item's cancellation reason.

func (Billing_Item) GetCancellationRequests 

func (r Billing_Item) GetCancellationRequests() (resp []datatypes.Billing_Item_Cancellation_Request, err error)

Retrieve This will return any cancellation requests that are associated with this billing item.

func (Billing_Item) GetCategory 

func (r Billing_Item) GetCategory() (resp datatypes.Product_Item_Category, err error)

Retrieve The item category to which the billing item's item belongs.

func (Billing_Item) GetChildren 

func (r Billing_Item) GetChildren() (resp []datatypes.Billing_Item, err error)

Retrieve A Billing Item's child billing items'

func (Billing_Item) GetChildrenWithActiveAgreement 

func (r Billing_Item) GetChildrenWithActiveAgreement() (resp []datatypes.Billing_Item, err error)

Retrieve A Billing Item's active child billing items.

func (Billing_Item) GetDowngradeItems 

func (r Billing_Item) GetDowngradeItems() (resp []datatypes.Product_Item, err error)

Retrieve For product items which have a downgrade path defined, this will return those product items.

func (Billing_Item) GetFilteredNextInvoiceChildren 

func (r Billing_Item) GetFilteredNextInvoiceChildren() (resp []datatypes.Billing_Item, err error)

Retrieve A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.

func (Billing_Item) GetHourlyFlag 

func (r Billing_Item) GetHourlyFlag() (resp bool, err error)

Retrieve A flag that will reflect whether this billing item is billed on an hourly basis or not.

func (Billing_Item) GetInvoiceItem 

func (r Billing_Item) GetInvoiceItem() (resp datatypes.Billing_Invoice_Item, err error)

Retrieve Invoice items associated with this billing item

func (Billing_Item) GetInvoiceItems 

func (r Billing_Item) GetInvoiceItems() (resp []datatypes.Billing_Invoice_Item, err error)

Retrieve All invoice items associated with the billing item

func (Billing_Item) GetItem 

func (r Billing_Item) GetItem() (resp datatypes.Product_Item, err error)

Retrieve The entry in the SoftLayer product catalog that a billing item is based upon.

func (Billing_Item) GetLocation 

func (r Billing_Item) GetLocation() (resp datatypes.Location, err error)

Retrieve The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information.

func (Billing_Item) GetNextInvoiceChildren 

func (r Billing_Item) GetNextInvoiceChildren() (resp []datatypes.Billing_Item, err error)

Retrieve A Billing Item's child billing items and associated items'

func (Billing_Item) GetNextInvoiceTotalOneTimeAmount 

func (r Billing_Item) GetNextInvoiceTotalOneTimeAmount() (resp datatypes.Float64, err error)

Retrieve A Billing Item's total, including any child billing items if they exist.'

func (Billing_Item) GetNextInvoiceTotalOneTimeTaxAmount 

func (r Billing_Item) GetNextInvoiceTotalOneTimeTaxAmount() (resp datatypes.Float64, err error)

Retrieve A Billing Item's total, including any child billing items if they exist.'

func (Billing_Item) GetNextInvoiceTotalRecurringAmount 

func (r Billing_Item) GetNextInvoiceTotalRecurringAmount() (resp datatypes.Float64, err error)

Retrieve A Billing Item's total, including any child billing items and associated billing items if they exist.'

func (Billing_Item) GetNextInvoiceTotalRecurringTaxAmount 

func (r Billing_Item) GetNextInvoiceTotalRecurringTaxAmount() (resp datatypes.Float64, err error)

Retrieve This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only.

func (Billing_Item) GetNonZeroNextInvoiceChildren 

func (r Billing_Item) GetNonZeroNextInvoiceChildren() (resp []datatypes.Billing_Item, err error)

Retrieve A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.

func (Billing_Item) GetObject 

func (r Billing_Item) GetObject() (resp datatypes.Billing_Item, err error)

getObject retrieves the SoftLayer_Billing_Item object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Billing_Item service. You can only retrieve billing items tied to the account that your portal user is assigned to. Billing items are an account's items of billable items. There are "parent" billing items and "child" billing items. The server billing item is generally referred to as a parent billing item. The items tied to a server, such as ram, harddrives, and operating systems are considered "child" billing items.

func (Billing_Item) GetOrderItem 

func (r Billing_Item) GetOrderItem() (resp datatypes.Billing_Order_Item, err error)

Retrieve A billing item's original order item. Simply a reference to the original order from which this billing item was created.

func (Billing_Item) GetOriginalLocation 

func (r Billing_Item) GetOriginalLocation() (resp datatypes.Location, err error)

Retrieve The original physical location for this billing item--may differ from current.

func (Billing_Item) GetPackage 

func (r Billing_Item) GetPackage() (resp datatypes.Product_Package, err error)

Retrieve The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms.

func (Billing_Item) GetParent 

func (r Billing_Item) GetParent() (resp datatypes.Billing_Item, err error)

Retrieve A billing item's parent item. If a billing item has no parent item then this value is null.

func (Billing_Item) GetParentVirtualGuestBillingItem 

func (r Billing_Item) GetParentVirtualGuestBillingItem() (resp datatypes.Billing_Item_Virtual_Guest, err error)

Retrieve A billing item's parent item. If a billing item has no parent item then this value is null.

func (Billing_Item) GetPendingCancellationFlag 

func (r Billing_Item) GetPendingCancellationFlag() (resp bool, err error)

Retrieve This flag indicates whether a billing item is scheduled to be canceled or not.

func (Billing_Item) GetPendingOrderItem 

func (r Billing_Item) GetPendingOrderItem() (resp datatypes.Billing_Order_Item, err error)

Retrieve The new order item that will replace this billing item.

func (Billing_Item) GetProvisionTransaction 

func (r Billing_Item) GetProvisionTransaction() (resp datatypes.Provisioning_Version1_Transaction, err error)

Retrieve Provisioning transaction for this billing item

func (Billing_Item) GetServiceBillingItemsByCategory 

func (r Billing_Item) GetServiceBillingItemsByCategory(categoryCode *string, includeZeroRecurringFee *bool) (resp []datatypes.Billing_Item, err error)

This service returns billing items of a specified category code. This service should be used to retrieve billing items that you wish to cancel. Some billing items can be canceled via [[SoftLayer_Security_Certificate_Request|service cancellation]] service.

In order to find billing items for cancellation, use [[SoftLayer_Product_Item_Category::getValidCancelableServiceItemCategories|product categories]] service to retrieve category codes that are eligible for cancellation.

func (Billing_Item) GetSoftwareDescription 

func (r Billing_Item) GetSoftwareDescription() (resp datatypes.Software_Description, err error)

Retrieve A friendly description of software component

func (Billing_Item) GetUpgradeItem 

func (r Billing_Item) GetUpgradeItem() (resp datatypes.Product_Item, err error)

Retrieve Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path.

func (Billing_Item) GetUpgradeItems 

func (r Billing_Item) GetUpgradeItems() (resp []datatypes.Product_Item, err error)

Retrieve Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path.

func (Billing_Item) Id 

func (r Billing_Item) Id(id int) Billing_Item

func (Billing_Item) Limit 

func (r Billing_Item) Limit(limit int) Billing_Item

func (Billing_Item) Mask 

func (r Billing_Item) Mask(mask string) Billing_Item

func (Billing_Item) Offset 

func (r Billing_Item) Offset(offset int) Billing_Item

func (Billing_Item) RemoveAssociationId 

func (r Billing_Item) RemoveAssociationId() (resp bool, err error)

Remove the association from a billing item.

func (Billing_Item) SetAssociationId 

func (r Billing_Item) SetAssociationId(associatedId *int) (resp bool, err error)

Set an associated billing item to an orphan billing item. Associations allow you to tie an "orphaned" billing item, any non-server billing item that doesn't have a parent item such as secondary IP subnets or StorageLayer accounts, to a server billing item. You may only set an association for an orphan to a server. You cannot associate a server to an orphan if the either the server or orphan billing items have a cancellation date set.

func (Billing_Item) VoidCancelService 

func (r Billing_Item) VoidCancelService() (resp bool, err error)

Void a previously made cancellation for a service

type Billing_Item_Cancellation_Reason 

type Billing_Item_Cancellation_Reason struct {
	Session session.SLSession
	Options sl.Options
}

The SoftLayer_Billing_Item_Cancellation_Reason data type contains cancellation reasons.

func GetBillingItemCancellationReasonService 

func GetBillingItemCancellationReasonService(sess session.SLSession) Billing_Item_Cancellation_Reason

GetBillingItemCancellationReasonService returns an instance of the Billing_Item_Cancellation_Reason SoftLayer service

func (Billing_Item_Cancellation_Reason) Filter 

func (r Billing_Item_Cancellation_Reason) Filter(filter string) Billing_Item_Cancellation_Reason

func (Billing_Item_Cancellation_Reason) GetAllCancellationReasons 

func (r Billing_Item_Cancellation_Reason) GetAllCancellationReasons() (resp []datatypes.Billing_Item_Cancellation_Reason, err error)

getAllCancellationReasons() retrieves a list of all cancellation reasons that a server/service may be assigned to.

func (Billing_Item_Cancellation_Reason) GetBillingCancellationReasonCategory 

func (r Billing_Item_Cancellation_Reason) GetBillingCancellationReasonCategory() (resp datatypes.Billing_Item_Cancellation_Reason_Category, err error)

Retrieve An billing cancellation reason category.

func (Billing_Item_Cancellation_Reason) GetBillingItems 

func (r Billing_Item_Cancellation_Reason) GetBillingItems() (resp []datatypes.Billing_Item, err error)

Retrieve The corresponding billing items having the specific cancellation reason.

func (Billing_Item_Cancellation_Reason) GetObject 

func (r Billing_Item_Cancellation_Reason) GetObject() (resp datatypes.Billing_Item_Cancellation_Reason, err error)

no documentation yet

func (Billing_Item_Cancellation_Reason) GetTranslatedReason 

func (r Billing_Item_Cancellation_Reason) GetTranslatedReason() (resp string, err error)

Retrieve

func (Billing_Item_Cancellation_Reason) Id 

func (r Billing_Item_Cancellation_Reason) Id(id int) Billing_Item_Cancellation_Reason

func (Billing_Item_Cancellation_Reason) Limit 

func (r Billing_Item_Cancellation_Reason) Limit(limit int) Billing_Item_Cancellation_Reason

func (Billing_Item_Cancellation_Reason) Mask 

func (r Billing_Item_Cancellation_Reason) Mask(mask string) Billing_Item_Cancellation_Reason

func (Billing_Item_Cancellation_Reason) Offset 

func (r Billing_Item_Cancellation_Reason) Offset(offset int) Billing_Item_Cancellation_Reason

type Billing_Item_Cancellation_Reason_Category 

type Billing_Item_Cancellation_Reason_Category struct {
	Session session.SLSession
	Options sl.Options
}

The SoftLayer_Billing_Item_Cancellation_Reason_Category data type contains cancellation reason categories.

func GetBillingItemCancellationReasonCategoryService 

func GetBillingItemCancellationReasonCategoryService(sess session.SLSession) Billing_Item_Cancellation_Reason_Category

GetBillingItemCancellationReasonCategoryService returns an instance of the Billing_Item_Cancellation_Reason_Category SoftLayer service

func (Billing_Item_Cancellation_Reason_Category) Filter 

func (r Billing_Item_Cancellation_Reason_Category) Filter(filter string) Billing_Item_Cancellation_Reason_Category

func (Billing_Item_Cancellation_Reason_Category) GetAllCancellationReasonCategories 

func (r Billing_Item_Cancellation_Reason_Category) GetAllCancellationReasonCategories() (resp []datatypes.Billing_Item_Cancellation_Reason_Category, err error)

getAllCancellationReasonCategories() retrieves a list of all cancellation reason categories

func (Billing_Item_Cancellation_Reason_Category) GetBillingCancellationReasons 

func (r Billing_Item_Cancellation_Reason_Category) GetBillingCancellationReasons() (resp []datatypes.Billing_Item_Cancellation_Reason, err error)

Retrieve The corresponding billing cancellation reasons having the specific billing cancellation reason category.

func (Billing_Item_Cancellation_Reason_Category) GetObject 

func (r Billing_Item_Cancellation_Reason_Category) GetObject() (resp datatypes.Billing_Item_Cancellation_Reason_Category, err error)

no documentation yet

func (Billing_Item_Cancellation_Reason_Category) Id 

func (r Billing_Item_Cancellation_Reason_Category) Id(id int) Billing_Item_Cancellation_Reason_Category

func (Billing_Item_Cancellation_Reason_Category) Limit 

func (r Billing_Item_Cancellation_Reason_Category) Limit(limit int) Billing_Item_Cancellation_Reason_Category

func (Billing_Item_Cancellation_Reason_Category) Mask 

func (r Billing_Item_Cancellation_Reason_Category) Mask(mask string) Billing_Item_Cancellation_Reason_Category

func (Billing_Item_Cancellation_Reason_Category) Offset 

func (r Billing_Item_Cancellation_Reason_Category) Offset(offset int) Billing_Item_Cancellation_Reason_Category

type Billing_Item_Cancellation_Request 

type Billing_Item_Cancellation_Request struct {
	Session session.SLSession
	Options sl.Options
}

SoftLayer_Billing_Item_Cancellation_Request data type is used to cancel service billing items.

func GetBillingItemCancellationRequestService 

func GetBillingItemCancellationRequestService(sess session.SLSession) Billing_Item_Cancellation_Request

GetBillingItemCancellationRequestService returns an instance of the Billing_Item_Cancellation_Request SoftLayer service

func (Billing_Item_Cancellation_Request) CreateObject 

func (r Billing_Item_Cancellation_Request) CreateObject(templateObject *datatypes.Billing_Item_Cancellation_Request) (resp datatypes.Billing_Item_Cancellation_Request, err error)

This method creates a service cancellation request.

You need to have "Cancel Services" privilege to create a cancellation request. You have to provide at least one SoftLayer_Billing_Item_Cancellation_Request_Item in the "items" property. Make sure billing item's category code belongs to the cancelable product codes. You can retrieve the cancelable product category by the [[SoftLayer_Product_Item_Category::getValidCancelableServiceItemCategories|product category]] service.

func (Billing_Item_Cancellation_Request) Filter 

func (r Billing_Item_Cancellation_Request) Filter(filter string) Billing_Item_Cancellation_Request

func (Billing_Item_Cancellation_Request) GetAccount 

func (r Billing_Item_Cancellation_Request) GetAccount() (resp datatypes.Account, err error)

Retrieve The SoftLayer account that a service cancellation request belongs to.

func (Billing_Item_Cancellation_Request) GetAllCancellationRequests 

func (r Billing_Item_Cancellation_Request) GetAllCancellationRequests() (resp []datatypes.Billing_Item_Cancellation_Request, err error)

This method returns all service cancellation requests.

Make sure to include the "resultLimit" in the SOAP request header for quicker response. If there is no result limit header is passed, it will return the latest 25 results by default.

func (Billing_Item_Cancellation_Request) GetCancellationCutoffDate 

func (r Billing_Item_Cancellation_Request) GetCancellationCutoffDate(accountId *int, categoryCode *string) (resp datatypes.Time, err error)

Services can be canceled 2 or 3 days prior to your next bill date. This service returns the time by which a cancellation request submission is permitted in the current billing cycle. If the current time falls into the cut off date, this will return next earliest cancellation cut off date.

Available category codes are: service, server

func (Billing_Item_Cancellation_Request) GetItems 

func (r Billing_Item_Cancellation_Request) GetItems() (resp []datatypes.Billing_Item_Cancellation_Request_Item, err error)

Retrieve A collection of service cancellation items.

func (Billing_Item_Cancellation_Request) GetObject 

func (r Billing_Item_Cancellation_Request) GetObject() (resp datatypes.Billing_Item_Cancellation_Request, err error)

getObject retrieves the SoftLayer_Billing_Item_Cancellation_Request object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Billing_Item_Cancellation_Request service. You can only retrieve cancellation request records that are assigned to your SoftLayer account.

func (Billing_Item_Cancellation_Request) GetStatus 

func (r Billing_Item_Cancellation_Request) GetStatus() (resp datatypes.Billing_Item_Cancellation_Request_Status, err error)

Retrieve The status of a service cancellation request.

func (Billing_Item_Cancellation_Request) GetTicket 

func (r Billing_Item_Cancellation_Request) GetTicket() (resp datatypes.Ticket, err error)

Retrieve The ticket that is associated with the service cancellation request.

func (Billing_Item_Cancellation_Request) GetUser 

func (r Billing_Item_Cancellation_Request) GetUser() (resp datatypes.User_Customer, err error)

Retrieve The user that initiated a service cancellation request.

func (Billing_Item_Cancellation_Request) Id 

func (r Billing_Item_Cancellation_Request) Id(id int) Billing_Item_Cancellation_Request

func (Billing_Item_Cancellation_Request) Limit 

func (r Billing_Item_Cancellation_Request) Limit(limit int) Billing_Item_Cancellation_Request

func (Billing_Item_Cancellation_Request) Mask 

func (r Billing_Item_Cancellation_Request) Mask(mask string) Billing_Item_Cancellation_Request

func (Billing_Item_Cancellation_Request) Offset 

func (r Billing_Item_Cancellation_Request) Offset(offset int) Billing_Item_Cancellation_Request

func (Billing_Item_Cancellation_Request) RemoveCancellationItem 

func (r Billing_Item_Cancellation_Request) RemoveCancellationItem(itemId *int) (resp bool, err error)

This method removes a cancellation item from a cancellation request that is in "Pending" or "Approved" status.

func (Billing_Item_Cancellation_Request) ValidateBillingItemForCancellation 

func (r Billing_Item_Cancellation_Request) ValidateBillingItemForCancellation(billingItemId *int) (resp bool, err error)

This method examined if a billing item is eligible for cancellation. It checks if the billing item you provided is already in your existing cancellation request.

func (Billing_Item_Cancellation_Request) Void 

func (r Billing_Item_Cancellation_Request) Void(closeRelatedTicketFlag *bool) (resp bool, err error)

This method voids a service cancellation request in "Pending" or "Approved" status.

type Billing_Item_Chronicle added in v1.0.6 

type Billing_Item_Chronicle struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetBillingItemChronicleService added in v1.0.6 

func GetBillingItemChronicleService(sess session.SLSession) Billing_Item_Chronicle

GetBillingItemChronicleService returns an instance of the Billing_Item_Chronicle SoftLayer service

func (Billing_Item_Chronicle) Filter added in v1.0.6 

func (r Billing_Item_Chronicle) Filter(filter string) Billing_Item_Chronicle

func (Billing_Item_Chronicle) GetAssociatedChildren added in v1.0.6 

func (r Billing_Item_Chronicle) GetAssociatedChildren() (resp []datatypes.Billing_Item_Chronicle, err error)

Retrieve A Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item.

func (Billing_Item_Chronicle) GetObject added in v1.0.6 

func (r Billing_Item_Chronicle) GetObject() (resp datatypes.Billing_Item_Chronicle, err error)

no documentation yet

func (Billing_Item_Chronicle) GetProduct added in v1.0.6 

func (r Billing_Item_Chronicle) GetProduct() (resp datatypes.Product_Item, err error)

Retrieve The entry in the product catalog that the underlying billing item is based on.

func (Billing_Item_Chronicle) Id added in v1.0.6 

func (r Billing_Item_Chronicle) Id(id int) Billing_Item_Chronicle

func (Billing_Item_Chronicle) Limit added in v1.0.6 

func (r Billing_Item_Chronicle) Limit(limit int) Billing_Item_Chronicle

func (Billing_Item_Chronicle) Mask added in v1.0.6 

func (r Billing_Item_Chronicle) Mask(mask string) Billing_Item_Chronicle

func (Billing_Item_Chronicle) Offset added in v1.0.6 

func (r Billing_Item_Chronicle) Offset(offset int) Billing_Item_Chronicle

type Billing_Item_Virtual_DedicatedHost 

type Billing_Item_Virtual_DedicatedHost struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetBillingItemVirtualDedicatedHostService 

func GetBillingItemVirtualDedicatedHostService(sess session.SLSession) Billing_Item_Virtual_DedicatedHost

GetBillingItemVirtualDedicatedHostService returns an instance of the Billing_Item_Virtual_DedicatedHost SoftLayer service

func (Billing_Item_Virtual_DedicatedHost) CancelItem 

func (r Billing_Item_Virtual_DedicatedHost) CancelItem(cancelImmediately *bool, cancelAssociatedBillingItems *bool, reason *string, customerNote *string) (resp bool, err error)

Cancel the resource or service for a billing Item. By default the billing item will be canceled on the next bill date and reclaim of the resource will begin shortly after the cancellation. Setting the "cancelImmediately" property to true will start the cancellation immediately if the item is eligible to be canceled immediately.

The reason parameter could be from the list below: * "No longer needed" * "Business closing down" * "Server / Upgrade Costs" * "Migrating to larger server" * "Migrating to smaller server" * "Migrating to a different SoftLayer datacenter" * "Network performance / latency" * "Support response / timing" * "Sales process / upgrades" * "Moving to competitor"

func (Billing_Item_Virtual_DedicatedHost) CancelService 

func (r Billing_Item_Virtual_DedicatedHost) CancelService() (resp bool, err error)

Cancel the resource or service (excluding bare metal servers) for a billing Item. The billing item will be cancelled immediately and reclaim of the resource will begin shortly.

func (Billing_Item_Virtual_DedicatedHost) CancelServiceOnAnniversaryDate 

func (r Billing_Item_Virtual_DedicatedHost) CancelServiceOnAnniversaryDate() (resp bool, err error)

Cancel the resource or service for a billing Item

func (Billing_Item_Virtual_DedicatedHost) Filter 

func (r Billing_Item_Virtual_DedicatedHost) Filter(filter string) Billing_Item_Virtual_DedicatedHost

func (Billing_Item_Virtual_DedicatedHost) GetAccount 

func (r Billing_Item_Virtual_DedicatedHost) GetAccount() (resp datatypes.Account, err error)

Retrieve The account that a billing item belongs to.

func (Billing_Item_Virtual_DedicatedHost) GetActiveAgreement 

func (r Billing_Item_Virtual_DedicatedHost) GetActiveAgreement() (resp datatypes.Account_Agreement, err error)

Retrieve

func (Billing_Item_Virtual_DedicatedHost) GetActiveAgreementFlag 

func (r Billing_Item_Virtual_DedicatedHost) GetActiveAgreementFlag() (resp datatypes.Account_Agreement, err error)

Retrieve A flag indicating that the billing item is under an active agreement.

func (Billing_Item_Virtual_DedicatedHost) GetActiveAssociatedChildren 

func (r Billing_Item_Virtual_DedicatedHost) GetActiveAssociatedChildren() (resp []datatypes.Billing_Item, err error)

Retrieve A billing item's active associated child billing items. This includes "floating" items that are not necessarily child items of this billing item.

func (Billing_Item_Virtual_DedicatedHost) GetActiveAssociatedGuestDiskBillingItems 

func (r Billing_Item_Virtual_DedicatedHost) GetActiveAssociatedGuestDiskBillingItems() (resp []datatypes.Billing_Item, err error)

Retrieve

func (Billing_Item_Virtual_DedicatedHost) GetActiveBundledItems 

func (r Billing_Item_Virtual_DedicatedHost) GetActiveBundledItems() (resp []datatypes.Billing_Item, err error)

Retrieve A Billing Item's active bundled billing items.

func (Billing_Item_Virtual_DedicatedHost) GetActiveCancellationItem 

func (r Billing_Item_Virtual_DedicatedHost) GetActiveCancellationItem() (resp datatypes.Billing_Item_Cancellation_Request_Item, err error)

Retrieve A service cancellation request item that corresponds to the billing item.

func (Billing_Item_Virtual_DedicatedHost) GetActiveChildren 

func (r Billing_Item_Virtual_DedicatedHost) GetActiveChildren() (resp []datatypes.Billing_Item, err error)

Retrieve A Billing Item's active child billing items.

func (Billing_Item_Virtual_DedicatedHost) GetActiveFlag 

func (r Billing_Item_Virtual_DedicatedHost) GetActiveFlag() (resp bool, err error)

Retrieve

func (Billing_Item_Virtual_DedicatedHost) GetActiveSparePoolAssociatedGuestDiskBillingItems 

func (r Billing_Item_Virtual_DedicatedHost) GetActiveSparePoolAssociatedGuestDiskBillingItems() (resp []datatypes.Billing_Item, err error)

Retrieve

func (Billing_Item_Virtual_DedicatedHost) GetActiveSparePoolBundledItems 

func (r Billing_Item_Virtual_DedicatedHost) GetActiveSparePoolBundledItems() (resp []datatypes.Billing_Item, err error)

Retrieve A Billing Item's spare pool bundled billing items.

func (Billing_Item_Virtual_DedicatedHost) GetAssociatedBillingItem 

func (r Billing_Item_Virtual_DedicatedHost) GetAssociatedBillingItem() (resp datatypes.Billing_Item, err error)

Retrieve A billing item's associated parent. This is to be used for billing items that are "floating", and therefore are not child items of any parent billing item. If it is desired to associate an item to another, populate this with the SoftLayer_Billing_Item ID of that associated parent item.

func (Billing_Item_Virtual_DedicatedHost) GetAssociatedBillingItemHistory 

func (r Billing_Item_Virtual_DedicatedHost) GetAssociatedBillingItemHistory() (resp []datatypes.Billing_Item_Association_History, err error)

Retrieve A history of billing items which a billing item has been associated with.

func (Billing_Item_Virtual_DedicatedHost) GetAssociatedChildren 

func (r Billing_Item_Virtual_DedicatedHost) GetAssociatedChildren() (resp []datatypes.Billing_Item, err error)

Retrieve A Billing Item's associated child billing items. This includes "floating" items that are not necessarily child billing items of this billing item.

func (Billing_Item_Virtual_DedicatedHost) GetAssociatedParent 

func (r Billing_Item_Virtual_DedicatedHost) GetAssociatedParent() (resp []datatypes.Billing_Item, err error)

Retrieve A billing item's associated parent billing item. This object will be the same as the parent billing item if parentId is set.

func (Billing_Item_Virtual_DedicatedHost) GetAvailableMatchingVlans 

func (r Billing_Item_Virtual_DedicatedHost) GetAvailableMatchingVlans() (resp []datatypes.Network_Vlan, err error)

Retrieve

func (Billing_Item_Virtual_DedicatedHost) GetBandwidthAllocation 

func (r Billing_Item_Virtual_DedicatedHost) GetBandwidthAllocation() (resp datatypes.Network_Bandwidth_Version1_Allocation, err error)

Retrieve The bandwidth allocation for a billing item.

func (Billing_Item_Virtual_DedicatedHost) GetBillableChildren 

func (r Billing_Item_Virtual_DedicatedHost) GetBillableChildren() (resp []datatypes.Billing_Item, err error)

Retrieve A billing item's recurring child items that have once been billed and are scheduled to be billed in the future.

func (Billing_Item_Virtual_DedicatedHost) GetBundledItems 

func (r Billing_Item_Virtual_DedicatedHost) GetBundledItems() (resp []datatypes.Billing_Item, err error)

Retrieve A Billing Item's bundled billing items.

func (Billing_Item_Virtual_DedicatedHost) GetCanceledChildren 

func (r Billing_Item_Virtual_DedicatedHost) GetCanceledChildren() (resp []datatypes.Billing_Item, err error)

Retrieve A Billing Item's active child billing items.

func (Billing_Item_Virtual_DedicatedHost) GetCancellationReason 

func (r Billing_Item_Virtual_DedicatedHost) GetCancellationReason() (resp datatypes.Billing_Item_Cancellation_Reason, err error)

Retrieve The billing item's cancellation reason.

func (Billing_Item_Virtual_DedicatedHost) GetCancellationRequests 

func (r Billing_Item_Virtual_DedicatedHost) GetCancellationRequests() (resp []datatypes.Billing_Item_Cancellation_Request, err error)

Retrieve This will return any cancellation requests that are associated with this billing item.

func (Billing_Item_Virtual_DedicatedHost) GetCategory 

func (r Billing_Item_Virtual_DedicatedHost) GetCategory() (resp datatypes.Product_Item_Category, err error)

Retrieve The item category to which the billing item's item belongs.

func (Billing_Item_Virtual_DedicatedHost) GetChildren 

func (r Billing_Item_Virtual_DedicatedHost) GetChildren() (resp []datatypes.Billing_Item, err error)

Retrieve A Billing Item's child billing items'

func (Billing_Item_Virtual_DedicatedHost) GetChildrenWithActiveAgreement 

func (r Billing_Item_Virtual_DedicatedHost) GetChildrenWithActiveAgreement() (resp []datatypes.Billing_Item, err error)

Retrieve A Billing Item's active child billing items.

func (Billing_Item_Virtual_DedicatedHost) GetDowngradeItems 

func (r Billing_Item_Virtual_DedicatedHost) GetDowngradeItems() (resp []datatypes.Product_Item, err error)

Retrieve For product items which have a downgrade path defined, this will return those product items.

func (Billing_Item_Virtual_DedicatedHost) GetFilteredNextInvoiceChildren 

func (r Billing_Item_Virtual_DedicatedHost) GetFilteredNextInvoiceChildren() (resp []datatypes.Billing_Item, err error)

Retrieve A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.

func (Billing_Item_Virtual_DedicatedHost) GetHourlyFlag 

func (r Billing_Item_Virtual_DedicatedHost) GetHourlyFlag() (resp bool, err error)

Retrieve A flag that will reflect whether this billing item is billed on an hourly basis or not.

func (Billing_Item_Virtual_DedicatedHost) GetInvoiceItem 

func (r Billing_Item_Virtual_DedicatedHost) GetInvoiceItem() (resp datatypes.Billing_Invoice_Item, err error)

Retrieve Invoice items associated with this billing item

func (Billing_Item_Virtual_DedicatedHost) GetInvoiceItems 

func (r Billing_Item_Virtual_DedicatedHost) GetInvoiceItems() (resp []datatypes.Billing_Invoice_Item, err error)

Retrieve All invoice items associated with the billing item

func (Billing_Item_Virtual_DedicatedHost) GetItem 

func (r Billing_Item_Virtual_DedicatedHost) GetItem() (resp datatypes.Product_Item, err error)

Retrieve The entry in the SoftLayer product catalog that a billing item is based upon.

func (Billing_Item_Virtual_DedicatedHost) GetLocation 

func (r Billing_Item_Virtual_DedicatedHost) GetLocation() (resp datatypes.Location, err error)

Retrieve The location of the billing item. Some billing items have physical properties such as the server itself. For items such as these, we provide location information.

func (Billing_Item_Virtual_DedicatedHost) GetNextInvoiceChildren 

func (r Billing_Item_Virtual_DedicatedHost) GetNextInvoiceChildren() (resp []datatypes.Billing_Item, err error)

Retrieve A Billing Item's child billing items and associated items'

func (Billing_Item_Virtual_DedicatedHost) GetNextInvoiceTotalOneTimeAmount 

func (r Billing_Item_Virtual_DedicatedHost) GetNextInvoiceTotalOneTimeAmount() (resp datatypes.Float64, err error)

Retrieve A Billing Item's total, including any child billing items if they exist.'

func (Billing_Item_Virtual_DedicatedHost) GetNextInvoiceTotalOneTimeTaxAmount 

func (r Billing_Item_Virtual_DedicatedHost) GetNextInvoiceTotalOneTimeTaxAmount() (resp datatypes.Float64, err error)

Retrieve A Billing Item's total, including any child billing items if they exist.'

func (Billing_Item_Virtual_DedicatedHost) GetNextInvoiceTotalRecurringAmount 

func (r Billing_Item_Virtual_DedicatedHost) GetNextInvoiceTotalRecurringAmount() (resp datatypes.Float64, err error)

Retrieve A Billing Item's total, including any child billing items and associated billing items if they exist.'

func (Billing_Item_Virtual_DedicatedHost) GetNextInvoiceTotalRecurringTaxAmount 

func (r Billing_Item_Virtual_DedicatedHost) GetNextInvoiceTotalRecurringTaxAmount() (resp datatypes.Float64, err error)

Retrieve This is deprecated and will always be zero. Because tax is calculated in real-time, previewing the next recurring invoice is pre-tax only.

func (Billing_Item_Virtual_DedicatedHost) GetNonZeroNextInvoiceChildren 

func (r Billing_Item_Virtual_DedicatedHost) GetNonZeroNextInvoiceChildren() (resp []datatypes.Billing_Item, err error)

Retrieve A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.

func (Billing_Item_Virtual_DedicatedHost) GetObject 

func (r Billing_Item_Virtual_DedicatedHost) GetObject() (resp datatypes.Billing_Item_Virtual_DedicatedHost, err error)

no documentation yet

func (Billing_Item_Virtual_DedicatedHost) GetOrderItem 

func (r Billing_Item_Virtual_DedicatedHost) GetOrderItem() (resp datatypes.Billing_Order_Item, err error)

Retrieve A billing item's original order item. Simply a reference to the original order from which this billing item was created.

func (Billing_Item_Virtual_DedicatedHost) GetOriginalLocation 

func (r Billing_Item_Virtual_DedicatedHost) GetOriginalLocation() (resp datatypes.Location, err error)

Retrieve The original physical location for this billing item--may differ from current.

func (Billing_Item_Virtual_DedicatedHost) GetPackage 

func (r Billing_Item_Virtual_DedicatedHost) GetPackage() (resp datatypes.Product_Package, err error)

Retrieve The package under which this billing item was sold. A Package is the general grouping of products as seen on our order forms.

func (Billing_Item_Virtual_DedicatedHost) GetParent 

func (r Billing_Item_Virtual_DedicatedHost) GetParent() (resp datatypes.Billing_Item, err error)

Retrieve A billing item's parent item. If a billing item has no parent item then this value is null.

func (Billing_Item_Virtual_DedicatedHost) GetParentVirtualGuestBillingItem 

func (r Billing_Item_Virtual_DedicatedHost) GetParentVirtualGuestBillingItem() (resp datatypes.Billing_Item_Virtual_Guest, err error)

Retrieve A billing item's parent item. If a billing item has no parent item then this value is null.

func (Billing_Item_Virtual_DedicatedHost) GetPendingCancellationFlag 

func (r Billing_Item_Virtual_DedicatedHost) GetPendingCancellationFlag() (resp bool, err error)

Retrieve This flag indicates whether a billing item is scheduled to be canceled or not.

func (Billing_Item_Virtual_DedicatedHost) GetPendingOrderItem 

func (r Billing_Item_Virtual_DedicatedHost) GetPendingOrderItem() (resp datatypes.Billing_Order_Item, err error)

Retrieve The new order item that will replace this billing item.

func (Billing_Item_Virtual_DedicatedHost) GetProvisionTransaction 

func (r Billing_Item_Virtual_DedicatedHost) GetProvisionTransaction() (resp datatypes.Provisioning_Version1_Transaction, err error)

Retrieve Provisioning transaction for this billing item

func (Billing_Item_Virtual_DedicatedHost) GetResource 

func (r Billing_Item_Virtual_DedicatedHost) GetResource() (resp datatypes.Virtual_DedicatedHost, err error)

Retrieve The resource for a virtual dedicated host billing item.

func (Billing_Item_Virtual_DedicatedHost) GetServiceBillingItemsByCategory 

func (r Billing_Item_Virtual_DedicatedHost) GetServiceBillingItemsByCategory(categoryCode *string, includeZeroRecurringFee *bool) (resp []datatypes.Billing_Item, err error)

This service returns billing items of a specified category code. This service should be used to retrieve billing items that you wish to cancel. Some billing items can be canceled via [[SoftLayer_Security_Certificate_Request|service cancellation]] service.

In order to find billing items for cancellation, use [[SoftLayer_Product_Item_Category::getValidCancelableServiceItemCategories|product categories]] service to retrieve category codes that are eligible for cancellation.

func (Billing_Item_Virtual_DedicatedHost) GetSoftwareDescription 

func (r Billing_Item_Virtual_DedicatedHost) GetSoftwareDescription() (resp datatypes.Software_Description, err error)

Retrieve A friendly description of software component

func (Billing_Item_Virtual_DedicatedHost) GetUpgradeItem 

func (r Billing_Item_Virtual_DedicatedHost) GetUpgradeItem() (resp datatypes.Product_Item, err error)

Retrieve Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path.

func (Billing_Item_Virtual_DedicatedHost) GetUpgradeItems 

func (r Billing_Item_Virtual_DedicatedHost) GetUpgradeItems() (resp []datatypes.Product_Item, err error)

Retrieve Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path.

func (Billing_Item_Virtual_DedicatedHost) Id 

func (r Billing_Item_Virtual_DedicatedHost) Id(id int) Billing_Item_Virtual_DedicatedHost

func (Billing_Item_Virtual_DedicatedHost) Limit 

func (r Billing_Item_Virtual_DedicatedHost) Limit(limit int) Billing_Item_Virtual_DedicatedHost

func (Billing_Item_Virtual_DedicatedHost) Mask 

func (r Billing_Item_Virtual_DedicatedHost) Mask(mask string) Billing_Item_Virtual_DedicatedHost

func (Billing_Item_Virtual_DedicatedHost) Offset 

func (r Billing_Item_Virtual_DedicatedHost) Offset(offset int) Billing_Item_Virtual_DedicatedHost

func (Billing_Item_Virtual_DedicatedHost) RemoveAssociationId 

func (r Billing_Item_Virtual_DedicatedHost) RemoveAssociationId() (resp bool, err error)

Remove the association from a billing item.

func (Billing_Item_Virtual_DedicatedHost) SetAssociationId 

func (r Billing_Item_Virtual_DedicatedHost) SetAssociationId(associatedId *int) (resp bool, err error)

Set an associated billing item to an orphan billing item. Associations allow you to tie an "orphaned" billing item, any non-server billing item that doesn't have a parent item such as secondary IP subnets or StorageLayer accounts, to a server billing item. You may only set an association for an orphan to a server. You cannot associate a server to an orphan if the either the server or orphan billing items have a cancellation date set.

func (Billing_Item_Virtual_DedicatedHost) VoidCancelService 

func (r Billing_Item_Virtual_DedicatedHost) VoidCancelService() (resp bool, err error)

Void a previously made cancellation for a service

type Billing_Order 

type Billing_Order struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetBillingOrderService 

func GetBillingOrderService(sess session.SLSession) Billing_Order

GetBillingOrderService returns an instance of the Billing_Order SoftLayer service

func (Billing_Order) ApproveModifiedOrder 

func (r Billing_Order) ApproveModifiedOrder() (resp bool, err error)

When an order has been modified, the customer will need to approve the changes. This method will allow the customer to approve the changes.

func (Billing_Order) Filter 

func (r Billing_Order) Filter(filter string) Billing_Order

func (Billing_Order) GetAccount 

func (r Billing_Order) GetAccount() (resp datatypes.Account, err error)

Retrieve The [[SoftLayer_Account|account]] to which an order belongs.

func (Billing_Order) GetAllObjects 

func (r Billing_Order) GetAllObjects() (resp []datatypes.Billing_Order, err error)

This will get all billing orders for your account.

func (Billing_Order) GetBrand 

func (r Billing_Order) GetBrand() (resp datatypes.Brand, err error)

Retrieve

func (Billing_Order) GetCart 

func (r Billing_Order) GetCart() (resp datatypes.Billing_Order_Cart, err error)

Retrieve A cart is similar to a quote, except that it can be continually modified by the customer and does not have locked-in prices. Not all orders will have a cart associated with them. See [[SoftLayer_Billing_Order_Cart]] for more information.

func (Billing_Order) GetCoreRestrictedItems 

func (r Billing_Order) GetCoreRestrictedItems() (resp []datatypes.Billing_Order_Item, err error)

Retrieve The [[SoftLayer_Billing_Order_Item (type)|order items]] that are core restricted

func (Billing_Order) GetCreditCardTransactions 

func (r Billing_Order) GetCreditCardTransactions() (resp []datatypes.Billing_Payment_Card_Transaction, err error)

Retrieve All credit card transactions associated with this order. If this order was not placed with a credit card, this will be empty.

func (Billing_Order) GetExchangeRate 

func (r Billing_Order) GetExchangeRate() (resp datatypes.Billing_Currency_ExchangeRate, err error)

Retrieve

func (Billing_Order) GetInitialInvoice 

func (r Billing_Order) GetInitialInvoice() (resp datatypes.Billing_Invoice, err error)

Retrieve

func (Billing_Order) GetItems 

func (r Billing_Order) GetItems() (resp []datatypes.Billing_Order_Item, err error)

Retrieve The SoftLayer_Billing_Order_items included in an order.

func (Billing_Order) GetObject 

func (r Billing_Order) GetObject() (resp datatypes.Billing_Order, err error)

getObject retrieves the SoftLayer_Billing_Order object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Billing_Order service. You can only retrieve orders that are assigned to your portal user's account.

func (Billing_Order) GetOrderApprovalDate 

func (r Billing_Order) GetOrderApprovalDate() (resp datatypes.Time, err error)

Retrieve

func (Billing_Order) GetOrderNonServerMonthlyAmount 

func (r Billing_Order) GetOrderNonServerMonthlyAmount() (resp datatypes.Float64, err error)

Retrieve An order's non-server items total monthly fee.

func (Billing_Order) GetOrderServerMonthlyAmount 

func (r Billing_Order) GetOrderServerMonthlyAmount() (resp datatypes.Float64, err error)

Retrieve An order's server items total monthly fee.

func (Billing_Order) GetOrderStatuses 

func (r Billing_Order) GetOrderStatuses() (resp []datatypes.Container_Billing_Order_Status, err error)

Get a list of [[SoftLayer_Container_Billing_Order_Status]] objects.

func (Billing_Order) GetOrderTopLevelItems 

func (r Billing_Order) GetOrderTopLevelItems() (resp []datatypes.Billing_Order_Item, err error)

Retrieve An order's top level items. This normally includes the server line item and any non-server additional services such as NAS or ISCSI.

func (Billing_Order) GetOrderTotalAmount 

func (r Billing_Order) GetOrderTotalAmount() (resp datatypes.Float64, err error)

Retrieve This amount represents the order's initial charge including set up fee and taxes.

func (Billing_Order) GetOrderTotalOneTime 

func (r Billing_Order) GetOrderTotalOneTime() (resp datatypes.Float64, err error)

Retrieve An order's total one time amount summing all the set up fees, the labor fees and the one time fees. Taxes will be applied for non-tax-exempt. This amount represents the initial fees that will be charged.

func (Billing_Order) GetOrderTotalOneTimeAmount 

func (r Billing_Order) GetOrderTotalOneTimeAmount() (resp datatypes.Float64, err error)

Retrieve An order's total one time amount. This amount represents the initial fees before tax.

func (Billing_Order) GetOrderTotalOneTimeTaxAmount 

func (r Billing_Order) GetOrderTotalOneTimeTaxAmount() (resp datatypes.Float64, err error)

Retrieve An order's total one time tax amount. This amount represents the tax that will be applied to the total charge, if the SoftLayer_Account tied to a SoftLayer_Billing_Order is a taxable account.

func (Billing_Order) GetOrderTotalRecurring 

func (r Billing_Order) GetOrderTotalRecurring() (resp datatypes.Float64, err error)

Retrieve An order's total recurring amount. Taxes will be applied for non-tax-exempt. This amount represents the fees that will be charged on a recurring (usually monthly) basis.

func (Billing_Order) GetOrderTotalRecurringAmount 

func (r Billing_Order) GetOrderTotalRecurringAmount() (resp datatypes.Float64, err error)

Retrieve An order's total recurring amount. This amount represents the fees that will be charged on a recurring (usually monthly) basis.

func (Billing_Order) GetOrderTotalRecurringTaxAmount 

func (r Billing_Order) GetOrderTotalRecurringTaxAmount() (resp datatypes.Float64, err error)

Retrieve The total tax amount of the recurring fees, if the SoftLayer_Account tied to a SoftLayer_Billing_Order is a taxable account.

func (Billing_Order) GetOrderTotalSetupAmount 

func (r Billing_Order) GetOrderTotalSetupAmount() (resp datatypes.Float64, err error)

Retrieve An order's total setup fee.

func (Billing_Order) GetOrderType 

func (r Billing_Order) GetOrderType() (resp datatypes.Billing_Order_Type, err error)

Retrieve The type of an order. This lets you know where this order was generated from.

func (Billing_Order) GetPaypalTransactions 

func (r Billing_Order) GetPaypalTransactions() (resp []datatypes.Billing_Payment_PayPal_Transaction, err error)

Retrieve All PayPal transactions associated with this order. If this order was not placed with PayPal, this will be empty.

func (Billing_Order) GetPdf 

func (r Billing_Order) GetPdf() (resp []byte, err error)

Retrieve a PDF record of a SoftLayer quote. If the order is not a quote, an error will be thrown.

func (Billing_Order) GetPdfFilename 

func (r Billing_Order) GetPdfFilename() (resp string, err error)

Retrieve the default filename of an order PDF.

func (Billing_Order) GetPresaleEvent 

func (r Billing_Order) GetPresaleEvent() (resp datatypes.Sales_Presale_Event, err error)

Retrieve

func (Billing_Order) GetQuote 

func (r Billing_Order) GetQuote() (resp datatypes.Billing_Order_Quote, err error)

Retrieve The quote of an order. This quote holds information about its expiration date, creation date, name and status. This information is tied to an order having the status 'QUOTE'

func (Billing_Order) GetRecalculatedOrderContainer 

func (r Billing_Order) GetRecalculatedOrderContainer(message *string, ignoreDiscountsFlag *bool) (resp datatypes.Container_Product_Order, err error)

Generate an [[SoftLayer_Container_Product_Order|order container]] from a billing order. This will take into account promotions, reseller status, estimated taxes and all other standard order verification processes.

func (Billing_Order) GetReceipt 

func (r Billing_Order) GetReceipt() (resp datatypes.Container_Product_Order_Receipt, err error)

Generate a [[SoftLayer_Container_Product_Order_Receipt]] object with all the order information.

func (Billing_Order) GetReferralPartner 

func (r Billing_Order) GetReferralPartner() (resp datatypes.Account, err error)

Retrieve The Referral Partner who referred this order. (Only necessary for new customer orders)

func (Billing_Order) GetUpgradeRequestFlag 

func (r Billing_Order) GetUpgradeRequestFlag() (resp bool, err error)

Retrieve This flag indicates an order is an upgrade.

func (Billing_Order) GetUserRecord 

func (r Billing_Order) GetUserRecord() (resp datatypes.User_Customer, err error)

Retrieve The SoftLayer_User_Customer object tied to an order.

func (Billing_Order) Id 

func (r Billing_Order) Id(id int) Billing_Order

func (Billing_Order) IsPendingEditApproval 

func (r Billing_Order) IsPendingEditApproval() (resp bool, err error)

When an order has been modified, it will contain a status indicating so. This method checks that status and also verifies that the active user's account is the same as the account on the order.

func (Billing_Order) Limit 

func (r Billing_Order) Limit(limit int) Billing_Order

func (Billing_Order) Mask 

func (r Billing_Order) Mask(mask string) Billing_Order

func (Billing_Order) Offset 

func (r Billing_Order) Offset(offset int) Billing_Order

type Billing_Order_Cart 

type Billing_Order_Cart struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetBillingOrderCartService 

func GetBillingOrderCartService(sess session.SLSession) Billing_Order_Cart

GetBillingOrderCartService returns an instance of the Billing_Order_Cart SoftLayer service

func (Billing_Order_Cart) Claim 

func (r Billing_Order_Cart) Claim(quoteKey *string, quoteId *int) (resp datatypes.Billing_Order_Quote, err error)

This method is used to transfer an anonymous quote to the active user and associated account. An anonymous quote is one that was created by a user without being authenticated. If a quote was created anonymously and then the customer attempts to access that anonymous quote via the API (which requires authentication), the customer will be unable to retrieve the quote due to the security restrictions in place. By providing the ability for a customer to claim a quote, s/he will be able to pull the anonymous quote onto his/her account and successfully view the quote.

To claim a quote, both the quote id and the quote key (the 32-character random string) must be provided.

func (Billing_Order_Cart) CreateCart 

func (r Billing_Order_Cart) CreateCart(orderData *datatypes.Container_Product_Order) (resp int, err error)

When creating a new cart, the order data is sent through SoftLayer_Product_Order::verifyOrder to make sure that the cart contains valid data. If an issue is found with the order, an exception will be thrown and you will receive the same response as if SoftLayer_Product_Order::verifyOrder were called directly. Once the order verification is complete, the cart will be created.

The response is the new cart id.

func (Billing_Order_Cart) DeleteCart 

func (r Billing_Order_Cart) DeleteCart() (resp bool, err error)

If a cart is no longer needed, it can be deleted using this service. Once a cart has been deleted, it cannot be retrieved again.

func (Billing_Order_Cart) DeleteQuote 

func (r Billing_Order_Cart) DeleteQuote() (resp datatypes.Billing_Order_Quote, err error)

Account master users and sub-users in the SoftLayer customer portal can delete the quote of an order.

func (Billing_Order_Cart) Filter 

func (r Billing_Order_Cart) Filter(filter string) Billing_Order_Cart

func (Billing_Order_Cart) GetAccount 

func (r Billing_Order_Cart) GetAccount() (resp datatypes.Account, err error)

Retrieve A quote's corresponding account.

func (Billing_Order_Cart) GetCartByCartKey 

func (r Billing_Order_Cart) GetCartByCartKey(cartKey *string) (resp datatypes.Billing_Order_Cart, err error)

Retrieve a valid cart record of a SoftLayer order.

func (Billing_Order_Cart) GetDoNotContactFlag 

func (r Billing_Order_Cart) GetDoNotContactFlag() (resp bool, err error)

Retrieve Indicates whether the owner of the quote chosen to no longer be contacted.

func (Billing_Order_Cart) GetObject 

func (r Billing_Order_Cart) GetObject() (resp datatypes.Billing_Order_Cart, err error)

no documentation yet

func (Billing_Order_Cart) GetOrder 

func (r Billing_Order_Cart) GetOrder() (resp datatypes.Billing_Order, err error)

Retrieve This order contains the records for which products were selected for this quote.

func (Billing_Order_Cart) GetOrdersFromQuote 

func (r Billing_Order_Cart) GetOrdersFromQuote() (resp []datatypes.Billing_Order, err error)

Retrieve These are all the orders that were created from this quote.

func (Billing_Order_Cart) GetPdf 

func (r Billing_Order_Cart) GetPdf() (resp []byte, err error)

Retrieve a PDF copy of the cart.

func (Billing_Order_Cart) GetQuoteByQuoteKey 

func (r Billing_Order_Cart) GetQuoteByQuoteKey(quoteKey *string) (resp datatypes.Billing_Order_Quote, err error)

This method will return a [[SoftLayer_Billing_Order_Quote]] that is identified by the quote key specified. If you do not have access to the quote or it does not exist, an exception will be thrown indicating so.

func (Billing_Order_Cart) GetRecalculatedOrderContainer 

func (r Billing_Order_Cart) GetRecalculatedOrderContainer(orderData *datatypes.Container_Product_Order, orderBeingPlacedFlag *bool) (resp datatypes.Container_Product_Order, err error)

This method allows the customer to retrieve a saved cart and put it in a format that's suitable to be sent to SoftLayer_Billing_Order_Cart::createCart to create a new cart or to SoftLayer_Billing_Order_Cart::updateCart to update an existing cart.

func (Billing_Order_Cart) Id 

func (r Billing_Order_Cart) Id(id int) Billing_Order_Cart

func (Billing_Order_Cart) Limit 

func (r Billing_Order_Cart) Limit(limit int) Billing_Order_Cart

func (Billing_Order_Cart) Mask 

func (r Billing_Order_Cart) Mask(mask string) Billing_Order_Cart

func (Billing_Order_Cart) Offset 

func (r Billing_Order_Cart) Offset(offset int) Billing_Order_Cart

func (Billing_Order_Cart) PlaceOrder 

func (r Billing_Order_Cart) PlaceOrder(orderData interface{}) (resp datatypes.Container_Product_Order_Receipt, err error)

Use this method for placing server orders and additional services orders. The same applies for this as with verifyOrder. Send in the SoftLayer_Container_Product_Order_Hardware_Server for server orders. In addition to verifying the order, placeOrder() also makes an initial authorization on the SoftLayer_Account tied to this order, if a credit card is on file. If the account tied to this order is a paypal customer, an URL will also be returned to the customer. After placing the order, you must go to this URL to finish the authorization process. This tells paypal that you indeed want to place the order. After going to this URL, it will direct you back to a SoftLayer webpage that tells us you have finished the process. After this, it will go to sales for final approval.

func (Billing_Order_Cart) PlaceQuote 

func (r Billing_Order_Cart) PlaceQuote(orderData interface{}) (resp datatypes.Container_Product_Order, err error)

Use this method for placing server quotes and additional services quotes. The same applies for this as with verifyOrder. Send in the SoftLayer_Container_Product_Order_Hardware_Server for server quotes. In addition to verifying the quote, placeQuote() also makes an initial authorization on the SoftLayer_Account tied to this order, if a credit card is on file. If the account tied to this order is a paypal customer, an URL will also be returned to the customer. After placing the order, you must go to this URL to finish the authorization process. This tells paypal that you indeed want to place the order. After going to this URL, it will direct you back to a SoftLayer webpage that tells us you have finished the process.

func (Billing_Order_Cart) SaveQuote 

func (r Billing_Order_Cart) SaveQuote() (resp datatypes.Billing_Order_Quote, err error)

Account master users and sub-users in the SoftLayer customer portal can save the quote of an order to avoid its deletion after 5 days or its expiration after 2 days.

func (Billing_Order_Cart) UpdateCart 

func (r Billing_Order_Cart) UpdateCart(orderData *datatypes.Container_Product_Order) (resp int, err error)

Like SoftLayer_Billing_Order_Cart::createCart, the order data will be sent through SoftLayer_Product_Order::verifyOrder to make sure that the updated cart information is valid. Once it has been verified, the new order data will be saved.

This will return the cart id.

func (Billing_Order_Cart) VerifyOrder 

func (r Billing_Order_Cart) VerifyOrder(orderData interface{}) (resp datatypes.Container_Product_Order, err error)

Use this method for placing server orders and additional services orders. The same applies for this as with verifyOrder. Send in the SoftLayer_Container_Product_Order_Hardware_Server for server orders. In addition to verifying the order, placeOrder() also makes an initial authorization on the SoftLayer_Account tied to this order, if a credit card is on file. If the account tied to this order is a paypal customer, an URL will also be returned to the customer. After placing the order, you must go to this URL to finish the authorization process. This tells paypal that you indeed want to place the order. After going to this URL, it will direct you back to a SoftLayer webpage that tells us you have finished the process. After this, it will go to sales for final approval.

func (Billing_Order_Cart) WithdrawGdprAcceptance 

func (r Billing_Order_Cart) WithdrawGdprAcceptance() (err error)

Withdraws the users acceptance of the GDPR terms.

type Billing_Order_Item 

type Billing_Order_Item struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetBillingOrderItemService 

func GetBillingOrderItemService(sess session.SLSession) Billing_Order_Item

GetBillingOrderItemService returns an instance of the Billing_Order_Item SoftLayer service

func (Billing_Order_Item) Filter 

func (r Billing_Order_Item) Filter(filter string) Billing_Order_Item

func (Billing_Order_Item) GetBillingItem 

func (r Billing_Order_Item) GetBillingItem() (resp datatypes.Billing_Item, err error)

Retrieve The SoftLayer_Billing_Item tied to the order item.

func (Billing_Order_Item) GetBundledItems 

func (r Billing_Order_Item) GetBundledItems() (resp []datatypes.Billing_Order_Item, err error)

Retrieve The other items included with an ordered item.

func (Billing_Order_Item) GetCategory 

func (r Billing_Order_Item) GetCategory() (resp datatypes.Product_Item_Category, err error)

Retrieve The item category tied to an order item.

func (Billing_Order_Item) GetChildren 

func (r Billing_Order_Item) GetChildren() (resp []datatypes.Billing_Order_Item, err error)

Retrieve The child order items for an order item. All server order items should have children. These children are considered a part of the server.

func (Billing_Order_Item) GetGlobalIdentifier 

func (r Billing_Order_Item) GetGlobalIdentifier() (resp string, err error)

Retrieve A hardware's universally unique identifier.

func (Billing_Order_Item) GetHardwareGenericComponent 

func (r Billing_Order_Item) GetHardwareGenericComponent() (resp datatypes.Hardware_Component_Model_Generic, err error)

Retrieve The component type tied to an order item. All hardware-specific items should have a generic hardware component.

func (Billing_Order_Item) GetItem 

func (r Billing_Order_Item) GetItem() (resp datatypes.Product_Item, err error)

Retrieve The SoftLayer_Product_Item tied to an order item. The item is the actual definition of the product being sold.

func (Billing_Order_Item) GetItemCategoryAnswers 

func (r Billing_Order_Item) GetItemCategoryAnswers() (resp []datatypes.Billing_Order_Item_Category_Answer, err error)

Retrieve This is an item's category answers.

func (Billing_Order_Item) GetItemPrice 

func (r Billing_Order_Item) GetItemPrice() (resp datatypes.Product_Item_Price, err error)

Retrieve The SoftLayer_Product_Item_Price tied to an order item. The item price object describes the cost of an item.

func (Billing_Order_Item) GetLocation 

func (r Billing_Order_Item) GetLocation() (resp datatypes.Location, err error)

Retrieve The location of an ordered item. This is usually the same as the server it is being ordered with. Otherwise it describes the location of the additional service being ordered.

func (Billing_Order_Item) GetNextOrderChildren 

func (r Billing_Order_Item) GetNextOrderChildren() (resp []datatypes.Billing_Order_Item, err error)

Retrieve

func (Billing_Order_Item) GetObject 

func (r Billing_Order_Item) GetObject() (resp datatypes.Billing_Order_Item, err error)

getObject retrieves the SoftLayer_Billing_Item object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Billing_Item service. You can only retrieve billing items tied to the account that your portal user is assigned to. Billing items are an account's items of billable items. There are "parent" billing items and "child" billing items. The server billing item is generally referred to as a parent billing item. The items tied to a server, such as ram, harddrives, and operating systems are considered "child" billing items.

func (Billing_Order_Item) GetOldBillingItem 

func (r Billing_Order_Item) GetOldBillingItem() (resp datatypes.Billing_Item, err error)

Retrieve This is only populated when an upgrade order is placed. The old billing item represents what the billing was before the upgrade happened.

func (Billing_Order_Item) GetOrder 

func (r Billing_Order_Item) GetOrder() (resp datatypes.Billing_Order, err error)

Retrieve The order to which this item belongs. The order contains all the information related to the items included in an order

func (Billing_Order_Item) GetOrderApprovalDate 

func (r Billing_Order_Item) GetOrderApprovalDate() (resp datatypes.Time, err error)

Retrieve

func (Billing_Order_Item) GetPackage 

func (r Billing_Order_Item) GetPackage() (resp datatypes.Product_Package, err error)

Retrieve The SoftLayer_Product_Package an order item is a part of.

func (Billing_Order_Item) GetParent 

func (r Billing_Order_Item) GetParent() (resp datatypes.Billing_Order_Item, err error)

Retrieve The parent order item ID for an item. Items that are associated with a server will have a parent. The parent will be the server item itself.

func (Billing_Order_Item) GetPreset 

func (r Billing_Order_Item) GetPreset() (resp datatypes.Product_Package_Preset, err error)

Retrieve The SoftLayer_Product_Package_Preset related to this order item.

func (Billing_Order_Item) GetPromoCode 

func (r Billing_Order_Item) GetPromoCode() (resp datatypes.Product_Promotion, err error)

Retrieve

func (Billing_Order_Item) GetRedundantPowerSupplyCount 

func (r Billing_Order_Item) GetRedundantPowerSupplyCount() (resp uint, err error)

Retrieve A count of power supplies contained within this SoftLayer_Billing_Order

func (Billing_Order_Item) GetSoftwareDescription 

func (r Billing_Order_Item) GetSoftwareDescription() (resp datatypes.Software_Description, err error)

Retrieve For ordered items that are software items, a full description of that software can be found with this property.

func (Billing_Order_Item) GetStorageGroups 

func (r Billing_Order_Item) GetStorageGroups() (resp []datatypes.Configuration_Storage_Group_Order, err error)

Retrieve The drive storage groups that are attached to this billing order item.

func (Billing_Order_Item) GetTotalRecurringAmount 

func (r Billing_Order_Item) GetTotalRecurringAmount() (resp datatypes.Float64, err error)

Retrieve The recurring fee of an ordered item. This amount represents the fees that will be charged on a recurring (usually monthly) basis.

func (Billing_Order_Item) GetUpgradeItem 

func (r Billing_Order_Item) GetUpgradeItem() (resp datatypes.Product_Item, err error)

Retrieve The next SoftLayer_Product_Item in the upgrade path for this order item.

func (Billing_Order_Item) Id 

func (r Billing_Order_Item) Id(id int) Billing_Order_Item

func (Billing_Order_Item) Limit 

func (r Billing_Order_Item) Limit(limit int) Billing_Order_Item

func (Billing_Order_Item) Mask 

func (r Billing_Order_Item) Mask(mask string) Billing_Order_Item

func (Billing_Order_Item) Offset 

func (r Billing_Order_Item) Offset(offset int) Billing_Order_Item

type Billing_Order_Quote 

type Billing_Order_Quote struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetBillingOrderQuoteService 

func GetBillingOrderQuoteService(sess session.SLSession) Billing_Order_Quote

GetBillingOrderQuoteService returns an instance of the Billing_Order_Quote SoftLayer service

func (Billing_Order_Quote) Claim 

func (r Billing_Order_Quote) Claim(quoteKey *string, quoteId *int) (resp datatypes.Billing_Order_Quote, err error)

This method is used to transfer an anonymous quote to the active user and associated account. An anonymous quote is one that was created by a user without being authenticated. If a quote was created anonymously and then the customer attempts to access that anonymous quote via the API (which requires authentication), the customer will be unable to retrieve the quote due to the security restrictions in place. By providing the ability for a customer to claim a quote, s/he will be able to pull the anonymous quote onto his/her account and successfully view the quote.

To claim a quote, both the quote id and the quote key (the 32-character random string) must be provided.

func (Billing_Order_Quote) DeleteQuote 

func (r Billing_Order_Quote) DeleteQuote() (resp datatypes.Billing_Order_Quote, err error)

Account master users and sub-users in the SoftLayer customer portal can delete the quote of an order.

func (Billing_Order_Quote) Filter 

func (r Billing_Order_Quote) Filter(filter string) Billing_Order_Quote

func (Billing_Order_Quote) GetAccount 

func (r Billing_Order_Quote) GetAccount() (resp datatypes.Account, err error)

Retrieve A quote's corresponding account.

func (Billing_Order_Quote) GetDoNotContactFlag 

func (r Billing_Order_Quote) GetDoNotContactFlag() (resp bool, err error)

Retrieve Indicates whether the owner of the quote chosen to no longer be contacted.

func (Billing_Order_Quote) GetObject 

func (r Billing_Order_Quote) GetObject() (resp datatypes.Billing_Order_Quote, err error)

getObject retrieves the SoftLayer_Billing_Order_Quote object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Billing_Order_Quote service. You can only retrieve quotes that are assigned to your portal user's account.

func (Billing_Order_Quote) GetOrder 

func (r Billing_Order_Quote) GetOrder() (resp datatypes.Billing_Order, err error)

Retrieve This order contains the records for which products were selected for this quote.

func (Billing_Order_Quote) GetOrdersFromQuote 

func (r Billing_Order_Quote) GetOrdersFromQuote() (resp []datatypes.Billing_Order, err error)

Retrieve These are all the orders that were created from this quote.

func (Billing_Order_Quote) GetPdf 

func (r Billing_Order_Quote) GetPdf() (resp []byte, err error)

Retrieve a PDF record of a SoftLayer quoted order. SoftLayer keeps PDF records of all quoted orders for customer retrieval from the portal and API. You must have a PDF reader installed in order to view these quoted order files.

func (Billing_Order_Quote) GetQuoteByQuoteKey 

func (r Billing_Order_Quote) GetQuoteByQuoteKey(quoteKey *string) (resp datatypes.Billing_Order_Quote, err error)

This method will return a [[SoftLayer_Billing_Order_Quote]] that is identified by the quote key specified. If you do not have access to the quote or it does not exist, an exception will be thrown indicating so.

func (Billing_Order_Quote) GetRecalculatedOrderContainer 

func (r Billing_Order_Quote) GetRecalculatedOrderContainer(userOrderData *datatypes.Container_Product_Order, orderBeingPlacedFlag *bool) (resp datatypes.Container_Product_Order, err error)

Generate an [[SoftLayer_Container_Product_Order|order container]] from the previously-created quote. This will take into account promotions, reseller status, estimated taxes and all other standard order verification processes.

func (Billing_Order_Quote) Id 

func (r Billing_Order_Quote) Id(id int) Billing_Order_Quote

func (Billing_Order_Quote) Limit 

func (r Billing_Order_Quote) Limit(limit int) Billing_Order_Quote

func (Billing_Order_Quote) Mask 

func (r Billing_Order_Quote) Mask(mask string) Billing_Order_Quote

func (Billing_Order_Quote) Offset 

func (r Billing_Order_Quote) Offset(offset int) Billing_Order_Quote

func (Billing_Order_Quote) PlaceOrder 

func (r Billing_Order_Quote) PlaceOrder(orderData interface{}) (resp datatypes.Container_Product_Order_Receipt, err error)

Use this method for placing server orders and additional services orders. The same applies for this as with verifyOrder. Send in the SoftLayer_Container_Product_Order_Hardware_Server for server orders. In addition to verifying the order, placeOrder() also makes an initial authorization on the SoftLayer_Account tied to this order, if a credit card is on file. If the account tied to this order is a paypal customer, an URL will also be returned to the customer. After placing the order, you must go to this URL to finish the authorization process. This tells paypal that you indeed want to place the order. After going to this URL, it will direct you back to a SoftLayer webpage that tells us you have finished the process. After this, it will go to sales for final approval.

func (Billing_Order_Quote) PlaceQuote 

func (r Billing_Order_Quote) PlaceQuote(orderData interface{}) (resp datatypes.Container_Product_Order, err error)

Use this method for placing server quotes and additional services quotes. The same applies for this as with verifyOrder. Send in the SoftLayer_Container_Product_Order_Hardware_Server for server quotes. In addition to verifying the quote, placeQuote() also makes an initial authorization on the SoftLayer_Account tied to this order, if a credit card is on file. If the account tied to this order is a paypal customer, an URL will also be returned to the customer. After placing the order, you must go to this URL to finish the authorization process. This tells paypal that you indeed want to place the order. After going to this URL, it will direct you back to a SoftLayer webpage that tells us you have finished the process.

func (Billing_Order_Quote) SaveQuote 

func (r Billing_Order_Quote) SaveQuote() (resp datatypes.Billing_Order_Quote, err error)

Account master users and sub-users in the SoftLayer customer portal can save the quote of an order to avoid its deletion after 5 days or its expiration after 2 days.

func (Billing_Order_Quote) VerifyOrder 

func (r Billing_Order_Quote) VerifyOrder(orderData interface{}) (resp datatypes.Container_Product_Order, err error)

Use this method for placing server orders and additional services orders. The same applies for this as with verifyOrder. Send in the SoftLayer_Container_Product_Order_Hardware_Server for server orders. In addition to verifying the order, placeOrder() also makes an initial authorization on the SoftLayer_Account tied to this order, if a credit card is on file. If the account tied to this order is a paypal customer, an URL will also be returned to the customer. After placing the order, you must go to this URL to finish the authorization process. This tells paypal that you indeed want to place the order. After going to this URL, it will direct you back to a SoftLayer webpage that tells us you have finished the process. After this, it will go to sales for final approval.

func (Billing_Order_Quote) WithdrawGdprAcceptance 

func (r Billing_Order_Quote) WithdrawGdprAcceptance() (err error)

Withdraws the users acceptance of the GDPR terms.

type Brand 

type Brand struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetBrandService 

func GetBrandService(sess session.SLSession) Brand

GetBrandService returns an instance of the Brand SoftLayer service

func (Brand) CreateCustomerAccount 

func (r Brand) CreateCustomerAccount(account *datatypes.Account, bypassDuplicateAccountCheck *bool) (resp datatypes.Account, err error)

Create a new customer account record. By default, the newly created account will be associated to a platform (PaaS) account. To skip the automatic creation and linking to a new platform account, set the <em>bluemixLinkedFlag</em> to <strong>false</strong> on the account template.

func (Brand) CreateObject 

func (r Brand) CreateObject(templateObject *datatypes.Brand) (resp datatypes.Brand, err error)

createObject() allows the creation of a new brand. This will also create an `account` to serve as the owner of the brand.

In order to create a brand, a template object must be sent in with several required values.

### Input [[SoftLayer_Brand]]

- `name`

  • Name of brand
  • Required
  • Type: string

- `keyName`

  • Reference key name
  • Required
  • Type: string

- `longName`

  • More descriptive name of brand
  • Required
  • Type: string

- `account.firstName`

  • First Name of account contact
  • Required
  • Type: string

- `account.lastName`

  • Last Name of account contact
  • Required
  • Type: string

- `account.address1`

  • Street Address of company
  • Required
  • Type: string

- `account.address2`

  • Street Address of company
  • Optional
  • Type: string

- `account.city`

  • City of company
  • Required
  • Type: string

- `account.state`

  • State of company (if applicable)
  • Conditionally Required
  • Type: string

- `account.postalCode`

  • Postal Code of company
  • Required
  • Type: string

- `account.country`

  • Country of company
  • Required
  • Type: string

- `account.officePhone`

  • Office Phone number of Company
  • Required
  • Type: string

- `account.alternatePhone`

  • Alternate Phone number of Company
  • Optional
  • Type: string

- `account.companyName`

  • Name of company
  • Required
  • Type: string

- `account.email`

  • Email address of account contact
  • Required
  • Type: string

REST Example: ``` 

curl -X POST -d '{
    "parameters":[{
        "name": "Brand Corp",
        "keyName": "BRAND_CORP",
        "longName": "Brand Corporation",
        "account": {
            "firstName": "Gloria",
            "lastName": "Brand",
            "address1": "123 Drive",
            "city": "Boston",
            "state": "MA",
            "postalCode": "02107",
            "country": "US",
            "companyName": "Brand Corp",
            "officePhone": "857-111-1111",
            "email": "noreply@example.com"
        }
    }]
}' https://api.softlayer.com/rest/v3.1/SoftLayer_Brand/createObject.json

```

func (Brand) DisableAccount 

func (r Brand) DisableAccount(accountId *int) (err error)

Disable an account associated with this Brand. Anything that would disqualify the account from being disabled will cause an exception to be raised.

func (Brand) Filter 

func (r Brand) Filter(filter string) Brand

func (Brand) GetAccount 

func (r Brand) GetAccount() (resp datatypes.Account, err error)

Retrieve

func (Brand) GetAllOwnedAccounts 

func (r Brand) GetAllOwnedAccounts() (resp []datatypes.Account, err error)

Retrieve All accounts owned by the brand.

func (Brand) GetAllTicketSubjects 

func (r Brand) GetAllTicketSubjects(account *datatypes.Account) (resp []datatypes.Ticket_Subject, err error)

(DEPRECATED) Use [[SoftLayer_Ticket_Subject::getAllObjects]] method. Deprecated: This function has been marked as deprecated.

func (Brand) GetAllowAccountCreationFlag 

func (r Brand) GetAllowAccountCreationFlag() (resp bool, err error)

Retrieve This flag indicates if creation of accounts is allowed.

func (Brand) GetBillingItemSnapshots added in v1.0.6 

func (r Brand) GetBillingItemSnapshots() (resp []datatypes.Billing_Item_Chronicle, err error)

Retrieve 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.

func (Brand) GetBillingItemSnapshotsForSingleOwnedAccount added in v1.0.6 

func (r Brand) GetBillingItemSnapshotsForSingleOwnedAccount(accountId *int) (resp []datatypes.Billing_Item_Chronicle, err error)

This service returns the snapshots of billing items recorded periodically given an account ID. The provided account ID must be owned by the brand that calls this service. In this context, it can be interpreted that the billing items snapshots belong to both the account and that accounts brand. 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.

func (Brand) GetBillingItemSnapshotsWithExternalAccountId added in v1.0.6 

func (r Brand) GetBillingItemSnapshotsWithExternalAccountId(externalAccountId *string) (resp []datatypes.Billing_Item_Chronicle, err error)

This service returns the 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.

func (Brand) GetBusinessPartner 

func (r Brand) GetBusinessPartner() (resp datatypes.Brand_Business_Partner, err error)

Retrieve Business Partner details for the brand. Country Enterprise Code, Channel, Segment, Reseller Level.

func (Brand) GetBusinessPartnerFlag 

func (r Brand) GetBusinessPartnerFlag() (resp bool, err error)

Retrieve Flag indicating if the brand is a business partner.

func (Brand) GetCatalog 

func (r Brand) GetCatalog() (resp datatypes.Product_Catalog, err error)

Retrieve The Product Catalog for the Brand

func (Brand) GetContactInformation 

func (r Brand) GetContactInformation() (resp []datatypes.Brand_Contact, err error)

Retrieve the contact information for the brand such as the corporate or support contact. This will include the contact name, telephone number, fax number, email address, and mailing address of the contact.

func (Brand) GetContacts 

func (r Brand) GetContacts() (resp []datatypes.Brand_Contact, err error)

Retrieve The contacts for the brand.

func (Brand) GetCustomerCountryLocationRestrictions 

func (r Brand) GetCustomerCountryLocationRestrictions() (resp []datatypes.Brand_Restriction_Location_CustomerCountry, err error)

Retrieve This references relationship between brands, locations and countries associated with a user's account that are ineligible when ordering products. For example, the India datacenter may not be available on this brand for customers that live in Great Britain.

func (Brand) GetDistributor 

func (r Brand) GetDistributor() (resp datatypes.Brand, err error)

Retrieve

func (Brand) GetDistributorChildFlag 

func (r Brand) GetDistributorChildFlag() (resp bool, err error)

Retrieve

func (Brand) GetDistributorFlag 

func (r Brand) GetDistributorFlag() (resp string, err error)

Retrieve

func (Brand) GetHardware 

func (r Brand) GetHardware() (resp []datatypes.Hardware, err error)

Retrieve An account's associated hardware objects.

func (Brand) GetHasAgentAdvancedSupportFlag 

func (r Brand) GetHasAgentAdvancedSupportFlag() (resp bool, err error)

Retrieve

func (Brand) GetHasAgentSupportFlag 

func (r Brand) GetHasAgentSupportFlag() (resp bool, err error)

Retrieve

func (Brand) GetMerchantName 

func (r Brand) GetMerchantName() (resp string, err error)

Get the payment processor merchant name.

func (Brand) GetObject 

func (r Brand) GetObject() (resp datatypes.Brand, err error)

no documentation yet

func (Brand) GetOpenTickets 

func (r Brand) GetOpenTickets() (resp []datatypes.Ticket, err error)

Retrieve

func (Brand) GetOwnedAccounts 

func (r Brand) GetOwnedAccounts() (resp []datatypes.Account, err error)

Retrieve Active accounts owned by the brand.

func (Brand) GetSecurityLevel 

func (r Brand) GetSecurityLevel() (resp datatypes.Security_Level, err error)

Retrieve

func (Brand) GetTicketGroups 

func (r Brand) GetTicketGroups() (resp []datatypes.Ticket_Group, err error)

Retrieve

func (Brand) GetTickets 

func (r Brand) GetTickets() (resp []datatypes.Ticket, err error)

Retrieve

func (Brand) GetToken 

func (r Brand) GetToken(userId *int) (resp string, err error)

(DEPRECATED) Use [[SoftLayer_User_Customer::getImpersonationToken]] method. Deprecated: This function has been marked as deprecated.

func (Brand) GetUsers 

func (r Brand) GetUsers() (resp []datatypes.User_Customer, err error)

Retrieve

func (Brand) GetVirtualGuests 

func (r Brand) GetVirtualGuests() (resp []datatypes.Virtual_Guest, err error)

Retrieve An account's associated virtual guest objects.

func (Brand) Id 

func (r Brand) Id(id int) Brand

func (Brand) IsIbmSlicBrand 

func (r Brand) IsIbmSlicBrand() (resp bool, err error)

Check if the brand is IBM SLIC top level brand or sub brand.

func (Brand) IsPlatformServicesBrand 

func (r Brand) IsPlatformServicesBrand() (resp bool, err error)

Check if the alternate billing system of brand is Bluemix.

func (Brand) Limit 

func (r Brand) Limit(limit int) Brand

func (Brand) Mask 

func (r Brand) Mask(mask string) Brand

func (Brand) MigrateExternalAccount added in v1.1.3 

func (r Brand) MigrateExternalAccount(accountId *int) (resp datatypes.Account_Brand_Migration_Request, err error)

Will attempt to migrate an external account to the brand in context.

func (Brand) Offset 

func (r Brand) Offset(offset int) Brand

func (Brand) ReactivateAccount 

func (r Brand) ReactivateAccount(accountId *int) (err error)

Reactivate an account associated with this Brand. Anything that would disqualify the account from being reactivated will cause an exception to be raised.

func (Brand) RefreshBillingItemSnapshot added in v1.0.6 

func (r Brand) RefreshBillingItemSnapshot(accountId *int) (resp bool, err error)

When this service is called given an IBM Cloud infrastructure account ID owned by the calling brand, the process is started to refresh the billing item snapshots belonging to that account. This refresh is async and can take an undetermined amount of time. Even if this endpoint returns an OK, it doesn't guarantee that refresh did not fail or encounter issues.

func (Brand) VerifyCanDisableAccount 

func (r Brand) VerifyCanDisableAccount(accountId *int) (err error)

Verify that an account may be disabled by a Brand Agent. Anything that would disqualify the account from being disabled will cause an exception to be raised.

func (Brand) VerifyCanReactivateAccount 

func (r Brand) VerifyCanReactivateAccount(accountId *int) (err error)

Verify that an account may be reactivated by a Brand Agent. Anything that would disqualify the account from being reactivated will cause an exception to be raised.

type Brand_Business_Partner 

type Brand_Business_Partner struct {
	Session session.SLSession
	Options sl.Options
}

Contains business partner details associated with a brand. Country Enterprise Identifier (CEID), Channel ID, Segment ID and Reseller Level.

func GetBrandBusinessPartnerService 

func GetBrandBusinessPartnerService(sess session.SLSession) Brand_Business_Partner

GetBrandBusinessPartnerService returns an instance of the Brand_Business_Partner SoftLayer service

func (Brand_Business_Partner) Filter 

func (r Brand_Business_Partner) Filter(filter string) Brand_Business_Partner

func (Brand_Business_Partner) GetBrand 

func (r Brand_Business_Partner) GetBrand() (resp datatypes.Brand, err error)

Retrieve Brand associated with the business partner data

func (Brand_Business_Partner) GetChannel 

func (r Brand_Business_Partner) GetChannel() (resp datatypes.Business_Partner_Channel, err error)

Retrieve Channel indicator used to categorize business partner revenue.

func (Brand_Business_Partner) GetObject 

func (r Brand_Business_Partner) GetObject() (resp datatypes.Brand_Business_Partner, err error)

no documentation yet

func (Brand_Business_Partner) GetSegment 

func (r Brand_Business_Partner) GetSegment() (resp datatypes.Business_Partner_Segment, err error)

Retrieve Segment indicator used to categorize business partner revenue.

func (Brand_Business_Partner) Id 

func (r Brand_Business_Partner) Id(id int) Brand_Business_Partner

func (Brand_Business_Partner) Limit 

func (r Brand_Business_Partner) Limit(limit int) Brand_Business_Partner

func (Brand_Business_Partner) Mask 

func (r Brand_Business_Partner) Mask(mask string) Brand_Business_Partner

func (Brand_Business_Partner) Offset 

func (r Brand_Business_Partner) Offset(offset int) Brand_Business_Partner

type Brand_Restriction_Location_CustomerCountry 

type Brand_Restriction_Location_CustomerCountry struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetBrandRestrictionLocationCustomerCountryService 

func GetBrandRestrictionLocationCustomerCountryService(sess session.SLSession) Brand_Restriction_Location_CustomerCountry

GetBrandRestrictionLocationCustomerCountryService returns an instance of the Brand_Restriction_Location_CustomerCountry SoftLayer service

func (Brand_Restriction_Location_CustomerCountry) Filter 

func (r Brand_Restriction_Location_CustomerCountry) Filter(filter string) Brand_Restriction_Location_CustomerCountry

func (Brand_Restriction_Location_CustomerCountry) GetAllObjects 

func (r Brand_Restriction_Location_CustomerCountry) GetAllObjects() (resp []datatypes.Brand_Restriction_Location_CustomerCountry, err error)

no documentation yet

func (Brand_Restriction_Location_CustomerCountry) GetBrand 

func (r Brand_Restriction_Location_CustomerCountry) GetBrand() (resp datatypes.Brand, err error)

Retrieve This references the brand that has a brand-location-country restriction setup.

func (Brand_Restriction_Location_CustomerCountry) GetLocation 

func (r Brand_Restriction_Location_CustomerCountry) GetLocation() (resp datatypes.Location, err error)

Retrieve This references the datacenter that has a brand-location-country restriction setup. For example, if a datacenter is listed with a restriction for Canada, a Canadian customer may not be eligible to order services at that location.

func (Brand_Restriction_Location_CustomerCountry) GetObject 

func (r Brand_Restriction_Location_CustomerCountry) GetObject() (resp datatypes.Brand_Restriction_Location_CustomerCountry, err error)

no documentation yet

func (Brand_Restriction_Location_CustomerCountry) Id 

func (r Brand_Restriction_Location_CustomerCountry) Id(id int) Brand_Restriction_Location_CustomerCountry

func (Brand_Restriction_Location_CustomerCountry) Limit 

func (r Brand_Restriction_Location_CustomerCountry) Limit(limit int) Brand_Restriction_Location_CustomerCountry

func (Brand_Restriction_Location_CustomerCountry) Mask 

func (r Brand_Restriction_Location_CustomerCountry) Mask(mask string) Brand_Restriction_Location_CustomerCountry

func (Brand_Restriction_Location_CustomerCountry) Offset 

func (r Brand_Restriction_Location_CustomerCountry) Offset(offset int) Brand_Restriction_Location_CustomerCountry

type Business_Partner_Channel 

type Business_Partner_Channel struct {
	Session session.SLSession
	Options sl.Options
}

Contains business partner channel information

func GetBusinessPartnerChannelService 

func GetBusinessPartnerChannelService(sess session.SLSession) Business_Partner_Channel

GetBusinessPartnerChannelService returns an instance of the Business_Partner_Channel SoftLayer service

func (Business_Partner_Channel) Filter 

func (r Business_Partner_Channel) Filter(filter string) Business_Partner_Channel

func (Business_Partner_Channel) GetObject 

func (r Business_Partner_Channel) GetObject() (resp datatypes.Business_Partner_Channel, err error)

no documentation yet

func (Business_Partner_Channel) Id 

func (r Business_Partner_Channel) Id(id int) Business_Partner_Channel

func (Business_Partner_Channel) Limit 

func (r Business_Partner_Channel) Limit(limit int) Business_Partner_Channel

func (Business_Partner_Channel) Mask 

func (r Business_Partner_Channel) Mask(mask string) Business_Partner_Channel

func (Business_Partner_Channel) Offset 

func (r Business_Partner_Channel) Offset(offset int) Business_Partner_Channel

type Business_Partner_Segment 

type Business_Partner_Segment struct {
	Session session.SLSession
	Options sl.Options
}

Contains business partner segment information

func GetBusinessPartnerSegmentService 

func GetBusinessPartnerSegmentService(sess session.SLSession) Business_Partner_Segment

GetBusinessPartnerSegmentService returns an instance of the Business_Partner_Segment SoftLayer service

func (Business_Partner_Segment) Filter 

func (r Business_Partner_Segment) Filter(filter string) Business_Partner_Segment

func (Business_Partner_Segment) GetObject 

func (r Business_Partner_Segment) GetObject() (resp datatypes.Business_Partner_Segment, err error)

no documentation yet

func (Business_Partner_Segment) Id 

func (r Business_Partner_Segment) Id(id int) Business_Partner_Segment

func (Business_Partner_Segment) Limit 

func (r Business_Partner_Segment) Limit(limit int) Business_Partner_Segment

func (Business_Partner_Segment) Mask 

func (r Business_Partner_Segment) Mask(mask string) Business_Partner_Segment

func (Business_Partner_Segment) Offset 

func (r Business_Partner_Segment) Offset(offset int) Business_Partner_Segment

type Catalyst_Company_Type 

type Catalyst_Company_Type struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetCatalystCompanyTypeService 

func GetCatalystCompanyTypeService(sess session.SLSession) Catalyst_Company_Type

GetCatalystCompanyTypeService returns an instance of the Catalyst_Company_Type SoftLayer service

func (Catalyst_Company_Type) Filter 

func (r Catalyst_Company_Type) Filter(filter string) Catalyst_Company_Type

func (Catalyst_Company_Type) GetAllObjects 

func (r Catalyst_Company_Type) GetAllObjects() (resp []datatypes.Catalyst_Company_Type, err error)

<<<EOT

func (Catalyst_Company_Type) GetObject 

func (r Catalyst_Company_Type) GetObject() (resp datatypes.Catalyst_Company_Type, err error)

no documentation yet

func (Catalyst_Company_Type) Id 

func (r Catalyst_Company_Type) Id(id int) Catalyst_Company_Type

func (Catalyst_Company_Type) Limit 

func (r Catalyst_Company_Type) Limit(limit int) Catalyst_Company_Type

func (Catalyst_Company_Type) Mask 

func (r Catalyst_Company_Type) Mask(mask string) Catalyst_Company_Type

func (Catalyst_Company_Type) Offset 

func (r Catalyst_Company_Type) Offset(offset int) Catalyst_Company_Type

type Catalyst_Enrollment 

type Catalyst_Enrollment struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetCatalystEnrollmentService 

func GetCatalystEnrollmentService(sess session.SLSession) Catalyst_Enrollment

GetCatalystEnrollmentService returns an instance of the Catalyst_Enrollment SoftLayer service

func (Catalyst_Enrollment) Filter 

func (r Catalyst_Enrollment) Filter(filter string) Catalyst_Enrollment

func (Catalyst_Enrollment) GetAccount 

func (r Catalyst_Enrollment) GetAccount() (resp datatypes.Account, err error)

Retrieve

func (Catalyst_Enrollment) GetAffiliate 

func (r Catalyst_Enrollment) GetAffiliate() (resp datatypes.Catalyst_Affiliate, err error)

Retrieve

func (Catalyst_Enrollment) GetAffiliates 

func (r Catalyst_Enrollment) GetAffiliates() (resp []datatypes.Catalyst_Affiliate, err error)

no documentation yet

func (Catalyst_Enrollment) GetCompanyType 

func (r Catalyst_Enrollment) GetCompanyType() (resp datatypes.Catalyst_Company_Type, err error)

Retrieve

func (Catalyst_Enrollment) GetCompanyTypes 

func (r Catalyst_Enrollment) GetCompanyTypes() (resp []datatypes.Catalyst_Company_Type, err error)

no documentation yet

func (Catalyst_Enrollment) GetEnrollmentRequestAnnualRevenueOptions 

func (r Catalyst_Enrollment) GetEnrollmentRequestAnnualRevenueOptions() (resp []datatypes.Catalyst_Enrollment_Request_Container_AnswerOption, err error)

no documentation yet

func (Catalyst_Enrollment) GetEnrollmentRequestUserCountOptions 

func (r Catalyst_Enrollment) GetEnrollmentRequestUserCountOptions() (resp []datatypes.Catalyst_Enrollment_Request_Container_AnswerOption, err error)

no documentation yet

func (Catalyst_Enrollment) GetEnrollmentRequestYearsInOperationOptions 

func (r Catalyst_Enrollment) GetEnrollmentRequestYearsInOperationOptions() (resp []datatypes.Catalyst_Enrollment_Request_Container_AnswerOption, err error)

no documentation yet

func (Catalyst_Enrollment) GetIsActiveFlag 

func (r Catalyst_Enrollment) GetIsActiveFlag() (resp bool, err error)

Retrieve

func (Catalyst_Enrollment) GetObject 

func (r Catalyst_Enrollment) GetObject() (resp datatypes.Catalyst_Enrollment, err error)

no documentation yet

func (Catalyst_Enrollment) GetRepresentative 

func (r Catalyst_Enrollment) GetRepresentative() (resp datatypes.User_Employee, err error)

Retrieve

func (Catalyst_Enrollment) Id 

func (r Catalyst_Enrollment) Id(id int) Catalyst_Enrollment

func (Catalyst_Enrollment) Limit 

func (r Catalyst_Enrollment) Limit(limit int) Catalyst_Enrollment

func (Catalyst_Enrollment) Mask 

func (r Catalyst_Enrollment) Mask(mask string) Catalyst_Enrollment

func (Catalyst_Enrollment) Offset 

func (r Catalyst_Enrollment) Offset(offset int) Catalyst_Enrollment

func (Catalyst_Enrollment) RequestManualEnrollment 

func (r Catalyst_Enrollment) RequestManualEnrollment(request *datatypes.Container_Catalyst_ManualEnrollmentRequest) (err error)

no documentation yet

func (Catalyst_Enrollment) RequestSelfEnrollment 

func (r Catalyst_Enrollment) RequestSelfEnrollment(enrollmentRequest *datatypes.Catalyst_Enrollment_Request) (resp datatypes.Account, err error)

no documentation yet

type Compliance_Report_Type 

type Compliance_Report_Type struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetComplianceReportTypeService 

func GetComplianceReportTypeService(sess session.SLSession) Compliance_Report_Type

GetComplianceReportTypeService returns an instance of the Compliance_Report_Type SoftLayer service

func (Compliance_Report_Type) Filter 

func (r Compliance_Report_Type) Filter(filter string) Compliance_Report_Type

func (Compliance_Report_Type) GetAllObjects 

func (r Compliance_Report_Type) GetAllObjects() (resp []datatypes.Compliance_Report_Type, err error)

no documentation yet

func (Compliance_Report_Type) GetObject 

func (r Compliance_Report_Type) GetObject() (resp datatypes.Compliance_Report_Type, err error)

no documentation yet

func (Compliance_Report_Type) Id 

func (r Compliance_Report_Type) Id(id int) Compliance_Report_Type

func (Compliance_Report_Type) Limit 

func (r Compliance_Report_Type) Limit(limit int) Compliance_Report_Type

func (Compliance_Report_Type) Mask 

func (r Compliance_Report_Type) Mask(mask string) Compliance_Report_Type

func (Compliance_Report_Type) Offset 

func (r Compliance_Report_Type) Offset(offset int) Compliance_Report_Type

type Configuration_Storage_Group_Array_Type 

type Configuration_Storage_Group_Array_Type struct {
	Session session.SLSession
	Options sl.Options
}

Supported hardware raid modes

func GetConfigurationStorageGroupArrayTypeService 

func GetConfigurationStorageGroupArrayTypeService(sess session.SLSession) Configuration_Storage_Group_Array_Type

GetConfigurationStorageGroupArrayTypeService returns an instance of the Configuration_Storage_Group_Array_Type SoftLayer service

func (Configuration_Storage_Group_Array_Type) Filter 

func (r Configuration_Storage_Group_Array_Type) Filter(filter string) Configuration_Storage_Group_Array_Type

func (Configuration_Storage_Group_Array_Type) GetAllObjects 

func (r Configuration_Storage_Group_Array_Type) GetAllObjects() (resp []datatypes.Configuration_Storage_Group_Array_Type, err error)

no documentation yet

func (Configuration_Storage_Group_Array_Type) GetHardwareComponentModels 

func (r Configuration_Storage_Group_Array_Type) GetHardwareComponentModels() (resp []datatypes.Hardware_Component_Model, err error)

Retrieve

func (Configuration_Storage_Group_Array_Type) GetObject 

func (r Configuration_Storage_Group_Array_Type) GetObject() (resp datatypes.Configuration_Storage_Group_Array_Type, err error)

no documentation yet

func (Configuration_Storage_Group_Array_Type) Id 

func (r Configuration_Storage_Group_Array_Type) Id(id int) Configuration_Storage_Group_Array_Type

func (Configuration_Storage_Group_Array_Type) Limit 

func (r Configuration_Storage_Group_Array_Type) Limit(limit int) Configuration_Storage_Group_Array_Type

func (Configuration_Storage_Group_Array_Type) Mask 

func (r Configuration_Storage_Group_Array_Type) Mask(mask string) Configuration_Storage_Group_Array_Type

func (Configuration_Storage_Group_Array_Type) Offset 

func (r Configuration_Storage_Group_Array_Type) Offset(offset int) Configuration_Storage_Group_Array_Type

type Configuration_Template 

type Configuration_Template struct {
	Session session.SLSession
	Options sl.Options
}

The SoftLayer_Configuration_Template data type contains general information of an arbitrary resource.

func GetConfigurationTemplateService 

func GetConfigurationTemplateService(sess session.SLSession) Configuration_Template

GetConfigurationTemplateService returns an instance of the Configuration_Template SoftLayer service

func (Configuration_Template) CopyTemplate 

func (r Configuration_Template) CopyTemplate(templateObject *datatypes.Configuration_Template) (resp datatypes.Configuration_Template, err error)

Copy a configuration template and returns a newly created template copy

func (Configuration_Template) DeleteObject 

func (r Configuration_Template) DeleteObject() (resp bool, err error)

Deletes a customer configuration template.

func (Configuration_Template) EditObject 

func (r Configuration_Template) EditObject(templateObject *datatypes.Configuration_Template) (resp bool, err error)

Edit the object by passing in a modified instance of the object. Use this method to modify configuration template name or description.

func (Configuration_Template) Filter 

func (r Configuration_Template) Filter(filter string) Configuration_Template

func (Configuration_Template) GetAccount 

func (r Configuration_Template) GetAccount() (resp datatypes.Account, err error)

Retrieve

func (Configuration_Template) GetAllObjects 

func (r Configuration_Template) GetAllObjects() (resp []datatypes.Configuration_Template, err error)

Retrieves all available configuration templates

func (Configuration_Template) GetConfigurationSections 

func (r Configuration_Template) GetConfigurationSections() (resp []datatypes.Configuration_Template_Section, err error)

Retrieve

func (Configuration_Template) GetDefaultValues 

func (r Configuration_Template) GetDefaultValues() (resp []datatypes.Configuration_Template_Section_Definition_Value, err error)

Retrieve

func (Configuration_Template) GetDefinitions 

func (r Configuration_Template) GetDefinitions() (resp []datatypes.Configuration_Template_Section_Definition, err error)

Retrieve

func (Configuration_Template) GetItem 

func (r Configuration_Template) GetItem() (resp datatypes.Product_Item, err error)

Retrieve

func (Configuration_Template) GetLinkedSectionReferences 

func (r Configuration_Template) GetLinkedSectionReferences() (resp datatypes.Configuration_Template_Section_Reference, err error)

Retrieve

func (Configuration_Template) GetObject 

func (r Configuration_Template) GetObject() (resp datatypes.Configuration_Template, err error)

no documentation yet

func (Configuration_Template) GetParent 

func (r Configuration_Template) GetParent() (resp datatypes.Configuration_Template, err error)

Retrieve

func (Configuration_Template) GetUser 

func (r Configuration_Template) GetUser() (resp datatypes.User_Customer, err error)

Retrieve

func (Configuration_Template) Id 

func (r Configuration_Template) Id(id int) Configuration_Template

func (Configuration_Template) Limit 

func (r Configuration_Template) Limit(limit int) Configuration_Template

func (Configuration_Template) Mask 

func (r Configuration_Template) Mask(mask string) Configuration_Template

func (Configuration_Template) Offset 

func (r Configuration_Template) Offset(offset int) Configuration_Template

func (Configuration_Template) UpdateDefaultValues 

func (r Configuration_Template) UpdateDefaultValues(configurationValues []datatypes.Configuration_Template_Section_Definition_Value) (resp bool, err error)

Updates default configuration values.

type Configuration_Template_Section 

type Configuration_Template_Section struct {
	Session session.SLSession
	Options sl.Options
}

The SoftLayer_Configuration_Template_Section data type contains information of a configuration section.

Configuration can contain sub-sections.

func GetConfigurationTemplateSectionService 

func GetConfigurationTemplateSectionService(sess session.SLSession) Configuration_Template_Section

GetConfigurationTemplateSectionService returns an instance of the Configuration_Template_Section SoftLayer service

func (Configuration_Template_Section) Filter 

func (r Configuration_Template_Section) Filter(filter string) Configuration_Template_Section

func (Configuration_Template_Section) GetDefinitions 

func (r Configuration_Template_Section) GetDefinitions() (resp []datatypes.Configuration_Template_Section_Definition, err error)

Retrieve

func (Configuration_Template_Section) GetDisallowedDeletionFlag 

func (r Configuration_Template_Section) GetDisallowedDeletionFlag() (resp bool, err error)

Retrieve

func (Configuration_Template_Section) GetLinkedTemplate 

func (r Configuration_Template_Section) GetLinkedTemplate() (resp datatypes.Configuration_Template, err error)

Retrieve

func (Configuration_Template_Section) GetLinkedTemplateReference 

func (r Configuration_Template_Section) GetLinkedTemplateReference() (resp datatypes.Configuration_Template_Section_Reference, err error)

Retrieve

func (Configuration_Template_Section) GetObject 

func (r Configuration_Template_Section) GetObject() (resp datatypes.Configuration_Template_Section, err error)

no documentation yet

func (Configuration_Template_Section) GetProfiles 

func (r Configuration_Template_Section) GetProfiles() (resp []datatypes.Configuration_Template_Section_Profile, err error)

Retrieve

func (Configuration_Template_Section) GetSectionType 

func (r Configuration_Template_Section) GetSectionType() (resp datatypes.Configuration_Template_Section_Type, err error)

Retrieve

func (Configuration_Template_Section) GetSectionTypeName 

func (r Configuration_Template_Section) GetSectionTypeName() (resp string, err error)

Retrieve

func (Configuration_Template_Section) GetSubSections 

func (r Configuration_Template_Section) GetSubSections() (resp []datatypes.Configuration_Template_Section, err error)

Retrieve

func (Configuration_Template_Section) GetTemplate 

func (r Configuration_Template_Section) GetTemplate() (resp datatypes.Configuration_Template, err error)

Retrieve

func (Configuration_Template_Section) HasSubSections 

func (r Configuration_Template_Section) HasSubSections() (resp bool, err error)

Returns true if the object has sub-sections

func (Configuration_Template_Section) Id 

func (r Configuration_Template_Section) Id(id int) Configuration_Template_Section

func (Configuration_Template_Section) Limit 

func (r Configuration_Template_Section) Limit(limit int) Configuration_Template_Section

func (Configuration_Template_Section) Mask 

func (r Configuration_Template_Section) Mask(mask string) Configuration_Template_Section

func (Configuration_Template_Section) Offset 

func (r Configuration_Template_Section) Offset(offset int) Configuration_Template_Section

type Configuration_Template_Section_Definition 

type Configuration_Template_Section_Definition struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetConfigurationTemplateSectionDefinitionService 

func GetConfigurationTemplateSectionDefinitionService(sess session.SLSession) Configuration_Template_Section_Definition

GetConfigurationTemplateSectionDefinitionService returns an instance of the Configuration_Template_Section_Definition SoftLayer service

func (Configuration_Template_Section_Definition) Filter 

func (r Configuration_Template_Section_Definition) Filter(filter string) Configuration_Template_Section_Definition

func (Configuration_Template_Section_Definition) GetAttributes 

func (r Configuration_Template_Section_Definition) GetAttributes() (resp []datatypes.Configuration_Template_Section_Definition_Attribute, err error)

Retrieve

func (Configuration_Template_Section_Definition) GetDefaultValue 

func (r Configuration_Template_Section_Definition) GetDefaultValue() (resp datatypes.Configuration_Template_Section_Definition_Value, err error)

Retrieve

func (Configuration_Template_Section_Definition) GetGroup 

func (r Configuration_Template_Section_Definition) GetGroup() (resp datatypes.Configuration_Template_Section_Definition_Group, err error)

Retrieve

func (Configuration_Template_Section_Definition) GetMonitoringDataFlag 

func (r Configuration_Template_Section_Definition) GetMonitoringDataFlag() (resp bool, err error)

Retrieve

func (Configuration_Template_Section_Definition) GetObject 

func (r Configuration_Template_Section_Definition) GetObject() (resp datatypes.Configuration_Template_Section_Definition, err error)

no documentation yet

func (Configuration_Template_Section_Definition) GetSection 

func (r Configuration_Template_Section_Definition) GetSection() (resp datatypes.Configuration_Template_Section, err error)

Retrieve

func (Configuration_Template_Section_Definition) GetValueType 

func (r Configuration_Template_Section_Definition) GetValueType() (resp datatypes.Configuration_Template_Section_Definition_Type, err error)

Retrieve

func (Configuration_Template_Section_Definition) Id 

func (r Configuration_Template_Section_Definition) Id(id int) Configuration_Template_Section_Definition

func (Configuration_Template_Section_Definition) Limit 

func (r Configuration_Template_Section_Definition) Limit(limit int) Configuration_Template_Section_Definition

func (Configuration_Template_Section_Definition) Mask 

func (r Configuration_Template_Section_Definition) Mask(mask string) Configuration_Template_Section_Definition

func (Configuration_Template_Section_Definition) Offset 

func (r Configuration_Template_Section_Definition) Offset(offset int) Configuration_Template_Section_Definition

type Configuration_Template_Section_Definition_Group 

type Configuration_Template_Section_Definition_Group struct {
	Session session.SLSession
	Options sl.Options
}

Configuration definition group gives you details of the definition and allows extra functionality.

func GetConfigurationTemplateSectionDefinitionGroupService 

func GetConfigurationTemplateSectionDefinitionGroupService(sess session.SLSession) Configuration_Template_Section_Definition_Group

GetConfigurationTemplateSectionDefinitionGroupService returns an instance of the Configuration_Template_Section_Definition_Group SoftLayer service

func (Configuration_Template_Section_Definition_Group) Filter 

func (r Configuration_Template_Section_Definition_Group) Filter(filter string) Configuration_Template_Section_Definition_Group

func (Configuration_Template_Section_Definition_Group) GetAllGroups 

func (r Configuration_Template_Section_Definition_Group) GetAllGroups() (resp []datatypes.Configuration_Template_Section_Definition_Group, err error)

Get all configuration definition group objects.

”getAllGroups” returns an array of SoftLayer_Configuration_Template_Section_Definition_Group objects upon success.

func (Configuration_Template_Section_Definition_Group) GetObject 

func (r Configuration_Template_Section_Definition_Group) GetObject() (resp datatypes.Configuration_Template_Section_Definition_Group, err error)

no documentation yet

func (Configuration_Template_Section_Definition_Group) GetParent 

func (r Configuration_Template_Section_Definition_Group) GetParent() (resp datatypes.Configuration_Template_Section_Definition_Group, err error)

Retrieve

func (Configuration_Template_Section_Definition_Group) Id 

func (r Configuration_Template_Section_Definition_Group) Id(id int) Configuration_Template_Section_Definition_Group

func (Configuration_Template_Section_Definition_Group) Limit 

func (r Configuration_Template_Section_Definition_Group) Limit(limit int) Configuration_Template_Section_Definition_Group

func (Configuration_Template_Section_Definition_Group) Mask 

func (r Configuration_Template_Section_Definition_Group) Mask(mask string) Configuration_Template_Section_Definition_Group

func (Configuration_Template_Section_Definition_Group) Offset 

func (r Configuration_Template_Section_Definition_Group) Offset(offset int) Configuration_Template_Section_Definition_Group

type Configuration_Template_Section_Definition_Type 

type Configuration_Template_Section_Definition_Type struct {
	Session session.SLSession
	Options sl.Options
}

SoftLayer_Configuration_Template_Section_Definition_Type further defines the value of a configuration definition.

func GetConfigurationTemplateSectionDefinitionTypeService 

func GetConfigurationTemplateSectionDefinitionTypeService(sess session.SLSession) Configuration_Template_Section_Definition_Type

GetConfigurationTemplateSectionDefinitionTypeService returns an instance of the Configuration_Template_Section_Definition_Type SoftLayer service

func (Configuration_Template_Section_Definition_Type) Filter 

func (r Configuration_Template_Section_Definition_Type) Filter(filter string) Configuration_Template_Section_Definition_Type

func (Configuration_Template_Section_Definition_Type) GetObject 

func (r Configuration_Template_Section_Definition_Type) GetObject() (resp datatypes.Configuration_Template_Section_Definition_Type, err error)

no documentation yet

func (Configuration_Template_Section_Definition_Type) Id 

func (r Configuration_Template_Section_Definition_Type) Id(id int) Configuration_Template_Section_Definition_Type

func (Configuration_Template_Section_Definition_Type) Limit 

func (r Configuration_Template_Section_Definition_Type) Limit(limit int) Configuration_Template_Section_Definition_Type

func (Configuration_Template_Section_Definition_Type) Mask 

func (r Configuration_Template_Section_Definition_Type) Mask(mask string) Configuration_Template_Section_Definition_Type

func (Configuration_Template_Section_Definition_Type) Offset 

func (r Configuration_Template_Section_Definition_Type) Offset(offset int) Configuration_Template_Section_Definition_Type

type Configuration_Template_Section_Definition_Value 

type Configuration_Template_Section_Definition_Value struct {
	Session session.SLSession
	Options sl.Options
}

SoftLayer_Configuration_Section_Value is used to set the value for a configuration definition

func GetConfigurationTemplateSectionDefinitionValueService 

func GetConfigurationTemplateSectionDefinitionValueService(sess session.SLSession) Configuration_Template_Section_Definition_Value

GetConfigurationTemplateSectionDefinitionValueService returns an instance of the Configuration_Template_Section_Definition_Value SoftLayer service

func (Configuration_Template_Section_Definition_Value) Filter 

func (r Configuration_Template_Section_Definition_Value) Filter(filter string) Configuration_Template_Section_Definition_Value

func (Configuration_Template_Section_Definition_Value) GetDefinition 

func (r Configuration_Template_Section_Definition_Value) GetDefinition() (resp datatypes.Configuration_Template_Section_Definition, err error)

Retrieve

func (Configuration_Template_Section_Definition_Value) GetObject 

func (r Configuration_Template_Section_Definition_Value) GetObject() (resp datatypes.Configuration_Template_Section_Definition_Value, err error)

no documentation yet

func (Configuration_Template_Section_Definition_Value) GetTemplate 

func (r Configuration_Template_Section_Definition_Value) GetTemplate() (resp datatypes.Configuration_Template, err error)

Retrieve

func (Configuration_Template_Section_Definition_Value) Id 

func (r Configuration_Template_Section_Definition_Value) Id(id int) Configuration_Template_Section_Definition_Value

func (Configuration_Template_Section_Definition_Value) Limit 

func (r Configuration_Template_Section_Definition_Value) Limit(limit int) Configuration_Template_Section_Definition_Value

func (Configuration_Template_Section_Definition_Value) Mask 

func (r Configuration_Template_Section_Definition_Value) Mask(mask string) Configuration_Template_Section_Definition_Value

func (Configuration_Template_Section_Definition_Value) Offset 

func (r Configuration_Template_Section_Definition_Value) Offset(offset int) Configuration_Template_Section_Definition_Value

type Configuration_Template_Section_Profile 

type Configuration_Template_Section_Profile struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetConfigurationTemplateSectionProfileService 

func GetConfigurationTemplateSectionProfileService(sess session.SLSession) Configuration_Template_Section_Profile

GetConfigurationTemplateSectionProfileService returns an instance of the Configuration_Template_Section_Profile SoftLayer service

func (Configuration_Template_Section_Profile) Filter 

func (r Configuration_Template_Section_Profile) Filter(filter string) Configuration_Template_Section_Profile

func (Configuration_Template_Section_Profile) GetConfigurationSection 

func (r Configuration_Template_Section_Profile) GetConfigurationSection() (resp datatypes.Configuration_Template_Section, err error)

Retrieve

func (Configuration_Template_Section_Profile) GetObject 

func (r Configuration_Template_Section_Profile) GetObject() (resp datatypes.Configuration_Template_Section_Profile, err error)

no documentation yet

func (Configuration_Template_Section_Profile) Id 

func (r Configuration_Template_Section_Profile) Id(id int) Configuration_Template_Section_Profile

func (Configuration_Template_Section_Profile) Limit 

func (r Configuration_Template_Section_Profile) Limit(limit int) Configuration_Template_Section_Profile

func (Configuration_Template_Section_Profile) Mask 

func (r Configuration_Template_Section_Profile) Mask(mask string) Configuration_Template_Section_Profile

func (Configuration_Template_Section_Profile) Offset 

func (r Configuration_Template_Section_Profile) Offset(offset int) Configuration_Template_Section_Profile

type Configuration_Template_Section_Reference 

type Configuration_Template_Section_Reference struct {
	Session session.SLSession
	Options sl.Options
}

The SoftLayer_Configuration_Template_Section_Reference data type contains information of a configuration section and its associated configuration template.

func GetConfigurationTemplateSectionReferenceService 

func GetConfigurationTemplateSectionReferenceService(sess session.SLSession) Configuration_Template_Section_Reference

GetConfigurationTemplateSectionReferenceService returns an instance of the Configuration_Template_Section_Reference SoftLayer service

func (Configuration_Template_Section_Reference) Filter 

func (r Configuration_Template_Section_Reference) Filter(filter string) Configuration_Template_Section_Reference

func (Configuration_Template_Section_Reference) GetObject 

func (r Configuration_Template_Section_Reference) GetObject() (resp datatypes.Configuration_Template_Section_Reference, err error)

no documentation yet

func (Configuration_Template_Section_Reference) GetSection 

func (r Configuration_Template_Section_Reference) GetSection() (resp datatypes.Configuration_Template_Section, err error)

Retrieve

func (Configuration_Template_Section_Reference) GetTemplate 

func (r Configuration_Template_Section_Reference) GetTemplate() (resp datatypes.Configuration_Template, err error)

Retrieve

func (Configuration_Template_Section_Reference) Id 

func (r Configuration_Template_Section_Reference) Id(id int) Configuration_Template_Section_Reference

func (Configuration_Template_Section_Reference) Limit 

func (r Configuration_Template_Section_Reference) Limit(limit int) Configuration_Template_Section_Reference

func (Configuration_Template_Section_Reference) Mask 

func (r Configuration_Template_Section_Reference) Mask(mask string) Configuration_Template_Section_Reference

func (Configuration_Template_Section_Reference) Offset 

func (r Configuration_Template_Section_Reference) Offset(offset int) Configuration_Template_Section_Reference

type Configuration_Template_Section_Type 

type Configuration_Template_Section_Type struct {
	Session session.SLSession
	Options sl.Options
}

The SoftLayer_Configuration_Template_Section_Type data type contains information of a configuration section type.

Configuration can contain sub-sections.

func GetConfigurationTemplateSectionTypeService 

func GetConfigurationTemplateSectionTypeService(sess session.SLSession) Configuration_Template_Section_Type

GetConfigurationTemplateSectionTypeService returns an instance of the Configuration_Template_Section_Type SoftLayer service

func (Configuration_Template_Section_Type) Filter 

func (r Configuration_Template_Section_Type) Filter(filter string) Configuration_Template_Section_Type

func (Configuration_Template_Section_Type) GetObject 

func (r Configuration_Template_Section_Type) GetObject() (resp datatypes.Configuration_Template_Section_Type, err error)

no documentation yet

func (Configuration_Template_Section_Type) Id 

func (r Configuration_Template_Section_Type) Id(id int) Configuration_Template_Section_Type

func (Configuration_Template_Section_Type) Limit 

func (r Configuration_Template_Section_Type) Limit(limit int) Configuration_Template_Section_Type

func (Configuration_Template_Section_Type) Mask 

func (r Configuration_Template_Section_Type) Mask(mask string) Configuration_Template_Section_Type

func (Configuration_Template_Section_Type) Offset 

func (r Configuration_Template_Section_Type) Offset(offset int) Configuration_Template_Section_Type

type Configuration_Template_Type 

type Configuration_Template_Type struct {
	Session session.SLSession
	Options sl.Options
}

The SoftLayer_Configuration_Template_Type data type contains configuration template type information.

func GetConfigurationTemplateTypeService 

func GetConfigurationTemplateTypeService(sess session.SLSession) Configuration_Template_Type

GetConfigurationTemplateTypeService returns an instance of the Configuration_Template_Type SoftLayer service

func (Configuration_Template_Type) Filter 

func (r Configuration_Template_Type) Filter(filter string) Configuration_Template_Type

func (Configuration_Template_Type) GetObject 

func (r Configuration_Template_Type) GetObject() (resp datatypes.Configuration_Template_Type, err error)

no documentation yet

func (Configuration_Template_Type) Id 

func (r Configuration_Template_Type) Id(id int) Configuration_Template_Type

func (Configuration_Template_Type) Limit 

func (r Configuration_Template_Type) Limit(limit int) Configuration_Template_Type

func (Configuration_Template_Type) Mask 

func (r Configuration_Template_Type) Mask(mask string) Configuration_Template_Type

func (Configuration_Template_Type) Offset 

func (r Configuration_Template_Type) Offset(offset int) Configuration_Template_Type

type Dns_Domain 

type Dns_Domain struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetDnsDomainService 

func GetDnsDomainService(sess session.SLSession) Dns_Domain

GetDnsDomainService returns an instance of the Dns_Domain SoftLayer service

func (Dns_Domain) CreateARecord 

func (r Dns_Domain) CreateARecord(host *string, data *string, ttl *int) (resp datatypes.Dns_Domain_ResourceRecord_AType, err error)

Create an A record on a SoftLayer domain. This is a shortcut method, meant to take the work out of creating a SoftLayer_Dns_Domain_ResourceRecord if you already have a domain record available. createARecord returns the newly created SoftLayer_Dns_Domain_ResourceRecord_AType.

func (Dns_Domain) CreateAaaaRecord 

func (r Dns_Domain) CreateAaaaRecord(host *string, data *string, ttl *int) (resp datatypes.Dns_Domain_ResourceRecord_AaaaType, err error)

Create an AAAA record on a SoftLayer domain. This is a shortcut method, meant to take the work out of creating a SoftLayer_Dns_Domain_ResourceRecord if you already have a domain record available. createARecord returns the newly created SoftLayer_Dns_Domain_ResourceRecord_AaaaType.

func (Dns_Domain) CreateCnameRecord 

func (r Dns_Domain) CreateCnameRecord(host *string, data *string, ttl *int) (resp datatypes.Dns_Domain_ResourceRecord_CnameType, err error)

Create a CNAME record on a SoftLayer domain. This is a shortcut method, meant to take the work out of creating a SoftLayer_Dns_Domain_ResourceRecord if you already have a domain record available. createCnameRecord returns the newly created SoftLayer_Dns_Domain_ResourceRecord_CnameType.

func (Dns_Domain) CreateMxRecord 

func (r Dns_Domain) CreateMxRecord(host *string, data *string, ttl *int, mxPriority *int) (resp datatypes.Dns_Domain_ResourceRecord_MxType, err error)

Create an MX record on a SoftLayer domain. This is a shortcut method, meant to take the work out of creating a SoftLayer_Dns_Domain_ResourceRecord if you already have a domain record available. MX records are created with a default priority of 10. createMxRecord returns the newly created SoftLayer_Dns_Domain_ResourceRecord_MxType.

func (Dns_Domain) CreateNsRecord 

func (r Dns_Domain) CreateNsRecord(host *string, data *string, ttl *int) (resp datatypes.Dns_Domain_ResourceRecord_NsType, err error)

Create an NS record on a SoftLayer domain. This is a shortcut method, meant to take the work out of creating a SoftLayer_Dns_Domain_ResourceRecord if you already have a domain record available. createNsRecord returns the newly created SoftLayer_Dns_Domain_ResourceRecord_NsType.

func (Dns_Domain) CreateObject 

func (r Dns_Domain) CreateObject(templateObject *datatypes.Dns_Domain) (resp datatypes.Dns_Domain, err error)

Create a new domain on the SoftLayer name servers. The SoftLayer_Dns_Domain object passed to this function must have at least one A or AAAA resource record.

createObject creates a default SOA record with the data: * ”'host”': "@" * ”'data”': "ns1.softlayer.com." * ”'responsible person”': "root.[your domain name]." * ”'expire”': 604800 seconds * ”'refresh”': 3600 seconds * ”'retry”': 300 seconds * ”'minimum”': 3600 seconds

If your new domain uses the .de top-level domain then SOA refresh is set to 10000 seconds, retry is set to 1800 seconds, and minimum to 10000 seconds.

If your domain doesn't contain NS resource records for ns1.softlayer.com or ns2.softlayer.com then ”createObject” will create them for you.

”createObject” returns a Boolean ”true” on successful object creation or ”false” if your domain was unable to be created..

func (Dns_Domain) CreateObjects 

func (r Dns_Domain) CreateObjects(templateObjects []datatypes.Dns_Domain) (resp []datatypes.Dns_Domain, err error)

Create multiple domains on the SoftLayer name servers. Each domain record passed to ”createObjects” follows the logic in the SoftLayer_Dns_Domain ”createObject” method.

func (Dns_Domain) CreatePtrRecord 

func (r Dns_Domain) CreatePtrRecord(ipAddress *string, ptrRecord *string, ttl *int) (resp datatypes.Dns_Domain_ResourceRecord, err error)

setPtrRecordForIpAddress() sets a single reverse DNS record for a single IP address and returns the newly created or edited [[SoftLayer_Dns_Domain_ResourceRecord]] record. Currently this method only supports IPv4 addresses and performs no operation when given an IPv6 address.

func (Dns_Domain) CreateSpfRecord 

func (r Dns_Domain) CreateSpfRecord(host *string, data *string, ttl *int) (resp datatypes.Dns_Domain_ResourceRecord_SpfType, err error)

Create an SPF record on a SoftLayer domain. This is a shortcut method, meant to take the work out of creating a SoftLayer_Dns_Domain_ResourceRecord if you already have a domain record available. createARecord returns the newly created SoftLayer_Dns_Domain_ResourceRecord_SpfType.

func (Dns_Domain) CreateTxtRecord 

func (r Dns_Domain) CreateTxtRecord(host *string, data *string, ttl *int) (resp datatypes.Dns_Domain_ResourceRecord_TxtType, err error)

Create a TXT record on a SoftLayer domain. This is a shortcut method, meant to take the work out of creating a SoftLayer_Dns_Domain_ResourceRecord if you already have a domain record available. createARecord returns the newly created SoftLayer_Dns_Domain_ResourceRecord_TxtType.

func (Dns_Domain) DeleteObject 

func (r Dns_Domain) DeleteObject() (resp bool, err error)

deleteObject permanently removes a domain and all of it's associated resource records from the softlayer name servers. ”'This cannot be undone.”' Be wary of running this method. If you remove a domain in error you will need to re-create it by creating a new SoftLayer_Dns_Domain object.

func (Dns_Domain) Filter 

func (r Dns_Domain) Filter(filter string) Dns_Domain

func (Dns_Domain) GetAccount 

func (r Dns_Domain) GetAccount() (resp datatypes.Account, err error)

Retrieve The SoftLayer customer account that owns a domain.

func (Dns_Domain) GetByDomainName 

func (r Dns_Domain) GetByDomainName(name *string) (resp []datatypes.Dns_Domain, err error)

Search for [[SoftLayer_Dns_Domain]] records by domain name. getByDomainName() performs an inclusive search for domain records, returning multiple records based on partial name matches. Use this method to locate domain records if you don't have access to their id numbers.

func (Dns_Domain) GetManagedResourceFlag 

func (r Dns_Domain) GetManagedResourceFlag() (resp bool, err error)

Retrieve A flag indicating that the dns domain record is a managed resource.

func (Dns_Domain) GetObject 

func (r Dns_Domain) GetObject() (resp datatypes.Dns_Domain, err error)

getObject retrieves the SoftLayer_Dns_Domain object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Dns_Domain service. You can only retrieve domains that are assigned to your SoftLayer account.

func (Dns_Domain) GetResourceRecords 

func (r Dns_Domain) GetResourceRecords() (resp []datatypes.Dns_Domain_ResourceRecord, err error)

Retrieve The individual records contained within a domain record. These include but are not limited to A, AAAA, MX, CTYPE, SPF and TXT records.

func (Dns_Domain) GetSecondary 

func (r Dns_Domain) GetSecondary() (resp datatypes.Dns_Secondary, err error)

Retrieve The secondary DNS record that defines this domain as being managed through zone transfers.

func (Dns_Domain) GetSoaResourceRecord 

func (r Dns_Domain) GetSoaResourceRecord() (resp datatypes.Dns_Domain_ResourceRecord_SoaType, err error)

Retrieve The start of authority (SOA) record contains authoritative and propagation details for a DNS zone. This property is not considered in requests to createObject and editObject.

func (Dns_Domain) GetZoneFileContents 

func (r Dns_Domain) GetZoneFileContents() (resp string, err error)

Return a SoftLayer hosted domain and resource records' data formatted as zone file.

func (Dns_Domain) Id 

func (r Dns_Domain) Id(id int) Dns_Domain

func (Dns_Domain) Limit 

func (r Dns_Domain) Limit(limit int) Dns_Domain

func (Dns_Domain) Mask 

func (r Dns_Domain) Mask(mask string) Dns_Domain

func (Dns_Domain) Offset 

func (r Dns_Domain) Offset(offset int) Dns_Domain

type Dns_Domain_ResourceRecord 

type Dns_Domain_ResourceRecord struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetDnsDomainResourceRecordService 

func GetDnsDomainResourceRecordService(sess session.SLSession) Dns_Domain_ResourceRecord

GetDnsDomainResourceRecordService returns an instance of the Dns_Domain_ResourceRecord SoftLayer service

func (Dns_Domain_ResourceRecord) CreateObject 

func (r Dns_Domain_ResourceRecord) CreateObject(templateObject *datatypes.Dns_Domain_ResourceRecord) (resp datatypes.Dns_Domain_ResourceRecord, err error)

createObject creates a new domain resource record. The ”host” property of the templateObject parameter is scrubbed to remove all non-alpha numeric characters except for "@", "_", ".", "*", and "-". The ”data” property of the templateObject parameter is scrubbed to remove all non-alphanumeric characters for "." and "-". Creating a resource record updates the serial number of the domain the resource record is associated with.

”createObject” returns Boolean ”true” on successful create or ”false” if it was unable to create a resource record.

func (Dns_Domain_ResourceRecord) CreateObjects 

func (r Dns_Domain_ResourceRecord) CreateObjects(templateObjects []datatypes.Dns_Domain_ResourceRecord) (resp []datatypes.Dns_Domain_ResourceRecord, err error)

Create multiple resource records on a domain. This follows the same logic as ”createObject'. The serial number of the domain associated with this resource record is updated upon creation.

”createObjects” returns Boolean ”true” on successful creation or ”false” if it was unable to create a resource record.

func (Dns_Domain_ResourceRecord) DeleteObject 

func (r Dns_Domain_ResourceRecord) DeleteObject() (resp bool, err error)

Delete a domain's resource record. ”'This cannot be undone.”' Be wary of running this method. If you remove a resource record in error you will need to re-create it by creating a new SoftLayer_Dns_Domain_ResourceRecord object. The serial number of the domain associated with this resource record is updated upon deletion. You may not delete SOA, NS, or PTR resource records.

”deleteObject” returns Boolean ”true” on successful deletion or ”false” if it was unable to remove a resource record.

func (Dns_Domain_ResourceRecord) DeleteObjects 

func (r Dns_Domain_ResourceRecord) DeleteObjects(templateObjects []datatypes.Dns_Domain_ResourceRecord) (resp bool, err error)

Remove multiple resource records from a domain. This follows the same logic as ”deleteObject” and ”'cannot be undone”'. The serial number of the domain associated with this resource record is updated upon deletion. You may not delete SOA records, PTR records, or NS resource records that point to ns1.softlayer.com or ns2.softlayer.com.

”deleteObjects” returns Boolean ”true” on successful deletion or ”false” if it was unable to remove a resource record.

func (Dns_Domain_ResourceRecord) EditObject 

func (r Dns_Domain_ResourceRecord) EditObject(templateObject *datatypes.Dns_Domain_ResourceRecord) (resp bool, err error)

editObject edits an existing domain resource record. The ”host” property of the templateObject parameter is scrubbed to remove all non-alpha numeric characters except for "@", "_", ".", "*", and "-". The ”data” property of the templateObject parameter is scrubbed to remove all non-alphanumeric characters for "." and "-". Editing a resource record updates the serial number of the domain the resource record is associated with.

”editObject” returns Boolean ”true” on a successful edit or ”false” if it was unable to edit the resource record.

func (Dns_Domain_ResourceRecord) EditObjects 

func (r Dns_Domain_ResourceRecord) EditObjects(templateObjects []datatypes.Dns_Domain_ResourceRecord) (resp bool, err error)

Edit multiple resource records on a domain. This follows the same logic as ”createObject'. The serial number of the domain associated with this resource record is updated upon creation.

”createObjects” returns Boolean ”true” on successful creation or ”false” if it was unable to create a resource record.

func (Dns_Domain_ResourceRecord) Filter 

func (r Dns_Domain_ResourceRecord) Filter(filter string) Dns_Domain_ResourceRecord

func (Dns_Domain_ResourceRecord) GetDomain 

func (r Dns_Domain_ResourceRecord) GetDomain() (resp datatypes.Dns_Domain, err error)

Retrieve The domain that a resource record belongs to.

func (Dns_Domain_ResourceRecord) GetObject 

func (r Dns_Domain_ResourceRecord) GetObject() (resp datatypes.Dns_Domain_ResourceRecord, err error)

getObject retrieves the SoftLayer_Dns_Domain_ResourceRecord object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Dns_Domain_ResourceRecord service. You can only retrieve resource records belonging to domains that are assigned to your SoftLayer account.

func (Dns_Domain_ResourceRecord) Id 

func (r Dns_Domain_ResourceRecord) Id(id int) Dns_Domain_ResourceRecord

func (Dns_Domain_ResourceRecord) Limit 

func (r Dns_Domain_ResourceRecord) Limit(limit int) Dns_Domain_ResourceRecord

func (Dns_Domain_ResourceRecord) Mask 

func (r Dns_Domain_ResourceRecord) Mask(mask string) Dns_Domain_ResourceRecord

func (Dns_Domain_ResourceRecord) Offset 

func (r Dns_Domain_ResourceRecord) Offset(offset int) Dns_Domain_ResourceRecord

type Dns_Domain_ResourceRecord_MxType 

type Dns_Domain_ResourceRecord_MxType struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetDnsDomainResourceRecordMxTypeService 

func GetDnsDomainResourceRecordMxTypeService(sess session.SLSession) Dns_Domain_ResourceRecord_MxType

GetDnsDomainResourceRecordMxTypeService returns an instance of the Dns_Domain_ResourceRecord_MxType SoftLayer service

func (Dns_Domain_ResourceRecord_MxType) CreateObject 

func (r Dns_Domain_ResourceRecord_MxType) CreateObject(templateObject *datatypes.Dns_Domain_ResourceRecord_MxType) (resp datatypes.Dns_Domain_ResourceRecord_MxType, err error)

createObject creates a new MX record. The ”host” property of the templateObject parameter is scrubbed to remove all non-alpha numeric characters except for "@", "_", ".", "*", and "-". The ”data” property of the templateObject parameter is scrubbed to remove all non-alphanumeric characters for "." and "-". Creating an MX record updates the serial number of the domain the resource record is associated with.

func (Dns_Domain_ResourceRecord_MxType) CreateObjects 

func (r Dns_Domain_ResourceRecord_MxType) CreateObjects(templateObjects []datatypes.Dns_Domain_ResourceRecord) (resp []datatypes.Dns_Domain_ResourceRecord, err error)

Create multiple MX records on a domain. This follows the same logic as ”createObject'. The serial number of the domain associated with this MX record is updated upon creation.

”createObjects” returns Boolean ”true” on successful creation or ”false” if it was unable to create a resource record.

func (Dns_Domain_ResourceRecord_MxType) DeleteObject 

func (r Dns_Domain_ResourceRecord_MxType) DeleteObject() (resp bool, err error)

Delete a domain's MX record. ”'This cannot be undone.”' Be wary of running this method. If you remove a resource record in error you will need to re-create it by creating a new SoftLayer_Dns_Domain_ResourceRecord_MxType object. The serial number of the domain associated with this MX record is updated upon deletion.

”deleteObject” returns Boolean ”true” on successful deletion or ”false” if it was unable to remove a resource record.

func (Dns_Domain_ResourceRecord_MxType) DeleteObjects 

func (r Dns_Domain_ResourceRecord_MxType) DeleteObjects(templateObjects []datatypes.Dns_Domain_ResourceRecord_MxType) (resp bool, err error)

Remove multiple MX records from a domain. This follows the same logic as ”deleteObject” and ”'cannot be undone”'. The serial number of the domain associated with this MX record is updated upon deletion.

”deleteObjects” returns Boolean ”true” on successful deletion or ”false” if it was unable to remove a resource record.

func (Dns_Domain_ResourceRecord_MxType) EditObject 

func (r Dns_Domain_ResourceRecord_MxType) EditObject(templateObject *datatypes.Dns_Domain_ResourceRecord_MxType) (resp bool, err error)

editObject edits an existing MX resource record. The ”host” property of the templateObject parameter is scrubbed to remove all non-alpha numeric characters except for "@", "_", ".", "*", and "-". The ”data” property of the templateObject parameter is scrubbed to remove all non-alphanumeric characters for "." and "-". Editing an MX record updates the serial number of the domain the record is associated with.

”editObject” returns Boolean ”true” on a successful edit or ”false” if it was unable to edit the resource record.

func (Dns_Domain_ResourceRecord_MxType) EditObjects 

func (r Dns_Domain_ResourceRecord_MxType) EditObjects(templateObjects []datatypes.Dns_Domain_ResourceRecord_MxType) (resp bool, err error)

Edit multiple MX records on a domain. This follows the same logic as ”createObject'. The serial number of the domain associated with this MX record is updated upon creation.

”createObjects” returns Boolean ”true” on successful creation or ”false” if it was unable to create a resource record.

func (Dns_Domain_ResourceRecord_MxType) Filter 

func (r Dns_Domain_ResourceRecord_MxType) Filter(filter string) Dns_Domain_ResourceRecord_MxType

func (Dns_Domain_ResourceRecord_MxType) GetDomain 

func (r Dns_Domain_ResourceRecord_MxType) GetDomain() (resp datatypes.Dns_Domain, err error)

Retrieve The domain that a resource record belongs to.

func (Dns_Domain_ResourceRecord_MxType) GetObject 

func (r Dns_Domain_ResourceRecord_MxType) GetObject() (resp datatypes.Dns_Domain_ResourceRecord_MxType, err error)

getObject retrieves the SoftLayer_Dns_Domain_ResourceRecord_MxType object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Dns_Domain_ResourceRecord_MxType service. You can only retrieve resource records belonging to domains that are assigned to your SoftLayer account.

func (Dns_Domain_ResourceRecord_MxType) Id 

func (r Dns_Domain_ResourceRecord_MxType) Id(id int) Dns_Domain_ResourceRecord_MxType

func (Dns_Domain_ResourceRecord_MxType) Limit 

func (r Dns_Domain_ResourceRecord_MxType) Limit(limit int) Dns_Domain_ResourceRecord_MxType

func (Dns_Domain_ResourceRecord_MxType) Mask 

func (r Dns_Domain_ResourceRecord_MxType) Mask(mask string) Dns_Domain_ResourceRecord_MxType

func (Dns_Domain_ResourceRecord_MxType) Offset 

func (r Dns_Domain_ResourceRecord_MxType) Offset(offset int) Dns_Domain_ResourceRecord_MxType

type Dns_Domain_ResourceRecord_SrvType 

type Dns_Domain_ResourceRecord_SrvType struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetDnsDomainResourceRecordSrvTypeService 

func GetDnsDomainResourceRecordSrvTypeService(sess session.SLSession) Dns_Domain_ResourceRecord_SrvType

GetDnsDomainResourceRecordSrvTypeService returns an instance of the Dns_Domain_ResourceRecord_SrvType SoftLayer service

func (Dns_Domain_ResourceRecord_SrvType) CreateObject 

func (r Dns_Domain_ResourceRecord_SrvType) CreateObject(templateObject *datatypes.Dns_Domain_ResourceRecord_SrvType) (resp datatypes.Dns_Domain_ResourceRecord_SrvType, err error)

createObject creates a new SRV record. The ”host” property of the templateObject parameter is scrubbed to remove all non-alpha numeric characters except for "@", "_", ".", "*", and "-". The ”data” property of the templateObject parameter is scrubbed to remove all non-alphanumeric characters for "." and "-". Creating an SRV record updates the serial number of the domain the resource record is associated with.

func (Dns_Domain_ResourceRecord_SrvType) CreateObjects 

func (r Dns_Domain_ResourceRecord_SrvType) CreateObjects(templateObjects []datatypes.Dns_Domain_ResourceRecord) (resp []datatypes.Dns_Domain_ResourceRecord, err error)

Create multiple SRV records on a domain. This follows the same logic as ”createObject'. The serial number of the domain associated with this SRV record is updated upon creation.

”createObjects” returns Boolean ”true” on successful creation or ”false” if it was unable to create a resource record.

func (Dns_Domain_ResourceRecord_SrvType) DeleteObject 

func (r Dns_Domain_ResourceRecord_SrvType) DeleteObject() (resp bool, err error)

Delete a domain's SRV record. ”'This cannot be undone.”' Be wary of running this method. If you remove a resource record in error you will need to re-create it by creating a new SoftLayer_Dns_Domain_ResourceRecord_SrvType object. The serial number of the domain associated with this SRV record is updated upon deletion.

”deleteObject” returns Boolean ”true” on successful deletion or ”false” if it was unable to remove a resource record.

func (Dns_Domain_ResourceRecord_SrvType) DeleteObjects 

func (r Dns_Domain_ResourceRecord_SrvType) DeleteObjects(templateObjects []datatypes.Dns_Domain_ResourceRecord_SrvType) (resp bool, err error)

Remove multiple SRV records from a domain. This follows the same logic as ”deleteObject” and ”'cannot be undone”'. The serial number of the domain associated with this SRV record is updated upon deletion.

”deleteObjects” returns Boolean ”true” on successful deletion or ”false” if it was unable to remove a resource record.

func (Dns_Domain_ResourceRecord_SrvType) EditObject 

func (r Dns_Domain_ResourceRecord_SrvType) EditObject(templateObject *datatypes.Dns_Domain_ResourceRecord_SrvType) (resp bool, err error)

editObject edits an existing SRV resource record. The ”host” property of the templateObject parameter is scrubbed to remove all non-alpha numeric characters except for "@", "_", ".", "*", and "-". The ”data” property of the templateObject parameter is scrubbed to remove all non-alphanumeric characters for "." and "-". Editing an SRV record updates the serial number of the domain the record is associated with.

”editObject” returns Boolean ”true” on a successful edit or ”false” if it was unable to edit the resource record.

func (Dns_Domain_ResourceRecord_SrvType) EditObjects 

func (r Dns_Domain_ResourceRecord_SrvType) EditObjects(templateObjects []datatypes.Dns_Domain_ResourceRecord_SrvType) (resp bool, err error)

Edit multiple SRV records on a domain. This follows the same logic as ”createObject'. The serial number of the domain associated with this SRV record is updated upon creation.

”createObjects” returns Boolean ”true” on successful creation or ”false” if it was unable to create a resource record.

func (Dns_Domain_ResourceRecord_SrvType) Filter 

func (r Dns_Domain_ResourceRecord_SrvType) Filter(filter string) Dns_Domain_ResourceRecord_SrvType

func (Dns_Domain_ResourceRecord_SrvType) GetDomain 

func (r Dns_Domain_ResourceRecord_SrvType) GetDomain() (resp datatypes.Dns_Domain, err error)

Retrieve The domain that a resource record belongs to.

func (Dns_Domain_ResourceRecord_SrvType) GetObject 

func (r Dns_Domain_ResourceRecord_SrvType) GetObject() (resp datatypes.Dns_Domain_ResourceRecord_SrvType, err error)

getObject retrieves the SoftLayer_Dns_Domain_ResourceRecord_SrvType object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Dns_Domain_ResourceRecord_SrvType service. You can only retrieve resource records belonging to domains that are assigned to your SoftLayer account.

func (Dns_Domain_ResourceRecord_SrvType) Id 

func (r Dns_Domain_ResourceRecord_SrvType) Id(id int) Dns_Domain_ResourceRecord_SrvType

func (Dns_Domain_ResourceRecord_SrvType) Limit 

func (r Dns_Domain_ResourceRecord_SrvType) Limit(limit int) Dns_Domain_ResourceRecord_SrvType

func (Dns_Domain_ResourceRecord_SrvType) Mask 

func (r Dns_Domain_ResourceRecord_SrvType) Mask(mask string) Dns_Domain_ResourceRecord_SrvType

func (Dns_Domain_ResourceRecord_SrvType) Offset 

func (r Dns_Domain_ResourceRecord_SrvType) Offset(offset int) Dns_Domain_ResourceRecord_SrvType

type Dns_Secondary 

type Dns_Secondary struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetDnsSecondaryService 

func GetDnsSecondaryService(sess session.SLSession) Dns_Secondary

GetDnsSecondaryService returns an instance of the Dns_Secondary SoftLayer service

func (Dns_Secondary) ConvertToPrimary 

func (r Dns_Secondary) ConvertToPrimary() (resp bool, err error)

A secondary DNS record may be converted to a primary DNS record. By converting a secondary DNS record, the SoftLayer name servers will be the authoritative nameserver for this domain and will be directly editable in the SoftLayer API and Portal.

Primary DNS record conversion performs the following steps: * The SOA record is updated with SoftLayer's primary name server. * All NS records are removed and replaced with SoftLayer's NS records. * The secondary DNS record is removed.

After the DNS records are converted, the following restrictions will apply to the new domain record: * You will need to manage the zone record using the [[SoftLayer_Dns_Domain]] service. * You may not edit the SOA or NS records. * You may only edit the following resource records: A, AAAA, CNAME, MX, TX, SRV.

This change can not be undone, and the record can not be converted back into a secondary DNS record once the conversion is complete.

func (Dns_Secondary) CreateObject 

func (r Dns_Secondary) CreateObject(templateObject *datatypes.Dns_Secondary) (resp datatypes.Dns_Secondary, err error)

Create a secondary DNS record. The ”zoneName”, ”masterIpAddress”, and ”transferFrequency” properties in the templateObject parameter are required parameters to create a secondary DNS record.

func (Dns_Secondary) CreateObjects 

func (r Dns_Secondary) CreateObjects(templateObjects []datatypes.Dns_Secondary) (resp []datatypes.Dns_Secondary, err error)

Create multiple secondary DNS records. Each record passed to ”createObjects” follows the logic in the SoftLayer_Dns_Secondary [[SoftLayer_Dns_Secondary::createObject|createObject]] method.

func (Dns_Secondary) DeleteObject 

func (r Dns_Secondary) DeleteObject() (resp bool, err error)

Delete a secondary DNS Record. This will also remove any associated domain records and resource records on the SoftLayer nameservers that were created as a result of the zone transfers. This action cannot be undone.

func (Dns_Secondary) EditObject 

func (r Dns_Secondary) EditObject(templateObject *datatypes.Dns_Secondary) (resp bool, err error)

Edit the properties of a secondary DNS record by passing in a modified instance of a SoftLayer_Dns_Secondary object. You may only edit the ”masterIpAddress” and ”transferFrequency” properties of your secondary DNS record. ”ZoneName” may not be altered after a secondary DNS record has been created. Please remove and re-create the record if you need to make changes to your zone name.

func (Dns_Secondary) Filter 

func (r Dns_Secondary) Filter(filter string) Dns_Secondary

func (Dns_Secondary) GetAccount 

func (r Dns_Secondary) GetAccount() (resp datatypes.Account, err error)

Retrieve The SoftLayer account that owns a secondary DNS record.

func (Dns_Secondary) GetByDomainName 

func (r Dns_Secondary) GetByDomainName(name *string) (resp []datatypes.Dns_Secondary, err error)

Search for [[SoftLayer_Dns_Secondary]] records by domain name. getByDomainName() performs an inclusive search for secondary domain records, returning multiple records based on partial name matches. Use this method to locate secondary domain records if you don't have access to their id numbers.

func (Dns_Secondary) GetDomain 

func (r Dns_Secondary) GetDomain() (resp datatypes.Dns_Domain, err error)

Retrieve The domain record created by zone transfer from a secondary DNS record.

func (Dns_Secondary) GetErrorMessages 

func (r Dns_Secondary) GetErrorMessages() (resp []datatypes.Dns_Message, err error)

Retrieve The error messages created during secondary DNS record transfer.

func (Dns_Secondary) GetObject 

func (r Dns_Secondary) GetObject() (resp datatypes.Dns_Secondary, err error)

getObject retrieves the SoftLayer_Dns_Secondary object whose ID number corresponds to the ID number of the init paramater passed to the SoftLayer_Dns_Secondary service. You can only retrieve a secondary DNS record that is assigned to your SoftLayer customer account.

func (Dns_Secondary) GetStatus 

func (r Dns_Secondary) GetStatus() (resp datatypes.Dns_Status, err error)

Retrieve The current status of the secondary DNS zone.

func (Dns_Secondary) Id 

func (r Dns_Secondary) Id(id int) Dns_Secondary

func (Dns_Secondary) Limit 

func (r Dns_Secondary) Limit(limit int) Dns_Secondary

func (Dns_Secondary) Mask 

func (r Dns_Secondary) Mask(mask string) Dns_Secondary

func (Dns_Secondary) Offset 

func (r Dns_Secondary) Offset(offset int) Dns_Secondary

func (Dns_Secondary) TransferNow 

func (r Dns_Secondary) TransferNow() (resp bool, err error)

Force a secondary DNS zone transfer by setting it's status "Transfer Now". A zone transfer will be initiated within a minute of receiving this API call.

type Email_Subscription 

type Email_Subscription struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetEmailSubscriptionService 

func GetEmailSubscriptionService(sess session.SLSession) Email_Subscription

GetEmailSubscriptionService returns an instance of the Email_Subscription SoftLayer service

func (Email_Subscription) Disable 

func (r Email_Subscription) Disable() (resp bool, err error)

no documentation yet

func (Email_Subscription) Enable 

func (r Email_Subscription) Enable() (resp bool, err error)

no documentation yet

func (Email_Subscription) Filter 

func (r Email_Subscription) Filter(filter string) Email_Subscription

func (Email_Subscription) GetAllObjects 

func (r Email_Subscription) GetAllObjects() (resp []datatypes.Email_Subscription, err error)

no documentation yet

func (Email_Subscription) GetEnabled 

func (r Email_Subscription) GetEnabled() (resp bool, err error)

Retrieve

func (Email_Subscription) GetObject 

func (r Email_Subscription) GetObject() (resp datatypes.Email_Subscription, err error)

no documentation yet

func (Email_Subscription) Id 

func (r Email_Subscription) Id(id int) Email_Subscription

func (Email_Subscription) Limit 

func (r Email_Subscription) Limit(limit int) Email_Subscription

func (Email_Subscription) Mask 

func (r Email_Subscription) Mask(mask string) Email_Subscription

func (Email_Subscription) Offset 

func (r Email_Subscription) Offset(offset int) Email_Subscription

type Email_Subscription_Group 

type Email_Subscription_Group struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetEmailSubscriptionGroupService 

func GetEmailSubscriptionGroupService(sess session.SLSession) Email_Subscription_Group

GetEmailSubscriptionGroupService returns an instance of the Email_Subscription_Group SoftLayer service

func (Email_Subscription_Group) Filter 

func (r Email_Subscription_Group) Filter(filter string) Email_Subscription_Group

func (Email_Subscription_Group) GetAllObjects 

func (r Email_Subscription_Group) GetAllObjects() (resp []datatypes.Email_Subscription_Group, err error)

no documentation yet

func (Email_Subscription_Group) GetObject 

func (r Email_Subscription_Group) GetObject() (resp datatypes.Email_Subscription_Group, err error)

no documentation yet

func (Email_Subscription_Group) GetSubscriptions 

func (r Email_Subscription_Group) GetSubscriptions() (resp []datatypes.Email_Subscription, err error)

Retrieve All email subscriptions associated with this group.

func (Email_Subscription_Group) Id 

func (r Email_Subscription_Group) Id(id int) Email_Subscription_Group

func (Email_Subscription_Group) Limit 

func (r Email_Subscription_Group) Limit(limit int) Email_Subscription_Group

func (Email_Subscription_Group) Mask 

func (r Email_Subscription_Group) Mask(mask string) Email_Subscription_Group

func (Email_Subscription_Group) Offset 

func (r Email_Subscription_Group) Offset(offset int) Email_Subscription_Group

type Event_Log 

type Event_Log struct {
	Session session.SLSession
	Options sl.Options
}

The SoftLayer_Event_Log data type contains an event detail occurred upon various SoftLayer resources.

func GetEventLogService 

func GetEventLogService(sess session.SLSession) Event_Log

GetEventLogService returns an instance of the Event_Log SoftLayer service

func (Event_Log) Filter 

func (r Event_Log) Filter(filter string) Event_Log

func (Event_Log) GetAllEventNames 

func (r Event_Log) GetAllEventNames(objectName *string) (resp []string, err error)

This all indexed event names.

func (Event_Log) GetAllEventObjectNames 

func (r Event_Log) GetAllEventObjectNames() (resp []string, err error)

This all indexed event object names.

func (Event_Log) GetAllObjects 

func (r Event_Log) GetAllObjects() (resp []datatypes.Event_Log, err error)

no documentation yet

func (Event_Log) GetAllUserTypes 

func (r Event_Log) GetAllUserTypes() (resp []string, err error)

no documentation yet

func (Event_Log) GetUser 

func (r Event_Log) GetUser() (resp datatypes.User_Customer, err error)

Retrieve

func (Event_Log) Id 

func (r Event_Log) Id(id int) Event_Log

func (Event_Log) Limit 

func (r Event_Log) Limit(limit int) Event_Log

func (Event_Log) Mask 

func (r Event_Log) Mask(mask string) Event_Log

func (Event_Log) Offset 

func (r Event_Log) Offset(offset int) Event_Log

type Exception_Brand_Creation 

type Exception_Brand_Creation struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetExceptionBrandCreationService 

func GetExceptionBrandCreationService(sess session.SLSession) Exception_Brand_Creation

GetExceptionBrandCreationService returns an instance of the Exception_Brand_Creation SoftLayer service

func (Exception_Brand_Creation) Filter 

func (r Exception_Brand_Creation) Filter(filter string) Exception_Brand_Creation

func (Exception_Brand_Creation) Id 

func (r Exception_Brand_Creation) Id(id int) Exception_Brand_Creation

func (Exception_Brand_Creation) Limit 

func (r Exception_Brand_Creation) Limit(limit int) Exception_Brand_Creation

func (Exception_Brand_Creation) Mask 

func (r Exception_Brand_Creation) Mask(mask string) Exception_Brand_Creation

func (Exception_Brand_Creation) Offset 

func (r Exception_Brand_Creation) Offset(offset int) Exception_Brand_Creation

type FlexibleCredit_Program 

type FlexibleCredit_Program struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetFlexibleCreditProgramService 

func GetFlexibleCreditProgramService(sess session.SLSession) FlexibleCredit_Program

GetFlexibleCreditProgramService returns an instance of the FlexibleCredit_Program SoftLayer service

func (FlexibleCredit_Program) Filter 

func (r FlexibleCredit_Program) Filter(filter string) FlexibleCredit_Program

func (FlexibleCredit_Program) GetAffiliatesAvailableForSelfEnrollmentByVerificationType 

func (r FlexibleCredit_Program) GetAffiliatesAvailableForSelfEnrollmentByVerificationType(verificationTypeKeyName *string) (resp []datatypes.FlexibleCredit_Affiliate, err error)

no documentation yet

func (FlexibleCredit_Program) GetCompanyTypes 

func (r FlexibleCredit_Program) GetCompanyTypes() (resp []datatypes.FlexibleCredit_Company_Type, err error)

no documentation yet

func (FlexibleCredit_Program) GetObject 

func (r FlexibleCredit_Program) GetObject() (resp datatypes.FlexibleCredit_Program, err error)

no documentation yet

func (FlexibleCredit_Program) Id 

func (r FlexibleCredit_Program) Id(id int) FlexibleCredit_Program

func (FlexibleCredit_Program) Limit 

func (r FlexibleCredit_Program) Limit(limit int) FlexibleCredit_Program

func (FlexibleCredit_Program) Mask 

func (r FlexibleCredit_Program) Mask(mask string) FlexibleCredit_Program

func (FlexibleCredit_Program) Offset 

func (r FlexibleCredit_Program) Offset(offset int) FlexibleCredit_Program

func (FlexibleCredit_Program) SelfEnrollNewAccount 

func (r FlexibleCredit_Program) SelfEnrollNewAccount(accountTemplate *datatypes.Account) (resp datatypes.Account, err error)

no documentation yet

type Hardware 

type Hardware struct {
	Session session.SLSession
	Options sl.Options
}

The SoftLayer_Hardware data type contains general information relating to a single SoftLayer hardware.

func GetHardwareService 

func GetHardwareService(sess session.SLSession) Hardware

GetHardwareService returns an instance of the Hardware SoftLayer service

func (Hardware) AllowAccessToNetworkStorage 

func (r Hardware) AllowAccessToNetworkStorage(networkStorageTemplateObject *datatypes.Network_Storage) (resp bool, err error)

This method is used to allow access to a SoftLayer_Network_Storage volume that supports host- or network-level access control.

func (Hardware) AllowAccessToNetworkStorageList 

func (r Hardware) AllowAccessToNetworkStorageList(networkStorageTemplateObjects []datatypes.Network_Storage) (resp bool, err error)

This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support host- or network-level access control.

func (Hardware) CaptureImage 

func (r Hardware) CaptureImage(captureTemplate *datatypes.Container_Disk_Image_Capture_Template) (resp datatypes.Virtual_Guest_Block_Device_Template_Group, err error)

Captures an Image of the hard disk on the physical machine, based on the capture template parameter. Returns the image template group containing the disk image.

func (Hardware) CreateObject 

func (r Hardware) CreateObject(templateObject *datatypes.Hardware) (resp datatypes.Hardware, err error)

<style type="text/css">.create_object > li > div { padding-top: .5em; padding-bottom: .5em}</style> createObject() enables the creation of servers on an account. This method is a simplified alternative to interacting with the ordering system directly.

In order to create a server, a template object must be sent in with a few required values.

When this method returns an order will have been placed for a server of the specified configuration.

To determine when the server is available you can poll the server via [[SoftLayer_Hardware/getObject|getObject]], checking the <code>provisionDate</code> property. When <code>provisionDate</code> is not null, the server will be ready. Be sure to use the <code>globalIdentifier</code> as your initialization parameter.

<b>Warning:</b> Servers created via this method will incur charges on your account. For testing input parameters see [[SoftLayer_Hardware/generateOrderTemplate|generateOrderTemplate]].

<b>Input</b> - [[SoftLayer_Hardware (type)|SoftLayer_Hardware]] <ul class="create_object"> 

    <li><code>hostname</code>
        <div>Hostname for the server.</div><ul>
            <li><b>Required</b></li>
            <li><b>Type</b> - string</li>
        </ul>
        <br />
    </li>
    <li><code>domain</code>
        <div>Domain for the server.</div><ul>
            <li><b>Required</b></li>
            <li><b>Type</b> - string</li>
        </ul>
        <br />
    </li>
    <li><code>processorCoreAmount</code>
        <div>The number of logical CPU cores to allocate.</div><ul>
            <li><b>Required</b></li>
            <li><b>Type</b> - int</li>
            <li>See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.</li>
        </ul>
        <br />
    </li>
    <li><code>memoryCapacity</code>
        <div>The amount of memory to allocate in gigabytes.</div><ul>
            <li><b>Required</b></li>
            <li><b>Type</b> - int</li>
            <li>See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.</li>
        </ul>
        <br />
    </li>
    <li><code>hourlyBillingFlag</code>
        <div>Specifies the billing type for the server.</div><ul>
            <li><b>Required</b></li>
            <li><b>Type</b> - boolean</li>
            <li>When true the server will be billed on hourly usage, otherwise it will be billed on a monthly basis.</li>
        </ul>
        <br />
    </li>
    <li><code>operatingSystemReferenceCode</code>
        <div>An identifier for the operating system to provision the server with.</div><ul>
            <li><b>Required</b></li>
            <li><b>Type</b> - string</li>
            <li>See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.</li>
        </ul>
        <br />
    </li>
    <li><code>datacenter.name</code>
        <div>Specifies which datacenter the server is to be provisioned in.</div><ul>
            <li><b>Required</b></li>
            <li><b>Type</b> - string</li>
            <li>The <code>datacenter</code> property is a [[SoftLayer_Location (type)|location]] structure with the <code>name</code> field set.</li>
            <li>See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.</li>
        </ul>
        <http title="Example">{
    "datacenter": {
        "name": "dal05"
    }
}</http>

        <br />
    </li>
    <li><code>networkComponents.maxSpeed</code>
        <div>Specifies the connection speed for the server's network components.</div><ul>
            <li><b>Optional</b></li>
            <li><b>Type</b> - int</li>
            <li><b>Default</b> - The highest available zero cost port speed will be used.</li>
            <li><b>Description</b> - The <code>networkComponents</code> property is an array with a single [[SoftLayer_Network_Component (type)|network component]] structure. The <code>maxSpeed</code> property must be set to specify the network uplink speed, in megabits per second, of the server.</li>
            <li>See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.</li>
        </ul>
            <http title="Example">{
    "networkComponents": [
        {
            "maxSpeed": 1000
        }
    ]
}</http>

        <br />
    </li>
    <li><code>networkComponents.redundancyEnabledFlag</code>
        <div>Specifies whether or not the server's network components should be in redundancy groups.</div><ul>
            <li><b>Optional</b></li>
            <li><b>Type</b> - bool</li>
            <li><b>Default</b> - <code>false</code></li>
            <li><b>Description</b> - The <code>networkComponents</code> property is an array with a single [[SoftLayer_Network_Component (type)|network component]] structure. When the <code>redundancyEnabledFlag</code> property is true the server's network components will be in redundancy groups.</li>
        </ul>
            <http title="Example">{
    "networkComponents": [
        {
            "redundancyEnabledFlag": false
        }
    ]
}</http>

        <br />
    </li>
    <li><code>privateNetworkOnlyFlag</code>
        <div>Specifies whether or not the server only has access to the private network</div><ul>
            <li><b>Optional</b></li>
            <li><b>Type</b> - boolean</li>
            <li><b>Default</b> - <code>false</code></li>
            <li>When true this flag specifies that a server is to only have access to the private network.</li>
        </ul>
        <br />
    </li>
    <li><code>primaryNetworkComponent.networkVlan.id</code>
        <div>Specifies the network vlan which is to be used for the frontend interface of the server.</div><ul>
            <li><b>Optional</b></li>
            <li><b>Type</b> - int</li>
            <li><b>Description</b> - The <code>primaryNetworkComponent</code> property is a [[SoftLayer_Network_Component (type)|network component]] structure with the <code>networkVlan</code> property populated with a [[SoftLayer_Network_Vlan (type)|vlan]] structure. The <code>id</code> property must be set to specify the frontend network vlan of the server.</li>
        </ul>
        <http title="Example">{
    "primaryNetworkComponent": {
        "networkVlan": {
            "id": 1
        }
    }
}</http>

        <br />
    </li>
    <li><code>primaryBackendNetworkComponent.networkVlan.id</code>
        <div>Specifies the network vlan which is to be used for the backend interface of the server.</div><ul>
            <li><b>Optional</b></li>
            <li><b>Type</b> - int</li>
            <li><b>Description</b> - The <code>primaryBackendNetworkComponent</code> property is a [[SoftLayer_Network_Component (type)|network component]] structure with the <code>networkVlan</code> property populated with a [[SoftLayer_Network_Vlan (type)|vlan]] structure. The <code>id</code> property must be set to specify the backend network vlan of the server.</li>
        </ul>
        <http title="Example">{
    "primaryBackendNetworkComponent": {
        "networkVlan": {
            "id": 2
        }
    }
}</http>

        <br />
    </li>
    <li><code>fixedConfigurationPreset.keyName</code>
        <div></div><ul>
            <li><b>Optional</b></li>
            <li><b>Type</b> - string</li>
            <li><b>Description</b> - The <code>fixedConfigurationPreset</code> property is a [[SoftLayer_Product_Package_Preset (type)|fixed configuration preset]] structure. The <code>keyName</code> property must be set to specify preset to use.</li>
            <li>If a fixed configuration preset is used <code>processorCoreAmount</code>, <code>memoryCapacity</code> and <code>hardDrives</code> properties must not be set.</li>
            <li>See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.</li>
        </ul>
        <http title="Example">{
    "fixedConfigurationPreset": {
        "keyName": "SOME_KEY_NAME"
    }
}</http>

        <br />
    </li>
    <li><code>userData.value</code>
        <div>Arbitrary data to be made available to the server.</div><ul>
            <li><b>Optional</b></li>
            <li><b>Type</b> - string</li>
            <li><b>Description</b> - The <code>userData</code> property is an array with a single [[SoftLayer_Hardware_Attribute (type)|attribute]] structure with the <code>value</code> property set to an arbitrary value.</li>
            <li>This value can be retrieved via the [[SoftLayer_Resource_Metadata/getUserMetadata|getUserMetadata]] method from a request originating from the server. This is primarily useful for providing data to software that may be on the server and configured to execute upon first boot.</li>
        </ul>
        <http title="Example">{
    "userData": [
        {
            "value": "someValue"
        }
    ]
}</http>

        <br />
    </li>
    <li><code>hardDrives</code>
        <div>Hard drive settings for the server</div><ul>
            <li><b>Optional</b></li>
            <li><b>Type</b> - SoftLayer_Hardware_Component</li>
            <li><b>Default</b> - The largest available capacity for a zero cost primary disk will be used.</li>
            <li><b>Description</b> - The <code>hardDrives</code> property is an array of [[SoftLayer_Hardware_Component (type)|hardware component]] structures.</i>
            <li>Each hard drive must specify the <code>capacity</code> property.</li>
            <li>See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.</li>
        </ul>
        <http title="Example">{
    "hardDrives": [
        {
            "capacity": 500
        }
    ]
}</http>

        <br />
    </li>
    <li id="hardware-create-object-ssh-keys"><code>sshKeys</code>
        <div>SSH keys to install on the server upon provisioning.</div><ul>
            <li><b>Optional</b></li>
            <li><b>Type</b> - array of [[SoftLayer_Security_Ssh_Key (type)|SoftLayer_Security_Ssh_Key]]</li>
            <li><b>Description</b> - The <code>sshKeys</code> property is an array of [[SoftLayer_Security_Ssh_Key (type)|SSH Key]] structures with the <code>id</code> property set to the value of an existing SSH key.</li>
            <li>To create a new SSH key, call [[SoftLayer_Security_Ssh_Key/createObject|createObject]] on the [[SoftLayer_Security_Ssh_Key]] service.</li>
            <li>To obtain a list of existing SSH keys, call [[SoftLayer_Account/getSshKeys|getSshKeys]] on the [[SoftLayer_Account]] service.
        </ul>
        <http title="Example">{
    "sshKeys": [
        {
            "id": 123
        }
    ]
}</http>

    <br />
</li>
<li><code>postInstallScriptUri</code>
    <div>Specifies the uri location of the script to be downloaded and run after installation is complete.</div><ul>
        <li><b>Optional</b></li>
        <li><b>Type</b> - string</li>
    </ul>
    <br />
</li>

</ul>

<h1>REST Example</h1> 

<http title="Request">curl -X POST -d '{
 "parameters":[
     {
         "hostname": "host1",
         "domain": "example.com",
         "processorCoreAmount": 2,
         "memoryCapacity": 2,
         "hourlyBillingFlag": true,
         "operatingSystemReferenceCode": "UBUNTU_LATEST"
     }
 ]
}' https://api.softlayer.com/rest/v3/SoftLayer_Hardware.json

</http> <http title="Response">HTTP/1.1 201 Created Location: https://api.softlayer.com/rest/v3/SoftLayer_Hardware/f5a3fcff-db1d-4b7c-9fa0-0349e41c29c5/getObject 

{
    "accountId": 232298,
    "bareMetalInstanceFlag": null,
    "domain": "example.com",
    "hardwareStatusId": null,
    "hostname": "host1",
    "id": null,
    "serviceProviderId": null,
    "serviceProviderResourceId": null,
    "globalIdentifier": "f5a3fcff-db1d-4b7c-9fa0-0349e41c29c5",
    "hourlyBillingFlag": true,
    "memoryCapacity": 2,
    "operatingSystemReferenceCode": "UBUNTU_LATEST",
    "processorCoreAmount": 2
}

</http>

func (Hardware) DeleteObject 

func (r Hardware) DeleteObject() (resp bool, err error)

This method will cancel a server effective immediately. For servers billed hourly, the charges will stop immediately after the method returns.

func (Hardware) DeleteSoftwareComponentPasswords 

func (r Hardware) DeleteSoftwareComponentPasswords(softwareComponentPasswords []datatypes.Software_Component_Password) (resp bool, err error)

Delete software component passwords.

func (Hardware) DeleteTag 

func (r Hardware) DeleteTag(tagName *string) (resp bool, err error)

Delete an existing tag. If there are any references on the tag, an exception will be thrown.

func (Hardware) EditSoftwareComponentPasswords 

func (r Hardware) EditSoftwareComponentPasswords(softwareComponentPasswords []datatypes.Software_Component_Password) (resp bool, err error)

Edit the properties of a software component password such as the username, password, and notes.

func (Hardware) ExecuteRemoteScript 

func (r Hardware) ExecuteRemoteScript(uri *string) (err error)

Download and run remote script from uri on the hardware.

func (Hardware) Filter 

func (r Hardware) Filter(filter string) Hardware

func (Hardware) FindByIpAddress 

func (r Hardware) FindByIpAddress(ipAddress *string) (resp datatypes.Hardware, err error)

The ”'findByIpAddress”' method finds hardware using its primary public or private IP address. IP addresses that have a secondary subnet tied to the hardware will not return the hardware. If no hardware is found, no errors are generated and no data is returned.

func (Hardware) GenerateOrderTemplate 

func (r Hardware) GenerateOrderTemplate(templateObject *datatypes.Hardware) (resp datatypes.Container_Product_Order, err error)

Obtain an [[SoftLayer_Container_Product_Order_Hardware_Server (type)|order container]] that can be sent to [[SoftLayer_Product_Order/verifyOrder|verifyOrder]] or [[SoftLayer_Product_Order/placeOrder|placeOrder]].

This is primarily useful when there is a necessity to confirm the price which will be charged for an order.

See [[SoftLayer_Hardware/createObject|createObject]] for specifics on the requirements of the template object parameter.

func (Hardware) GetAccount 

func (r Hardware) GetAccount() (resp datatypes.Account, err error)

Retrieve The account associated with a piece of hardware.

func (Hardware) GetActiveComponents 

func (r Hardware) GetActiveComponents() (resp []datatypes.Hardware_Component, err error)

Retrieve A piece of hardware's active physical components.

func (Hardware) GetActiveNetworkMonitorIncident 

func (r Hardware) GetActiveNetworkMonitorIncident() (resp []datatypes.Network_Monitor_Version1_Incident, err error)

Retrieve A piece of hardware's active network monitoring incidents.

func (Hardware) GetAllPowerComponents 

func (r Hardware) GetAllPowerComponents() (resp []datatypes.Hardware_Power_Component, err error)

Retrieve

func (Hardware) GetAllowedHost 

func (r Hardware) GetAllowedHost() (resp datatypes.Network_Storage_Allowed_Host, err error)

Retrieve The SoftLayer_Network_Storage_Allowed_Host information to connect this server to Network Storage volumes that require access control lists.

func (Hardware) GetAllowedNetworkStorage 

func (r Hardware) GetAllowedNetworkStorage() (resp []datatypes.Network_Storage, err error)

Retrieve The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to.

func (Hardware) GetAllowedNetworkStorageReplicas 

func (r Hardware) GetAllowedNetworkStorageReplicas() (resp []datatypes.Network_Storage, err error)

Retrieve The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to.

func (Hardware) GetAntivirusSpywareSoftwareComponent 

func (r Hardware) GetAntivirusSpywareSoftwareComponent() (resp datatypes.Software_Component, err error)

Retrieve Information regarding an antivirus/spyware software component object.

func (Hardware) GetAttachedNetworkStorages 

func (r Hardware) GetAttachedNetworkStorages(nasType *string) (resp []datatypes.Network_Storage, err error)

This method is retrieve a list of SoftLayer_Network_Storage volumes that are authorized access to this SoftLayer_Hardware.

func (Hardware) GetAttributes 

func (r Hardware) GetAttributes() (resp []datatypes.Hardware_Attribute, err error)

Retrieve Information regarding a piece of hardware's specific attributes.

func (Hardware) GetAvailableBillingTermChangePrices added in v1.0.4 

func (r Hardware) GetAvailableBillingTermChangePrices() (resp []datatypes.Product_Item_Price, err error)

Retrieves a list of available term prices to this hardware. Currently, price terms are only available for increasing term length to monthly billed servers.

func (Hardware) GetAvailableNetworkStorages 

func (r Hardware) GetAvailableNetworkStorages(nasType *string) (resp []datatypes.Network_Storage, err error)

This method retrieves a list of SoftLayer_Network_Storage volumes that can be authorized to this SoftLayer_Hardware.

func (Hardware) GetAverageDailyPublicBandwidthUsage 

func (r Hardware) GetAverageDailyPublicBandwidthUsage() (resp datatypes.Float64, err error)

Retrieve The average daily public bandwidth usage for the current billing cycle.

func (Hardware) GetBackendIncomingBandwidth 

func (r Hardware) GetBackendIncomingBandwidth(startDate *datatypes.Time, endDate *datatypes.Time) (resp datatypes.Float64, err error)

The ”'getBackendIncomingBandwidth”' method retrieves the amount of incoming private network traffic used between the given start date and end date parameters. When entering start and end dates, only the month, day and year are used to calculate bandwidth totals - the time (HH:MM:SS) is ignored and defaults to midnight. The amount of bandwidth retrieved is measured in gigabytes.

func (Hardware) GetBackendNetworkComponents 

func (r Hardware) GetBackendNetworkComponents() (resp []datatypes.Network_Component, err error)

Retrieve A piece of hardware's back-end or private network components.

func (Hardware) GetBackendOutgoingBandwidth 

func (r Hardware) GetBackendOutgoingBandwidth(startDate *datatypes.Time, endDate *datatypes.Time) (resp datatypes.Float64, err error)

The ”'getBackendOutgoingBandwidth”' method retrieves the amount of outgoing private network traffic used between the given start date and end date parameters. When entering start and end dates, only the month, day and year are used to calculate bandwidth totals - the time (HH:MM:SS) is ignored and defaults to midnight. The amount of bandwidth retrieved is measured in gigabytes.

func (Hardware) GetBackendRouters 

func (r Hardware) GetBackendRouters() (resp []datatypes.Hardware, err error)

Retrieve A hardware's backend or private router.

func (Hardware) GetBandwidthAllocation 

func (r Hardware) GetBandwidthAllocation() (resp datatypes.Float64, err error)

Retrieve A hardware's allotted bandwidth (measured in GB).

func (Hardware) GetBandwidthAllotmentDetail 

func (r Hardware) GetBandwidthAllotmentDetail() (resp datatypes.Network_Bandwidth_Version1_Allotment_Detail, err error)

Retrieve A hardware's allotted detail record. Allotment details link bandwidth allocation with allotments.

func (Hardware) GetBenchmarkCertifications 

func (r Hardware) GetBenchmarkCertifications() (resp []datatypes.Hardware_Benchmark_Certification, err error)

Retrieve Information regarding a piece of hardware's benchmark certifications.

func (Hardware) GetBillingItem 

func (r Hardware) GetBillingItem() (resp datatypes.Billing_Item_Hardware, err error)

Retrieve Information regarding the billing item for a server.

func (Hardware) GetBillingItemFlag 

func (r Hardware) GetBillingItemFlag() (resp bool, err error)

Retrieve A flag indicating that a billing item exists.

func (Hardware) GetBlockCancelBecauseDisconnectedFlag 

func (r Hardware) GetBlockCancelBecauseDisconnectedFlag() (resp bool, err error)

Retrieve Determines whether the hardware is ineligible for cancellation because it is disconnected.

func (Hardware) GetBusinessContinuanceInsuranceFlag 

func (r Hardware) GetBusinessContinuanceInsuranceFlag() (resp bool, err error)

Retrieve Status indicating whether or not a piece of hardware has business continuance insurance.

func (Hardware) GetChildrenHardware 

func (r Hardware) GetChildrenHardware() (resp []datatypes.Hardware, err error)

Retrieve Child hardware.

func (Hardware) GetComponentDetailsXML 

func (r Hardware) GetComponentDetailsXML() (resp string, err error)

no documentation yet

func (Hardware) GetComponents 

func (r Hardware) GetComponents() (resp []datatypes.Hardware_Component, err error)

Retrieve A piece of hardware's components.

func (Hardware) GetContinuousDataProtectionSoftwareComponent 

func (r Hardware) GetContinuousDataProtectionSoftwareComponent() (resp datatypes.Software_Component, err error)

Retrieve A continuous data protection/server backup software component object.

func (Hardware) GetCreateObjectOptions 

func (r Hardware) GetCreateObjectOptions() (resp datatypes.Container_Hardware_Configuration, err error)

There are many options that may be provided while ordering a server, this method can be used to determine what these options are.

Detailed information on the return value can be found on the data type page for [[SoftLayer_Container_Hardware_Configuration (type)]].

func (Hardware) GetCurrentBillableBandwidthUsage 

func (r Hardware) GetCurrentBillableBandwidthUsage() (resp datatypes.Float64, err error)

Retrieve The current billable public outbound bandwidth for this hardware for the current billing cycle.

func (Hardware) GetCurrentBillingDetail 

func (r Hardware) GetCurrentBillingDetail() (resp []datatypes.Billing_Item, err error)

Get the billing detail for this hardware for the current billing period. This does not include bandwidth usage.

func (Hardware) GetCurrentBillingTotal 

func (r Hardware) GetCurrentBillingTotal() (resp datatypes.Float64, err error)

Get the total bill amount in US Dollars ($) for this hardware in the current billing period. This includes all bandwidth used up to the point the method is called on the hardware.

func (Hardware) GetDailyAverage 

func (r Hardware) GetDailyAverage(startDate *datatypes.Time, endDate *datatypes.Time) (resp datatypes.Float64, err error)

The ”'getDailyAverage”' method calculates the average daily network traffic used by the selected server. Using the required parameter ”dateTime” to enter a start and end date, the user retrieves this average, measure in gigabytes (GB) for the specified date range. When entering parameters, only the month, day and year are required - time entries are omitted as this method defaults the time to midnight in order to account for the entire day.

func (Hardware) GetDatacenter 

func (r Hardware) GetDatacenter() (resp datatypes.Location, err error)

Retrieve Information regarding the datacenter in which a piece of hardware resides.

func (Hardware) GetDatacenterName 

func (r Hardware) GetDatacenterName() (resp string, err error)

Retrieve The name of the datacenter in which a piece of hardware resides.

func (Hardware) GetDaysInSparePool 

func (r Hardware) GetDaysInSparePool() (resp int, err error)

Retrieve Number of day(s) a server have been in spare pool.

func (Hardware) GetDownlinkHardware 

func (r Hardware) GetDownlinkHardware() (resp []datatypes.Hardware, err error)

Retrieve All hardware that has uplink network connections to a piece of hardware.

func (Hardware) GetDownlinkNetworkHardware 

func (r Hardware) GetDownlinkNetworkHardware() (resp []datatypes.Hardware, err error)

Retrieve All hardware that has uplink network connections to a piece of hardware.

func (Hardware) GetDownlinkServers 

func (r Hardware) GetDownlinkServers() (resp []datatypes.Hardware, err error)

Retrieve Information regarding all servers attached to a piece of network hardware.

func (Hardware) GetDownlinkVirtualGuests 

func (r Hardware) GetDownlinkVirtualGuests() (resp []datatypes.Virtual_Guest, err error)

Retrieve Information regarding all virtual guests attached to a piece of network hardware.

func (Hardware) GetDownstreamHardwareBindings 

func (r Hardware) GetDownstreamHardwareBindings() (resp []datatypes.Network_Component_Uplink_Hardware, err error)

Retrieve All hardware downstream from a network device.

func (Hardware) GetDownstreamNetworkHardware 

func (r Hardware) GetDownstreamNetworkHardware() (resp []datatypes.Hardware, err error)

Retrieve All network hardware downstream from the selected piece of hardware.

func (Hardware) GetDownstreamNetworkHardwareWithIncidents 

func (r Hardware) GetDownstreamNetworkHardwareWithIncidents() (resp []datatypes.Hardware, err error)

Retrieve All network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. [DEPRECATED]

func (Hardware) GetDownstreamServers 

func (r Hardware) GetDownstreamServers() (resp []datatypes.Hardware, err error)

Retrieve Information regarding all servers attached downstream to a piece of network hardware.

func (Hardware) GetDownstreamVirtualGuests 

func (r Hardware) GetDownstreamVirtualGuests() (resp []datatypes.Virtual_Guest, err error)

Retrieve Information regarding all virtual guests attached to a piece of network hardware.

func (Hardware) GetDriveControllers 

func (r Hardware) GetDriveControllers() (resp []datatypes.Hardware_Component, err error)

Retrieve The drive controllers contained within a piece of hardware.

func (Hardware) GetEvaultNetworkStorage 

func (r Hardware) GetEvaultNetworkStorage() (resp []datatypes.Network_Storage, err error)

Retrieve Information regarding a piece of hardware's associated EVault network storage service account.

func (Hardware) GetFirewallServiceComponent 

func (r Hardware) GetFirewallServiceComponent() (resp datatypes.Network_Component_Firewall, err error)

Retrieve Information regarding a piece of hardware's firewall services.

func (Hardware) GetFixedConfigurationPreset 

func (r Hardware) GetFixedConfigurationPreset() (resp datatypes.Product_Package_Preset, err error)

Retrieve Defines the fixed components in a fixed configuration bare metal server.

func (Hardware) GetFrontendIncomingBandwidth 

func (r Hardware) GetFrontendIncomingBandwidth(startDate *datatypes.Time, endDate *datatypes.Time) (resp datatypes.Float64, err error)

The ”'getFrontendIncomingBandwidth”' method retrieves the amount of incoming public network traffic used by a server between the given start and end date parameters. When entering the ”dateTime” parameter, only the month, day and year of the start and end dates are required - the time (hour, minute and second) are set to midnight by default and cannot be changed. The amount of bandwidth retrieved is measured in gigabytes (GB).

func (Hardware) GetFrontendNetworkComponents 

func (r Hardware) GetFrontendNetworkComponents() (resp []datatypes.Network_Component, err error)

Retrieve A piece of hardware's front-end or public network components.

func (Hardware) GetFrontendOutgoingBandwidth 

func (r Hardware) GetFrontendOutgoingBandwidth(startDate *datatypes.Time, endDate *datatypes.Time) (resp datatypes.Float64, err error)

The ”'getFrontendOutgoingBandwidth”' method retrieves the amount of outgoing public network traffic used by a server between the given start and end date parameters. The ”dateTime” parameter requires only the day, month and year to be entered - the time (hour, minute and second) are set to midnight be default in order to gather the data for the entire start and end date indicated in the parameter. The amount of bandwidth retrieved is measured in gigabytes (GB).

func (Hardware) GetFrontendRouters 

func (r Hardware) GetFrontendRouters() (resp []datatypes.Hardware, err error)

Retrieve A hardware's frontend or public router.

func (Hardware) GetFutureBillingItem added in v1.0.4 

func (r Hardware) GetFutureBillingItem() (resp datatypes.Billing_Item_Hardware, err error)

Retrieve Information regarding the future billing item for a server.

func (Hardware) GetGlobalIdentifier 

func (r Hardware) GetGlobalIdentifier() (resp string, err error)

Retrieve A hardware's universally unique identifier.

func (Hardware) GetHardDrives 

func (r Hardware) GetHardDrives() (resp []datatypes.Hardware_Component, err error)

Retrieve The hard drives contained within a piece of hardware.

func (Hardware) GetHardwareChassis 

func (r Hardware) GetHardwareChassis() (resp datatypes.Hardware_Chassis, err error)

Retrieve The chassis that a piece of hardware is housed in.

func (Hardware) GetHardwareFunction 

func (r Hardware) GetHardwareFunction() (resp datatypes.Hardware_Function, err error)

Retrieve A hardware's function.

func (Hardware) GetHardwareFunctionDescription 

func (r Hardware) GetHardwareFunctionDescription() (resp string, err error)

Retrieve A hardware's function.

func (Hardware) GetHardwareState added in v1.0.4 

func (r Hardware) GetHardwareState() (resp datatypes.Hardware_State, err error)

Retrieve A hardware's power/transaction state.

func (Hardware) GetHardwareStatus 

func (r Hardware) GetHardwareStatus() (resp datatypes.Hardware_Status, err error)

Retrieve A hardware's status.

func (Hardware) GetHasTrustedPlatformModuleBillingItemFlag 

func (r Hardware) GetHasTrustedPlatformModuleBillingItemFlag() (resp bool, err error)

Retrieve Determine in hardware object has TPM enabled.

func (Hardware) GetHostIpsSoftwareComponent 

func (r Hardware) GetHostIpsSoftwareComponent() (resp datatypes.Software_Component, err error)

Retrieve Information regarding a host IPS software component object.

func (Hardware) GetHourlyBandwidth 

func (r Hardware) GetHourlyBandwidth(mode *string, day *datatypes.Time) (resp []datatypes.Metric_Tracking_Object_Data, err error)

The ”'getHourlyBandwidth”' method retrieves all bandwidth updates hourly for the specified hardware. Because the potential number of data points can become excessive, the method limits the user to obtain data in 24-hour intervals. The required ”dateTime” parameter is used as the starting point for the query and will be calculated for the 24-hour period starting with the specified date and time. For example, entering a parameter of

'02/01/2008 0:00'

results in a return of all bandwidth data for the entire day of February 1, 2008, as 0:00 specifies a midnight start date. Please note that the time entered should be completed using a 24-hour clock (military time, astronomical time).

For data spanning more than a single 24-hour period, refer to the getBandwidthData function on the metricTrackingObject for the piece of hardware.

func (Hardware) GetHourlyBillingFlag 

func (r Hardware) GetHourlyBillingFlag() (resp bool, err error)

Retrieve A server's hourly billing status.

func (Hardware) GetInboundBandwidthUsage 

func (r Hardware) GetInboundBandwidthUsage() (resp datatypes.Float64, err error)

Retrieve The sum of all the inbound network traffic data for the last 30 days.

func (Hardware) GetInboundPublicBandwidthUsage 

func (r Hardware) GetInboundPublicBandwidthUsage() (resp datatypes.Float64, err error)

Retrieve The total public inbound bandwidth for this hardware for the current billing cycle.

func (Hardware) GetIsBillingTermChangeAvailableFlag added in v1.0.4 

func (r Hardware) GetIsBillingTermChangeAvailableFlag() (resp bool, err error)

Retrieve Whether or not this hardware object is eligible to change to term billing.

func (Hardware) GetIsCloudReadyNodeCertified added in v1.1.6 

func (r Hardware) GetIsCloudReadyNodeCertified() (resp bool, err error)

Retrieve Determine if hardware object has the IBM_CLOUD_READY_NODE_CERTIFIED attribute.

func (Hardware) GetLastTransaction 

func (r Hardware) GetLastTransaction() (resp datatypes.Provisioning_Version1_Transaction, err error)

Retrieve Information regarding the last transaction a server performed.

func (Hardware) GetLatestNetworkMonitorIncident 

func (r Hardware) GetLatestNetworkMonitorIncident() (resp datatypes.Network_Monitor_Version1_Incident, err error)

Retrieve A piece of hardware's latest network monitoring incident.

func (Hardware) GetLocation 

func (r Hardware) GetLocation() (resp datatypes.Location, err error)

Retrieve Where a piece of hardware is located within SoftLayer's location hierarchy.

func (Hardware) GetLocationPathString 

func (r Hardware) GetLocationPathString() (resp string, err error)

Retrieve

func (Hardware) GetLockboxNetworkStorage 

func (r Hardware) GetLockboxNetworkStorage() (resp datatypes.Network_Storage, err error)

Retrieve Information regarding a lockbox account associated with a server.

func (Hardware) GetManagedResourceFlag 

func (r Hardware) GetManagedResourceFlag() (resp bool, err error)

Retrieve A flag indicating that the hardware is a managed resource.

func (Hardware) GetMemory 

func (r Hardware) GetMemory() (resp []datatypes.Hardware_Component, err error)

Retrieve Information regarding a piece of hardware's memory.

func (Hardware) GetMemoryCapacity 

func (r Hardware) GetMemoryCapacity() (resp uint, err error)

Retrieve The amount of memory a piece of hardware has, measured in gigabytes.

func (Hardware) GetMetricTrackingObject 

func (r Hardware) GetMetricTrackingObject() (resp datatypes.Metric_Tracking_Object, err error)

Retrieve A piece of hardware's metric tracking object.

func (Hardware) GetModules 

func (r Hardware) GetModules() (resp []datatypes.Hardware_Component, err error)

Retrieve

func (Hardware) GetMonitoringRobot 

func (r Hardware) GetMonitoringRobot() (resp datatypes.Monitoring_Robot, err error)

Retrieve

func (Hardware) GetMonitoringServiceComponent 

func (r Hardware) GetMonitoringServiceComponent() (resp datatypes.Network_Monitor_Version1_Query_Host_Stratum, err error)

Retrieve Information regarding a piece of hardware's network monitoring services.

func (Hardware) GetMonitoringServiceEligibilityFlag 

func (r Hardware) GetMonitoringServiceEligibilityFlag() (resp bool, err error)

Retrieve

func (Hardware) GetMotherboard 

func (r Hardware) GetMotherboard() (resp datatypes.Hardware_Component, err error)

Retrieve Information regarding a piece of hardware's motherboard.

func (Hardware) GetNetworkCards 

func (r Hardware) GetNetworkCards() (resp []datatypes.Hardware_Component, err error)

Retrieve Information regarding a piece of hardware's network cards.

func (Hardware) GetNetworkComponents 

func (r Hardware) GetNetworkComponents() (resp []datatypes.Network_Component, err error)

Retrieve Returns a hardware's network components.

func (Hardware) GetNetworkGatewayMember 

func (r Hardware) GetNetworkGatewayMember() (resp datatypes.Network_Gateway_Member, err error)

Retrieve The gateway member if this device is part of a network gateway.

func (Hardware) GetNetworkGatewayMemberFlag 

func (r Hardware) GetNetworkGatewayMemberFlag() (resp bool, err error)

Retrieve Whether or not this device is part of a network gateway.

func (Hardware) GetNetworkManagementIpAddress 

func (r Hardware) GetNetworkManagementIpAddress() (resp string, err error)

Retrieve A piece of hardware's network management IP address.

func (Hardware) GetNetworkMonitorAttachedDownHardware 

func (r Hardware) GetNetworkMonitorAttachedDownHardware() (resp []datatypes.Hardware, err error)

Retrieve All servers with failed monitoring that are attached downstream to a piece of hardware.

func (Hardware) GetNetworkMonitorAttachedDownVirtualGuests 

func (r Hardware) GetNetworkMonitorAttachedDownVirtualGuests() (resp []datatypes.Virtual_Guest, err error)

Retrieve Virtual guests that are attached downstream to a hardware that have failed monitoring

func (Hardware) GetNetworkMonitorIncidents 

func (r Hardware) GetNetworkMonitorIncidents() (resp []datatypes.Network_Monitor_Version1_Incident, err error)

Retrieve The status of all of a piece of hardware's network monitoring incidents.

func (Hardware) GetNetworkMonitors 

func (r Hardware) GetNetworkMonitors() (resp []datatypes.Network_Monitor_Version1_Query_Host, err error)

Retrieve Information regarding a piece of hardware's network monitors.

func (Hardware) GetNetworkStatus 

func (r Hardware) GetNetworkStatus() (resp string, err error)

Retrieve The value of a hardware's network status attribute. [DEPRECATED]

func (Hardware) GetNetworkStatusAttribute 

func (r Hardware) GetNetworkStatusAttribute() (resp datatypes.Hardware_Attribute, err error)

Retrieve The hardware's related network status attribute. [DEPRECATED]

func (Hardware) GetNetworkStorage 

func (r Hardware) GetNetworkStorage() (resp []datatypes.Network_Storage, err error)

Retrieve Information regarding a piece of hardware's associated network storage service account.

func (Hardware) GetNetworkVlans 

func (r Hardware) GetNetworkVlans() (resp []datatypes.Network_Vlan, err error)

Retrieve The network virtual LANs (VLANs) associated with a piece of hardware's network components.

func (Hardware) GetNextBillingCycleBandwidthAllocation 

func (r Hardware) GetNextBillingCycleBandwidthAllocation() (resp datatypes.Float64, err error)

Retrieve A hardware's allotted bandwidth for the next billing cycle (measured in GB).

func (Hardware) GetNotesHistory 

func (r Hardware) GetNotesHistory() (resp []datatypes.Hardware_Note, err error)

Retrieve

func (Hardware) GetNvRamCapacity 

func (r Hardware) GetNvRamCapacity() (resp uint, err error)

Retrieve The amount of non-volatile memory a piece of hardware has, measured in gigabytes.

func (Hardware) GetNvRamComponentModels 

func (r Hardware) GetNvRamComponentModels() (resp []datatypes.Hardware_Component_Model, err error)

Retrieve

func (Hardware) GetObject 

func (r Hardware) GetObject() (resp datatypes.Hardware, err error)

getObject retrieves the SoftLayer_Hardware object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Hardware service. You can only retrieve the account that your portal user is assigned to.

func (Hardware) GetOperatingSystem 

func (r Hardware) GetOperatingSystem() (resp datatypes.Software_Component_OperatingSystem, err error)

Retrieve Information regarding a piece of hardware's operating system.

func (Hardware) GetOperatingSystemReferenceCode 

func (r Hardware) GetOperatingSystemReferenceCode() (resp string, err error)

Retrieve A hardware's operating system software description.

func (Hardware) GetOutboundBandwidthUsage 

func (r Hardware) GetOutboundBandwidthUsage() (resp datatypes.Float64, err error)

Retrieve The sum of all the outbound network traffic data for the last 30 days.

func (Hardware) GetOutboundPublicBandwidthUsage 

func (r Hardware) GetOutboundPublicBandwidthUsage() (resp datatypes.Float64, err error)

Retrieve The total public outbound bandwidth for this hardware for the current billing cycle.

func (Hardware) GetParentBay 

func (r Hardware) GetParentBay() (resp datatypes.Hardware_Blade, err error)

Retrieve Blade Bay

func (Hardware) GetParentHardware 

func (r Hardware) GetParentHardware() (resp datatypes.Hardware, err error)

Retrieve Parent Hardware.

func (Hardware) GetPointOfPresenceLocation 

func (r Hardware) GetPointOfPresenceLocation() (resp datatypes.Location, err error)

Retrieve Information regarding the Point of Presence (PoP) location in which a piece of hardware resides.

func (Hardware) GetPowerComponents 

func (r Hardware) GetPowerComponents() (resp []datatypes.Hardware_Power_Component, err error)

Retrieve The power components for a hardware object.

func (Hardware) GetPowerSupply 

func (r Hardware) GetPowerSupply() (resp []datatypes.Hardware_Component, err error)

Retrieve Information regarding a piece of hardware's power supply.

func (Hardware) GetPrimaryBackendIpAddress 

func (r Hardware) GetPrimaryBackendIpAddress() (resp string, err error)

Retrieve The hardware's primary private IP address.

func (Hardware) GetPrimaryBackendNetworkComponent 

func (r Hardware) GetPrimaryBackendNetworkComponent() (resp datatypes.Network_Component, err error)

Retrieve Information regarding the hardware's primary back-end network component.

func (Hardware) GetPrimaryIpAddress 

func (r Hardware) GetPrimaryIpAddress() (resp string, err error)

Retrieve The hardware's primary public IP address.

func (Hardware) GetPrimaryNetworkComponent 

func (r Hardware) GetPrimaryNetworkComponent() (resp datatypes.Network_Component, err error)

Retrieve Information regarding the hardware's primary public network component.

func (Hardware) GetPrivateBandwidthData 

func (r Hardware) GetPrivateBandwidthData(startTime *int, endTime *int) (resp []datatypes.Metric_Tracking_Object_Data, err error)

Retrieve this server's private bandwidth data. If no timeframe is specified then getPrivateBandwidthData retrieves the last 24 hours of public bandwidth usage.

func (Hardware) GetPrivateNetworkOnlyFlag 

func (r Hardware) GetPrivateNetworkOnlyFlag() (resp bool, err error)

Retrieve Whether the hardware only has access to the private network.

func (Hardware) GetProcessorCoreAmount 

func (r Hardware) GetProcessorCoreAmount() (resp uint, err error)

Retrieve The total number of processor cores, summed from all processors that are attached to a piece of hardware

func (Hardware) GetProcessorPhysicalCoreAmount 

func (r Hardware) GetProcessorPhysicalCoreAmount() (resp uint, err error)

Retrieve The total number of physical processor cores, summed from all processors that are attached to a piece of hardware

func (Hardware) GetProcessors 

func (r Hardware) GetProcessors() (resp []datatypes.Hardware_Component, err error)

Retrieve Information regarding a piece of hardware's processors.

func (Hardware) GetPublicBandwidthData 

func (r Hardware) GetPublicBandwidthData(startTime *int, endTime *int) (resp []datatypes.Metric_Tracking_Object_Data, err error)

Retrieve this server's public bandwidth data. If no timeframe is specified then getPublicBandwidthData retrieves the last 24 hours of public bandwidth usage.

func (Hardware) GetRack 

func (r Hardware) GetRack() (resp datatypes.Location, err error)

Retrieve

func (Hardware) GetRaidControllers 

func (r Hardware) GetRaidControllers() (resp []datatypes.Hardware_Component, err error)

Retrieve The RAID controllers contained within a piece of hardware.

func (Hardware) GetRecentEvents 

func (r Hardware) GetRecentEvents() (resp []datatypes.Notification_Occurrence_Event, err error)

Retrieve Recent events that impact this hardware.

func (Hardware) GetRemoteManagementAccounts 

func (r Hardware) GetRemoteManagementAccounts() (resp []datatypes.Hardware_Component_RemoteManagement_User, err error)

Retrieve User credentials to issue commands and/or interact with the server's remote management card.

func (Hardware) GetRemoteManagementComponent 

func (r Hardware) GetRemoteManagementComponent() (resp datatypes.Network_Component, err error)

Retrieve A hardware's associated remote management component. This is normally IPMI.

func (Hardware) GetResourceConfigurations 

func (r Hardware) GetResourceConfigurations() (resp []datatypes.Hardware_Resource_Configuration, err error)

Retrieve

func (Hardware) GetResourceGroupMemberReferences 

func (r Hardware) GetResourceGroupMemberReferences() (resp []datatypes.Resource_Group_Member, err error)

Retrieve

func (Hardware) GetResourceGroupRoles 

func (r Hardware) GetResourceGroupRoles() (resp []datatypes.Resource_Group_Role, err error)

Retrieve

func (Hardware) GetResourceGroups 

func (r Hardware) GetResourceGroups() (resp []datatypes.Resource_Group, err error)

Retrieve The resource groups in which this hardware is a member.

func (Hardware) GetRouters 

func (r Hardware) GetRouters() (resp []datatypes.Hardware, err error)

Retrieve A hardware's routers.

func (Hardware) GetSecurityScanRequests 

func (r Hardware) GetSecurityScanRequests() (resp []datatypes.Network_Security_Scanner_Request, err error)

Retrieve Information regarding a piece of hardware's vulnerability scan requests.

func (Hardware) GetSensorData 

func (r Hardware) GetSensorData() (resp []datatypes.Container_RemoteManagement_SensorReading, err error)

The ”'getSensorData”' method retrieves a server's hardware state via its internal sensors. Remote sensor data is transmitted to the SoftLayer API by way of the server's remote management card. Sensor data measures various information, including system temperatures, voltages and other local server settings. Sensor data is cached for 30 second; calls made to this method for the same server within 30 seconds of each other will result in the same data being returned. To ensure that the data retrieved retrieves snapshot of varied data, make calls greater than 30 seconds apart.

func (Hardware) GetSensorDataWithGraphs 

func (r Hardware) GetSensorDataWithGraphs() (resp datatypes.Container_RemoteManagement_SensorReadingsWithGraphs, err error)

The ”'getSensorDataWithGraphs”' method retrieves the raw data returned from the server's remote management card. Along with raw data, graphs for the CPU and system temperatures and fan speeds are also returned. For more details on what information is returned, refer to the ”getSensorData” method.

func (Hardware) GetServerFanSpeedGraphs 

func (r Hardware) GetServerFanSpeedGraphs() (resp []datatypes.Container_RemoteManagement_Graphs_SensorSpeed, err error)

The ”'getServerFanSpeedGraphs”' method retrieves the server's fan speeds and displays the speeds using tachometer graphs. data used to construct these graphs is retrieved from the server's remote management card. Each graph returned will have an associated title.

func (Hardware) GetServerPowerState 

func (r Hardware) GetServerPowerState() (resp string, err error)

The ”'getPowerState”' method retrieves the power state for the selected server. The server's power status is retrieved from its remote management card. This method returns "on", for a server that has been powered on, or "off" for servers powered off.

func (Hardware) GetServerRoom 

func (r Hardware) GetServerRoom() (resp datatypes.Location, err error)

Retrieve Information regarding the server room in which the hardware is located.

func (Hardware) GetServerTemperatureGraphs 

func (r Hardware) GetServerTemperatureGraphs() (resp []datatypes.Container_RemoteManagement_Graphs_SensorTemperature, err error)

The ”'getServerTemperatureGraphs”' retrieves the server's temperatures and displays the various temperatures using thermometer graphs. Temperatures retrieved are CPU temperature(s) and system temperatures. Data used to construct the graphs is retrieved from the server's remote management card. All graphs returned will have an associated title.

func (Hardware) GetServiceProvider 

func (r Hardware) GetServiceProvider() (resp datatypes.Service_Provider, err error)

Retrieve Information regarding the piece of hardware's service provider.

func (Hardware) GetSoftwareComponents 

func (r Hardware) GetSoftwareComponents() (resp []datatypes.Software_Component, err error)

Retrieve Information regarding a piece of hardware's installed software.

func (Hardware) GetSparePoolBillingItem 

func (r Hardware) GetSparePoolBillingItem() (resp datatypes.Billing_Item_Hardware, err error)

Retrieve Information regarding the billing item for a spare pool server.

func (Hardware) GetSshKeys 

func (r Hardware) GetSshKeys() (resp []datatypes.Security_Ssh_Key, err error)

Retrieve SSH keys to be installed on the server during provisioning or an OS reload.

func (Hardware) GetStorageGroups added in v1.0.2 

func (r Hardware) GetStorageGroups() (resp []datatypes.Configuration_Storage_Group, err error)

Retrieve

func (Hardware) GetStorageNetworkComponents 

func (r Hardware) GetStorageNetworkComponents() (resp []datatypes.Network_Component, err error)

Retrieve A piece of hardware's private storage network components. [Deprecated]

func (Hardware) GetTagReferences 

func (r Hardware) GetTagReferences() (resp []datatypes.Tag_Reference, err error)

Retrieve

func (Hardware) GetTopLevelLocation 

func (r Hardware) GetTopLevelLocation() (resp datatypes.Location, err error)

Retrieve

func (Hardware) GetTransactionHistory 

func (r Hardware) GetTransactionHistory() (resp []datatypes.Provisioning_Version1_Transaction_History, err error)

This method will query transaction history for a piece of hardware.

func (Hardware) GetUpgradeItemPrices 

func (r Hardware) GetUpgradeItemPrices() (resp []datatypes.Product_Item_Price, err error)

Retrieve a list of upgradeable items available to this piece of hardware. Currently, getUpgradeItemPrices retrieves upgrades available for a server's memory, hard drives, network port speed, bandwidth allocation and GPUs.

func (Hardware) GetUpgradeRequest 

func (r Hardware) GetUpgradeRequest() (resp datatypes.Product_Upgrade_Request, err error)

Retrieve An account's associated upgrade request object, if any.

func (Hardware) GetUpgradeableActiveComponents added in v1.1.2 

func (r Hardware) GetUpgradeableActiveComponents() (resp []datatypes.Hardware_Component, err error)

Retrieve A piece of hardware's active upgradeable physical components.

func (Hardware) GetUplinkHardware 

func (r Hardware) GetUplinkHardware() (resp datatypes.Hardware, err error)

Retrieve The network device connected to a piece of hardware.

func (Hardware) GetUplinkNetworkComponents 

func (r Hardware) GetUplinkNetworkComponents() (resp []datatypes.Network_Component, err error)

Retrieve Information regarding the network component that is one level higher than a piece of hardware on the network infrastructure.

func (Hardware) GetUserData 

func (r Hardware) GetUserData() (resp []datatypes.Hardware_Attribute, err error)

Retrieve An array containing a single string of custom user data for a hardware order. Max size is 16 kb.

func (Hardware) GetVirtualChassis 

func (r Hardware) GetVirtualChassis() (resp datatypes.Hardware_Group, err error)

Retrieve Information regarding the virtual chassis for a piece of hardware.

func (Hardware) GetVirtualChassisSiblings 

func (r Hardware) GetVirtualChassisSiblings() (resp []datatypes.Hardware, err error)

Retrieve Information regarding the virtual chassis siblings for a piece of hardware.

func (Hardware) GetVirtualHost 

func (r Hardware) GetVirtualHost() (resp datatypes.Virtual_Host, err error)

Retrieve A piece of hardware's virtual host record.

func (Hardware) GetVirtualLicenses 

func (r Hardware) GetVirtualLicenses() (resp []datatypes.Software_VirtualLicense, err error)

Retrieve Information regarding a piece of hardware's virtual software licenses.

func (Hardware) GetVirtualRack 

func (r Hardware) GetVirtualRack() (resp datatypes.Network_Bandwidth_Version1_Allotment, err error)

Retrieve Information regarding the bandwidth allotment to which a piece of hardware belongs.

func (Hardware) GetVirtualRackId 

func (r Hardware) GetVirtualRackId() (resp int, err error)

Retrieve The name of the bandwidth allotment belonging to a piece of hardware.

func (Hardware) GetVirtualRackName 

func (r Hardware) GetVirtualRackName() (resp string, err error)

Retrieve The name of the bandwidth allotment belonging to a piece of hardware.

func (Hardware) GetVirtualizationPlatform 

func (r Hardware) GetVirtualizationPlatform() (resp datatypes.Software_Component, err error)

Retrieve A piece of hardware's virtualization platform software.

func (Hardware) Id 

func (r Hardware) Id(id int) Hardware

func (Hardware) ImportVirtualHost 

func (r Hardware) ImportVirtualHost() (resp datatypes.Virtual_Host, err error)

The ”'importVirtualHost”' method attempts to import the host record for the virtualization platform running on a server.

func (Hardware) IsPingable 

func (r Hardware) IsPingable() (resp bool, err error)

The ”'isPingable”' method issues a ping command to the selected server and returns the result of the ping command. This boolean return value displays ”true” upon successful ping or ”false” for a failed ping.

func (Hardware) Limit 

func (r Hardware) Limit(limit int) Hardware

func (Hardware) Mask 

func (r Hardware) Mask(mask string) Hardware

func (Hardware) Offset 

func (r Hardware) Offset(offset int) Hardware

func (Hardware) Ping 

func (r Hardware) Ping() (resp string, err error)

Issues a ping command to the server and returns the ping response.

func (Hardware) PowerCycle 

func (r Hardware) PowerCycle() (resp bool, err error)

The ”'powerCycle”' method completes a power off and power on of the server successively in one command. The power cycle command is equivalent to unplugging the server from the power strip and then plugging the server back in. ”'This method should only be used when all other options have been exhausted”'. Additional remote management commands may not be executed if this command was successfully issued within the last 20 minutes to avoid server failure. Remote management commands include:

rebootSoft rebootHard powerOn powerOff powerCycle

func (Hardware) PowerOff 

func (r Hardware) PowerOff() (resp bool, err error)

This method will power off the server via the server's remote management card.

func (Hardware) PowerOn 

func (r Hardware) PowerOn() (resp bool, err error)

The ”'powerOn”' method powers on a server via its remote management card. This boolean return value returns ”true” upon successful execution and ”false” if unsuccessful. Other remote management commands may not be issued in this command was successfully completed within the last 20 minutes to avoid server failure. Remote management commands include:

rebootSoft rebootHard powerOn powerOff powerCycle

func (Hardware) RebootDefault 

func (r Hardware) RebootDefault() (resp bool, err error)

The ”'rebootDefault”' method attempts to reboot the server by issuing a soft reboot, or reset, command to the server's remote management card. if the reset attempt is unsuccessful, a power cycle command will be issued via the power strip. The power cycle command is equivalent to unplugging the server from the power strip and then plugging the server back in. If the reset was successful within the last 20 minutes, another remote management command cannot be completed to avoid server failure. Remote management commands include:

rebootSoft rebootHard powerOn powerOff powerCycle

func (Hardware) RebootHard 

func (r Hardware) RebootHard() (resp bool, err error)

The ”'rebootHard”' method reboots the server by issuing a cycle command to the server's remote management card. A hard reboot is equivalent to pressing the ”Reset” button on a server - it is issued immediately and will not allow processes to shut down prior to the reboot. Completing a hard reboot may initiate system disk checks upon server reboot, causing the boot up to take longer than normally expected.

Remote management commands are unable to be executed if a reboot has been issued successfully within the last 20 minutes to avoid server failure. Remote management commands include:

rebootSoft rebootHard powerOn powerOff powerCycle

func (Hardware) RebootSoft 

func (r Hardware) RebootSoft() (resp bool, err error)

The ”'rebootSoft”' method reboots the server by issuing a reset command to the server's remote management card via soft reboot. When executing a soft reboot, servers allow all processes to shut down completely before rebooting. Remote management commands are unable to be issued within 20 minutes of issuing a successful soft reboot in order to avoid server failure. Remote management commands include:

rebootSoft rebootHard powerOn powerOff powerCycle

func (Hardware) RefreshDeviceStatus added in v1.0.5 

func (r Hardware) RefreshDeviceStatus() (resp datatypes.Hardware_State, err error)

no documentation yet

func (Hardware) RemoveAccessToNetworkStorage 

func (r Hardware) RemoveAccessToNetworkStorage(networkStorageTemplateObject *datatypes.Network_Storage) (resp bool, err error)

This method is used to remove access to s SoftLayer_Network_Storage volumes that supports host- or network-level access control.

func (Hardware) RemoveAccessToNetworkStorageList 

func (r Hardware) RemoveAccessToNetworkStorageList(networkStorageTemplateObjects []datatypes.Network_Storage) (resp bool, err error)

This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support host- or network-level access control.

func (Hardware) RemoveTags 

func (r Hardware) RemoveTags(tags *string) (resp bool, err error)

no documentation yet

func (Hardware) SetTags 

func (r Hardware) SetTags(tags *string) (resp bool, err error)

no documentation yet

func (Hardware) UpdateIpmiPassword 

func (r Hardware) UpdateIpmiPassword(password *string) (resp bool, err error)

This method will update the root IPMI password on this SoftLayer_Hardware.

type Hardware_Benchmark_Certification 

type Hardware_Benchmark_Certification struct {
	Session session.SLSession
	Options sl.Options
}

The SoftLayer_Hardware_Benchmark_Certification data type contains general information relating to a single SoftLayer hardware benchmark certification document.

func GetHardwareBenchmarkCertificationService 

func GetHardwareBenchmarkCertificationService(sess session.SLSession) Hardware_Benchmark_Certification

GetHardwareBenchmarkCertificationService returns an instance of the Hardware_Benchmark_Certification SoftLayer service

func (Hardware_Benchmark_Certification) Filter 

func (r Hardware_Benchmark_Certification) Filter(filter string) Hardware_Benchmark_Certification

func (Hardware_Benchmark_Certification) GetAccount 

func (r Hardware_Benchmark_Certification) GetAccount() (resp datatypes.Account, err error)

Retrieve Information regarding a benchmark certification result's associated SoftLayer customer account.

func (Hardware_Benchmark_Certification) GetHardware 

func (r Hardware_Benchmark_Certification) GetHardware() (resp datatypes.Hardware, err error)

Retrieve Information regarding the piece of hardware on which a benchmark certification test was performed.

func (Hardware_Benchmark_Certification) GetObject 

func (r Hardware_Benchmark_Certification) GetObject() (resp datatypes.Hardware_Benchmark_Certification, err error)

getObject retrieves the SoftLayer_Hardware_Benchmark_Certification object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Hardware_Benchmark_Certification service.

func (Hardware_Benchmark_Certification) GetResultFile 

func (r Hardware_Benchmark_Certification) GetResultFile() (resp []byte, err error)

Attempt to retrieve the file associated with a benchmark certification result, if such a file exists. If there is no file for this benchmark certification result, calling this method throws an exception. The "getResultFile" method attempts to retrieve the file associated with a benchmark certification result, if such a file exists. If no file exists for the benchmark certification, an exception is thrown.

func (Hardware_Benchmark_Certification) Id 

func (r Hardware_Benchmark_Certification) Id(id int) Hardware_Benchmark_Certification

func (Hardware_Benchmark_Certification) Limit 

func (r Hardware_Benchmark_Certification) Limit(limit int) Hardware_Benchmark_Certification

func (Hardware_Benchmark_Certification) Mask 

func (r Hardware_Benchmark_Certification) Mask(mask string) Hardware_Benchmark_Certification

func (Hardware_Benchmark_Certification) Offset 

func (r Hardware_Benchmark_Certification) Offset(offset int) Hardware_Benchmark_Certification

type Hardware_Blade 

type Hardware_Blade struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetHardwareBladeService 

func GetHardwareBladeService(sess session.SLSession) Hardware_Blade

GetHardwareBladeService returns an instance of the Hardware_Blade SoftLayer service

func (Hardware_Blade) Filter 

func (r Hardware_Blade) Filter(filter string) Hardware_Blade

func (Hardware_Blade) GetHardwareChild 

func (r Hardware_Blade) GetHardwareChild() (resp datatypes.Hardware, err error)

Retrieve

func (Hardware_Blade) GetHardwareParent 

func (r Hardware_Blade) GetHardwareParent() (resp datatypes.Hardware, err error)

Retrieve

func (Hardware_Blade) GetObject 

func (r Hardware_Blade) GetObject() (resp datatypes.Hardware_Blade, err error)

no documentation yet

func (Hardware_Blade) Id 

func (r Hardware_Blade) Id(id int) Hardware_Blade

func (Hardware_Blade) Limit 

func (r Hardware_Blade) Limit(limit int) Hardware_Blade

func (Hardware_Blade) Mask 

func (r Hardware_Blade) Mask(mask string) Hardware_Blade

func (Hardware_Blade) Offset 

func (r Hardware_Blade) Offset(offset int) Hardware_Blade

type Hardware_Component_Locator 

type Hardware_Component_Locator struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetHardwareComponentLocatorService 

func GetHardwareComponentLocatorService(sess session.SLSession) Hardware_Component_Locator

GetHardwareComponentLocatorService returns an instance of the Hardware_Component_Locator SoftLayer service

func (Hardware_Component_Locator) Filter 

func (r Hardware_Component_Locator) Filter(filter string) Hardware_Component_Locator

func (Hardware_Component_Locator) GetGenericComponentModelAvailability 

func (r Hardware_Component_Locator) GetGenericComponentModelAvailability(genericComponentModelIds []int) (resp []datatypes.Hardware_Component_Locator_Result, err error)

no documentation yet

func (Hardware_Component_Locator) GetPackageItemsAvailability 

func (r Hardware_Component_Locator) GetPackageItemsAvailability(packageId *int) (resp []datatypes.Hardware_Component_Locator_Result, err error)

no documentation yet

func (Hardware_Component_Locator) GetServerPackageAvailability 

func (r Hardware_Component_Locator) GetServerPackageAvailability() (resp []datatypes.Hardware_Component_Locator_Result, err error)

no documentation yet

func (Hardware_Component_Locator) Id 

func (r Hardware_Component_Locator) Id(id int) Hardware_Component_Locator

func (Hardware_Component_Locator) Limit 

func (r Hardware_Component_Locator) Limit(limit int) Hardware_Component_Locator

func (Hardware_Component_Locator) Mask 

func (r Hardware_Component_Locator) Mask(mask string) Hardware_Component_Locator

func (Hardware_Component_Locator) Offset 

func (r Hardware_Component_Locator) Offset(offset int) Hardware_Component_Locator

type Hardware_Component_Model 

type Hardware_Component_Model struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetHardwareComponentModelService 

func GetHardwareComponentModelService(sess session.SLSession) Hardware_Component_Model

GetHardwareComponentModelService returns an instance of the Hardware_Component_Model SoftLayer service

func (Hardware_Component_Model) Filter 

func (r Hardware_Component_Model) Filter(filter string) Hardware_Component_Model

func (Hardware_Component_Model) GetArchitectureType 

func (r Hardware_Component_Model) GetArchitectureType() (resp datatypes.Hardware_Component_Model_Architecture_Type, err error)

Retrieve

func (Hardware_Component_Model) GetAttributes 

func (r Hardware_Component_Model) GetAttributes() (resp []datatypes.Hardware_Component_Model_Attribute, err error)

Retrieve

func (Hardware_Component_Model) GetCompatibleArrayTypes 

func (r Hardware_Component_Model) GetCompatibleArrayTypes() (resp []datatypes.Configuration_Storage_Group_Array_Type, err error)

Retrieve

func (Hardware_Component_Model) GetCompatibleChildComponentModels 

func (r Hardware_Component_Model) GetCompatibleChildComponentModels() (resp []datatypes.Hardware_Component_Model, err error)

Retrieve All the component models that are compatible with a hardware component model.

func (Hardware_Component_Model) GetCompatibleParentComponentModels 

func (r Hardware_Component_Model) GetCompatibleParentComponentModels() (resp []datatypes.Hardware_Component_Model, err error)

Retrieve All the component models that a hardware component model is compatible with.

func (Hardware_Component_Model) GetFirmwareQuantity 

func (r Hardware_Component_Model) GetFirmwareQuantity() (resp uint, err error)

Retrieve

func (Hardware_Component_Model) GetFirmwares 

func (r Hardware_Component_Model) GetFirmwares() (resp []datatypes.Hardware_Component_Firmware, err error)

Retrieve

func (Hardware_Component_Model) GetHardwareComponents 

func (r Hardware_Component_Model) GetHardwareComponents() (resp []datatypes.Hardware_Component, err error)

Retrieve A hardware component model's physical components in inventory.

func (Hardware_Component_Model) GetHardwareGenericComponentModel 

func (r Hardware_Component_Model) GetHardwareGenericComponentModel() (resp datatypes.Hardware_Component_Model_Generic, err error)

Retrieve The non-vendor specific generic component model for a hardware component model.

func (Hardware_Component_Model) GetInfinibandCompatibleAttribute 

func (r Hardware_Component_Model) GetInfinibandCompatibleAttribute() (resp datatypes.Hardware_Component_Model_Attribute, err error)

Retrieve

func (Hardware_Component_Model) GetIsFlexSkuCompatible 

func (r Hardware_Component_Model) GetIsFlexSkuCompatible() (resp bool, err error)

Retrieve

func (Hardware_Component_Model) GetIsInfinibandCompatible 

func (r Hardware_Component_Model) GetIsInfinibandCompatible() (resp bool, err error)

Retrieve

func (Hardware_Component_Model) GetObject 

func (r Hardware_Component_Model) GetObject() (resp datatypes.Hardware_Component_Model, err error)

getObject retrieves the SoftLayer_Hardware_Component_Model object.

func (Hardware_Component_Model) GetQualifiedFirmwares added in v1.1.2 

func (r Hardware_Component_Model) GetQualifiedFirmwares() (resp []datatypes.Hardware_Component_Firmware, err error)

Retrieve

func (Hardware_Component_Model) GetRebootTime 

func (r Hardware_Component_Model) GetRebootTime() (resp datatypes.Hardware_Component_Motherboard_Reboot_Time, err error)

Retrieve A motherboard's average reboot time.

func (Hardware_Component_Model) GetType 

func (r Hardware_Component_Model) GetType() (resp string, err error)

Retrieve A hardware component model's type.

func (Hardware_Component_Model) GetValidAttributeTypes 

func (r Hardware_Component_Model) GetValidAttributeTypes() (resp []datatypes.Hardware_Component_Model_Attribute_Type, err error)

Retrieve The types of attributes that are allowed for a given hardware component model.

func (Hardware_Component_Model) GetVmwareQualifiedFirmwares added in v1.1.5 

func (r Hardware_Component_Model) GetVmwareQualifiedFirmwares() (resp []datatypes.Hardware_Component_Firmware, err error)

Retrieve

func (Hardware_Component_Model) Id 

func (r Hardware_Component_Model) Id(id int) Hardware_Component_Model

func (Hardware_Component_Model) Limit 

func (r Hardware_Component_Model) Limit(limit int) Hardware_Component_Model

func (Hardware_Component_Model) Mask 

func (r Hardware_Component_Model) Mask(mask string) Hardware_Component_Model

func (Hardware_Component_Model) Offset 

func (r Hardware_Component_Model) Offset(offset int) Hardware_Component_Model

type Hardware_Component_Partition_OperatingSystem 

type Hardware_Component_Partition_OperatingSystem struct {
	Session session.SLSession
	Options sl.Options
}

The SoftLayer_Hardware_Component_Partition_OperatingSystem data type contains general information relating to a single SoftLayer Operating System Partition Template.

func GetHardwareComponentPartitionOperatingSystemService 

func GetHardwareComponentPartitionOperatingSystemService(sess session.SLSession) Hardware_Component_Partition_OperatingSystem

GetHardwareComponentPartitionOperatingSystemService returns an instance of the Hardware_Component_Partition_OperatingSystem SoftLayer service

func (Hardware_Component_Partition_OperatingSystem) Filter 

func (r Hardware_Component_Partition_OperatingSystem) Filter(filter string) Hardware_Component_Partition_OperatingSystem

func (Hardware_Component_Partition_OperatingSystem) GetAllObjects 

func (r Hardware_Component_Partition_OperatingSystem) GetAllObjects() (resp []datatypes.Hardware_Component_Partition_OperatingSystem, err error)

no documentation yet

func (Hardware_Component_Partition_OperatingSystem) GetByDescription 

func (r Hardware_Component_Partition_OperatingSystem) GetByDescription(description *string) (resp datatypes.Hardware_Component_Partition_OperatingSystem, err error)

The ”'getByDescription”' method retrieves all possible partition templates based on the description (required parameter) entered when calling the method. The description is typically the operating system's name. Current recognized values include 'linux', 'windows', 'freebsd', and 'Debian'.

func (Hardware_Component_Partition_OperatingSystem) GetObject 

func (r Hardware_Component_Partition_OperatingSystem) GetObject() (resp datatypes.Hardware_Component_Partition_OperatingSystem, err error)

getObject retrieves the SoftLayer_Hardware_Component_Partition_OperatingSystem object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Hardware_Component_Partition_OperatingSystem service.s

func (Hardware_Component_Partition_OperatingSystem) GetPartitionTemplates 

func (r Hardware_Component_Partition_OperatingSystem) GetPartitionTemplates() (resp []datatypes.Hardware_Component_Partition_Template, err error)

Retrieve Information regarding an operating system's [[SoftLayer_Hardware_Component_Partition_Template|Partition Templates]].

func (Hardware_Component_Partition_OperatingSystem) Id 

func (r Hardware_Component_Partition_OperatingSystem) Id(id int) Hardware_Component_Partition_OperatingSystem

func (Hardware_Component_Partition_OperatingSystem) Limit 

func (r Hardware_Component_Partition_OperatingSystem) Limit(limit int) Hardware_Component_Partition_OperatingSystem

func (Hardware_Component_Partition_OperatingSystem) Mask 

func (r Hardware_Component_Partition_OperatingSystem) Mask(mask string) Hardware_Component_Partition_OperatingSystem

func (Hardware_Component_Partition_OperatingSystem) Offset 

func (r Hardware_Component_Partition_OperatingSystem) Offset(offset int) Hardware_Component_Partition_OperatingSystem

type Hardware_Component_Partition_Template 

type Hardware_Component_Partition_Template struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetHardwareComponentPartitionTemplateService 

func GetHardwareComponentPartitionTemplateService(sess session.SLSession) Hardware_Component_Partition_Template

GetHardwareComponentPartitionTemplateService returns an instance of the Hardware_Component_Partition_Template SoftLayer service

func (Hardware_Component_Partition_Template) Filter 

func (r Hardware_Component_Partition_Template) Filter(filter string) Hardware_Component_Partition_Template

func (Hardware_Component_Partition_Template) GetAccount 

func (r Hardware_Component_Partition_Template) GetAccount() (resp datatypes.Account, err error)

Retrieve A partition template's associated [[SoftLayer_Account|Account]].

func (Hardware_Component_Partition_Template) GetData 

func (r Hardware_Component_Partition_Template) GetData() (resp []datatypes.Hardware_Component_Partition_Template_Partition, err error)

Retrieve An individual partition for a partition template. This is identical to 'partitionTemplatePartition' except this will sort unix partitions.

func (Hardware_Component_Partition_Template) GetExpireDate 

func (r Hardware_Component_Partition_Template) GetExpireDate() (resp string, err error)

Retrieve

func (Hardware_Component_Partition_Template) GetObject 

func (r Hardware_Component_Partition_Template) GetObject() (resp datatypes.Hardware_Component_Partition_Template, err error)

getObject retrieves the SoftLayer_Hardware_Component_Partition_Template object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Hardware_Component_Partition_Template service. You can only retrieve the partition templates that your account created or the templates predefined by SoftLayer.

func (Hardware_Component_Partition_Template) GetPartitionOperatingSystem 

func (r Hardware_Component_Partition_Template) GetPartitionOperatingSystem() (resp datatypes.Hardware_Component_Partition_OperatingSystem, err error)

Retrieve A partition template's associated [[SoftLayer_Hardware_Component_Partition_OperatingSystem|Operating System]].

func (Hardware_Component_Partition_Template) GetPartitionTemplatePartition 

func (r Hardware_Component_Partition_Template) GetPartitionTemplatePartition() (resp []datatypes.Hardware_Component_Partition_Template_Partition, err error)

Retrieve An individual partition for a partition template.

func (Hardware_Component_Partition_Template) Id 

func (r Hardware_Component_Partition_Template) Id(id int) Hardware_Component_Partition_Template

func (Hardware_Component_Partition_Template) Limit 

func (r Hardware_Component_Partition_Template) Limit(limit int) Hardware_Component_Partition_Template

func (Hardware_Component_Partition_Template) Mask 

func (r Hardware_Component_Partition_Template) Mask(mask string) Hardware_Component_Partition_Template

func (Hardware_Component_Partition_Template) Offset 

func (r Hardware_Component_Partition_Template) Offset(offset int) Hardware_Component_Partition_Template

type Hardware_Router 

type Hardware_Router struct {
	Session session.SLSession
	Options sl.Options
}

The SoftLayer_Hardware_Router data type contains general information relating to a single SoftLayer router.

func GetHardwareRouterService 

func GetHardwareRouterService(sess session.SLSession) Hardware_Router

GetHardwareRouterService returns an instance of the Hardware_Router SoftLayer service

func (Hardware_Router) AllowAccessToNetworkStorage 

func (r Hardware_Router) AllowAccessToNetworkStorage(networkStorageTemplateObject *datatypes.Network_Storage) (resp bool, err error)

This method is used to allow access to a SoftLayer_Network_Storage volume that supports host- or network-level access control.

func (Hardware_Router) AllowAccessToNetworkStorageList 

func (r Hardware_Router) AllowAccessToNetworkStorageList(networkStorageTemplateObjects []datatypes.Network_Storage) (resp bool, err error)

This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support host- or network-level access control.

func (Hardware_Router) CaptureImage 

func (r Hardware_Router) CaptureImage(captureTemplate *datatypes.Container_Disk_Image_Capture_Template) (resp datatypes.Virtual_Guest_Block_Device_Template_Group, err error)

Captures an Image of the hard disk on the physical machine, based on the capture template parameter. Returns the image template group containing the disk image.

func (Hardware_Router) CreateObject 

func (r Hardware_Router) CreateObject(templateObject *datatypes.Hardware) (resp datatypes.Hardware, err error)

<style type="text/css">.create_object > li > div { padding-top: .5em; padding-bottom: .5em}</style> createObject() enables the creation of servers on an account. This method is a simplified alternative to interacting with the ordering system directly.

In order to create a server, a template object must be sent in with a few required values.

When this method returns an order will have been placed for a server of the specified configuration.

To determine when the server is available you can poll the server via [[SoftLayer_Hardware/getObject|getObject]], checking the <code>provisionDate</code> property. When <code>provisionDate</code> is not null, the server will be ready. Be sure to use the <code>globalIdentifier</code> as your initialization parameter.

<b>Warning:</b> Servers created via this method will incur charges on your account. For testing input parameters see [[SoftLayer_Hardware/generateOrderTemplate|generateOrderTemplate]].

<b>Input</b> - [[SoftLayer_Hardware (type)|SoftLayer_Hardware]] <ul class="create_object"> 

    <li><code>hostname</code>
        <div>Hostname for the server.</div><ul>
            <li><b>Required</b></li>
            <li><b>Type</b> - string</li>
        </ul>
        <br />
    </li>
    <li><code>domain</code>
        <div>Domain for the server.</div><ul>
            <li><b>Required</b></li>
            <li><b>Type</b> - string</li>
        </ul>
        <br />
    </li>
    <li><code>processorCoreAmount</code>
        <div>The number of logical CPU cores to allocate.</div><ul>
            <li><b>Required</b></li>
            <li><b>Type</b> - int</li>
            <li>See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.</li>
        </ul>
        <br />
    </li>
    <li><code>memoryCapacity</code>
        <div>The amount of memory to allocate in gigabytes.</div><ul>
            <li><b>Required</b></li>
            <li><b>Type</b> - int</li>
            <li>See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.</li>
        </ul>
        <br />
    </li>
    <li><code>hourlyBillingFlag</code>
        <div>Specifies the billing type for the server.</div><ul>
            <li><b>Required</b></li>
            <li><b>Type</b> - boolean</li>
            <li>When true the server will be billed on hourly usage, otherwise it will be billed on a monthly basis.</li>
        </ul>
        <br />
    </li>
    <li><code>operatingSystemReferenceCode</code>
        <div>An identifier for the operating system to provision the server with.</div><ul>
            <li><b>Required</b></li>
            <li><b>Type</b> - string</li>
            <li>See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.</li>
        </ul>
        <br />
    </li>
    <li><code>datacenter.name</code>
        <div>Specifies which datacenter the server is to be provisioned in.</div><ul>
            <li><b>Required</b></li>
            <li><b>Type</b> - string</li>
            <li>The <code>datacenter</code> property is a [[SoftLayer_Location (type)|location]] structure with the <code>name</code> field set.</li>
            <li>See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.</li>
        </ul>
        <http title="Example">{
    "datacenter": {
        "name": "dal05"
    }
}</http>

        <br />
    </li>
    <li><code>networkComponents.maxSpeed</code>
        <div>Specifies the connection speed for the server's network components.</div><ul>
            <li><b>Optional</b></li>
            <li><b>Type</b> - int</li>
            <li><b>Default</b> - The highest available zero cost port speed will be used.</li>
            <li><b>Description</b> - The <code>networkComponents</code> property is an array with a single [[SoftLayer_Network_Component (type)|network component]] structure. The <code>maxSpeed</code> property must be set to specify the network uplink speed, in megabits per second, of the server.</li>
            <li>See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.</li>
        </ul>
            <http title="Example">{
    "networkComponents": [
        {
            "maxSpeed": 1000
        }
    ]
}</http>

        <br />
    </li>
    <li><code>networkComponents.redundancyEnabledFlag</code>
        <div>Specifies whether or not the server's network components should be in redundancy groups.</div><ul>
            <li><b>Optional</b></li>
            <li><b>Type</b> - bool</li>
            <li><b>Default</b> - <code>false</code></li>
            <li><b>Description</b> - The <code>networkComponents</code> property is an array with a single [[SoftLayer_Network_Component (type)|network component]] structure. When the <code>redundancyEnabledFlag</code> property is true the server's network components will be in redundancy groups.</li>
        </ul>
            <http title="Example">{
    "networkComponents": [
        {
            "redundancyEnabledFlag": false
        }
    ]
}</http>

        <br />
    </li>
    <li><code>privateNetworkOnlyFlag</code>
        <div>Specifies whether or not the server only has access to the private network</div><ul>
            <li><b>Optional</b></li>
            <li><b>Type</b> - boolean</li>
            <li><b>Default</b> - <code>false</code></li>
            <li>When true this flag specifies that a server is to only have access to the private network.</li>
        </ul>
        <br />
    </li>
    <li><code>primaryNetworkComponent.networkVlan.id</code>
        <div>Specifies the network vlan which is to be used for the frontend interface of the server.</div><ul>
            <li><b>Optional</b></li>
            <li><b>Type</b> - int</li>
            <li><b>Description</b> - The <code>primaryNetworkComponent</code> property is a [[SoftLayer_Network_Component (type)|network component]] structure with the <code>networkVlan</code> property populated with a [[SoftLayer_Network_Vlan (type)|vlan]] structure. The <code>id</code> property must be set to specify the frontend network vlan of the server.</li>
        </ul>
        <http title="Example">{
    "primaryNetworkComponent": {
        "networkVlan": {
            "id": 1
        }
    }
}</http>

        <br />
    </li>
    <li><code>primaryBackendNetworkComponent.networkVlan.id</code>
        <div>Specifies the network vlan which is to be used for the backend interface of the server.</div><ul>
            <li><b>Optional</b></li>
            <li><b>Type</b> - int</li>
            <li><b>Description</b> - The <code>primaryBackendNetworkComponent</code> property is a [[SoftLayer_Network_Component (type)|network component]] structure with the <code>networkVlan</code> property populated with a [[SoftLayer_Network_Vlan (type)|vlan]] structure. The <code>id</code> property must be set to specify the backend network vlan of the server.</li>
        </ul>
        <http title="Example">{
    "primaryBackendNetworkComponent": {
        "networkVlan": {
            "id": 2
        }
    }
}</http>

        <br />
    </li>
    <li><code>fixedConfigurationPreset.keyName</code>
        <div></div><ul>
            <li><b>Optional</b></li>
            <li><b>Type</b> - string</li>
            <li><b>Description</b> - The <code>fixedConfigurationPreset</code> property is a [[SoftLayer_Product_Package_Preset (type)|fixed configuration preset]] structure. The <code>keyName</code> property must be set to specify preset to use.</li>
            <li>If a fixed configuration preset is used <code>processorCoreAmount</code>, <code>memoryCapacity</code> and <code>hardDrives</code> properties must not be set.</li>
            <li>See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.</li>
        </ul>
        <http title="Example">{
    "fixedConfigurationPreset": {
        "keyName": "SOME_KEY_NAME"
    }
}</http>

        <br />
    </li>
    <li><code>userData.value</code>
        <div>Arbitrary data to be made available to the server.</div><ul>
            <li><b>Optional</b></li>
            <li><b>Type</b> - string</li>
            <li><b>Description</b> - The <code>userData</code> property is an array with a single [[SoftLayer_Hardware_Attribute (type)|attribute]] structure with the <code>value</code> property set to an arbitrary value.</li>
            <li>This value can be retrieved via the [[SoftLayer_Resource_Metadata/getUserMetadata|getUserMetadata]] method from a request originating from the server. This is primarily useful for providing data to software that may be on the server and configured to execute upon first boot.</li>
        </ul>
        <http title="Example">{
    "userData": [
        {
            "value": "someValue"
        }
    ]
}</http>

        <br />
    </li>
    <li><code>hardDrives</code>
        <div>Hard drive settings for the server</div><ul>
            <li><b>Optional</b></li>
            <li><b>Type</b> - SoftLayer_Hardware_Component</li>
            <li><b>Default</b> - The largest available capacity for a zero cost primary disk will be used.</li>
            <li><b>Description</b> - The <code>hardDrives</code> property is an array of [[SoftLayer_Hardware_Component (type)|hardware component]] structures.</i>
            <li>Each hard drive must specify the <code>capacity</code> property.</li>
            <li>See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.</li>
        </ul>
        <http title="Example">{
    "hardDrives": [
        {
            "capacity": 500
        }
    ]
}</http>

        <br />
    </li>
    <li id="hardware-create-object-ssh-keys"><code>sshKeys</code>
        <div>SSH keys to install on the server upon provisioning.</div><ul>
            <li><b>Optional</b></li>
            <li><b>Type</b> - array of [[SoftLayer_Security_Ssh_Key (type)|SoftLayer_Security_Ssh_Key]]</li>
            <li><b>Description</b> - The <code>sshKeys</code> property is an array of [[SoftLayer_Security_Ssh_Key (type)|SSH Key]] structures with the <code>id</code> property set to the value of an existing SSH key.</li>
            <li>To create a new SSH key, call [[SoftLayer_Security_Ssh_Key/createObject|createObject]] on the [[SoftLayer_Security_Ssh_Key]] service.</li>
            <li>To obtain a list of existing SSH keys, call [[SoftLayer_Account/getSshKeys|getSshKeys]] on the [[SoftLayer_Account]] service.
        </ul>
        <http title="Example">{
    "sshKeys": [
        {
            "id": 123
        }
    ]
}</http>

    <br />
</li>
<li><code>postInstallScriptUri</code>
    <div>Specifies the uri location of the script to be downloaded and run after installation is complete.</div><ul>
        <li><b>Optional</b></li>
        <li><b>Type</b> - string</li>
    </ul>
    <br />
</li>

</ul>

<h1>REST Example</h1> 

<http title="Request">curl -X POST -d '{
 "parameters":[
     {
         "hostname": "host1",
         "domain": "example.com",
         "processorCoreAmount": 2,
         "memoryCapacity": 2,
         "hourlyBillingFlag": true,
         "operatingSystemReferenceCode": "UBUNTU_LATEST"
     }
 ]
}' https://api.softlayer.com/rest/v3/SoftLayer_Hardware.json

</http> <http title="Response">HTTP/1.1 201 Created Location: https://api.softlayer.com/rest/v3/SoftLayer_Hardware/f5a3fcff-db1d-4b7c-9fa0-0349e41c29c5/getObject 

{
    "accountId": 232298,
    "bareMetalInstanceFlag": null,
    "domain": "example.com",
    "hardwareStatusId": null,
    "hostname": "host1",
    "id": null,
    "serviceProviderId": null,
    "serviceProviderResourceId": null,
    "globalIdentifier": "f5a3fcff-db1d-4b7c-9fa0-0349e41c29c5",
    "hourlyBillingFlag": true,
    "memoryCapacity": 2,
    "operatingSystemReferenceCode": "UBUNTU_LATEST",
    "processorCoreAmount": 2
}

</http>

func (Hardware_Router) DeleteObject 

func (r Hardware_Router) DeleteObject() (resp bool, err error)

This method will cancel a server effective immediately. For servers billed hourly, the charges will stop immediately after the method returns.

func (Hardware_Router) DeleteSoftwareComponentPasswords 

func (r Hardware_Router) DeleteSoftwareComponentPasswords(softwareComponentPasswords []datatypes.Software_Component_Password) (resp bool, err error)

Delete software component passwords.

func (Hardware_Router) DeleteTag 

func (r Hardware_Router) DeleteTag(tagName *string) (resp bool, err error)

Delete an existing tag. If there are any references on the tag, an exception will be thrown.

func (Hardware_Router) EditSoftwareComponentPasswords 

func (r Hardware_Router) EditSoftwareComponentPasswords(softwareComponentPasswords []datatypes.Software_Component_Password) (resp bool, err error)

Edit the properties of a software component password such as the username, password, and notes.

func (Hardware_Router) ExecuteRemoteScript 

func (r Hardware_Router) ExecuteRemoteScript(uri *string) (err error)

Download and run remote script from uri on the hardware.

func (Hardware_Router) Filter 

func (r Hardware_Router) Filter(filter string) Hardware_Router

func (Hardware_Router) FindByIpAddress 

func (r Hardware_Router) FindByIpAddress(ipAddress *string) (resp datatypes.Hardware, err error)

The ”'findByIpAddress”' method finds hardware using its primary public or private IP address. IP addresses that have a secondary subnet tied to the hardware will not return the hardware. If no hardware is found, no errors are generated and no data is returned.

func (Hardware_Router) GenerateOrderTemplate 

func (r Hardware_Router) GenerateOrderTemplate(templateObject *datatypes.Hardware) (resp datatypes.Container_Product_Order, err error)

Obtain an [[SoftLayer_Container_Product_Order_Hardware_Server (type)|order container]] that can be sent to [[SoftLayer_Product_Order/verifyOrder|verifyOrder]] or [[SoftLayer_Product_Order/placeOrder|placeOrder]].

This is primarily useful when there is a necessity to confirm the price which will be charged for an order.

See [[SoftLayer_Hardware/createObject|createObject]] for specifics on the requirements of the template object parameter.

func (Hardware_Router) GetAccount 

func (r Hardware_Router) GetAccount() (resp datatypes.Account, err error)

Retrieve The account associated with a piece of hardware.

func (Hardware_Router) GetActiveComponents 

func (r Hardware_Router) GetActiveComponents() (resp []datatypes.Hardware_Component, err error)

Retrieve A piece of hardware's active physical components.

func (Hardware_Router) GetActiveNetworkMonitorIncident 

func (r Hardware_Router) GetActiveNetworkMonitorIncident() (resp []datatypes.Network_Monitor_Version1_Incident, err error)

Retrieve A piece of hardware's active network monitoring incidents.

func (Hardware_Router) GetAllPowerComponents 

func (r Hardware_Router) GetAllPowerComponents() (resp []datatypes.Hardware_Power_Component, err error)

Retrieve

func (Hardware_Router) GetAllowedHost 

func (r Hardware_Router) GetAllowedHost() (resp datatypes.Network_Storage_Allowed_Host, err error)

Retrieve The SoftLayer_Network_Storage_Allowed_Host information to connect this server to Network Storage volumes that require access control lists.

func (Hardware_Router) GetAllowedNetworkStorage 

func (r Hardware_Router) GetAllowedNetworkStorage() (resp []datatypes.Network_Storage, err error)

Retrieve The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to.

func (Hardware_Router) GetAllowedNetworkStorageReplicas 

func (r Hardware_Router) GetAllowedNetworkStorageReplicas() (resp []datatypes.Network_Storage, err error)

Retrieve The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to.

func (Hardware_Router) GetAntivirusSpywareSoftwareComponent 

func (r Hardware_Router) GetAntivirusSpywareSoftwareComponent() (resp datatypes.Software_Component, err error)

Retrieve Information regarding an antivirus/spyware software component object.

func (Hardware_Router) GetAttachedNetworkStorages 

func (r Hardware_Router) GetAttachedNetworkStorages(nasType *string) (resp []datatypes.Network_Storage, err error)

This method is retrieve a list of SoftLayer_Network_Storage volumes that are authorized access to this SoftLayer_Hardware.

func (Hardware_Router) GetAttributes 

func (r Hardware_Router) GetAttributes() (resp []datatypes.Hardware_Attribute, err error)

Retrieve Information regarding a piece of hardware's specific attributes.

func (Hardware_Router) GetAvailableBillingTermChangePrices added in v1.0.4 

func (r Hardware_Router) GetAvailableBillingTermChangePrices() (resp []datatypes.Product_Item_Price, err error)

Retrieves a list of available term prices to this hardware. Currently, price terms are only available for increasing term length to monthly billed servers.

func (Hardware_Router) GetAvailableNetworkStorages 

func (r Hardware_Router) GetAvailableNetworkStorages(nasType *string) (resp []datatypes.Network_Storage, err error)

This method retrieves a list of SoftLayer_Network_Storage volumes that can be authorized to this SoftLayer_Hardware.

func (Hardware_Router) GetAverageDailyPublicBandwidthUsage 

func (r Hardware_Router) GetAverageDailyPublicBandwidthUsage() (resp datatypes.Float64, err error)

Retrieve The average daily public bandwidth usage for the current billing cycle.

func (Hardware_Router) GetBackendIncomingBandwidth 

func (r Hardware_Router) GetBackendIncomingBandwidth(startDate *datatypes.Time, endDate *datatypes.Time) (resp datatypes.Float64, err error)

The ”'getBackendIncomingBandwidth”' method retrieves the amount of incoming private network traffic used between the given start date and end date parameters. When entering start and end dates, only the month, day and year are used to calculate bandwidth totals - the time (HH:MM:SS) is ignored and defaults to midnight. The amount of bandwidth retrieved is measured in gigabytes.

func (Hardware_Router) GetBackendNetworkComponents 

func (r Hardware_Router) GetBackendNetworkComponents() (resp []datatypes.Network_Component, err error)

Retrieve A piece of hardware's back-end or private network components.

func (Hardware_Router) GetBackendOutgoingBandwidth 

func (r Hardware_Router) GetBackendOutgoingBandwidth(startDate *datatypes.Time, endDate *datatypes.Time) (resp datatypes.Float64, err error)

The ”'getBackendOutgoingBandwidth”' method retrieves the amount of outgoing private network traffic used between the given start date and end date parameters. When entering start and end dates, only the month, day and year are used to calculate bandwidth totals - the time (HH:MM:SS) is ignored and defaults to midnight. The amount of bandwidth retrieved is measured in gigabytes.

func (Hardware_Router) GetBackendRouters 

func (r Hardware_Router) GetBackendRouters() (resp []datatypes.Hardware, err error)

Retrieve A hardware's backend or private router.

func (Hardware_Router) GetBandwidthAllocation 

func (r Hardware_Router) GetBandwidthAllocation() (resp datatypes.Float64, err error)

Retrieve A hardware's allotted bandwidth (measured in GB).

func (Hardware_Router) GetBandwidthAllotmentDetail 

func (r Hardware_Router) GetBandwidthAllotmentDetail() (resp datatypes.Network_Bandwidth_Version1_Allotment_Detail, err error)

Retrieve A hardware's allotted detail record. Allotment details link bandwidth allocation with allotments.

func (Hardware_Router) GetBenchmarkCertifications 

func (r Hardware_Router) GetBenchmarkCertifications() (resp []datatypes.Hardware_Benchmark_Certification, err error)

Retrieve Information regarding a piece of hardware's benchmark certifications.

func (Hardware_Router) GetBillingItem 

func (r Hardware_Router) GetBillingItem() (resp datatypes.Billing_Item_Hardware, err error)

Retrieve Information regarding the billing item for a server.

func (Hardware_Router) GetBillingItemFlag 

func (r Hardware_Router) GetBillingItemFlag() (resp bool, err error)

Retrieve A flag indicating that a billing item exists.

func (Hardware_Router) GetBlockCancelBecauseDisconnectedFlag 

func (r Hardware_Router) GetBlockCancelBecauseDisconnectedFlag() (resp bool, err error)

Retrieve Determines whether the hardware is ineligible for cancellation because it is disconnected.

func (Hardware_Router) GetBusinessContinuanceInsuranceFlag 

func (r Hardware_Router) GetBusinessContinuanceInsuranceFlag() (resp bool, err error)

Retrieve Status indicating whether or not a piece of hardware has business continuance insurance.

func (Hardware_Router) GetChildrenHardware 

func (r Hardware_Router) GetChildrenHardware() (resp []datatypes.Hardware, err error)

Retrieve Child hardware.

func (Hardware_Router) GetComponentDetailsXML 

func (r Hardware_Router) GetComponentDetailsXML() (resp string, err error)

no documentation yet

func (Hardware_Router) GetComponents 

func (r Hardware_Router) GetComponents() (resp []datatypes.Hardware_Component, err error)

Retrieve A piece of hardware's components.

func (Hardware_Router) GetContinuousDataProtectionSoftwareComponent 

func (r Hardware_Router) GetContinuousDataProtectionSoftwareComponent() (resp datatypes.Software_Component, err error)

Retrieve A continuous data protection/server backup software component object.

func (Hardware_Router) GetCreateObjectOptions 

func (r Hardware_Router) GetCreateObjectOptions() (resp datatypes.Container_Hardware_Configuration, err error)

There are many options that may be provided while ordering a server, this method can be used to determine what these options are.

Detailed information on the return value can be found on the data type page for [[SoftLayer_Container_Hardware_Configuration (type)]].

func (Hardware_Router) GetCurrentBillableBandwidthUsage 

func (r Hardware_Router) GetCurrentBillableBandwidthUsage() (resp datatypes.Float64, err error)

Retrieve The current billable public outbound bandwidth for this hardware for the current billing cycle.

func (Hardware_Router) GetCurrentBillingDetail 

func (r Hardware_Router) GetCurrentBillingDetail() (resp []datatypes.Billing_Item, err error)

Get the billing detail for this hardware for the current billing period. This does not include bandwidth usage.

func (Hardware_Router) GetCurrentBillingTotal 

func (r Hardware_Router) GetCurrentBillingTotal() (resp datatypes.Float64, err error)

Get the total bill amount in US Dollars ($) for this hardware in the current billing period. This includes all bandwidth used up to the point the method is called on the hardware.

func (Hardware_Router) GetDailyAverage 

func (r Hardware_Router) GetDailyAverage(startDate *datatypes.Time, endDate *datatypes.Time) (resp datatypes.Float64, err error)

The ”'getDailyAverage”' method calculates the average daily network traffic used by the selected server. Using the required parameter ”dateTime” to enter a start and end date, the user retrieves this average, measure in gigabytes (GB) for the specified date range. When entering parameters, only the month, day and year are required - time entries are omitted as this method defaults the time to midnight in order to account for the entire day.

func (Hardware_Router) GetDatacenter 

func (r Hardware_Router) GetDatacenter() (resp datatypes.Location, err error)

Retrieve Information regarding the datacenter in which a piece of hardware resides.

func (Hardware_Router) GetDatacenterName 

func (r Hardware_Router) GetDatacenterName() (resp string, err error)

Retrieve The name of the datacenter in which a piece of hardware resides.

func (Hardware_Router) GetDaysInSparePool 

func (r Hardware_Router) GetDaysInSparePool() (resp int, err error)

Retrieve Number of day(s) a server have been in spare pool.

func (Hardware_Router) GetDownlinkHardware 

func (r Hardware_Router) GetDownlinkHardware() (resp []datatypes.Hardware, err error)

Retrieve All hardware that has uplink network connections to a piece of hardware.

func (Hardware_Router) GetDownlinkNetworkHardware 

func (r Hardware_Router) GetDownlinkNetworkHardware() (resp []datatypes.Hardware, err error)

Retrieve All hardware that has uplink network connections to a piece of hardware.

func (Hardware_Router) GetDownlinkServers 

func (r Hardware_Router) GetDownlinkServers() (resp []datatypes.Hardware, err error)

Retrieve Information regarding all servers attached to a piece of network hardware.

func (Hardware_Router) GetDownlinkVirtualGuests 

func (r Hardware_Router) GetDownlinkVirtualGuests() (resp []datatypes.Virtual_Guest, err error)

Retrieve Information regarding all virtual guests attached to a piece of network hardware.

func (Hardware_Router) GetDownstreamHardwareBindings 

func (r Hardware_Router) GetDownstreamHardwareBindings() (resp []datatypes.Network_Component_Uplink_Hardware, err error)

Retrieve All hardware downstream from a network device.

func (Hardware_Router) GetDownstreamNetworkHardware 

func (r Hardware_Router) GetDownstreamNetworkHardware() (resp []datatypes.Hardware, err error)

Retrieve All network hardware downstream from the selected piece of hardware.

func (Hardware_Router) GetDownstreamNetworkHardwareWithIncidents 

func (r Hardware_Router) GetDownstreamNetworkHardwareWithIncidents() (resp []datatypes.Hardware, err error)

Retrieve All network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. [DEPRECATED]

func (Hardware_Router) GetDownstreamServers 

func (r Hardware_Router) GetDownstreamServers() (resp []datatypes.Hardware, err error)

Retrieve Information regarding all servers attached downstream to a piece of network hardware.

func (Hardware_Router) GetDownstreamVirtualGuests 

func (r Hardware_Router) GetDownstreamVirtualGuests() (resp []datatypes.Virtual_Guest, err error)

Retrieve Information regarding all virtual guests attached to a piece of network hardware.

func (Hardware_Router) GetDriveControllers 

func (r Hardware_Router) GetDriveControllers() (resp []datatypes.Hardware_Component, err error)

Retrieve The drive controllers contained within a piece of hardware.

func (Hardware_Router) GetEvaultNetworkStorage 

func (r Hardware_Router) GetEvaultNetworkStorage() (resp []datatypes.Network_Storage, err error)

Retrieve Information regarding a piece of hardware's associated EVault network storage service account.

func (Hardware_Router) GetFirewallServiceComponent 

func (r Hardware_Router) GetFirewallServiceComponent() (resp datatypes.Network_Component_Firewall, err error)

Retrieve Information regarding a piece of hardware's firewall services.

func (Hardware_Router) GetFixedConfigurationPreset 

func (r Hardware_Router) GetFixedConfigurationPreset() (resp datatypes.Product_Package_Preset, err error)

Retrieve Defines the fixed components in a fixed configuration bare metal server.

func (Hardware_Router) GetFrontendIncomingBandwidth 

func (r Hardware_Router) GetFrontendIncomingBandwidth(startDate *datatypes.Time, endDate *datatypes.Time) (resp datatypes.Float64, err error)

The ”'getFrontendIncomingBandwidth”' method retrieves the amount of incoming public network traffic used by a server between the given start and end date parameters. When entering the ”dateTime” parameter, only the month, day and year of the start and end dates are required - the time (hour, minute and second) are set to midnight by default and cannot be changed. The amount of bandwidth retrieved is measured in gigabytes (GB).

func (Hardware_Router) GetFrontendNetworkComponents 

func (r Hardware_Router) GetFrontendNetworkComponents() (resp []datatypes.Network_Component, err error)

Retrieve A piece of hardware's front-end or public network components.

func (Hardware_Router) GetFrontendOutgoingBandwidth 

func (r Hardware_Router) GetFrontendOutgoingBandwidth(startDate *datatypes.Time, endDate *datatypes.Time) (resp datatypes.Float64, err error)

The ”'getFrontendOutgoingBandwidth”' method retrieves the amount of outgoing public network traffic used by a server between the given start and end date parameters. The ”dateTime” parameter requires only the day, month and year to be entered - the time (hour, minute and second) are set to midnight be default in order to gather the data for the entire start and end date indicated in the parameter. The amount of bandwidth retrieved is measured in gigabytes (GB).

func (Hardware_Router) GetFrontendRouters 

func (r Hardware_Router) GetFrontendRouters() (resp []datatypes.Hardware, err error)

Retrieve A hardware's frontend or public router.

func (Hardware_Router) GetFutureBillingItem added in v1.0.4 

func (r Hardware_Router) GetFutureBillingItem() (resp datatypes.Billing_Item_Hardware, err error)

Retrieve Information regarding the future billing item for a server.

func (Hardware_Router) GetGlobalIdentifier 

func (r Hardware_Router) GetGlobalIdentifier() (resp string, err error)

Retrieve A hardware's universally unique identifier.

func (Hardware_Router) GetHardDrives 

func (r Hardware_Router) GetHardDrives() (resp []datatypes.Hardware_Component, err error)

Retrieve The hard drives contained within a piece of hardware.

func (Hardware_Router) GetHardwareChassis 

func (r Hardware_Router) GetHardwareChassis() (resp datatypes.Hardware_Chassis, err error)

Retrieve The chassis that a piece of hardware is housed in.

func (Hardware_Router) GetHardwareFunction 

func (r Hardware_Router) GetHardwareFunction() (resp datatypes.Hardware_Function, err error)

Retrieve A hardware's function.

func (Hardware_Router) GetHardwareFunctionDescription 

func (r Hardware_Router) GetHardwareFunctionDescription() (resp string, err error)

Retrieve A hardware's function.

func (Hardware_Router) GetHardwareState added in v1.0.4 

func (r Hardware_Router) GetHardwareState() (resp datatypes.Hardware_State, err error)

Retrieve A hardware's power/transaction state.

func (Hardware_Router) GetHardwareStatus 

func (r Hardware_Router) GetHardwareStatus() (resp datatypes.Hardware_Status, err error)

Retrieve A hardware's status.

func (Hardware_Router) GetHasTrustedPlatformModuleBillingItemFlag 

func (r Hardware_Router) GetHasTrustedPlatformModuleBillingItemFlag() (resp bool, err error)

Retrieve Determine in hardware object has TPM enabled.

func (Hardware_Router) GetHostIpsSoftwareComponent 

func (r Hardware_Router) GetHostIpsSoftwareComponent() (resp datatypes.Software_Component, err error)

Retrieve Information regarding a host IPS software component object.

func (Hardware_Router) GetHourlyBandwidth 

func (r Hardware_Router) GetHourlyBandwidth(mode *string, day *datatypes.Time) (resp []datatypes.Metric_Tracking_Object_Data, err error)

The ”'getHourlyBandwidth”' method retrieves all bandwidth updates hourly for the specified hardware. Because the potential number of data points can become excessive, the method limits the user to obtain data in 24-hour intervals. The required ”dateTime” parameter is used as the starting point for the query and will be calculated for the 24-hour period starting with the specified date and time. For example, entering a parameter of

'02/01/2008 0:00'

results in a return of all bandwidth data for the entire day of February 1, 2008, as 0:00 specifies a midnight start date. Please note that the time entered should be completed using a 24-hour clock (military time, astronomical time).

For data spanning more than a single 24-hour period, refer to the getBandwidthData function on the metricTrackingObject for the piece of hardware.

func (Hardware_Router) GetHourlyBillingFlag 

func (r Hardware_Router) GetHourlyBillingFlag() (resp bool, err error)

Retrieve A server's hourly billing status.

func (Hardware_Router) GetInboundBandwidthUsage 

func (r Hardware_Router) GetInboundBandwidthUsage() (resp datatypes.Float64, err error)

Retrieve The sum of all the inbound network traffic data for the last 30 days.

func (Hardware_Router) GetInboundPublicBandwidthUsage 

func (r Hardware_Router) GetInboundPublicBandwidthUsage() (resp datatypes.Float64, err error)

Retrieve The total public inbound bandwidth for this hardware for the current billing cycle.

func (Hardware_Router) GetIsBillingTermChangeAvailableFlag added in v1.0.4 

func (r Hardware_Router) GetIsBillingTermChangeAvailableFlag() (resp bool, err error)

Retrieve Whether or not this hardware object is eligible to change to term billing.

func (Hardware_Router) GetIsCloudReadyNodeCertified added in v1.1.6 

func (r Hardware_Router) GetIsCloudReadyNodeCertified() (resp bool, err error)

Retrieve Determine if hardware object has the IBM_CLOUD_READY_NODE_CERTIFIED attribute.

func (Hardware_Router) GetLastTransaction 

func (r Hardware_Router) GetLastTransaction() (resp datatypes.Provisioning_Version1_Transaction, err error)

Retrieve Information regarding the last transaction a server performed.

func (Hardware_Router) GetLatestNetworkMonitorIncident 

func (r Hardware_Router) GetLatestNetworkMonitorIncident() (resp datatypes.Network_Monitor_Version1_Incident, err error)

Retrieve A piece of hardware's latest network monitoring incident.

func (Hardware_Router) GetLocalDiskStorageCapabilityFlag 

func (r Hardware_Router) GetLocalDiskStorageCapabilityFlag() (resp bool, err error)

Retrieve A flag indicating that a VLAN on the router can be assigned to a host that has local disk functionality.

func (Hardware_Router) GetLocation 

func (r Hardware_Router) GetLocation() (resp datatypes.Location, err error)

Retrieve Where a piece of hardware is located within SoftLayer's location hierarchy.

func (Hardware_Router) GetLocationPathString 

func (r Hardware_Router) GetLocationPathString() (resp string, err error)

Retrieve

func (Hardware_Router) GetLockboxNetworkStorage 

func (r Hardware_Router) GetLockboxNetworkStorage() (resp datatypes.Network_Storage, err error)

Retrieve Information regarding a lockbox account associated with a server.

func (Hardware_Router) GetManagedResourceFlag 

func (r Hardware_Router) GetManagedResourceFlag() (resp bool, err error)

Retrieve A flag indicating that the hardware is a managed resource.

func (Hardware_Router) GetMemory 

func (r Hardware_Router) GetMemory() (resp []datatypes.Hardware_Component, err error)

Retrieve Information regarding a piece of hardware's memory.

func (Hardware_Router) GetMemoryCapacity 

func (r Hardware_Router) GetMemoryCapacity() (resp uint, err error)

Retrieve The amount of memory a piece of hardware has, measured in gigabytes.

func (Hardware_Router) GetMetricTrackingObject 

func (r Hardware_Router) GetMetricTrackingObject() (resp datatypes.Metric_Tracking_Object, err error)

Retrieve A piece of hardware's metric tracking object.

func (Hardware_Router) GetModules 

func (r Hardware_Router) GetModules() (resp []datatypes.Hardware_Component, err error)

Retrieve

func (Hardware_Router) GetMonitoringRobot 

func (r Hardware_Router) GetMonitoringRobot() (resp datatypes.Monitoring_Robot, err error)

Retrieve

func (Hardware_Router) GetMonitoringServiceComponent 

func (r Hardware_Router) GetMonitoringServiceComponent() (resp datatypes.Network_Monitor_Version1_Query_Host_Stratum, err error)

Retrieve Information regarding a piece of hardware's network monitoring services.

func (Hardware_Router) GetMonitoringServiceEligibilityFlag 

func (r Hardware_Router) GetMonitoringServiceEligibilityFlag() (resp bool, err error)

Retrieve

func (Hardware_Router) GetMotherboard 

func (r Hardware_Router) GetMotherboard() (resp datatypes.Hardware_Component, err error)

Retrieve Information regarding a piece of hardware's motherboard.

func (Hardware_Router) GetNetworkCards 

func (r Hardware_Router) GetNetworkCards() (resp []datatypes.Hardware_Component, err error)

Retrieve Information regarding a piece of hardware's network cards.

func (Hardware_Router) GetNetworkComponents 

func (r Hardware_Router) GetNetworkComponents() (resp []datatypes.Network_Component, err error)

Retrieve Returns a hardware's network components.

func (Hardware_Router) GetNetworkGatewayMember 

func (r Hardware_Router) GetNetworkGatewayMember() (resp datatypes.Network_Gateway_Member, err error)

Retrieve The gateway member if this device is part of a network gateway.

func (Hardware_Router) GetNetworkGatewayMemberFlag 

func (r Hardware_Router) GetNetworkGatewayMemberFlag() (resp bool, err error)

Retrieve Whether or not this device is part of a network gateway.

func (Hardware_Router) GetNetworkManagementIpAddress 

func (r Hardware_Router) GetNetworkManagementIpAddress() (resp string, err error)

Retrieve A piece of hardware's network management IP address.

func (Hardware_Router) GetNetworkMonitorAttachedDownHardware 

func (r Hardware_Router) GetNetworkMonitorAttachedDownHardware() (resp []datatypes.Hardware, err error)

Retrieve All servers with failed monitoring that are attached downstream to a piece of hardware.

func (Hardware_Router) GetNetworkMonitorAttachedDownVirtualGuests 

func (r Hardware_Router) GetNetworkMonitorAttachedDownVirtualGuests() (resp []datatypes.Virtual_Guest, err error)

Retrieve Virtual guests that are attached downstream to a hardware that have failed monitoring

func (Hardware_Router) GetNetworkMonitorIncidents 

func (r Hardware_Router) GetNetworkMonitorIncidents() (resp []datatypes.Network_Monitor_Version1_Incident, err error)

Retrieve The status of all of a piece of hardware's network monitoring incidents.

func (Hardware_Router) GetNetworkMonitors 

func (r Hardware_Router) GetNetworkMonitors() (resp []datatypes.Network_Monitor_Version1_Query_Host, err error)

Retrieve Information regarding a piece of hardware's network monitors.

func (Hardware_Router) GetNetworkStatus 

func (r Hardware_Router) GetNetworkStatus() (resp string, err error)

Retrieve The value of a hardware's network status attribute. [DEPRECATED]

func (Hardware_Router) GetNetworkStatusAttribute 

func (r Hardware_Router) GetNetworkStatusAttribute() (resp datatypes.Hardware_Attribute, err error)

Retrieve The hardware's related network status attribute. [DEPRECATED]

func (Hardware_Router) GetNetworkStorage 

func (r Hardware_Router) GetNetworkStorage() (resp []datatypes.Network_Storage, err error)

Retrieve Information regarding a piece of hardware's associated network storage service account.

func (Hardware_Router) GetNetworkVlans 

func (r Hardware_Router) GetNetworkVlans() (resp []datatypes.Network_Vlan, err error)

Retrieve The network virtual LANs (VLANs) associated with a piece of hardware's network components.

func (Hardware_Router) GetNextBillingCycleBandwidthAllocation 

func (r Hardware_Router) GetNextBillingCycleBandwidthAllocation() (resp datatypes.Float64, err error)

Retrieve A hardware's allotted bandwidth for the next billing cycle (measured in GB).

func (Hardware_Router) GetNotesHistory 

func (r Hardware_Router) GetNotesHistory() (resp []datatypes.Hardware_Note, err error)

Retrieve

func (Hardware_Router) GetNvRamCapacity 

func (r Hardware_Router) GetNvRamCapacity() (resp uint, err error)

Retrieve The amount of non-volatile memory a piece of hardware has, measured in gigabytes.

func (Hardware_Router) GetNvRamComponentModels 

func (r Hardware_Router) GetNvRamComponentModels() (resp []datatypes.Hardware_Component_Model, err error)

Retrieve

func (Hardware_Router) GetObject 

func (r Hardware_Router) GetObject() (resp datatypes.Hardware_Router, err error)

no documentation yet

func (Hardware_Router) GetOperatingSystem 

func (r Hardware_Router) GetOperatingSystem() (resp datatypes.Software_Component_OperatingSystem, err error)

Retrieve Information regarding a piece of hardware's operating system.

func (Hardware_Router) GetOperatingSystemReferenceCode 

func (r Hardware_Router) GetOperatingSystemReferenceCode() (resp string, err error)

Retrieve A hardware's operating system software description.

func (Hardware_Router) GetOutboundBandwidthUsage 

func (r Hardware_Router) GetOutboundBandwidthUsage() (resp datatypes.Float64, err error)

Retrieve The sum of all the outbound network traffic data for the last 30 days.

func (Hardware_Router) GetOutboundPublicBandwidthUsage 

func (r Hardware_Router) GetOutboundPublicBandwidthUsage() (resp datatypes.Float64, err error)

Retrieve The total public outbound bandwidth for this hardware for the current billing cycle.

func (Hardware_Router) GetParentBay 

func (r Hardware_Router) GetParentBay() (resp datatypes.Hardware_Blade, err error)

Retrieve Blade Bay

func (Hardware_Router) GetParentHardware 

func (r Hardware_Router) GetParentHardware() (resp datatypes.Hardware, err error)

Retrieve Parent Hardware.

func (Hardware_Router) GetPointOfPresenceLocation 

func (r Hardware_Router) GetPointOfPresenceLocation() (resp datatypes.Location, err error)

Retrieve Information regarding the Point of Presence (PoP) location in which a piece of hardware resides.

func (Hardware_Router) GetPowerComponents 

func (r Hardware_Router) GetPowerComponents() (resp []datatypes.Hardware_Power_Component, err error)

Retrieve The power components for a hardware object.

func (Hardware_Router) GetPowerSupply 

func (r Hardware_Router) GetPowerSupply() (resp []datatypes.Hardware_Component, err error)

Retrieve Information regarding a piece of hardware's power supply.

func (Hardware_Router) GetPrimaryBackendIpAddress 

func (r Hardware_Router) GetPrimaryBackendIpAddress() (resp string, err error)

Retrieve The hardware's primary private IP address.

func (Hardware_Router) GetPrimaryBackendNetworkComponent 

func (r Hardware_Router) GetPrimaryBackendNetworkComponent() (resp datatypes.Network_Component, err error)

Retrieve Information regarding the hardware's primary back-end network component.

func (Hardware_Router) GetPrimaryIpAddress 

func (r Hardware_Router) GetPrimaryIpAddress() (resp string, err error)

Retrieve The hardware's primary public IP address.

func (Hardware_Router) GetPrimaryNetworkComponent 

func (r Hardware_Router) GetPrimaryNetworkComponent() (resp datatypes.Network_Component, err error)

Retrieve Information regarding the hardware's primary public network component.

func (Hardware_Router) GetPrivateBandwidthData 

func (r Hardware_Router) GetPrivateBandwidthData(startTime *int, endTime *int) (resp []datatypes.Metric_Tracking_Object_Data, err error)

Retrieve this server's private bandwidth data. If no timeframe is specified then getPrivateBandwidthData retrieves the last 24 hours of public bandwidth usage.

func (Hardware_Router) GetPrivateNetworkOnlyFlag 

func (r Hardware_Router) GetPrivateNetworkOnlyFlag() (resp bool, err error)

Retrieve Whether the hardware only has access to the private network.

func (Hardware_Router) GetProcessorCoreAmount 

func (r Hardware_Router) GetProcessorCoreAmount() (resp uint, err error)

Retrieve The total number of processor cores, summed from all processors that are attached to a piece of hardware

func (Hardware_Router) GetProcessorPhysicalCoreAmount 

func (r Hardware_Router) GetProcessorPhysicalCoreAmount() (resp uint, err error)

Retrieve The total number of physical processor cores, summed from all processors that are attached to a piece of hardware

func (Hardware_Router) GetProcessors 

func (r Hardware_Router) GetProcessors() (resp []datatypes.Hardware_Component, err error)

Retrieve Information regarding a piece of hardware's processors.

func (Hardware_Router) GetPublicBandwidthData 

func (r Hardware_Router) GetPublicBandwidthData(startTime *int, endTime *int) (resp []datatypes.Metric_Tracking_Object_Data, err error)

Retrieve this server's public bandwidth data. If no timeframe is specified then getPublicBandwidthData retrieves the last 24 hours of public bandwidth usage.

func (Hardware_Router) GetRack 

func (r Hardware_Router) GetRack() (resp datatypes.Location, err error)

Retrieve

func (Hardware_Router) GetRaidControllers 

func (r Hardware_Router) GetRaidControllers() (resp []datatypes.Hardware_Component, err error)

Retrieve The RAID controllers contained within a piece of hardware.

func (Hardware_Router) GetRecentEvents 

func (r Hardware_Router) GetRecentEvents() (resp []datatypes.Notification_Occurrence_Event, err error)

Retrieve Recent events that impact this hardware.

func (Hardware_Router) GetRemoteManagementAccounts 

func (r Hardware_Router) GetRemoteManagementAccounts() (resp []datatypes.Hardware_Component_RemoteManagement_User, err error)

Retrieve User credentials to issue commands and/or interact with the server's remote management card.

func (Hardware_Router) GetRemoteManagementComponent 

func (r Hardware_Router) GetRemoteManagementComponent() (resp datatypes.Network_Component, err error)

Retrieve A hardware's associated remote management component. This is normally IPMI.

func (Hardware_Router) GetResourceConfigurations 

func (r Hardware_Router) GetResourceConfigurations() (resp []datatypes.Hardware_Resource_Configuration, err error)

Retrieve

func (Hardware_Router) GetResourceGroupMemberReferences 

func (r Hardware_Router) GetResourceGroupMemberReferences() (resp []datatypes.Resource_Group_Member, err error)

Retrieve

func (Hardware_Router) GetResourceGroupRoles 

func (r Hardware_Router) GetResourceGroupRoles() (resp []datatypes.Resource_Group_Role, err error)

Retrieve

func (Hardware_Router) GetResourceGroups 

func (r Hardware_Router) GetResourceGroups() (resp []datatypes.Resource_Group, err error)

Retrieve The resource groups in which this hardware is a member.

func (Hardware_Router) GetRouters 

func (r Hardware_Router) GetRouters() (resp []datatypes.Hardware, err error)

Retrieve A hardware's routers.

func (Hardware_Router) GetSanStorageCapabilityFlag 

func (r Hardware_Router) GetSanStorageCapabilityFlag() (resp bool, err error)

Retrieve A flag indicating that a VLAN on the router can be assigned to a host that has SAN disk functionality.

func (Hardware_Router) GetSecurityScanRequests 

func (r Hardware_Router) GetSecurityScanRequests() (resp []datatypes.Network_Security_Scanner_Request, err error)

Retrieve Information regarding a piece of hardware's vulnerability scan requests.

func (Hardware_Router) GetSensorData 

func (r Hardware_Router) GetSensorData() (resp []datatypes.Container_RemoteManagement_SensorReading, err error)

The ”'getSensorData”' method retrieves a server's hardware state via its internal sensors. Remote sensor data is transmitted to the SoftLayer API by way of the server's remote management card. Sensor data measures various information, including system temperatures, voltages and other local server settings. Sensor data is cached for 30 second; calls made to this method for the same server within 30 seconds of each other will result in the same data being returned. To ensure that the data retrieved retrieves snapshot of varied data, make calls greater than 30 seconds apart.

func (Hardware_Router) GetSensorDataWithGraphs 

func (r Hardware_Router) GetSensorDataWithGraphs() (resp datatypes.Container_RemoteManagement_SensorReadingsWithGraphs, err error)

The ”'getSensorDataWithGraphs”' method retrieves the raw data returned from the server's remote management card. Along with raw data, graphs for the CPU and system temperatures and fan speeds are also returned. For more details on what information is returned, refer to the ”getSensorData” method.

func (Hardware_Router) GetServerFanSpeedGraphs 

func (r Hardware_Router) GetServerFanSpeedGraphs() (resp []datatypes.Container_RemoteManagement_Graphs_SensorSpeed, err error)

The ”'getServerFanSpeedGraphs”' method retrieves the server's fan speeds and displays the speeds using tachometer graphs. data used to construct these graphs is retrieved from the server's remote management card. Each graph returned will have an associated title.

func (Hardware_Router) GetServerPowerState 

func (r Hardware_Router) GetServerPowerState() (resp string, err error)

The ”'getPowerState”' method retrieves the power state for the selected server. The server's power status is retrieved from its remote management card. This method returns "on", for a server that has been powered on, or "off" for servers powered off.

func (Hardware_Router) GetServerRoom 

func (r Hardware_Router) GetServerRoom() (resp datatypes.Location, err error)

Retrieve Information regarding the server room in which the hardware is located.

func (Hardware_Router) GetServerTemperatureGraphs 

func (r Hardware_Router) GetServerTemperatureGraphs() (resp []datatypes.Container_RemoteManagement_Graphs_SensorTemperature, err error)

The ”'getServerTemperatureGraphs”' retrieves the server's temperatures and displays the various temperatures using thermometer graphs. Temperatures retrieved are CPU temperature(s) and system temperatures. Data used to construct the graphs is retrieved from the server's remote management card. All graphs returned will have an associated title.

func (Hardware_Router) GetServiceProvider 

func (r Hardware_Router) GetServiceProvider() (resp datatypes.Service_Provider, err error)

Retrieve Information regarding the piece of hardware's service provider.

func (Hardware_Router) GetSoftwareComponents 

func (r Hardware_Router) GetSoftwareComponents() (resp []datatypes.Software_Component, err error)

Retrieve Information regarding a piece of hardware's installed software.

func (Hardware_Router) GetSparePoolBillingItem 

func (r Hardware_Router) GetSparePoolBillingItem() (resp datatypes.Billing_Item_Hardware, err error)

Retrieve Information regarding the billing item for a spare pool server.

func (Hardware_Router) GetSshKeys 

func (r Hardware_Router) GetSshKeys() (resp []datatypes.Security_Ssh_Key, err error)

Retrieve SSH keys to be installed on the server during provisioning or an OS reload.

func (Hardware_Router) GetStorageGroups added in v1.0.2 

func (r Hardware_Router) GetStorageGroups() (resp []datatypes.Configuration_Storage_Group, err error)

Retrieve

func (Hardware_Router) GetStorageNetworkComponents 

func (r Hardware_Router) GetStorageNetworkComponents() (resp []datatypes.Network_Component, err error)

Retrieve A piece of hardware's private storage network components. [Deprecated]

func (Hardware_Router) GetTagReferences 

func (r Hardware_Router) GetTagReferences() (resp []datatypes.Tag_Reference, err error)

Retrieve

func (Hardware_Router) GetTopLevelLocation 

func (r Hardware_Router) GetTopLevelLocation() (resp datatypes.Location, err error)

Retrieve

func (Hardware_Router) GetTransactionHistory 

func (r Hardware_Router) GetTransactionHistory() (resp []datatypes.Provisioning_Version1_Transaction_History, err error)

This method will query transaction history for a piece of hardware.

func (Hardware_Router) GetUpgradeItemPrices 

func (r Hardware_Router) GetUpgradeItemPrices() (resp []datatypes.Product_Item_Price, err error)

Retrieve a list of upgradeable items available to this piece of hardware. Currently, getUpgradeItemPrices retrieves upgrades available for a server's memory, hard drives, network port speed, bandwidth allocation and GPUs.

func (Hardware_Router) GetUpgradeRequest 

func (r Hardware_Router) GetUpgradeRequest() (resp datatypes.Product_Upgrade_Request, err error)

Retrieve An account's associated upgrade request object, if any.

func (Hardware_Router) GetUpgradeableActiveComponents added in v1.1.2 

func (r Hardware_Router) GetUpgradeableActiveComponents() (resp []datatypes.Hardware_Component, err error)

Retrieve A piece of hardware's active upgradeable physical components.

func (Hardware_Router) GetUplinkHardware 

func (r Hardware_Router) GetUplinkHardware() (resp datatypes.Hardware, err error)

Retrieve The network device connected to a piece of hardware.

func (Hardware_Router) GetUplinkNetworkComponents 

func (r Hardware_Router) GetUplinkNetworkComponents() (resp []datatypes.Network_Component, err error)

Retrieve Information regarding the network component that is one level higher than a piece of hardware on the network infrastructure.

func (Hardware_Router) GetUserData 

func (r Hardware_Router) GetUserData() (resp []datatypes.Hardware_Attribute, err error)

Retrieve An array containing a single string of custom user data for a hardware order. Max size is 16 kb.

func (Hardware_Router) GetVirtualChassis 

func (r Hardware_Router) GetVirtualChassis() (resp datatypes.Hardware_Group, err error)

Retrieve Information regarding the virtual chassis for a piece of hardware.

func (Hardware_Router) GetVirtualChassisSiblings 

func (r Hardware_Router) GetVirtualChassisSiblings() (resp []datatypes.Hardware, err error)

Retrieve Information regarding the virtual chassis siblings for a piece of hardware.

func (Hardware_Router) GetVirtualHost 

func (r Hardware_Router) GetVirtualHost() (resp datatypes.Virtual_Host, err error)

Retrieve A piece of hardware's virtual host record.

func (Hardware_Router) GetVirtualLicenses 

func (r Hardware_Router) GetVirtualLicenses() (resp []datatypes.Software_VirtualLicense, err error)

Retrieve Information regarding a piece of hardware's virtual software licenses.

func (Hardware_Router) GetVirtualRack 

func (r Hardware_Router) GetVirtualRack() (resp datatypes.Network_Bandwidth_Version1_Allotment, err error)

Retrieve Information regarding the bandwidth allotment to which a piece of hardware belongs.

func (Hardware_Router) GetVirtualRackId 

func (r Hardware_Router) GetVirtualRackId() (resp int, err error)

Retrieve The name of the bandwidth allotment belonging to a piece of hardware.

func (Hardware_Router) GetVirtualRackName 

func (r Hardware_Router) GetVirtualRackName() (resp string, err error)

Retrieve The name of the bandwidth allotment belonging to a piece of hardware.

func (Hardware_Router) GetVirtualizationPlatform 

func (r Hardware_Router) GetVirtualizationPlatform() (resp datatypes.Software_Component, err error)

Retrieve A piece of hardware's virtualization platform software.

func (Hardware_Router) Id 

func (r Hardware_Router) Id(id int) Hardware_Router

func (Hardware_Router) ImportVirtualHost 

func (r Hardware_Router) ImportVirtualHost() (resp datatypes.Virtual_Host, err error)

The ”'importVirtualHost”' method attempts to import the host record for the virtualization platform running on a server.

func (Hardware_Router) IsPingable 

func (r Hardware_Router) IsPingable() (resp bool, err error)

The ”'isPingable”' method issues a ping command to the selected server and returns the result of the ping command. This boolean return value displays ”true” upon successful ping or ”false” for a failed ping.

func (Hardware_Router) Limit 

func (r Hardware_Router) Limit(limit int) Hardware_Router

func (Hardware_Router) Mask 

func (r Hardware_Router) Mask(mask string) Hardware_Router

func (Hardware_Router) Offset 

func (r Hardware_Router) Offset(offset int) Hardware_Router

func (Hardware_Router) Ping 

func (r Hardware_Router) Ping() (resp string, err error)

Issues a ping command to the server and returns the ping response.

func (Hardware_Router) PowerCycle 

func (r Hardware_Router) PowerCycle() (resp bool, err error)

The ”'powerCycle”' method completes a power off and power on of the server successively in one command. The power cycle command is equivalent to unplugging the server from the power strip and then plugging the server back in. ”'This method should only be used when all other options have been exhausted”'. Additional remote management commands may not be executed if this command was successfully issued within the last 20 minutes to avoid server failure. Remote management commands include:

rebootSoft rebootHard powerOn powerOff powerCycle

func (Hardware_Router) PowerOff 

func (r Hardware_Router) PowerOff() (resp bool, err error)

This method will power off the server via the server's remote management card.

func (Hardware_Router) PowerOn 

func (r Hardware_Router) PowerOn() (resp bool, err error)

The ”'powerOn”' method powers on a server via its remote management card. This boolean return value returns ”true” upon successful execution and ”false” if unsuccessful. Other remote management commands may not be issued in this command was successfully completed within the last 20 minutes to avoid server failure. Remote management commands include:

rebootSoft rebootHard powerOn powerOff powerCycle

func (Hardware_Router) RebootDefault 

func (r Hardware_Router) RebootDefault() (resp bool, err error)

The ”'rebootDefault”' method attempts to reboot the server by issuing a soft reboot, or reset, command to the server's remote management card. if the reset attempt is unsuccessful, a power cycle command will be issued via the power strip. The power cycle command is equivalent to unplugging the server from the power strip and then plugging the server back in. If the reset was successful within the last 20 minutes, another remote management command cannot be completed to avoid server failure. Remote management commands include:

rebootSoft rebootHard powerOn powerOff powerCycle

func (Hardware_Router) RebootHard 

func (r Hardware_Router) RebootHard() (resp bool, err error)

The ”'rebootHard”' method reboots the server by issuing a cycle command to the server's remote management card. A hard reboot is equivalent to pressing the ”Reset” button on a server - it is issued immediately and will not allow processes to shut down prior to the reboot. Completing a hard reboot may initiate system disk checks upon server reboot, causing the boot up to take longer than normally expected.

Remote management commands are unable to be executed if a reboot has been issued successfully within the last 20 minutes to avoid server failure. Remote management commands include:

rebootSoft rebootHard powerOn powerOff powerCycle

func (Hardware_Router) RebootSoft 

func (r Hardware_Router) RebootSoft() (resp bool, err error)

The ”'rebootSoft”' method reboots the server by issuing a reset command to the server's remote management card via soft reboot. When executing a soft reboot, servers allow all processes to shut down completely before rebooting. Remote management commands are unable to be issued within 20 minutes of issuing a successful soft reboot in order to avoid server failure. Remote management commands include:

rebootSoft rebootHard powerOn powerOff powerCycle

func (Hardware_Router) RefreshDeviceStatus added in v1.0.5 

func (r Hardware_Router) RefreshDeviceStatus() (resp datatypes.Hardware_State, err error)

no documentation yet

func (Hardware_Router) RemoveAccessToNetworkStorage 

func (r Hardware_Router) RemoveAccessToNetworkStorage(networkStorageTemplateObject *datatypes.Network_Storage) (resp bool, err error)

This method is used to remove access to s SoftLayer_Network_Storage volumes that supports host- or network-level access control.

func (Hardware_Router) RemoveAccessToNetworkStorageList 

func (r Hardware_Router) RemoveAccessToNetworkStorageList(networkStorageTemplateObjects []datatypes.Network_Storage) (resp bool, err error)

This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support host- or network-level access control.

func (Hardware_Router) RemoveTags 

func (r Hardware_Router) RemoveTags(tags *string) (resp bool, err error)

no documentation yet

func (Hardware_Router) SetTags 

func (r Hardware_Router) SetTags(tags *string) (resp bool, err error)

no documentation yet

func (Hardware_Router) UpdateIpmiPassword 

func (r Hardware_Router) UpdateIpmiPassword(password *string) (resp bool, err error)

This method will update the root IPMI password on this SoftLayer_Hardware.

type Hardware_SecurityModule 

type Hardware_SecurityModule struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetHardwareSecurityModuleService 

func GetHardwareSecurityModuleService(sess session.SLSession) Hardware_SecurityModule

GetHardwareSecurityModuleService returns an instance of the Hardware_SecurityModule SoftLayer service

func (Hardware_SecurityModule) ActivatePrivatePort 

func (r Hardware_SecurityModule) ActivatePrivatePort() (resp bool, err error)

Activate a server's private network interface to the maximum available speed. This operation is an alias for [SoftLayer_Hardware_Server/setPrivateNetworkInterfaceSpeed] with a $newSpeed of -1 and a $redundancy of "redundant" or unspecified (which results in the best available redundancy state).

Receipt of a response does not indicate completion of the configuration change. Any subsequent attempts to request the interface change speed or state, while changes are pending, will result in a busy error.

A response of true indicates a change was required to activate the interface; thus changes are pending. A response of false indicates the interface was already active, and thus no changes are pending.

func (Hardware_SecurityModule) ActivatePublicPort 

func (r Hardware_SecurityModule) ActivatePublicPort() (resp bool, err error)

Activate a server's public network interface to the maximum available speed. This operation is an alias for [SoftLayer_Hardware_Server/setPublicNetworkInterfaceSpeed] with a $newSpeed of -1 and a $redundancy of "redundant" or unspecified (which results in the best available redundancy state).

Receipt of a response does not indicate completion of the configuration change. Any subsequent attempts to request the interface change speed or state, while changes are pending, will result in a busy error.

A response of true indicates a change was required to activate the interface; thus changes are pending. A response of false indicates the interface was already active, and thus no changes are pending.

func (Hardware_SecurityModule) AllowAccessToNetworkStorage 

func (r Hardware_SecurityModule) AllowAccessToNetworkStorage(networkStorageTemplateObject *datatypes.Network_Storage) (resp bool, err error)

This method is used to allow access to a SoftLayer_Network_Storage volume that supports host- or network-level access control.

func (Hardware_SecurityModule) AllowAccessToNetworkStorageList 

func (r Hardware_SecurityModule) AllowAccessToNetworkStorageList(networkStorageTemplateObjects []datatypes.Network_Storage) (resp bool, err error)

This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support host- or network-level access control.

func (Hardware_SecurityModule) BootToRescueLayer 

func (r Hardware_SecurityModule) BootToRescueLayer(noOsBootEnvironment *string) (resp bool, err error)

The Rescue Kernel is designed to provide you with the ability to bring a server online in order to troubleshoot system problems that would normally only be resolved by an OS Reload. The correct Rescue Kernel will be selected based upon the currently installed operating system. When the rescue kernel process is initiated, the server will shutdown and reboot on to the public network with the same IP's assigned to the server to allow for remote connections. It will bring your server offline for approximately 10 minutes while the rescue is in progress. The root/administrator password will be the same as what is listed in the portal for the server.

func (Hardware_SecurityModule) CaptureImage 

func (r Hardware_SecurityModule) CaptureImage(captureTemplate *datatypes.Container_Disk_Image_Capture_Template) (resp datatypes.Virtual_Guest_Block_Device_Template_Group, err error)

Captures an Image of the hard disk on the physical machine, based on the capture template parameter. Returns the image template group containing the disk image.

func (Hardware_SecurityModule) ChangeRedfishPowerState added in v1.1.4 

func (r Hardware_SecurityModule) ChangeRedfishPowerState(state *string) (resp bool, err error)

Changes the power state for the server. The server's power status is changed from its remote management card.

func (Hardware_SecurityModule) CreateFirmwareReflashTransaction 

func (r Hardware_SecurityModule) CreateFirmwareReflashTransaction(ipmi *int, raidController *int, bios *int) (resp bool, err error)

You can launch firmware reflash by selecting from your server list. It will bring your server offline for approximately 60 minutes while the flashes are in progress.

In the event of a hardware failure during this our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online, and will be contacting you to ensure that impact on your server is minimal.

func (Hardware_SecurityModule) CreateFirmwareUpdateTransaction 

func (r Hardware_SecurityModule) CreateFirmwareUpdateTransaction(ipmi *int, raidController *int, bios *int, harddrive *int, networkCard *int) (resp bool, err error)

You can launch firmware updates by selecting from your server list. It will bring your server offline for approximately 20 minutes while the updates are in progress.

In the event of a hardware failure during this test our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online, and will be contacting you to ensure that impact on your server is minimal.

func (Hardware_SecurityModule) CreateHyperThreadingUpdateTransaction 

func (r Hardware_SecurityModule) CreateHyperThreadingUpdateTransaction(disableHyperthreading *int) (resp bool, err error)

You can launch hyper-threading update by selecting from your server list. It will bring your server offline for approximately 60 minutes while the update is in progress.

In the event of a hardware failure during this our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online, and will be contacting you to ensure that impact on your server is minimal.

func (Hardware_SecurityModule) CreateObject 

func (r Hardware_SecurityModule) CreateObject(templateObject *datatypes.Hardware_SecurityModule) (resp datatypes.Hardware_SecurityModule, err error)

<style type="text/css">.create_object > li > div { padding-top: .5em; padding-bottom: .5em}</style> createObject() enables the creation of servers on an account. This method is a simplified alternative to interacting with the ordering system directly.

In order to create a server, a template object must be sent in with a few required values.

When this method returns an order will have been placed for a server of the specified configuration.

To determine when the server is available you can poll the server via [[SoftLayer_Hardware/getObject|getObject]], checking the <code>provisionDate</code> property. When <code>provisionDate</code> is not null, the server will be ready. Be sure to use the <code>globalIdentifier</code> as your initialization parameter.

<b>Warning:</b> Servers created via this method will incur charges on your account. For testing input parameters see [[SoftLayer_Hardware/generateOrderTemplate|generateOrderTemplate]].

<b>Input</b> - [[SoftLayer_Hardware (type)|SoftLayer_Hardware]] <ul class="create_object"> 

    <li><code>hostname</code>
        <div>Hostname for the server.</div><ul>
            <li><b>Required</b></li>
            <li><b>Type</b> - string</li>
        </ul>
        <br />
    </li>
    <li><code>domain</code>
        <div>Domain for the server.</div><ul>
            <li><b>Required</b></li>
            <li><b>Type</b> - string</li>
        </ul>
        <br />
    </li>
    <li><code>processorCoreAmount</code>
        <div>The number of logical CPU cores to allocate.</div><ul>
            <li><b>Required</b></li>
            <li><b>Type</b> - int</li>
            <li>See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.</li>
        </ul>
        <br />
    </li>
    <li><code>memoryCapacity</code>
        <div>The amount of memory to allocate in gigabytes.</div><ul>
            <li><b>Required</b></li>
            <li><b>Type</b> - int</li>
            <li>See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.</li>
        </ul>
        <br />
    </li>
    <li><code>hourlyBillingFlag</code>
        <div>Specifies the billing type for the server.</div><ul>
            <li><b>Required</b></li>
            <li><b>Type</b> - boolean</li>
            <li>When true the server will be billed on hourly usage, otherwise it will be billed on a monthly basis.</li>
        </ul>
        <br />
    </li>
    <li><code>operatingSystemReferenceCode</code>
        <div>An identifier for the operating system to provision the server with.</div><ul>
            <li><b>Required</b></li>
            <li><b>Type</b> - string</li>
            <li>See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.</li>
        </ul>
        <br />
    </li>
    <li><code>datacenter.name</code>
        <div>Specifies which datacenter the server is to be provisioned in.</div><ul>
            <li><b>Required</b></li>
            <li><b>Type</b> - string</li>
            <li>The <code>datacenter</code> property is a [[SoftLayer_Location (type)|location]] structure with the <code>name</code> field set.</li>
            <li>See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.</li>
        </ul>
        <http title="Example">{
    "datacenter": {
        "name": "dal05"
    }
}</http>

        <br />
    </li>
    <li><code>networkComponents.maxSpeed</code>
        <div>Specifies the connection speed for the server's network components.</div><ul>
            <li><b>Optional</b></li>
            <li><b>Type</b> - int</li>
            <li><b>Default</b> - The highest available zero cost port speed will be used.</li>
            <li><b>Description</b> - The <code>networkComponents</code> property is an array with a single [[SoftLayer_Network_Component (type)|network component]] structure. The <code>maxSpeed</code> property must be set to specify the network uplink speed, in megabits per second, of the server.</li>
            <li>See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.</li>
        </ul>
            <http title="Example">{
    "networkComponents": [
        {
            "maxSpeed": 1000
        }
    ]
}</http>

        <br />
    </li>
    <li><code>networkComponents.redundancyEnabledFlag</code>
        <div>Specifies whether or not the server's network components should be in redundancy groups.</div><ul>
            <li><b>Optional</b></li>
            <li><b>Type</b> - bool</li>
            <li><b>Default</b> - <code>false</code></li>
            <li><b>Description</b> - The <code>networkComponents</code> property is an array with a single [[SoftLayer_Network_Component (type)|network component]] structure. When the <code>redundancyEnabledFlag</code> property is true the server's network components will be in redundancy groups.</li>
        </ul>
            <http title="Example">{
    "networkComponents": [
        {
            "redundancyEnabledFlag": false
        }
    ]
}</http>

        <br />
    </li>
    <li><code>privateNetworkOnlyFlag</code>
        <div>Specifies whether or not the server only has access to the private network</div><ul>
            <li><b>Optional</b></li>
            <li><b>Type</b> - boolean</li>
            <li><b>Default</b> - <code>false</code></li>
            <li>When true this flag specifies that a server is to only have access to the private network.</li>
        </ul>
        <br />
    </li>
    <li><code>primaryNetworkComponent.networkVlan.id</code>
        <div>Specifies the network vlan which is to be used for the frontend interface of the server.</div><ul>
            <li><b>Optional</b></li>
            <li><b>Type</b> - int</li>
            <li><b>Description</b> - The <code>primaryNetworkComponent</code> property is a [[SoftLayer_Network_Component (type)|network component]] structure with the <code>networkVlan</code> property populated with a [[SoftLayer_Network_Vlan (type)|vlan]] structure. The <code>id</code> property must be set to specify the frontend network vlan of the server.</li>
        </ul>
        <http title="Example">{
    "primaryNetworkComponent": {
        "networkVlan": {
            "id": 1
        }
    }
}</http>

        <br />
    </li>
    <li><code>primaryBackendNetworkComponent.networkVlan.id</code>
        <div>Specifies the network vlan which is to be used for the backend interface of the server.</div><ul>
            <li><b>Optional</b></li>
            <li><b>Type</b> - int</li>
            <li><b>Description</b> - The <code>primaryBackendNetworkComponent</code> property is a [[SoftLayer_Network_Component (type)|network component]] structure with the <code>networkVlan</code> property populated with a [[SoftLayer_Network_Vlan (type)|vlan]] structure. The <code>id</code> property must be set to specify the backend network vlan of the server.</li>
        </ul>
        <http title="Example">{
    "primaryBackendNetworkComponent": {
        "networkVlan": {
            "id": 2
        }
    }
}</http>

        <br />
    </li>
    <li><code>fixedConfigurationPreset.keyName</code>
        <div></div><ul>
            <li><b>Optional</b></li>
            <li><b>Type</b> - string</li>
            <li><b>Description</b> - The <code>fixedConfigurationPreset</code> property is a [[SoftLayer_Product_Package_Preset (type)|fixed configuration preset]] structure. The <code>keyName</code> property must be set to specify preset to use.</li>
            <li>If a fixed configuration preset is used <code>processorCoreAmount</code>, <code>memoryCapacity</code> and <code>hardDrives</code> properties must not be set.</li>
            <li>See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.</li>
        </ul>
        <http title="Example">{
    "fixedConfigurationPreset": {
        "keyName": "SOME_KEY_NAME"
    }
}</http>

        <br />
    </li>
    <li><code>userData.value</code>
        <div>Arbitrary data to be made available to the server.</div><ul>
            <li><b>Optional</b></li>
            <li><b>Type</b> - string</li>
            <li><b>Description</b> - The <code>userData</code> property is an array with a single [[SoftLayer_Hardware_Attribute (type)|attribute]] structure with the <code>value</code> property set to an arbitrary value.</li>
            <li>This value can be retrieved via the [[SoftLayer_Resource_Metadata/getUserMetadata|getUserMetadata]] method from a request originating from the server. This is primarily useful for providing data to software that may be on the server and configured to execute upon first boot.</li>
        </ul>
        <http title="Example">{
    "userData": [
        {
            "value": "someValue"
        }
    ]
}</http>

        <br />
    </li>
    <li><code>hardDrives</code>
        <div>Hard drive settings for the server</div><ul>
            <li><b>Optional</b></li>
            <li><b>Type</b> - SoftLayer_Hardware_Component</li>
            <li><b>Default</b> - The largest available capacity for a zero cost primary disk will be used.</li>
            <li><b>Description</b> - The <code>hardDrives</code> property is an array of [[SoftLayer_Hardware_Component (type)|hardware component]] structures.</i>
            <li>Each hard drive must specify the <code>capacity</code> property.</li>
            <li>See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.</li>
        </ul>
        <http title="Example">{
    "hardDrives": [
        {
            "capacity": 500
        }
    ]
}</http>

        <br />
    </li>
    <li id="hardware-create-object-ssh-keys"><code>sshKeys</code>
        <div>SSH keys to install on the server upon provisioning.</div><ul>
            <li><b>Optional</b></li>
            <li><b>Type</b> - array of [[SoftLayer_Security_Ssh_Key (type)|SoftLayer_Security_Ssh_Key]]</li>
            <li><b>Description</b> - The <code>sshKeys</code> property is an array of [[SoftLayer_Security_Ssh_Key (type)|SSH Key]] structures with the <code>id</code> property set to the value of an existing SSH key.</li>
            <li>To create a new SSH key, call [[SoftLayer_Security_Ssh_Key/createObject|createObject]] on the [[SoftLayer_Security_Ssh_Key]] service.</li>
            <li>To obtain a list of existing SSH keys, call [[SoftLayer_Account/getSshKeys|getSshKeys]] on the [[SoftLayer_Account]] service.
        </ul>
        <http title="Example">{
    "sshKeys": [
        {
            "id": 123
        }
    ]
}</http>

    <br />
</li>
<li><code>postInstallScriptUri</code>
    <div>Specifies the uri location of the script to be downloaded and run after installation is complete.</div><ul>
        <li><b>Optional</b></li>
        <li><b>Type</b> - string</li>
    </ul>
    <br />
</li>

</ul>

<h1>REST Example</h1> 

<http title="Request">curl -X POST -d '{
 "parameters":[
     {
         "hostname": "host1",
         "domain": "example.com",
         "processorCoreAmount": 2,
         "memoryCapacity": 2,
         "hourlyBillingFlag": true,
         "operatingSystemReferenceCode": "UBUNTU_LATEST"
     }
 ]
}' https://api.softlayer.com/rest/v3/SoftLayer_Hardware.json

</http> <http title="Response">HTTP/1.1 201 Created Location: https://api.softlayer.com/rest/v3/SoftLayer_Hardware/f5a3fcff-db1d-4b7c-9fa0-0349e41c29c5/getObject 

{
    "accountId": 232298,
    "bareMetalInstanceFlag": null,
    "domain": "example.com",
    "hardwareStatusId": null,
    "hostname": "host1",
    "id": null,
    "serviceProviderId": null,
    "serviceProviderResourceId": null,
    "globalIdentifier": "f5a3fcff-db1d-4b7c-9fa0-0349e41c29c5",
    "hourlyBillingFlag": true,
    "memoryCapacity": 2,
    "operatingSystemReferenceCode": "UBUNTU_LATEST",
    "processorCoreAmount": 2
}

</http>

func (Hardware_SecurityModule) CreatePostSoftwareInstallTransaction 

func (r Hardware_SecurityModule) CreatePostSoftwareInstallTransaction(installCodes []string, returnBoolean *bool) (resp bool, err error)

no documentation yet

func (Hardware_SecurityModule) DeleteObject 

func (r Hardware_SecurityModule) DeleteObject() (resp bool, err error)

This method will cancel a server effective immediately. For servers billed hourly, the charges will stop immediately after the method returns.

func (Hardware_SecurityModule) DeleteSoftwareComponentPasswords 

func (r Hardware_SecurityModule) DeleteSoftwareComponentPasswords(softwareComponentPasswords []datatypes.Software_Component_Password) (resp bool, err error)

Delete software component passwords.

func (Hardware_SecurityModule) DeleteTag 

func (r Hardware_SecurityModule) DeleteTag(tagName *string) (resp bool, err error)

Delete an existing tag. If there are any references on the tag, an exception will be thrown.

func (Hardware_SecurityModule) EditObject 

func (r Hardware_SecurityModule) EditObject(templateObject *datatypes.Hardware_Server) (resp bool, err error)

Edit a server's properties

func (Hardware_SecurityModule) EditSoftwareComponentPasswords 

func (r Hardware_SecurityModule) EditSoftwareComponentPasswords(softwareComponentPasswords []datatypes.Software_Component_Password) (resp bool, err error)

Edit the properties of a software component password such as the username, password, and notes.

func (Hardware_SecurityModule) ExecuteRemoteScript 

func (r Hardware_SecurityModule) ExecuteRemoteScript(uri *string) (err error)

Download and run remote script from uri on the hardware.

func (Hardware_SecurityModule) Filter 

func (r Hardware_SecurityModule) Filter(filter string) Hardware_SecurityModule

func (Hardware_SecurityModule) FindByIpAddress 

func (r Hardware_SecurityModule) FindByIpAddress(ipAddress *string) (resp datatypes.Hardware, err error)

The ”'findByIpAddress”' method finds hardware using its primary public or private IP address. IP addresses that have a secondary subnet tied to the hardware will not return the hardware. If no hardware is found, no errors are generated and no data is returned.

func (Hardware_SecurityModule) GenerateOrderTemplate 

func (r Hardware_SecurityModule) GenerateOrderTemplate(templateObject *datatypes.Hardware) (resp datatypes.Container_Product_Order, err error)

Obtain an [[SoftLayer_Container_Product_Order_Hardware_Server (type)|order container]] that can be sent to [[SoftLayer_Product_Order/verifyOrder|verifyOrder]] or [[SoftLayer_Product_Order/placeOrder|placeOrder]].

This is primarily useful when there is a necessity to confirm the price which will be charged for an order.

See [[SoftLayer_Hardware/createObject|createObject]] for specifics on the requirements of the template object parameter.

func (Hardware_SecurityModule) GetAccount 

func (r Hardware_SecurityModule) GetAccount() (resp datatypes.Account, err error)

Retrieve The account associated with a piece of hardware.

func (Hardware_SecurityModule) GetActiveComponents 

func (r Hardware_SecurityModule) GetActiveComponents() (resp []datatypes.Hardware_Component, err error)

Retrieve A piece of hardware's active physical components.

func (Hardware_SecurityModule) GetActiveNetworkFirewallBillingItem 

func (r Hardware_SecurityModule) GetActiveNetworkFirewallBillingItem() (resp datatypes.Billing_Item, err error)

Retrieve The billing item for a server's attached network firewall.

func (Hardware_SecurityModule) GetActiveNetworkMonitorIncident 

func (r Hardware_SecurityModule) GetActiveNetworkMonitorIncident() (resp []datatypes.Network_Monitor_Version1_Incident, err error)

Retrieve A piece of hardware's active network monitoring incidents.

func (Hardware_SecurityModule) GetActiveTickets 

func (r Hardware_SecurityModule) GetActiveTickets() (resp []datatypes.Ticket, err error)

Retrieve

func (Hardware_SecurityModule) GetActiveTransaction 

func (r Hardware_SecurityModule) GetActiveTransaction() (resp datatypes.Provisioning_Version1_Transaction, err error)

Retrieve Transaction currently running for server.

func (Hardware_SecurityModule) GetActiveTransactions 

func (r Hardware_SecurityModule) GetActiveTransactions() (resp []datatypes.Provisioning_Version1_Transaction, err error)

Retrieve Any active transaction(s) that are currently running for the server (example: os reload).

func (Hardware_SecurityModule) GetAllPowerComponents 

func (r Hardware_SecurityModule) GetAllPowerComponents() (resp []datatypes.Hardware_Power_Component, err error)

Retrieve

func (Hardware_SecurityModule) GetAllowedHost 

func (r Hardware_SecurityModule) GetAllowedHost() (resp datatypes.Network_Storage_Allowed_Host, err error)

Retrieve The SoftLayer_Network_Storage_Allowed_Host information to connect this server to Network Storage volumes that require access control lists.

func (Hardware_SecurityModule) GetAllowedNetworkStorage 

func (r Hardware_SecurityModule) GetAllowedNetworkStorage() (resp []datatypes.Network_Storage, err error)

Retrieve The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to.

func (Hardware_SecurityModule) GetAllowedNetworkStorageReplicas 

func (r Hardware_SecurityModule) GetAllowedNetworkStorageReplicas() (resp []datatypes.Network_Storage, err error)

Retrieve The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to.

func (Hardware_SecurityModule) GetAntivirusSpywareSoftwareComponent 

func (r Hardware_SecurityModule) GetAntivirusSpywareSoftwareComponent() (resp datatypes.Software_Component, err error)

Retrieve Information regarding an antivirus/spyware software component object.

func (Hardware_SecurityModule) GetAttachedNetworkStorages 

func (r Hardware_SecurityModule) GetAttachedNetworkStorages(nasType *string) (resp []datatypes.Network_Storage, err error)

This method is retrieve a list of SoftLayer_Network_Storage volumes that are authorized access to this SoftLayer_Hardware.

func (Hardware_SecurityModule) GetAttributes 

func (r Hardware_SecurityModule) GetAttributes() (resp []datatypes.Hardware_Attribute, err error)

Retrieve Information regarding a piece of hardware's specific attributes.

func (Hardware_SecurityModule) GetAvailableBillingTermChangePrices added in v1.0.4 

func (r Hardware_SecurityModule) GetAvailableBillingTermChangePrices() (resp []datatypes.Product_Item_Price, err error)

Retrieves a list of available term prices to this hardware. Currently, price terms are only available for increasing term length to monthly billed servers.

func (Hardware_SecurityModule) GetAvailableMonitoring 

func (r Hardware_SecurityModule) GetAvailableMonitoring() (resp []datatypes.Network_Monitor_Version1_Query_Host_Stratum, err error)

Retrieve An object that stores the maximum level for the monitoring query types and response types.

func (Hardware_SecurityModule) GetAvailableNetworkStorages 

func (r Hardware_SecurityModule) GetAvailableNetworkStorages(nasType *string) (resp []datatypes.Network_Storage, err error)

This method retrieves a list of SoftLayer_Network_Storage volumes that can be authorized to this SoftLayer_Hardware.

func (Hardware_SecurityModule) GetAverageDailyBandwidthUsage 

func (r Hardware_SecurityModule) GetAverageDailyBandwidthUsage() (resp datatypes.Float64, err error)

Retrieve The average daily total bandwidth usage for the current billing cycle.

func (Hardware_SecurityModule) GetAverageDailyPrivateBandwidthUsage 

func (r Hardware_SecurityModule) GetAverageDailyPrivateBandwidthUsage() (resp datatypes.Float64, err error)

Retrieve The average daily private bandwidth usage for the current billing cycle.

func (Hardware_SecurityModule) GetAverageDailyPublicBandwidthUsage 

func (r Hardware_SecurityModule) GetAverageDailyPublicBandwidthUsage() (resp datatypes.Float64, err error)

Retrieve The average daily public bandwidth usage for the current billing cycle.

func (Hardware_SecurityModule) GetBackendBandwidthUsage 

func (r Hardware_SecurityModule) GetBackendBandwidthUsage(startDate *datatypes.Time, endDate *datatypes.Time) (resp []datatypes.Metric_Tracking_Object_Data, err error)

Use this method to return an array of private bandwidth utilization records between a given date range.

This method represents the NEW version of getFrontendBandwidthUse

func (Hardware_SecurityModule) GetBackendIncomingBandwidth 

func (r Hardware_SecurityModule) GetBackendIncomingBandwidth(startDate *datatypes.Time, endDate *datatypes.Time) (resp datatypes.Float64, err error)

The ”'getBackendIncomingBandwidth”' method retrieves the amount of incoming private network traffic used between the given start date and end date parameters. When entering start and end dates, only the month, day and year are used to calculate bandwidth totals - the time (HH:MM:SS) is ignored and defaults to midnight. The amount of bandwidth retrieved is measured in gigabytes.

func (Hardware_SecurityModule) GetBackendNetworkComponents 

func (r Hardware_SecurityModule) GetBackendNetworkComponents() (resp []datatypes.Network_Component, err error)

Retrieve A piece of hardware's back-end or private network components.

func (Hardware_SecurityModule) GetBackendOutgoingBandwidth 

func (r Hardware_SecurityModule) GetBackendOutgoingBandwidth(startDate *datatypes.Time, endDate *datatypes.Time) (resp datatypes.Float64, err error)

The ”'getBackendOutgoingBandwidth”' method retrieves the amount of outgoing private network traffic used between the given start date and end date parameters. When entering start and end dates, only the month, day and year are used to calculate bandwidth totals - the time (HH:MM:SS) is ignored and defaults to midnight. The amount of bandwidth retrieved is measured in gigabytes.

func (Hardware_SecurityModule) GetBackendRouters 

func (r Hardware_SecurityModule) GetBackendRouters() (resp []datatypes.Hardware, err error)

Retrieve A hardware's backend or private router.

func (Hardware_SecurityModule) GetBandwidthAllocation 

func (r Hardware_SecurityModule) GetBandwidthAllocation() (resp datatypes.Float64, err error)

Retrieve A hardware's allotted bandwidth (measured in GB).

func (Hardware_SecurityModule) GetBandwidthAllotmentDetail 

func (r Hardware_SecurityModule) GetBandwidthAllotmentDetail() (resp datatypes.Network_Bandwidth_Version1_Allotment_Detail, err error)

Retrieve A hardware's allotted detail record. Allotment details link bandwidth allocation with allotments.

func (Hardware_SecurityModule) GetBandwidthForDateRange 

func (r Hardware_SecurityModule) GetBandwidthForDateRange(startDate *datatypes.Time, endDate *datatypes.Time) (resp []datatypes.Metric_Tracking_Object_Data, err error)

Retrieve a collection of bandwidth data from an individual public or private network tracking object. Data is ideal if you with to employ your own traffic storage and graphing systems.

func (Hardware_SecurityModule) GetBenchmarkCertifications 

func (r Hardware_SecurityModule) GetBenchmarkCertifications() (resp []datatypes.Hardware_Benchmark_Certification, err error)

Retrieve Information regarding a piece of hardware's benchmark certifications.

func (Hardware_SecurityModule) GetBillingCycleBandwidthUsage 

func (r Hardware_SecurityModule) GetBillingCycleBandwidthUsage() (resp []datatypes.Network_Bandwidth_Usage, err error)

Retrieve The raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to.

func (Hardware_SecurityModule) GetBillingCyclePrivateBandwidthUsage 

func (r Hardware_SecurityModule) GetBillingCyclePrivateBandwidthUsage() (resp datatypes.Network_Bandwidth_Usage, err error)

Retrieve The raw private bandwidth usage data for the current billing cycle.

func (Hardware_SecurityModule) GetBillingCyclePublicBandwidthUsage 

func (r Hardware_SecurityModule) GetBillingCyclePublicBandwidthUsage() (resp datatypes.Network_Bandwidth_Usage, err error)

Retrieve The raw public bandwidth usage data for the current billing cycle.

func (Hardware_SecurityModule) GetBillingItem 

func (r Hardware_SecurityModule) GetBillingItem() (resp datatypes.Billing_Item_Hardware, err error)

Retrieve Information regarding the billing item for a server.

func (Hardware_SecurityModule) GetBillingItemFlag 

func (r Hardware_SecurityModule) GetBillingItemFlag() (resp bool, err error)

Retrieve A flag indicating that a billing item exists.

func (Hardware_SecurityModule) GetBiosPasswordNullFlag 

func (r Hardware_SecurityModule) GetBiosPasswordNullFlag() (resp bool, err error)

Retrieve Determine if BIOS password should be left as null.

func (Hardware_SecurityModule) GetBlockCancelBecauseDisconnectedFlag 

func (r Hardware_SecurityModule) GetBlockCancelBecauseDisconnectedFlag() (resp bool, err error)

Retrieve Determines whether the hardware is ineligible for cancellation because it is disconnected.

func (Hardware_SecurityModule) GetBootModeOptions 

func (r Hardware_SecurityModule) GetBootModeOptions() (resp []string, err error)

Retrieve the valid boot modes for this server

func (Hardware_SecurityModule) GetBusinessContinuanceInsuranceFlag 

func (r Hardware_SecurityModule) GetBusinessContinuanceInsuranceFlag() (resp bool, err error)

Retrieve Status indicating whether or not a piece of hardware has business continuance insurance.

func (Hardware_SecurityModule) GetCaptureEnabledFlag added in v1.0.1 

func (r Hardware_SecurityModule) GetCaptureEnabledFlag() (resp datatypes.Container_Hardware_CaptureEnabled, err error)

Retrieve Determine if the server is able to be image captured. If unable to image capture a reason will be provided.

func (Hardware_SecurityModule) GetChildrenHardware 

func (r Hardware_SecurityModule) GetChildrenHardware() (resp []datatypes.Hardware, err error)

Retrieve Child hardware.

func (Hardware_SecurityModule) GetComponentDetailsXML 

func (r Hardware_SecurityModule) GetComponentDetailsXML() (resp string, err error)

no documentation yet

func (Hardware_SecurityModule) GetComponents 

func (r Hardware_SecurityModule) GetComponents() (resp []datatypes.Hardware_Component, err error)

Retrieve A piece of hardware's components.

func (Hardware_SecurityModule) GetContainsSolidStateDrivesFlag 

func (r Hardware_SecurityModule) GetContainsSolidStateDrivesFlag() (resp bool, err error)

Retrieve

func (Hardware_SecurityModule) GetContinuousDataProtectionSoftwareComponent 

func (r Hardware_SecurityModule) GetContinuousDataProtectionSoftwareComponent() (resp datatypes.Software_Component, err error)

Retrieve A continuous data protection/server backup software component object.

func (Hardware_SecurityModule) GetControlPanel 

func (r Hardware_SecurityModule) GetControlPanel() (resp datatypes.Software_Component_ControlPanel, err error)

Retrieve A server's control panel.

func (Hardware_SecurityModule) GetCost 

func (r Hardware_SecurityModule) GetCost() (resp datatypes.Float64, err error)

Retrieve The total cost of a server, measured in US Dollars ($USD).

func (Hardware_SecurityModule) GetCreateObjectOptions 

func (r Hardware_SecurityModule) GetCreateObjectOptions() (resp datatypes.Container_Hardware_Configuration, err error)

There are many options that may be provided while ordering a server, this method can be used to determine what these options are.

Detailed information on the return value can be found on the data type page for [[SoftLayer_Container_Hardware_Configuration (type)]].

func (Hardware_SecurityModule) GetCurrentBandwidthSummary 

func (r Hardware_SecurityModule) GetCurrentBandwidthSummary() (resp datatypes.Metric_Tracking_Object_Bandwidth_Summary, err error)

Retrieve An object that provides commonly used bandwidth summary components for the current billing cycle.

func (Hardware_SecurityModule) GetCurrentBenchmarkCertificationResultFile 

func (r Hardware_SecurityModule) GetCurrentBenchmarkCertificationResultFile() (resp []byte, err error)

Attempt to retrieve the file associated with the current benchmark certification result, if such a file exists. If there is no file for this benchmark certification result, calling this method throws an exception.

func (Hardware_SecurityModule) GetCurrentBillableBandwidthUsage 

func (r Hardware_SecurityModule) GetCurrentBillableBandwidthUsage() (resp datatypes.Float64, err error)

Retrieve The current billable public outbound bandwidth for this hardware for the current billing cycle.

func (Hardware_SecurityModule) GetCurrentBillingDetail 

func (r Hardware_SecurityModule) GetCurrentBillingDetail() (resp []datatypes.Billing_Item, err error)

Get the billing detail for this hardware for the current billing period. This does not include bandwidth usage.

func (Hardware_SecurityModule) GetCurrentBillingTotal 

func (r Hardware_SecurityModule) GetCurrentBillingTotal() (resp datatypes.Float64, err error)

Get the total bill amount in US Dollars ($) for this hardware in the current billing period. This includes all bandwidth used up to the point the method is called on the hardware.

func (Hardware_SecurityModule) GetCustomerInstalledOperatingSystemFlag 

func (r Hardware_SecurityModule) GetCustomerInstalledOperatingSystemFlag() (resp bool, err error)

Retrieve Indicates if a server has a Customer Installed OS

func (Hardware_SecurityModule) GetCustomerOwnedFlag 

func (r Hardware_SecurityModule) GetCustomerOwnedFlag() (resp bool, err error)

Retrieve Indicates if a server is a customer owned device.

func (Hardware_SecurityModule) GetDailyAverage 

func (r Hardware_SecurityModule) GetDailyAverage(startDate *datatypes.Time, endDate *datatypes.Time) (resp datatypes.Float64, err error)

The ”'getDailyAverage”' method calculates the average daily network traffic used by the selected server. Using the required parameter ”dateTime” to enter a start and end date, the user retrieves this average, measure in gigabytes (GB) for the specified date range. When entering parameters, only the month, day and year are required - time entries are omitted as this method defaults the time to midnight in order to account for the entire day.

func (Hardware_SecurityModule) GetDatacenter 

func (r Hardware_SecurityModule) GetDatacenter() (resp datatypes.Location, err error)

Retrieve Information regarding the datacenter in which a piece of hardware resides.

func (Hardware_SecurityModule) GetDatacenterName 

func (r Hardware_SecurityModule) GetDatacenterName() (resp string, err error)

Retrieve The name of the datacenter in which a piece of hardware resides.

func (Hardware_SecurityModule) GetDaysInSparePool 

func (r Hardware_SecurityModule) GetDaysInSparePool() (resp int, err error)

Retrieve Number of day(s) a server have been in spare pool.

func (Hardware_SecurityModule) GetDownlinkHardware 

func (r Hardware_SecurityModule) GetDownlinkHardware() (resp []datatypes.Hardware, err error)

Retrieve All hardware that has uplink network connections to a piece of hardware.

func (Hardware_SecurityModule) GetDownlinkNetworkHardware 

func (r Hardware_SecurityModule) GetDownlinkNetworkHardware() (resp []datatypes.Hardware, err error)

Retrieve All hardware that has uplink network connections to a piece of hardware.

func (Hardware_SecurityModule) GetDownlinkServers 

func (r Hardware_SecurityModule) GetDownlinkServers() (resp []datatypes.Hardware, err error)

Retrieve Information regarding all servers attached to a piece of network hardware.

func (Hardware_SecurityModule) GetDownlinkVirtualGuests 

func (r Hardware_SecurityModule) GetDownlinkVirtualGuests() (resp []datatypes.Virtual_Guest, err error)

Retrieve Information regarding all virtual guests attached to a piece of network hardware.

func (Hardware_SecurityModule) GetDownstreamHardwareBindings 

func (r Hardware_SecurityModule) GetDownstreamHardwareBindings() (resp []datatypes.Network_Component_Uplink_Hardware, err error)

Retrieve All hardware downstream from a network device.

func (Hardware_SecurityModule) GetDownstreamNetworkHardware 

func (r Hardware_SecurityModule) GetDownstreamNetworkHardware() (resp []datatypes.Hardware, err error)

Retrieve All network hardware downstream from the selected piece of hardware.

func (Hardware_SecurityModule) GetDownstreamNetworkHardwareWithIncidents 

func (r Hardware_SecurityModule) GetDownstreamNetworkHardwareWithIncidents() (resp []datatypes.Hardware, err error)

Retrieve All network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. [DEPRECATED]

func (Hardware_SecurityModule) GetDownstreamServers 

func (r Hardware_SecurityModule) GetDownstreamServers() (resp []datatypes.Hardware, err error)

Retrieve Information regarding all servers attached downstream to a piece of network hardware.

func (Hardware_SecurityModule) GetDownstreamVirtualGuests 

func (r Hardware_SecurityModule) GetDownstreamVirtualGuests() (resp []datatypes.Virtual_Guest, err error)

Retrieve Information regarding all virtual guests attached to a piece of network hardware.

func (Hardware_SecurityModule) GetDriveControllers 

func (r Hardware_SecurityModule) GetDriveControllers() (resp []datatypes.Hardware_Component, err error)

Retrieve The drive controllers contained within a piece of hardware.

func (Hardware_SecurityModule) GetEvaultNetworkStorage 

func (r Hardware_SecurityModule) GetEvaultNetworkStorage() (resp []datatypes.Network_Storage, err error)

Retrieve Information regarding a piece of hardware's associated EVault network storage service account.

func (Hardware_SecurityModule) GetFirewallProtectableSubnets 

func (r Hardware_SecurityModule) GetFirewallProtectableSubnets() (resp []datatypes.Network_Subnet, err error)

Get the subnets associated with this server that are protectable by a network component firewall.

func (Hardware_SecurityModule) GetFirewallServiceComponent 

func (r Hardware_SecurityModule) GetFirewallServiceComponent() (resp datatypes.Network_Component_Firewall, err error)

Retrieve Information regarding a piece of hardware's firewall services.

func (Hardware_SecurityModule) GetFixedConfigurationPreset 

func (r Hardware_SecurityModule) GetFixedConfigurationPreset() (resp datatypes.Product_Package_Preset, err error)

Retrieve Defines the fixed components in a fixed configuration bare metal server.

func (Hardware_SecurityModule) GetFrontendBandwidthUsage 

func (r Hardware_SecurityModule) GetFrontendBandwidthUsage(startDate *datatypes.Time, endDate *datatypes.Time) (resp []datatypes.Metric_Tracking_Object_Data, err error)

Use this method to return an array of public bandwidth utilization records between a given date range.

This method represents the NEW version of getFrontendBandwidthUse

func (Hardware_SecurityModule) GetFrontendIncomingBandwidth 

func (r Hardware_SecurityModule) GetFrontendIncomingBandwidth(startDate *datatypes.Time, endDate *datatypes.Time) (resp datatypes.Float64, err error)

The ”'getFrontendIncomingBandwidth”' method retrieves the amount of incoming public network traffic used by a server between the given start and end date parameters. When entering the ”dateTime” parameter, only the month, day and year of the start and end dates are required - the time (hour, minute and second) are set to midnight by default and cannot be changed. The amount of bandwidth retrieved is measured in gigabytes (GB).

func (Hardware_SecurityModule) GetFrontendNetworkComponents 

func (r Hardware_SecurityModule) GetFrontendNetworkComponents() (resp []datatypes.Network_Component, err error)

Retrieve A piece of hardware's front-end or public network components.

func (Hardware_SecurityModule) GetFrontendOutgoingBandwidth 

func (r Hardware_SecurityModule) GetFrontendOutgoingBandwidth(startDate *datatypes.Time, endDate *datatypes.Time) (resp datatypes.Float64, err error)

The ”'getFrontendOutgoingBandwidth”' method retrieves the amount of outgoing public network traffic used by a server between the given start and end date parameters. The ”dateTime” parameter requires only the day, month and year to be entered - the time (hour, minute and second) are set to midnight be default in order to gather the data for the entire start and end date indicated in the parameter. The amount of bandwidth retrieved is measured in gigabytes (GB).

func (Hardware_SecurityModule) GetFrontendRouters 

func (r Hardware_SecurityModule) GetFrontendRouters() (resp []datatypes.Hardware, err error)

Retrieve A hardware's frontend or public router.

func (Hardware_SecurityModule) GetFutureBillingItem added in v1.0.4 

func (r Hardware_SecurityModule) GetFutureBillingItem() (resp datatypes.Billing_Item_Hardware, err error)

Retrieve Information regarding the future billing item for a server.

func (Hardware_SecurityModule) GetGlobalIdentifier 

func (r Hardware_SecurityModule) GetGlobalIdentifier() (resp string, err error)

Retrieve A hardware's universally unique identifier.

func (Hardware_SecurityModule) GetHardDrives 

func (r Hardware_SecurityModule) GetHardDrives() (resp []datatypes.Hardware_Component, err error)

Retrieve The hard drives contained within a piece of hardware.

func (Hardware_SecurityModule) GetHardwareByIpAddress 

func (r Hardware_SecurityModule) GetHardwareByIpAddress(ipAddress *string) (resp datatypes.Hardware_Server, err error)

Retrieve a server by searching for the primary IP address.

func (Hardware_SecurityModule) GetHardwareChassis 

func (r Hardware_SecurityModule) GetHardwareChassis() (resp datatypes.Hardware_Chassis, err error)

Retrieve The chassis that a piece of hardware is housed in.

func (Hardware_SecurityModule) GetHardwareFunction 

func (r Hardware_SecurityModule) GetHardwareFunction() (resp datatypes.Hardware_Function, err error)

Retrieve A hardware's function.

func (Hardware_SecurityModule) GetHardwareFunctionDescription 

func (r Hardware_SecurityModule) GetHardwareFunctionDescription() (resp string, err error)

Retrieve A hardware's function.

func (Hardware_SecurityModule) GetHardwareState added in v1.0.4 

func (r Hardware_SecurityModule) GetHardwareState() (resp datatypes.Hardware_State, err error)

Retrieve A hardware's power/transaction state.

func (Hardware_SecurityModule) GetHardwareStatus 

func (r Hardware_SecurityModule) GetHardwareStatus() (resp datatypes.Hardware_Status, err error)

Retrieve A hardware's status.

func (Hardware_SecurityModule) GetHasSingleRootVirtualizationBillingItemFlag 

func (r Hardware_SecurityModule) GetHasSingleRootVirtualizationBillingItemFlag() (resp bool, err error)

Retrieve Determine if hardware has Single Root IO VIrtualization (SR-IOV) billing item.

func (Hardware_SecurityModule) GetHasTrustedPlatformModuleBillingItemFlag 

func (r Hardware_SecurityModule) GetHasTrustedPlatformModuleBillingItemFlag() (resp bool, err error)

Retrieve Determine in hardware object has TPM enabled.

func (Hardware_SecurityModule) GetHostIpsSoftwareComponent 

func (r Hardware_SecurityModule) GetHostIpsSoftwareComponent() (resp datatypes.Software_Component, err error)

Retrieve Information regarding a host IPS software component object.

func (Hardware_SecurityModule) GetHourlyBandwidth 

func (r Hardware_SecurityModule) GetHourlyBandwidth(mode *string, day *datatypes.Time) (resp []datatypes.Metric_Tracking_Object_Data, err error)

The ”'getHourlyBandwidth”' method retrieves all bandwidth updates hourly for the specified hardware. Because the potential number of data points can become excessive, the method limits the user to obtain data in 24-hour intervals. The required ”dateTime” parameter is used as the starting point for the query and will be calculated for the 24-hour period starting with the specified date and time. For example, entering a parameter of

'02/01/2008 0:00'

results in a return of all bandwidth data for the entire day of February 1, 2008, as 0:00 specifies a midnight start date. Please note that the time entered should be completed using a 24-hour clock (military time, astronomical time).

For data spanning more than a single 24-hour period, refer to the getBandwidthData function on the metricTrackingObject for the piece of hardware.

func (Hardware_SecurityModule) GetHourlyBillingFlag 

func (r Hardware_SecurityModule) GetHourlyBillingFlag() (resp bool, err error)

Retrieve A server's hourly billing status.

func (Hardware_SecurityModule) GetInboundBandwidthUsage 

func (r Hardware_SecurityModule) GetInboundBandwidthUsage() (resp datatypes.Float64, err error)

Retrieve The sum of all the inbound network traffic data for the last 30 days.

func (Hardware_SecurityModule) GetInboundPrivateBandwidthUsage 

func (r Hardware_SecurityModule) GetInboundPrivateBandwidthUsage() (resp datatypes.Float64, err error)

Retrieve The total private inbound bandwidth for this hardware for the current billing cycle.

func (Hardware_SecurityModule) GetInboundPublicBandwidthUsage 

func (r Hardware_SecurityModule) GetInboundPublicBandwidthUsage() (resp datatypes.Float64, err error)

Retrieve The total public inbound bandwidth for this hardware for the current billing cycle.

func (Hardware_SecurityModule) GetIsBillingTermChangeAvailableFlag added in v1.0.4 

func (r Hardware_SecurityModule) GetIsBillingTermChangeAvailableFlag() (resp bool, err error)

Retrieve Whether or not this hardware object is eligible to change to term billing.

func (Hardware_SecurityModule) GetIsCloudReadyNodeCertified 

func (r Hardware_SecurityModule) GetIsCloudReadyNodeCertified() (resp bool, err error)

Retrieve Determine if hardware object has the IBM_CLOUD_READY_NODE_CERTIFIED attribute.

func (Hardware_SecurityModule) GetIsIpmiDisabled 

func (r Hardware_SecurityModule) GetIsIpmiDisabled() (resp bool, err error)

Retrieve Determine if remote management has been disabled due to port speed.

func (Hardware_SecurityModule) GetIsNfsOnly added in v1.1.6 

func (r Hardware_SecurityModule) GetIsNfsOnly() (resp string, err error)

Retrieve A server that has nfs only drive.

func (Hardware_SecurityModule) GetIsQeInternalServer added in v1.1.3 

func (r Hardware_SecurityModule) GetIsQeInternalServer() (resp bool, err error)

Retrieve Determine if hardware object has the QE_INTERNAL_SERVER attribute.

func (Hardware_SecurityModule) GetIsVirtualPrivateCloudNode 

func (r Hardware_SecurityModule) GetIsVirtualPrivateCloudNode() (resp bool, err error)

Retrieve Determine if hardware object is a Virtual Private Cloud node.

func (Hardware_SecurityModule) GetItemPricesFromSoftwareDescriptions 

func (r Hardware_SecurityModule) GetItemPricesFromSoftwareDescriptions(softwareDescriptions []datatypes.Software_Description, includeTranslationsFlag *bool, returnAllPricesFlag *bool) (resp []datatypes.Product_Item, err error)

Return a collection of SoftLayer_Item_Price objects from a collection of SoftLayer_Software_Description

func (Hardware_SecurityModule) GetLastOperatingSystemReload 

func (r Hardware_SecurityModule) GetLastOperatingSystemReload() (resp datatypes.Provisioning_Version1_Transaction, err error)

Retrieve The last transaction that a server's operating system was loaded.

func (Hardware_SecurityModule) GetLastTransaction 

func (r Hardware_SecurityModule) GetLastTransaction() (resp datatypes.Provisioning_Version1_Transaction, err error)

Retrieve Information regarding the last transaction a server performed.

func (Hardware_SecurityModule) GetLatestNetworkMonitorIncident 

func (r Hardware_SecurityModule) GetLatestNetworkMonitorIncident() (resp datatypes.Network_Monitor_Version1_Incident, err error)

Retrieve A piece of hardware's latest network monitoring incident.

func (Hardware_SecurityModule) GetLocation 

func (r Hardware_SecurityModule) GetLocation() (resp datatypes.Location, err error)

Retrieve Where a piece of hardware is located within SoftLayer's location hierarchy.

func (Hardware_SecurityModule) GetLocationPathString 

func (r Hardware_SecurityModule) GetLocationPathString() (resp string, err error)

Retrieve

func (Hardware_SecurityModule) GetLockboxNetworkStorage 

func (r Hardware_SecurityModule) GetLockboxNetworkStorage() (resp datatypes.Network_Storage, err error)

Retrieve Information regarding a lockbox account associated with a server.

func (Hardware_SecurityModule) GetLogicalVolumeStorageGroups added in v1.0.2 

func (r Hardware_SecurityModule) GetLogicalVolumeStorageGroups() (resp []datatypes.Configuration_Storage_Group, err error)

Retrieve Returns a list of logical volumes on the physical machine.

func (Hardware_SecurityModule) GetManagedResourceFlag 

func (r Hardware_SecurityModule) GetManagedResourceFlag() (resp bool, err error)

Retrieve A flag indicating that the hardware is a managed resource.

func (Hardware_SecurityModule) GetManagementNetworkComponent 

func (r Hardware_SecurityModule) GetManagementNetworkComponent() (resp datatypes.Network_Component, err error)

Retrieve the remote management network component attached with this server.

func (Hardware_SecurityModule) GetMemory 

func (r Hardware_SecurityModule) GetMemory() (resp []datatypes.Hardware_Component, err error)

Retrieve Information regarding a piece of hardware's memory.

func (Hardware_SecurityModule) GetMemoryCapacity 

func (r Hardware_SecurityModule) GetMemoryCapacity() (resp uint, err error)

Retrieve The amount of memory a piece of hardware has, measured in gigabytes.

func (Hardware_SecurityModule) GetMetricTrackingObject 

func (r Hardware_SecurityModule) GetMetricTrackingObject() (resp datatypes.Metric_Tracking_Object, err error)

Retrieve A piece of hardware's metric tracking object.

func (Hardware_SecurityModule) GetMetricTrackingObjectId 

func (r Hardware_SecurityModule) GetMetricTrackingObjectId() (resp int, err error)

Retrieve The metric tracking object id for this server.

func (Hardware_SecurityModule) GetModules 

func (r Hardware_SecurityModule) GetModules() (resp []datatypes.Hardware_Component, err error)

Retrieve

func (Hardware_SecurityModule) GetMonitoringRobot 

func (r Hardware_SecurityModule) GetMonitoringRobot() (resp datatypes.Monitoring_Robot, err error)

Retrieve

func (Hardware_SecurityModule) GetMonitoringServiceComponent 

func (r Hardware_SecurityModule) GetMonitoringServiceComponent() (resp datatypes.Network_Monitor_Version1_Query_Host_Stratum, err error)

Retrieve Information regarding a piece of hardware's network monitoring services.

func (Hardware_SecurityModule) GetMonitoringServiceEligibilityFlag 

func (r Hardware_SecurityModule) GetMonitoringServiceEligibilityFlag() (resp bool, err error)

Retrieve

func (Hardware_SecurityModule) GetMonitoringUserNotification 

func (r Hardware_SecurityModule) GetMonitoringUserNotification() (resp []datatypes.User_Customer_Notification_Hardware, err error)

Retrieve The monitoring notification objects for this hardware. Each object links this hardware instance to a user account that will be notified if monitoring on this hardware object fails

func (Hardware_SecurityModule) GetMotherboard 

func (r Hardware_SecurityModule) GetMotherboard() (resp datatypes.Hardware_Component, err error)

Retrieve Information regarding a piece of hardware's motherboard.

func (Hardware_SecurityModule) GetNetworkCards 

func (r Hardware_SecurityModule) GetNetworkCards() (resp []datatypes.Hardware_Component, err error)

Retrieve Information regarding a piece of hardware's network cards.

func (Hardware_SecurityModule) GetNetworkComponentFirewallProtectableIpAddresses 

func (r Hardware_SecurityModule) GetNetworkComponentFirewallProtectableIpAddresses() (resp []datatypes.Network_Subnet_IpAddress, err error)

Get the IP addresses associated with this server that are protectable by a network component firewall. Note, this may not return all values for IPv6 subnets for this server. Please use getFirewallProtectableSubnets to get all protectable subnets.

func (Hardware_SecurityModule) GetNetworkComponents 

func (r Hardware_SecurityModule) GetNetworkComponents() (resp []datatypes.Network_Component, err error)

Retrieve Returns a hardware's network components.

func (Hardware_SecurityModule) GetNetworkGatewayMember 

func (r Hardware_SecurityModule) GetNetworkGatewayMember() (resp datatypes.Network_Gateway_Member, err error)

Retrieve The gateway member if this device is part of a network gateway.

func (Hardware_SecurityModule) GetNetworkGatewayMemberFlag 

func (r Hardware_SecurityModule) GetNetworkGatewayMemberFlag() (resp bool, err error)

Retrieve Whether or not this device is part of a network gateway.

func (Hardware_SecurityModule) GetNetworkManagementIpAddress 

func (r Hardware_SecurityModule) GetNetworkManagementIpAddress() (resp string, err error)

Retrieve A piece of hardware's network management IP address.

func (Hardware_SecurityModule) GetNetworkMonitorAttachedDownHardware 

func (r Hardware_SecurityModule) GetNetworkMonitorAttachedDownHardware() (resp []datatypes.Hardware, err error)

Retrieve All servers with failed monitoring that are attached downstream to a piece of hardware.

func (Hardware_SecurityModule) GetNetworkMonitorAttachedDownVirtualGuests 

func (r Hardware_SecurityModule) GetNetworkMonitorAttachedDownVirtualGuests() (resp []datatypes.Virtual_Guest, err error)

Retrieve Virtual guests that are attached downstream to a hardware that have failed monitoring

func (Hardware_SecurityModule) GetNetworkMonitorIncidents 

func (r Hardware_SecurityModule) GetNetworkMonitorIncidents() (resp []datatypes.Network_Monitor_Version1_Incident, err error)

Retrieve The status of all of a piece of hardware's network monitoring incidents.

func (Hardware_SecurityModule) GetNetworkMonitors 

func (r Hardware_SecurityModule) GetNetworkMonitors() (resp []datatypes.Network_Monitor_Version1_Query_Host, err error)

Retrieve Information regarding a piece of hardware's network monitors.

func (Hardware_SecurityModule) GetNetworkStatus 

func (r Hardware_SecurityModule) GetNetworkStatus() (resp string, err error)

Retrieve The value of a hardware's network status attribute. [DEPRECATED]

func (Hardware_SecurityModule) GetNetworkStatusAttribute 

func (r Hardware_SecurityModule) GetNetworkStatusAttribute() (resp datatypes.Hardware_Attribute, err error)

Retrieve The hardware's related network status attribute. [DEPRECATED]

func (Hardware_SecurityModule) GetNetworkStorage 

func (r Hardware_SecurityModule) GetNetworkStorage() (resp []datatypes.Network_Storage, err error)

Retrieve Information regarding a piece of hardware's associated network storage service account.

func (Hardware_SecurityModule) GetNetworkVlans 

func (r Hardware_SecurityModule) GetNetworkVlans() (resp []datatypes.Network_Vlan, err error)

Retrieve The network virtual LANs (VLANs) associated with a piece of hardware's network components.

func (Hardware_SecurityModule) GetNextBillingCycleBandwidthAllocation 

func (r Hardware_SecurityModule) GetNextBillingCycleBandwidthAllocation() (resp datatypes.Float64, err error)

Retrieve A hardware's allotted bandwidth for the next billing cycle (measured in GB).

func (Hardware_SecurityModule) GetNotesHistory 

func (r Hardware_SecurityModule) GetNotesHistory() (resp []datatypes.Hardware_Note, err error)

Retrieve

func (Hardware_SecurityModule) GetNvRamCapacity 

func (r Hardware_SecurityModule) GetNvRamCapacity() (resp uint, err error)

Retrieve The amount of non-volatile memory a piece of hardware has, measured in gigabytes.

func (Hardware_SecurityModule) GetNvRamComponentModels 

func (r Hardware_SecurityModule) GetNvRamComponentModels() (resp []datatypes.Hardware_Component_Model, err error)

Retrieve

func (Hardware_SecurityModule) GetObject 

func (r Hardware_SecurityModule) GetObject() (resp datatypes.Hardware_SecurityModule, err error)

no documentation yet

func (Hardware_SecurityModule) GetOpenCancellationTicket 

func (r Hardware_SecurityModule) GetOpenCancellationTicket() (resp datatypes.Ticket, err error)

Retrieve An open ticket requesting cancellation of this server, if one exists.

func (Hardware_SecurityModule) GetOperatingSystem 

func (r Hardware_SecurityModule) GetOperatingSystem() (resp datatypes.Software_Component_OperatingSystem, err error)

Retrieve Information regarding a piece of hardware's operating system.

func (Hardware_SecurityModule) GetOperatingSystemReferenceCode 

func (r Hardware_SecurityModule) GetOperatingSystemReferenceCode() (resp string, err error)

Retrieve A hardware's operating system software description.

func (Hardware_SecurityModule) GetOutboundBandwidthUsage 

func (r Hardware_SecurityModule) GetOutboundBandwidthUsage() (resp datatypes.Float64, err error)

Retrieve The sum of all the outbound network traffic data for the last 30 days.

func (Hardware_SecurityModule) GetOutboundPrivateBandwidthUsage 

func (r Hardware_SecurityModule) GetOutboundPrivateBandwidthUsage() (resp datatypes.Float64, err error)

Retrieve The total private outbound bandwidth for this hardware for the current billing cycle.

func (Hardware_SecurityModule) GetOutboundPublicBandwidthUsage 

func (r Hardware_SecurityModule) GetOutboundPublicBandwidthUsage() (resp datatypes.Float64, err error)

Retrieve The total public outbound bandwidth for this hardware for the current billing cycle.

func (Hardware_SecurityModule) GetOverBandwidthAllocationFlag 

func (r Hardware_SecurityModule) GetOverBandwidthAllocationFlag() (resp int, err error)

Retrieve Whether the bandwidth usage for this hardware for the current billing cycle exceeds the allocation.

func (Hardware_SecurityModule) GetPMInfo 

func (r Hardware_SecurityModule) GetPMInfo() (resp []datatypes.Container_RemoteManagement_PmInfo, err error)

Retrieve a server's hardware state via its internal sensors. Remote sensor data is transmitted to the SoftLayer API by way of the server's remote management card. Sensor data measures system temperatures, voltages, and other local server settings. Sensor data is cached for 30 seconds. Calls made to getSensorData for the same server within 30 seconds of each other will return the same data. Subsequent calls will return new data once the cache expires.

func (Hardware_SecurityModule) GetParentBay 

func (r Hardware_SecurityModule) GetParentBay() (resp datatypes.Hardware_Blade, err error)

Retrieve Blade Bay

func (Hardware_SecurityModule) GetParentHardware 

func (r Hardware_SecurityModule) GetParentHardware() (resp datatypes.Hardware, err error)

Retrieve Parent Hardware.

func (Hardware_SecurityModule) GetPartitions added in v1.0.3 

func (r Hardware_SecurityModule) GetPartitions() (resp []datatypes.Hardware_Server_Partition, err error)

Retrieve

func (Hardware_SecurityModule) GetPointOfPresenceLocation 

func (r Hardware_SecurityModule) GetPointOfPresenceLocation() (resp datatypes.Location, err error)

Retrieve Information regarding the Point of Presence (PoP) location in which a piece of hardware resides.

func (Hardware_SecurityModule) GetPowerComponents 

func (r Hardware_SecurityModule) GetPowerComponents() (resp []datatypes.Hardware_Power_Component, err error)

Retrieve The power components for a hardware object.

func (Hardware_SecurityModule) GetPowerSupply 

func (r Hardware_SecurityModule) GetPowerSupply() (resp []datatypes.Hardware_Component, err error)

Retrieve Information regarding a piece of hardware's power supply.

func (Hardware_SecurityModule) GetPrimaryBackendIpAddress 

func (r Hardware_SecurityModule) GetPrimaryBackendIpAddress() (resp string, err error)

Retrieve The hardware's primary private IP address.

func (Hardware_SecurityModule) GetPrimaryBackendNetworkComponent 

func (r Hardware_SecurityModule) GetPrimaryBackendNetworkComponent() (resp datatypes.Network_Component, err error)

Retrieve Information regarding the hardware's primary back-end network component.

func (Hardware_SecurityModule) GetPrimaryDriveSize 

func (r Hardware_SecurityModule) GetPrimaryDriveSize() (resp int, err error)

no documentation yet

func (Hardware_SecurityModule) GetPrimaryIpAddress 

func (r Hardware_SecurityModule) GetPrimaryIpAddress() (resp string, err error)

Retrieve The hardware's primary public IP address.

func (Hardware_SecurityModule) GetPrimaryNetworkComponent 

func (r Hardware_SecurityModule) GetPrimaryNetworkComponent() (resp datatypes.Network_Component, err error)

Retrieve Information regarding the hardware's primary public network component.

func (Hardware_SecurityModule) GetPrivateBackendNetworkComponents added in v1.0.6 

func (r Hardware_SecurityModule) GetPrivateBackendNetworkComponents() (resp []datatypes.Network_Component, err error)

Retrieve A collection of backendNetwork components

func (Hardware_SecurityModule) GetPrivateBandwidthData 

func (r Hardware_SecurityModule) GetPrivateBandwidthData(startTime *int, endTime *int) (resp []datatypes.Metric_Tracking_Object_Data, err error)

Retrieve this server's private bandwidth data. If no timeframe is specified then getPrivateBandwidthData retrieves the last 24 hours of public bandwidth usage.

func (Hardware_SecurityModule) GetPrivateBandwidthDataSummary 

func (r Hardware_SecurityModule) GetPrivateBandwidthDataSummary() (resp datatypes.Container_Network_Bandwidth_Data_Summary, err error)

Retrieve a brief summary of a server's private network bandwidth usage. getPrivateBandwidthDataSummary retrieves a server's bandwidth allocation for its billing period, its estimated usage during its billing period, and an estimation of how much bandwidth it will use during its billing period based on its current usage. A server's projected bandwidth usage increases in accuracy as it progresses through its billing period.

func (Hardware_SecurityModule) GetPrivateIpAddress 

func (r Hardware_SecurityModule) GetPrivateIpAddress() (resp string, err error)

Retrieve A server's primary private IP address.

func (Hardware_SecurityModule) GetPrivateNetworkComponent 

func (r Hardware_SecurityModule) GetPrivateNetworkComponent() (resp datatypes.Network_Component, err error)

Retrieve the private network component attached with this server.

func (Hardware_SecurityModule) GetPrivateNetworkOnlyFlag 

func (r Hardware_SecurityModule) GetPrivateNetworkOnlyFlag() (resp bool, err error)

Retrieve Whether the hardware only has access to the private network.

func (Hardware_SecurityModule) GetPrivateVlan 

func (r Hardware_SecurityModule) GetPrivateVlan() (resp datatypes.Network_Vlan, err error)

Retrieve the backend VLAN for the primary IP address of the server

func (Hardware_SecurityModule) GetProcessorCoreAmount 

func (r Hardware_SecurityModule) GetProcessorCoreAmount() (resp uint, err error)

Retrieve The total number of processor cores, summed from all processors that are attached to a piece of hardware

func (Hardware_SecurityModule) GetProcessorPhysicalCoreAmount 

func (r Hardware_SecurityModule) GetProcessorPhysicalCoreAmount() (resp uint, err error)

Retrieve The total number of physical processor cores, summed from all processors that are attached to a piece of hardware

func (Hardware_SecurityModule) GetProcessors 

func (r Hardware_SecurityModule) GetProcessors() (resp []datatypes.Hardware_Component, err error)

Retrieve Information regarding a piece of hardware's processors.

func (Hardware_SecurityModule) GetProjectedOverBandwidthAllocationFlag 

func (r Hardware_SecurityModule) GetProjectedOverBandwidthAllocationFlag() (resp int, err error)

Retrieve Whether the bandwidth usage for this hardware for the current billing cycle is projected to exceed the allocation.

func (Hardware_SecurityModule) GetProjectedPublicBandwidthUsage 

func (r Hardware_SecurityModule) GetProjectedPublicBandwidthUsage() (resp datatypes.Float64, err error)

Retrieve The projected public outbound bandwidth for this hardware for the current billing cycle.

func (Hardware_SecurityModule) GetProvisionDate 

func (r Hardware_SecurityModule) GetProvisionDate() (resp datatypes.Time, err error)

no documentation yet

func (Hardware_SecurityModule) GetPublicBandwidthData 

func (r Hardware_SecurityModule) GetPublicBandwidthData(startTime *int, endTime *int) (resp []datatypes.Metric_Tracking_Object_Data, err error)

Retrieve this server's public bandwidth data. If no timeframe is specified then getPublicBandwidthData retrieves the last 24 hours of public bandwidth usage.

func (Hardware_SecurityModule) GetPublicBandwidthDataSummary 

func (r Hardware_SecurityModule) GetPublicBandwidthDataSummary() (resp datatypes.Container_Network_Bandwidth_Data_Summary, err error)

Retrieve a brief summary of a server's public network bandwidth usage. getPublicBandwidthDataSummary retrieves a server's bandwidth allocation for its billing period, its estimated usage during its billing period, and an estimation of how much bandwidth it will use during its billing period based on its current usage. A server's projected bandwidth usage increases in accuracy as it progresses through its billing period.

func (Hardware_SecurityModule) GetPublicBandwidthTotal 

func (r Hardware_SecurityModule) GetPublicBandwidthTotal(startTime *int, endTime *int) (resp uint, err error)

Retrieve the total number of bytes used by a server over a specified time period via the data warehouse tracking objects for this hardware.

func (Hardware_SecurityModule) GetPublicNetworkComponent 

func (r Hardware_SecurityModule) GetPublicNetworkComponent() (resp datatypes.Network_Component, err error)

Retrieve a SoftLayer server's public network component. Some servers are only connected to the private network and may not have a public network component. In that case getPublicNetworkComponent returns a null object.

func (Hardware_SecurityModule) GetPublicVlan 

func (r Hardware_SecurityModule) GetPublicVlan() (resp datatypes.Network_Vlan, err error)

Retrieve the frontend VLAN for the primary IP address of the server

func (Hardware_SecurityModule) GetPublicVlanByHostname 

func (r Hardware_SecurityModule) GetPublicVlanByHostname(hostname *string) (resp datatypes.Network_Vlan, err error)

Retrieve the frontend network Vlan by searching the hostname of a server

func (Hardware_SecurityModule) GetRack 

func (r Hardware_SecurityModule) GetRack() (resp datatypes.Location, err error)

Retrieve

func (Hardware_SecurityModule) GetRaidControllers 

func (r Hardware_SecurityModule) GetRaidControllers() (resp []datatypes.Hardware_Component, err error)

Retrieve The RAID controllers contained within a piece of hardware.

func (Hardware_SecurityModule) GetReadyNodeFlag 

func (r Hardware_SecurityModule) GetReadyNodeFlag() (resp bool, err error)

Retrieve Determine if hardware object is vSan Ready Node.

func (Hardware_SecurityModule) GetRecentEvents 

func (r Hardware_SecurityModule) GetRecentEvents() (resp []datatypes.Notification_Occurrence_Event, err error)

Retrieve Recent events that impact this hardware.

func (Hardware_SecurityModule) GetRecentRemoteManagementCommands 

func (r Hardware_SecurityModule) GetRecentRemoteManagementCommands() (resp []datatypes.Hardware_Component_RemoteManagement_Command_Request, err error)

Retrieve The last five commands issued to the server's remote management card.

func (Hardware_SecurityModule) GetRedfishPowerState added in v1.1.4 

func (r Hardware_SecurityModule) GetRedfishPowerState() (resp string, err error)

Retrieves the power state for the server. The server's power status is retrieved from its remote management card. This will return 'on' or 'off'.

func (Hardware_SecurityModule) GetRegionalInternetRegistry 

func (r Hardware_SecurityModule) GetRegionalInternetRegistry() (resp datatypes.Network_Regional_Internet_Registry, err error)

Retrieve

func (Hardware_SecurityModule) GetRemoteManagement 

func (r Hardware_SecurityModule) GetRemoteManagement() (resp datatypes.Hardware_Component_RemoteManagement, err error)

Retrieve A server's remote management card.

func (Hardware_SecurityModule) GetRemoteManagementAccounts 

func (r Hardware_SecurityModule) GetRemoteManagementAccounts() (resp []datatypes.Hardware_Component_RemoteManagement_User, err error)

Retrieve User credentials to issue commands and/or interact with the server's remote management card.

func (Hardware_SecurityModule) GetRemoteManagementComponent 

func (r Hardware_SecurityModule) GetRemoteManagementComponent() (resp datatypes.Network_Component, err error)

Retrieve A hardware's associated remote management component. This is normally IPMI.

func (Hardware_SecurityModule) GetRemoteManagementUsers 

func (r Hardware_SecurityModule) GetRemoteManagementUsers() (resp []datatypes.Hardware_Component_RemoteManagement_User, err error)

Retrieve User(s) who have access to issue commands and/or interact with the server's remote management card.

func (Hardware_SecurityModule) GetResourceConfigurations 

func (r Hardware_SecurityModule) GetResourceConfigurations() (resp []datatypes.Hardware_Resource_Configuration, err error)

Retrieve

func (Hardware_SecurityModule) GetResourceGroupMemberReferences 

func (r Hardware_SecurityModule) GetResourceGroupMemberReferences() (resp []datatypes.Resource_Group_Member, err error)

Retrieve

func (Hardware_SecurityModule) GetResourceGroupRoles 

func (r Hardware_SecurityModule) GetResourceGroupRoles() (resp []datatypes.Resource_Group_Role, err error)

Retrieve

func (Hardware_SecurityModule) GetResourceGroups 

func (r Hardware_SecurityModule) GetResourceGroups() (resp []datatypes.Resource_Group, err error)

Retrieve The resource groups in which this hardware is a member.

func (Hardware_SecurityModule) GetReverseDomainRecords 

func (r Hardware_SecurityModule) GetReverseDomainRecords() (resp []datatypes.Dns_Domain, err error)

Retrieve the reverse domain records associated with this server.

func (Hardware_SecurityModule) GetRouters 

func (r Hardware_SecurityModule) GetRouters() (resp []datatypes.Hardware, err error)

Retrieve A hardware's routers.

func (Hardware_SecurityModule) GetSecurityScanRequests 

func (r Hardware_SecurityModule) GetSecurityScanRequests() (resp []datatypes.Network_Security_Scanner_Request, err error)

Retrieve Information regarding a piece of hardware's vulnerability scan requests.

func (Hardware_SecurityModule) GetSensorData 

func (r Hardware_SecurityModule) GetSensorData() (resp []datatypes.Container_RemoteManagement_SensorReading, err error)

Retrieve a server's hardware state via its internal sensors. Remote sensor data is transmitted to the SoftLayer API by way of the server's remote management card. Sensor data measures system temperatures, voltages, and other local server settings. Sensor data is cached for 30 seconds. Calls made to getSensorData for the same server within 30 seconds of each other will return the same data. Subsequent calls will return new data once the cache expires.

func (Hardware_SecurityModule) GetSensorDataWithGraphs 

func (r Hardware_SecurityModule) GetSensorDataWithGraphs() (resp datatypes.Container_RemoteManagement_SensorReadingsWithGraphs, err error)

Retrieves the raw data returned from the server's remote management card. For more details of what is returned please refer to the getSensorData method. Along with the raw data, graphs for the cpu and system temperatures and fan speeds are also returned.

func (Hardware_SecurityModule) GetServerDetails 

func (r Hardware_SecurityModule) GetServerDetails() (resp datatypes.Container_Hardware_Server_Details, err error)

Retrieve a server's hardware components, software, and network components. getServerDetails is an aggregation function that combines the results of [[SoftLayer_Hardware_Server::getComponents]], [[SoftLayer_Hardware_Server::getSoftware]], and [[SoftLayer_Hardware_Server::getNetworkComponents]] in a single container.

func (Hardware_SecurityModule) GetServerFanSpeedGraphs 

func (r Hardware_SecurityModule) GetServerFanSpeedGraphs() (resp []datatypes.Container_RemoteManagement_Graphs_SensorSpeed, err error)

Retrieve the server's fan speeds and displays them using tachometer graphs. Data used to construct graphs is retrieved from the server's remote management card. All graphs returned will have a title associated with it.

func (Hardware_SecurityModule) GetServerPowerState 

func (r Hardware_SecurityModule) GetServerPowerState() (resp string, err error)

Retrieves the power state for the server. The server's power status is retrieved from its remote management card. This will return 'on' or 'off'.

func (Hardware_SecurityModule) GetServerRoom 

func (r Hardware_SecurityModule) GetServerRoom() (resp datatypes.Location, err error)

Retrieve Information regarding the server room in which the hardware is located.

func (Hardware_SecurityModule) GetServerTemperatureGraphs 

func (r Hardware_SecurityModule) GetServerTemperatureGraphs() (resp []datatypes.Container_RemoteManagement_Graphs_SensorTemperature, err error)

Retrieve the server's temperature and displays them using thermometer graphs. Temperatures retrieved are CPU(s) and system temperatures. Data used to construct graphs is retrieved from the server's remote management card. All graphs returned will have a title associated with it.

func (Hardware_SecurityModule) GetServiceProvider 

func (r Hardware_SecurityModule) GetServiceProvider() (resp datatypes.Service_Provider, err error)

Retrieve Information regarding the piece of hardware's service provider.

func (Hardware_SecurityModule) GetSoftwareComponents 

func (r Hardware_SecurityModule) GetSoftwareComponents() (resp []datatypes.Software_Component, err error)

Retrieve Information regarding a piece of hardware's installed software.

func (Hardware_SecurityModule) GetSoftwareGuardExtensionEnabled 

func (r Hardware_SecurityModule) GetSoftwareGuardExtensionEnabled() (resp bool, err error)

Retrieve Determine if hardware object has Software Guard Extension (SGX) enabled.

func (Hardware_SecurityModule) GetSparePoolBillingItem 

func (r Hardware_SecurityModule) GetSparePoolBillingItem() (resp datatypes.Billing_Item_Hardware, err error)

Retrieve Information regarding the billing item for a spare pool server.

func (Hardware_SecurityModule) GetSshKeys 

func (r Hardware_SecurityModule) GetSshKeys() (resp []datatypes.Security_Ssh_Key, err error)

Retrieve SSH keys to be installed on the server during provisioning or an OS reload.

func (Hardware_SecurityModule) GetStatisticsRemoteManagement 

func (r Hardware_SecurityModule) GetStatisticsRemoteManagement() (resp datatypes.Hardware_Component_RemoteManagement, err error)

Retrieve A server's remote management card used for statistics.

func (Hardware_SecurityModule) GetStorageGroups added in v1.0.2 

func (r Hardware_SecurityModule) GetStorageGroups() (resp []datatypes.Configuration_Storage_Group, err error)

Retrieve

func (Hardware_SecurityModule) GetStorageNetworkComponents 

func (r Hardware_SecurityModule) GetStorageNetworkComponents() (resp []datatypes.Network_Component, err error)

Retrieve A piece of hardware's private storage network components. [Deprecated]

func (Hardware_SecurityModule) GetTagReferences 

func (r Hardware_SecurityModule) GetTagReferences() (resp []datatypes.Tag_Reference, err error)

Retrieve

func (Hardware_SecurityModule) GetTopLevelLocation 

func (r Hardware_SecurityModule) GetTopLevelLocation() (resp datatypes.Location, err error)

Retrieve

func (Hardware_SecurityModule) GetTransactionHistory 

func (r Hardware_SecurityModule) GetTransactionHistory() (resp []datatypes.Provisioning_Version1_Transaction_History, err error)

This method will query transaction history for a piece of hardware.

func (Hardware_SecurityModule) GetUefiBootFlag 

func (r Hardware_SecurityModule) GetUefiBootFlag() (resp bool, err error)

Retrieve Whether to use UEFI boot instead of BIOS.

func (Hardware_SecurityModule) GetUpgradeItemPrices 

func (r Hardware_SecurityModule) GetUpgradeItemPrices() (resp []datatypes.Product_Item_Price, err error)

Retrieve a list of upgradeable items available to this piece of hardware. Currently, getUpgradeItemPrices retrieves upgrades available for a server's memory, hard drives, network port speed, bandwidth allocation and GPUs.

func (Hardware_SecurityModule) GetUpgradeRequest 

func (r Hardware_SecurityModule) GetUpgradeRequest() (resp datatypes.Product_Upgrade_Request, err error)

Retrieve An account's associated upgrade request object, if any.

func (Hardware_SecurityModule) GetUpgradeableActiveComponents added in v1.1.2 

func (r Hardware_SecurityModule) GetUpgradeableActiveComponents() (resp []datatypes.Hardware_Component, err error)

Retrieve A piece of hardware's active upgradeable physical components.

func (Hardware_SecurityModule) GetUplinkHardware 

func (r Hardware_SecurityModule) GetUplinkHardware() (resp datatypes.Hardware, err error)

Retrieve The network device connected to a piece of hardware.

func (Hardware_SecurityModule) GetUplinkNetworkComponents 

func (r Hardware_SecurityModule) GetUplinkNetworkComponents() (resp []datatypes.Network_Component, err error)

Retrieve Information regarding the network component that is one level higher than a piece of hardware on the network infrastructure.

func (Hardware_SecurityModule) GetUserData 

func (r Hardware_SecurityModule) GetUserData() (resp []datatypes.Hardware_Attribute, err error)

Retrieve An array containing a single string of custom user data for a hardware order. Max size is 16 kb.

func (Hardware_SecurityModule) GetUsers 

func (r Hardware_SecurityModule) GetUsers() (resp []datatypes.User_Customer, err error)

Retrieve A list of users that have access to this computing instance.

func (Hardware_SecurityModule) GetValidBlockDeviceTemplateGroups 

func (r Hardware_SecurityModule) GetValidBlockDeviceTemplateGroups(visibility *string) (resp []datatypes.Virtual_Guest_Block_Device_Template_Group, err error)

This method will return the list of block device template groups that are valid to the host. For instance, it will only retrieve FLEX images.

func (Hardware_SecurityModule) GetVirtualChassis 

func (r Hardware_SecurityModule) GetVirtualChassis() (resp datatypes.Hardware_Group, err error)

Retrieve Information regarding the virtual chassis for a piece of hardware.

func (Hardware_SecurityModule) GetVirtualChassisSiblings 

func (r Hardware_SecurityModule) GetVirtualChassisSiblings() (resp []datatypes.Hardware, err error)

Retrieve Information regarding the virtual chassis siblings for a piece of hardware.

func (Hardware_SecurityModule) GetVirtualGuests 

func (r Hardware_SecurityModule) GetVirtualGuests() (resp []datatypes.Virtual_Guest, err error)

Retrieve [DEPRECATED] A hardware server's virtual servers.

func (Hardware_SecurityModule) GetVirtualHost 

func (r Hardware_SecurityModule) GetVirtualHost() (resp datatypes.Virtual_Host, err error)

Retrieve A piece of hardware's virtual host record.

func (Hardware_SecurityModule) GetVirtualLicenses 

func (r Hardware_SecurityModule) GetVirtualLicenses() (resp []datatypes.Software_VirtualLicense, err error)

Retrieve Information regarding a piece of hardware's virtual software licenses.

func (Hardware_SecurityModule) GetVirtualRack 

func (r Hardware_SecurityModule) GetVirtualRack() (resp datatypes.Network_Bandwidth_Version1_Allotment, err error)

Retrieve Information regarding the bandwidth allotment to which a piece of hardware belongs.

func (Hardware_SecurityModule) GetVirtualRackId 

func (r Hardware_SecurityModule) GetVirtualRackId() (resp int, err error)

Retrieve The name of the bandwidth allotment belonging to a piece of hardware.

func (Hardware_SecurityModule) GetVirtualRackName 

func (r Hardware_SecurityModule) GetVirtualRackName() (resp string, err error)

Retrieve The name of the bandwidth allotment belonging to a piece of hardware.

func (Hardware_SecurityModule) GetVirtualizationPlatform 

func (r Hardware_SecurityModule) GetVirtualizationPlatform() (resp datatypes.Software_Component, err error)

Retrieve A piece of hardware's virtualization platform software.

func (Hardware_SecurityModule) GetWindowsUpdateAvailableUpdates 

func (r Hardware_SecurityModule) GetWindowsUpdateAvailableUpdates() (resp []datatypes.Container_Utility_Microsoft_Windows_UpdateServices_UpdateItem, err error)

Retrieve a list of Windows updates available for a server from the local SoftLayer Windows Server Update Services (WSUS) server. Windows servers provisioned by SoftLayer are configured to use the local WSUS server via the private network by default.

func (Hardware_SecurityModule) GetWindowsUpdateInstalledUpdates 

func (r Hardware_SecurityModule) GetWindowsUpdateInstalledUpdates() (resp []datatypes.Container_Utility_Microsoft_Windows_UpdateServices_UpdateItem, err error)

Retrieve a list of Windows updates installed on a server as reported by the local SoftLayer Windows Server Update Services (WSUS) server. Windows servers provisioned by SoftLayer are configured to use the local WSUS server via the private network by default.

func (Hardware_SecurityModule) GetWindowsUpdateStatus 

func (r Hardware_SecurityModule) GetWindowsUpdateStatus() (resp datatypes.Container_Utility_Microsoft_Windows_UpdateServices_Status, err error)

This method returns an update status record for this server. That record will specify if the server is missing updates, or has updates that must be reinstalled or require a reboot to go into affect.

func (Hardware_SecurityModule) Id 

func (r Hardware_SecurityModule) Id(id int) Hardware_SecurityModule

func (Hardware_SecurityModule) ImportVirtualHost 

func (r Hardware_SecurityModule) ImportVirtualHost() (resp datatypes.Virtual_Host, err error)

The ”'importVirtualHost”' method attempts to import the host record for the virtualization platform running on a server.

func (Hardware_SecurityModule) InitiateIderaBareMetalRestore 

func (r Hardware_SecurityModule) InitiateIderaBareMetalRestore() (resp bool, err error)

Idera Bare Metal Server Restore is a backup agent designed specifically for making full system restores made with Idera Server Backup.

func (Hardware_SecurityModule) InitiateR1SoftBareMetalRestore 

func (r Hardware_SecurityModule) InitiateR1SoftBareMetalRestore() (resp bool, err error)

R1Soft Bare Metal Server Restore is an R1Soft disk agent designed specifically for making full system restores made with R1Soft CDP Server backup.

func (Hardware_SecurityModule) IsBackendPingable 

func (r Hardware_SecurityModule) IsBackendPingable() (resp bool, err error)

Issues a ping command and returns the success (true) or failure (false) of the ping command.

func (Hardware_SecurityModule) IsPingable 

func (r Hardware_SecurityModule) IsPingable() (resp bool, err error)

Issues a ping command and returns the success (true) or failure (false) of the ping command.

func (Hardware_SecurityModule) IsWindowsServer 

func (r Hardware_SecurityModule) IsWindowsServer() (resp bool, err error)

Determine if the server runs any version of the Microsoft Windows operating systems. Return ”true” if it does and ”false if otherwise.

func (Hardware_SecurityModule) Limit 

func (r Hardware_SecurityModule) Limit(limit int) Hardware_SecurityModule

func (Hardware_SecurityModule) Mask 

func (r Hardware_SecurityModule) Mask(mask string) Hardware_SecurityModule

func (Hardware_SecurityModule) MassFirmwareReflash 

func (r Hardware_SecurityModule) MassFirmwareReflash(hardwareIds []int, ipmi *bool, raidController *bool, bios *bool) (resp []datatypes.Container_Hardware_Server_Request, err error)

You can launch firmware reflashes by selecting from your server list. It will bring your server offline for approximately 60 minutes while the reflashes are in progress.

In the event of a hardware failure during this test our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online. They will be contact you to ensure that impact on your server is minimal.

func (Hardware_SecurityModule) MassFirmwareUpdate 

func (r Hardware_SecurityModule) MassFirmwareUpdate(hardwareIds []int, ipmi *bool, raidController *bool, bios *bool, harddrive *bool, networkCard *bool) (resp []datatypes.Container_Hardware_Server_Request, err error)

You can launch firmware updates by selecting from your server list. It will bring your server offline for approximately 20 minutes while the updates are in progress.

In the event of a hardware failure during this test our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online, and will be contacting you to ensure that impact on your server is minimal.

func (Hardware_SecurityModule) MassHyperThreadingUpdate 

func (r Hardware_SecurityModule) MassHyperThreadingUpdate(hardwareIds []int, disableHyperthreading *bool) (resp []datatypes.Container_Hardware_Server_Request, err error)

You can launch hyper-threading update by selecting from your server list. It will bring your server offline for approximately 60 minutes while the updates are in progress.

In the event of a hardware failure during this update our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online. They will be in contact with you to ensure that impact on your server is minimal.

func (Hardware_SecurityModule) MassReloadOperatingSystem 

func (r Hardware_SecurityModule) MassReloadOperatingSystem(hardwareIds []string, token *string, config *datatypes.Container_Hardware_Server_Configuration) (resp string, err error)

Reloads current or customer specified operating system configuration.

This service has a confirmation protocol for proceeding with the reload. To proceed with the reload without confirmation, simply pass in 'FORCE' as the token parameter. To proceed with the reload with confirmation, simply call the service with no parameter. A token string will be returned by this service. The token will remain active for 10 minutes. Use this token as the parameter to confirm that a reload is to be performed for the server.

As a precaution, we strongly recommend backing up all data before reloading the operating system. The reload will format the primary disk and will reconfigure the server to the current specifications on record.

The reload will take AT MINIMUM 66 minutes.

func (Hardware_SecurityModule) MassSparePool 

func (r Hardware_SecurityModule) MassSparePool(hardwareIds []string, action *string, newOrder *bool) (resp []datatypes.Container_Hardware_Server_Request, err error)

The ability to place multiple bare metal servers in a state where they are powered down and ports closed yet still allocated to the customer as a part of the Spare Pool program.

func (Hardware_SecurityModule) Offset 

func (r Hardware_SecurityModule) Offset(offset int) Hardware_SecurityModule

func (Hardware_SecurityModule) Ping 

func (r Hardware_SecurityModule) Ping() (resp string, err error)

Issues a ping command to the server and returns the ping response.

func (Hardware_SecurityModule) PopulateServerRam 

func (r Hardware_SecurityModule) PopulateServerRam(ramSerialString *string) (err error)

no documentation yet

func (Hardware_SecurityModule) PowerCycle 

func (r Hardware_SecurityModule) PowerCycle() (resp bool, err error)

Power off then power on the server via powerstrip. The power cycle command is equivalent to unplugging the server from the powerstrip and then plugging the server back into the powerstrip. This should only be used as a last resort. If a reboot command has been issued successfully in the past 20 minutes, another remote management command (rebootSoft, rebootHard, powerOn, powerOff and powerCycle) will not be allowed. This is to avoid any type of server failures.

func (Hardware_SecurityModule) PowerOff 

func (r Hardware_SecurityModule) PowerOff() (resp bool, err error)

This method will power off the server via the server's remote management card.

func (Hardware_SecurityModule) PowerOn 

func (r Hardware_SecurityModule) PowerOn() (resp bool, err error)

Power on server via its remote management card. If a reboot command has been issued successfully in the past 20 minutes, another remote management command (rebootSoft, rebootHard, powerOn, powerOff and powerCycle) will not be allowed. This is to avoid any type of server failures.

func (Hardware_SecurityModule) RebootDefault 

func (r Hardware_SecurityModule) RebootDefault() (resp bool, err error)

Attempts to reboot the server by issuing a reset (soft reboot) command to the server's remote management card. If the reset (soft reboot) attempt is unsuccessful, a power cycle command will be issued via the powerstrip. The power cycle command is equivalent to unplugging the server from the powerstrip and then plugging the server back into the powerstrip. If a reboot command has been issued successfully in the past 20 minutes, another remote management command (rebootSoft, rebootHard, powerOn, powerOff and powerCycle) will not be allowed. This is to avoid any type of server failures.

func (Hardware_SecurityModule) RebootHard 

func (r Hardware_SecurityModule) RebootHard() (resp bool, err error)

Reboot the server by issuing a cycle command to the server's remote management card. This is equivalent to pressing the 'Reset' button on the server. This command is issued immediately and will not wait for processes to shutdown. After this command is issued, the server may take a few moments to boot up as server may run system disks checks. If a reboot command has been issued successfully in the past 20 minutes, another remote management command (rebootSoft, rebootHard, powerOn, powerOff and powerCycle) will not be allowed. This is to avoid any type of server failures.

func (Hardware_SecurityModule) RebootSoft 

func (r Hardware_SecurityModule) RebootSoft() (resp bool, err error)

Reboot the server by issuing a reset command to the server's remote management card. This is a graceful reboot. The servers will allow all process to shutdown gracefully before rebooting. If a reboot command has been issued successfully in the past 20 minutes, another remote management command (rebootSoft, rebootHard, powerOn, powerOff and powerCycle) will not be allowed. This is to avoid any type of server failures.

func (Hardware_SecurityModule) RefreshDeviceStatus added in v1.0.5 

func (r Hardware_SecurityModule) RefreshDeviceStatus() (resp datatypes.Hardware_State, err error)

no documentation yet

func (Hardware_SecurityModule) ReloadCurrentOperatingSystemConfiguration 

func (r Hardware_SecurityModule) ReloadCurrentOperatingSystemConfiguration(token *string) (resp string, err error)

Reloads current operating system configuration.

This service has a confirmation protocol for proceeding with the reload. To proceed with the reload without confirmation, simply pass in 'FORCE' as the token parameter. To proceed with the reload with confirmation, simply call the service with no parameter. A token string will be returned by this service. The token will remain active for 10 minutes. Use this token as the parameter to confirm that a reload is to be performed for the server.

As a precaution, we strongly recommend backing up all data before reloading the operating system. The reload will format the primary disk and will reconfigure the server to the current specifications on record.

The reload will take AT MINIMUM 66 minutes.

func (Hardware_SecurityModule) ReloadOperatingSystem 

func (r Hardware_SecurityModule) ReloadOperatingSystem(token *string, config *datatypes.Container_Hardware_Server_Configuration) (resp string, err error)

Reloads current or customer specified operating system configuration.

This service has a confirmation protocol for proceeding with the reload. To proceed with the reload without confirmation, simply pass in 'FORCE' as the token parameter. To proceed with the reload with confirmation, simply call the service with no parameter. A token string will be returned by this service. The token will remain active for 10 minutes. Use this token as the parameter to confirm that a reload is to be performed for the server.

As a precaution, we strongly recommend backing up all data before reloading the operating system. The reload will format the primary disk and will reconfigure the server to the current specifications on record.

The reload will take AT MINIMUM 66 minutes.

func (Hardware_SecurityModule) RemoveAccessToNetworkStorage 

func (r Hardware_SecurityModule) RemoveAccessToNetworkStorage(networkStorageTemplateObject *datatypes.Network_Storage) (resp bool, err error)

This method is used to remove access to s SoftLayer_Network_Storage volumes that supports host- or network-level access control.

func (Hardware_SecurityModule) RemoveAccessToNetworkStorageList 

func (r Hardware_SecurityModule) RemoveAccessToNetworkStorageList(networkStorageTemplateObjects []datatypes.Network_Storage) (resp bool, err error)

This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support host- or network-level access control.

func (Hardware_SecurityModule) RemoveTags 

func (r Hardware_SecurityModule) RemoveTags(tags *string) (resp bool, err error)

no documentation yet

func (Hardware_SecurityModule) RunPassmarkCertificationBenchmark 

func (r Hardware_SecurityModule) RunPassmarkCertificationBenchmark() (resp bool, err error)

You can launch a new Passmark hardware test by selecting from your server list. It will bring your server offline for approximately 20 minutes while the testing is in progress, and will publish a certificate with the results to your hardware details page.

While the hard drives are tested for the initial deployment, the Passmark Certificate utility will not test the hard drives on your live server. This is to ensure that no data is overwritten. If you would like to test the server's hard drives, you can have the full Passmark suite installed to your server free of charge through a new Support ticket.

While the test itself does not overwrite any data on the server, it is recommended that you make full off-server backups of all data prior to launching the test. The Passmark hardware test is designed to force any latent hardware issues to the surface, so hardware failure is possible.

In the event of a hardware failure during this test our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online, and will be contacting you to ensure that impact on your server is minimal.

func (Hardware_SecurityModule) SetOperatingSystemPassword 

func (r Hardware_SecurityModule) SetOperatingSystemPassword(newPassword *string) (resp bool, err error)

Changes the password that we have stored in our database for a servers' Operating System

func (Hardware_SecurityModule) SetPrivateNetworkInterfaceSpeed 

func (r Hardware_SecurityModule) SetPrivateNetworkInterfaceSpeed(newSpeed *int, redundancy *string) (resp bool, err error)

Set the private network interface speed and redundancy configuration.

Possible $newSpeed values are -1 (maximum available), 0 (disconnect), 10, 100, 1000, and 10000; not all values are available to every server. The maximum speed is limited by the speed requested during provisioning. All intermediate speeds are limited by the capability of the pod the server is deployed in. No guarantee is made that a speed other than what was requested during provisioning will be available.

If specified, possible $redundancy values are either "redundant" or "degraded". Not specifying a redundancy mode will use the best possible redundancy available to the server. However, specifying a redundacy mode that is not available to the server will result in an error. "redundant" indicates all available interfaces should be active. "degraded" indicates only the primary interface should be active. Irrespective of the number of interfaces available to a server, it is only possible to have either a single interface or all interfaces active.

Receipt of a response does not indicate completion of the configuration change. Any subsequent attempts to request the interface change speed or state, while changes are pending, will result in a busy error.

A response of true indicates a change was required to achieve the desired interface configuration; thus changes are pending. A response of false indicates the current interface configuration matches the desired configuration, and thus no changes are pending.

<h4>Backwards Compatibility Until February 27th, 2019</h4>

In order to provide a period of transition to the new API, some backwards compatible behaviors will be active during this period. <ul> <li> A "doubled" (eg. 200) speed value will be translated to a redundancy value of "redundant". If a redundancy value is specified, it is assumed no translation is needed and will result in an error due to doubled speeds no longer being valid.</li> <li> A non-doubled (eg. 100) speed value <i>without</i> a redundancy value will be translated to a redundancy value of "degraded".</li> </ul> After the compatibility period, a doubled speed value will result in an error, and a non-doubled speed value without a redundancy value specified will result in the best available redundancy state. An exception is made for the new relative speed value -1. When using -1 without a redundancy value, the best possible redundancy will be used. Please transition away from using doubled speed values in favor of specifying redundancy (when applicable) or using relative speed values 0 and -1.

func (Hardware_SecurityModule) SetPublicNetworkInterfaceSpeed 

func (r Hardware_SecurityModule) SetPublicNetworkInterfaceSpeed(newSpeed *int, redundancy *string) (resp bool, err error)

Set the public network interface speed and redundancy configuration.

Possible $newSpeed values are -1 (maximum available), 0 (disconnect), 10, 100, 1000, and 10000; not all values are available to every server. The maximum speed is limited by the speed requested during provisioning. All intermediate speeds are limited by the capability of the pod the server is deployed in. No guarantee is made that a speed other than what was requested during provisioning will be available.

If specified, possible $redundancy values are either "redundant" or "degraded". Not specifying a redundancy mode will use the best possible redundancy available to the server. However, specifying a redundacy mode that is not available to the server will result in an error. "redundant" indicates all available interfaces should be active. "degraded" indicates only the primary interface should be active. Irrespective of the number of interfaces available to a server, it is only possible to have either a single interface or all interfaces active.

Receipt of a response does not indicate completion of the configuration change. Any subsequent attempts to request the interface change speed or state, while changes are pending, will result in a busy error.

A response of true indicates a change was required to achieve the desired interface configuration; thus changes are pending. A response of false indicates the current interface configuration matches the desired configuration, and thus no changes are pending.

<h4>Backwards Compatibility Until February 27th, 2019</h4>

In order to provide a period of transition to the new API, some backwards compatible behaviors will be active during this period. <ul> <li> A "doubled" (eg. 200) speed value will be translated to a redundancy value of "redundant". If a redundancy value is specified, it is assumed no translation is needed and will result in an error due to doubled speeds no longer being valid.</li> <li> A non-doubled (eg. 100) speed value <i>without</i> a redundancy value will be translated to a redundancy value of "degraded".</li> </ul> After the compatibility period, a doubled speed value will result in an error, and a non-doubled speed value without a redundancy value specified will result in the best available redundancy state. An exception is made for the new relative speed value -1. When using -1 without a redundancy value, the best possible redundancy will be used. Please transition away from using doubled speed values in favor of specifying redundancy (when applicable) or using relative speed values 0 and -1.

func (Hardware_SecurityModule) SetTags 

func (r Hardware_SecurityModule) SetTags(tags *string) (resp bool, err error)

no documentation yet

func (Hardware_SecurityModule) SetUserMetadata 

func (r Hardware_SecurityModule) SetUserMetadata(metadata []string) (resp []datatypes.Hardware_Attribute, err error)

Sets the data that will be written to the configuration drive.

func (Hardware_SecurityModule) ShutdownPrivatePort 

func (r Hardware_SecurityModule) ShutdownPrivatePort() (resp bool, err error)

Disconnect a server's private network interface. This operation is an alias for calling [SoftLayer_Hardware_Server/setPrivateNetworkInterfaceSpeed] with a $newSpeed of 0 and unspecified $redundancy.

Receipt of a response does not indicate completion of the configuration change. Any subsequent attempts to request the interface change speed or state, while changes are pending, will result in a busy error.

A response of true indicates a change was required to disconnect the interface; thus changes are pending. A response of false indicates the interface was already disconnected, and thus no changes are pending.

func (Hardware_SecurityModule) ShutdownPublicPort 

func (r Hardware_SecurityModule) ShutdownPublicPort() (resp bool, err error)

Disconnect a server's public network interface. This operation is an alias for [SoftLayer_Hardware_Server/setPublicNetworkInterfaceSpeed] with a $newSpeed of 0 and unspecified $redundancy.

Receipt of a response does not indicate completion of the configuration change. Any subsequent attempts to request the interface change speed or state, while changes are pending, will result in a busy error.

A response of true indicates a change was required to disconnect the interface; thus changes are pending. A response of false indicates the interface was already disconnected, and thus no changes are pending.

func (Hardware_SecurityModule) SparePool 

func (r Hardware_SecurityModule) SparePool(action *string, newOrder *bool) (resp bool, err error)

The ability to place bare metal servers in a state where they are powered down, and ports closed yet still allocated to the customer as a part of the Spare Pool program.

func (Hardware_SecurityModule) TestRaidAlertService added in v1.0.1 

func (r Hardware_SecurityModule) TestRaidAlertService() (resp bool, err error)

Test the RAID Alert service by sending the service a request to store a test email for this server. The server must have an account ID and MAC address. A RAID controller must also be installed.

func (Hardware_SecurityModule) ToggleManagementInterface 

func (r Hardware_SecurityModule) ToggleManagementInterface(enabled *bool) (resp bool, err error)

Attempt to toggle the IPMI interface. If there is an active transaction on the server, it will throw an exception. This method creates a job to toggle the interface. It is not instant.

func (Hardware_SecurityModule) UpdateIpmiPassword 

func (r Hardware_SecurityModule) UpdateIpmiPassword(password *string) (resp bool, err error)

This method will update the root IPMI password on this SoftLayer_Hardware.

func (Hardware_SecurityModule) ValidatePartitionsForOperatingSystem 

func (r Hardware_SecurityModule) ValidatePartitionsForOperatingSystem(operatingSystem *datatypes.Software_Description, partitions []datatypes.Hardware_Component_Partition) (resp bool, err error)

Validates a collection of partitions for an operating system

func (Hardware_SecurityModule) ValidateSecurityLevel added in v1.1.4 

func (r Hardware_SecurityModule) ValidateSecurityLevel() (err error)

no documentation yet

type Hardware_SecurityModule750 

type Hardware_SecurityModule750 struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetHardwareSecurityModule750Service 

func GetHardwareSecurityModule750Service(sess session.SLSession) Hardware_SecurityModule750

GetHardwareSecurityModule750Service returns an instance of the Hardware_SecurityModule750 SoftLayer service

func (Hardware_SecurityModule750) ActivatePrivatePort 

func (r Hardware_SecurityModule750) ActivatePrivatePort() (resp bool, err error)

Activate a server's private network interface to the maximum available speed. This operation is an alias for [SoftLayer_Hardware_Server/setPrivateNetworkInterfaceSpeed] with a $newSpeed of -1 and a $redundancy of "redundant" or unspecified (which results in the best available redundancy state).

Receipt of a response does not indicate completion of the configuration change. Any subsequent attempts to request the interface change speed or state, while changes are pending, will result in a busy error.

A response of true indicates a change was required to activate the interface; thus changes are pending. A response of false indicates the interface was already active, and thus no changes are pending.

func (Hardware_SecurityModule750) ActivatePublicPort 

func (r Hardware_SecurityModule750) ActivatePublicPort() (resp bool, err error)

Activate a server's public network interface to the maximum available speed. This operation is an alias for [SoftLayer_Hardware_Server/setPublicNetworkInterfaceSpeed] with a $newSpeed of -1 and a $redundancy of "redundant" or unspecified (which results in the best available redundancy state).

Receipt of a response does not indicate completion of the configuration change. Any subsequent attempts to request the interface change speed or state, while changes are pending, will result in a busy error.

A response of true indicates a change was required to activate the interface; thus changes are pending. A response of false indicates the interface was already active, and thus no changes are pending.

func (Hardware_SecurityModule750) AllowAccessToNetworkStorage 

func (r Hardware_SecurityModule750) AllowAccessToNetworkStorage(networkStorageTemplateObject *datatypes.Network_Storage) (resp bool, err error)

This method is used to allow access to a SoftLayer_Network_Storage volume that supports host- or network-level access control.

func (Hardware_SecurityModule750) AllowAccessToNetworkStorageList 

func (r Hardware_SecurityModule750) AllowAccessToNetworkStorageList(networkStorageTemplateObjects []datatypes.Network_Storage) (resp bool, err error)

This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support host- or network-level access control.

func (Hardware_SecurityModule750) BootToRescueLayer 

func (r Hardware_SecurityModule750) BootToRescueLayer(noOsBootEnvironment *string) (resp bool, err error)

The Rescue Kernel is designed to provide you with the ability to bring a server online in order to troubleshoot system problems that would normally only be resolved by an OS Reload. The correct Rescue Kernel will be selected based upon the currently installed operating system. When the rescue kernel process is initiated, the server will shutdown and reboot on to the public network with the same IP's assigned to the server to allow for remote connections. It will bring your server offline for approximately 10 minutes while the rescue is in progress. The root/administrator password will be the same as what is listed in the portal for the server.

func (Hardware_SecurityModule750) CaptureImage 

func (r Hardware_SecurityModule750) CaptureImage(captureTemplate *datatypes.Container_Disk_Image_Capture_Template) (resp datatypes.Virtual_Guest_Block_Device_Template_Group, err error)

Captures an Image of the hard disk on the physical machine, based on the capture template parameter. Returns the image template group containing the disk image.

func (Hardware_SecurityModule750) ChangeRedfishPowerState added in v1.1.4 

func (r Hardware_SecurityModule750) ChangeRedfishPowerState(state *string) (resp bool, err error)

Changes the power state for the server. The server's power status is changed from its remote management card.

func (Hardware_SecurityModule750) CreateFirmwareReflashTransaction 

func (r Hardware_SecurityModule750) CreateFirmwareReflashTransaction(ipmi *int, raidController *int, bios *int) (resp bool, err error)

You can launch firmware reflash by selecting from your server list. It will bring your server offline for approximately 60 minutes while the flashes are in progress.

In the event of a hardware failure during this our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online, and will be contacting you to ensure that impact on your server is minimal.

func (Hardware_SecurityModule750) CreateFirmwareUpdateTransaction 

func (r Hardware_SecurityModule750) CreateFirmwareUpdateTransaction(ipmi *int, raidController *int, bios *int, harddrive *int, networkCard *int) (resp bool, err error)

You can launch firmware updates by selecting from your server list. It will bring your server offline for approximately 20 minutes while the updates are in progress.

In the event of a hardware failure during this test our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online, and will be contacting you to ensure that impact on your server is minimal.

func (Hardware_SecurityModule750) CreateHyperThreadingUpdateTransaction 

func (r Hardware_SecurityModule750) CreateHyperThreadingUpdateTransaction(disableHyperthreading *int) (resp bool, err error)

You can launch hyper-threading update by selecting from your server list. It will bring your server offline for approximately 60 minutes while the update is in progress.

In the event of a hardware failure during this our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online, and will be contacting you to ensure that impact on your server is minimal.

func (Hardware_SecurityModule750) CreateObject 

func (r Hardware_SecurityModule750) CreateObject(templateObject *datatypes.Hardware_SecurityModule750) (resp datatypes.Hardware_SecurityModule750, err error)

<style type="text/css">.create_object > li > div { padding-top: .5em; padding-bottom: .5em}</style> createObject() enables the creation of servers on an account. This method is a simplified alternative to interacting with the ordering system directly.

In order to create a server, a template object must be sent in with a few required values.

When this method returns an order will have been placed for a server of the specified configuration.

To determine when the server is available you can poll the server via [[SoftLayer_Hardware/getObject|getObject]], checking the <code>provisionDate</code> property. When <code>provisionDate</code> is not null, the server will be ready. Be sure to use the <code>globalIdentifier</code> as your initialization parameter.

<b>Warning:</b> Servers created via this method will incur charges on your account. For testing input parameters see [[SoftLayer_Hardware/generateOrderTemplate|generateOrderTemplate]].

<b>Input</b> - [[SoftLayer_Hardware (type)|SoftLayer_Hardware]] <ul class="create_object"> 

    <li><code>hostname</code>
        <div>Hostname for the server.</div><ul>
            <li><b>Required</b></li>
            <li><b>Type</b> - string</li>
        </ul>
        <br />
    </li>
    <li><code>domain</code>
        <div>Domain for the server.</div><ul>
            <li><b>Required</b></li>
            <li><b>Type</b> - string</li>
        </ul>
        <br />
    </li>
    <li><code>processorCoreAmount</code>
        <div>The number of logical CPU cores to allocate.</div><ul>
            <li><b>Required</b></li>
            <li><b>Type</b> - int</li>
            <li>See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.</li>
        </ul>
        <br />
    </li>
    <li><code>memoryCapacity</code>
        <div>The amount of memory to allocate in gigabytes.</div><ul>
            <li><b>Required</b></li>
            <li><b>Type</b> - int</li>
            <li>See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.</li>
        </ul>
        <br />
    </li>
    <li><code>hourlyBillingFlag</code>
        <div>Specifies the billing type for the server.</div><ul>
            <li><b>Required</b></li>
            <li><b>Type</b> - boolean</li>
            <li>When true the server will be billed on hourly usage, otherwise it will be billed on a monthly basis.</li>
        </ul>
        <br />
    </li>
    <li><code>operatingSystemReferenceCode</code>
        <div>An identifier for the operating system to provision the server with.</div><ul>
            <li><b>Required</b></li>
            <li><b>Type</b> - string</li>
            <li>See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.</li>
        </ul>
        <br />
    </li>
    <li><code>datacenter.name</code>
        <div>Specifies which datacenter the server is to be provisioned in.</div><ul>
            <li><b>Required</b></li>
            <li><b>Type</b> - string</li>
            <li>The <code>datacenter</code> property is a [[SoftLayer_Location (type)|location]] structure with the <code>name</code> field set.</li>
            <li>See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.</li>
        </ul>
        <http title="Example">{
    "datacenter": {
        "name": "dal05"
    }
}</http>

        <br />
    </li>
    <li><code>networkComponents.maxSpeed</code>
        <div>Specifies the connection speed for the server's network components.</div><ul>
            <li><b>Optional</b></li>
            <li><b>Type</b> - int</li>
            <li><b>Default</b> - The highest available zero cost port speed will be used.</li>
            <li><b>Description</b> - The <code>networkComponents</code> property is an array with a single [[SoftLayer_Network_Component (type)|network component]] structure. The <code>maxSpeed</code> property must be set to specify the network uplink speed, in megabits per second, of the server.</li>
            <li>See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.</li>
        </ul>
            <http title="Example">{
    "networkComponents": [
        {
            "maxSpeed": 1000
        }
    ]
}</http>

        <br />
    </li>
    <li><code>networkComponents.redundancyEnabledFlag</code>
        <div>Specifies whether or not the server's network components should be in redundancy groups.</div><ul>
            <li><b>Optional</b></li>
            <li><b>Type</b> - bool</li>
            <li><b>Default</b> - <code>false</code></li>
            <li><b>Description</b> - The <code>networkComponents</code> property is an array with a single [[SoftLayer_Network_Component (type)|network component]] structure. When the <code>redundancyEnabledFlag</code> property is true the server's network components will be in redundancy groups.</li>
        </ul>
            <http title="Example">{
    "networkComponents": [
        {
            "redundancyEnabledFlag": false
        }
    ]
}</http>

        <br />
    </li>
    <li><code>privateNetworkOnlyFlag</code>
        <div>Specifies whether or not the server only has access to the private network</div><ul>
            <li><b>Optional</b></li>
            <li><b>Type</b> - boolean</li>
            <li><b>Default</b> - <code>false</code></li>
            <li>When true this flag specifies that a server is to only have access to the private network.</li>
        </ul>
        <br />
    </li>
    <li><code>primaryNetworkComponent.networkVlan.id</code>
        <div>Specifies the network vlan which is to be used for the frontend interface of the server.</div><ul>
            <li><b>Optional</b></li>
            <li><b>Type</b> - int</li>
            <li><b>Description</b> - The <code>primaryNetworkComponent</code> property is a [[SoftLayer_Network_Component (type)|network component]] structure with the <code>networkVlan</code> property populated with a [[SoftLayer_Network_Vlan (type)|vlan]] structure. The <code>id</code> property must be set to specify the frontend network vlan of the server.</li>
        </ul>
        <http title="Example">{
    "primaryNetworkComponent": {
        "networkVlan": {
            "id": 1
        }
    }
}</http>

        <br />
    </li>
    <li><code>primaryBackendNetworkComponent.networkVlan.id</code>
        <div>Specifies the network vlan which is to be used for the backend interface of the server.</div><ul>
            <li><b>Optional</b></li>
            <li><b>Type</b> - int</li>
            <li><b>Description</b> - The <code>primaryBackendNetworkComponent</code> property is a [[SoftLayer_Network_Component (type)|network component]] structure with the <code>networkVlan</code> property populated with a [[SoftLayer_Network_Vlan (type)|vlan]] structure. The <code>id</code> property must be set to specify the backend network vlan of the server.</li>
        </ul>
        <http title="Example">{
    "primaryBackendNetworkComponent": {
        "networkVlan": {
            "id": 2
        }
    }
}</http>

        <br />
    </li>
    <li><code>fixedConfigurationPreset.keyName</code>
        <div></div><ul>
            <li><b>Optional</b></li>
            <li><b>Type</b> - string</li>
            <li><b>Description</b> - The <code>fixedConfigurationPreset</code> property is a [[SoftLayer_Product_Package_Preset (type)|fixed configuration preset]] structure. The <code>keyName</code> property must be set to specify preset to use.</li>
            <li>If a fixed configuration preset is used <code>processorCoreAmount</code>, <code>memoryCapacity</code> and <code>hardDrives</code> properties must not be set.</li>
            <li>See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.</li>
        </ul>
        <http title="Example">{
    "fixedConfigurationPreset": {
        "keyName": "SOME_KEY_NAME"
    }
}</http>

        <br />
    </li>
    <li><code>userData.value</code>
        <div>Arbitrary data to be made available to the server.</div><ul>
            <li><b>Optional</b></li>
            <li><b>Type</b> - string</li>
            <li><b>Description</b> - The <code>userData</code> property is an array with a single [[SoftLayer_Hardware_Attribute (type)|attribute]] structure with the <code>value</code> property set to an arbitrary value.</li>
            <li>This value can be retrieved via the [[SoftLayer_Resource_Metadata/getUserMetadata|getUserMetadata]] method from a request originating from the server. This is primarily useful for providing data to software that may be on the server and configured to execute upon first boot.</li>
        </ul>
        <http title="Example">{
    "userData": [
        {
            "value": "someValue"
        }
    ]
}</http>

        <br />
    </li>
    <li><code>hardDrives</code>
        <div>Hard drive settings for the server</div><ul>
            <li><b>Optional</b></li>
            <li><b>Type</b> - SoftLayer_Hardware_Component</li>
            <li><b>Default</b> - The largest available capacity for a zero cost primary disk will be used.</li>
            <li><b>Description</b> - The <code>hardDrives</code> property is an array of [[SoftLayer_Hardware_Component (type)|hardware component]] structures.</i>
            <li>Each hard drive must specify the <code>capacity</code> property.</li>
            <li>See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.</li>
        </ul>
        <http title="Example">{
    "hardDrives": [
        {
            "capacity": 500
        }
    ]
}</http>

        <br />
    </li>
    <li id="hardware-create-object-ssh-keys"><code>sshKeys</code>
        <div>SSH keys to install on the server upon provisioning.</div><ul>
            <li><b>Optional</b></li>
            <li><b>Type</b> - array of [[SoftLayer_Security_Ssh_Key (type)|SoftLayer_Security_Ssh_Key]]</li>
            <li><b>Description</b> - The <code>sshKeys</code> property is an array of [[SoftLayer_Security_Ssh_Key (type)|SSH Key]] structures with the <code>id</code> property set to the value of an existing SSH key.</li>
            <li>To create a new SSH key, call [[SoftLayer_Security_Ssh_Key/createObject|createObject]] on the [[SoftLayer_Security_Ssh_Key]] service.</li>
            <li>To obtain a list of existing SSH keys, call [[SoftLayer_Account/getSshKeys|getSshKeys]] on the [[SoftLayer_Account]] service.
        </ul>
        <http title="Example">{
    "sshKeys": [
        {
            "id": 123
        }
    ]
}</http>

    <br />
</li>
<li><code>postInstallScriptUri</code>
    <div>Specifies the uri location of the script to be downloaded and run after installation is complete.</div><ul>
        <li><b>Optional</b></li>
        <li><b>Type</b> - string</li>
    </ul>
    <br />
</li>

</ul>

<h1>REST Example</h1> 

<http title="Request">curl -X POST -d '{
 "parameters":[
     {
         "hostname": "host1",
         "domain": "example.com",
         "processorCoreAmount": 2,
         "memoryCapacity": 2,
         "hourlyBillingFlag": true,
         "operatingSystemReferenceCode": "UBUNTU_LATEST"
     }
 ]
}' https://api.softlayer.com/rest/v3/SoftLayer_Hardware.json

</http> <http title="Response">HTTP/1.1 201 Created Location: https://api.softlayer.com/rest/v3/SoftLayer_Hardware/f5a3fcff-db1d-4b7c-9fa0-0349e41c29c5/getObject 

{
    "accountId": 232298,
    "bareMetalInstanceFlag": null,
    "domain": "example.com",
    "hardwareStatusId": null,
    "hostname": "host1",
    "id": null,
    "serviceProviderId": null,
    "serviceProviderResourceId": null,
    "globalIdentifier": "f5a3fcff-db1d-4b7c-9fa0-0349e41c29c5",
    "hourlyBillingFlag": true,
    "memoryCapacity": 2,
    "operatingSystemReferenceCode": "UBUNTU_LATEST",
    "processorCoreAmount": 2
}

</http>

func (Hardware_SecurityModule750) CreatePostSoftwareInstallTransaction 

func (r Hardware_SecurityModule750) CreatePostSoftwareInstallTransaction(installCodes []string, returnBoolean *bool) (resp bool, err error)

no documentation yet

func (Hardware_SecurityModule750) DeleteObject 

func (r Hardware_SecurityModule750) DeleteObject() (resp bool, err error)

This method will cancel a server effective immediately. For servers billed hourly, the charges will stop immediately after the method returns.

func (Hardware_SecurityModule750) DeleteSoftwareComponentPasswords 

func (r Hardware_SecurityModule750) DeleteSoftwareComponentPasswords(softwareComponentPasswords []datatypes.Software_Component_Password) (resp bool, err error)

Delete software component passwords.

func (Hardware_SecurityModule750) DeleteTag 

func (r Hardware_SecurityModule750) DeleteTag(tagName *string) (resp bool, err error)

Delete an existing tag. If there are any references on the tag, an exception will be thrown.

func (Hardware_SecurityModule750) EditObject 

func (r Hardware_SecurityModule750) EditObject(templateObject *datatypes.Hardware_Server) (resp bool, err error)

Edit a server's properties

func (Hardware_SecurityModule750) EditSoftwareComponentPasswords 

func (r Hardware_SecurityModule750) EditSoftwareComponentPasswords(softwareComponentPasswords []datatypes.Software_Component_Password) (resp bool, err error)

Edit the properties of a software component password such as the username, password, and notes.

func (Hardware_SecurityModule750) ExecuteRemoteScript 

func (r Hardware_SecurityModule750) ExecuteRemoteScript(uri *string) (err error)

Download and run remote script from uri on the hardware.

func (Hardware_SecurityModule750) Filter 

func (r Hardware_SecurityModule750) Filter(filter string) Hardware_SecurityModule750

func (Hardware_SecurityModule750) FindByIpAddress 

func (r Hardware_SecurityModule750) FindByIpAddress(ipAddress *string) (resp datatypes.Hardware, err error)

The ”'findByIpAddress”' method finds hardware using its primary public or private IP address. IP addresses that have a secondary subnet tied to the hardware will not return the hardware. If no hardware is found, no errors are generated and no data is returned.

func (Hardware_SecurityModule750) GenerateOrderTemplate 

func (r Hardware_SecurityModule750) GenerateOrderTemplate(templateObject *datatypes.Hardware) (resp datatypes.Container_Product_Order, err error)

Obtain an [[SoftLayer_Container_Product_Order_Hardware_Server (type)|order container]] that can be sent to [[SoftLayer_Product_Order/verifyOrder|verifyOrder]] or [[SoftLayer_Product_Order/placeOrder|placeOrder]].

This is primarily useful when there is a necessity to confirm the price which will be charged for an order.

See [[SoftLayer_Hardware/createObject|createObject]] for specifics on the requirements of the template object parameter.

func (Hardware_SecurityModule750) GetAccount 

func (r Hardware_SecurityModule750) GetAccount() (resp datatypes.Account, err error)

Retrieve The account associated with a piece of hardware.

func (Hardware_SecurityModule750) GetActiveComponents 

func (r Hardware_SecurityModule750) GetActiveComponents() (resp []datatypes.Hardware_Component, err error)

Retrieve A piece of hardware's active physical components.

func (Hardware_SecurityModule750) GetActiveNetworkFirewallBillingItem 

func (r Hardware_SecurityModule750) GetActiveNetworkFirewallBillingItem() (resp datatypes.Billing_Item, err error)

Retrieve The billing item for a server's attached network firewall.

func (Hardware_SecurityModule750) GetActiveNetworkMonitorIncident 

func (r Hardware_SecurityModule750) GetActiveNetworkMonitorIncident() (resp []datatypes.Network_Monitor_Version1_Incident, err error)

Retrieve A piece of hardware's active network monitoring incidents.

func (Hardware_SecurityModule750) GetActiveTickets 

func (r Hardware_SecurityModule750) GetActiveTickets() (resp []datatypes.Ticket, err error)

Retrieve

func (Hardware_SecurityModule750) GetActiveTransaction 

func (r Hardware_SecurityModule750) GetActiveTransaction() (resp datatypes.Provisioning_Version1_Transaction, err error)

Retrieve Transaction currently running for server.

func (Hardware_SecurityModule750) GetActiveTransactions 

func (r Hardware_SecurityModule750) GetActiveTransactions() (resp []datatypes.Provisioning_Version1_Transaction, err error)

Retrieve Any active transaction(s) that are currently running for the server (example: os reload).

func (Hardware_SecurityModule750) GetAllPowerComponents 

func (r Hardware_SecurityModule750) GetAllPowerComponents() (resp []datatypes.Hardware_Power_Component, err error)

Retrieve

func (Hardware_SecurityModule750) GetAllowedHost 

func (r Hardware_SecurityModule750) GetAllowedHost() (resp datatypes.Network_Storage_Allowed_Host, err error)

Retrieve The SoftLayer_Network_Storage_Allowed_Host information to connect this server to Network Storage volumes that require access control lists.

func (Hardware_SecurityModule750) GetAllowedNetworkStorage 

func (r Hardware_SecurityModule750) GetAllowedNetworkStorage() (resp []datatypes.Network_Storage, err error)

Retrieve The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to.

func (Hardware_SecurityModule750) GetAllowedNetworkStorageReplicas 

func (r Hardware_SecurityModule750) GetAllowedNetworkStorageReplicas() (resp []datatypes.Network_Storage, err error)

Retrieve The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to.

func (Hardware_SecurityModule750) GetAntivirusSpywareSoftwareComponent 

func (r Hardware_SecurityModule750) GetAntivirusSpywareSoftwareComponent() (resp datatypes.Software_Component, err error)

Retrieve Information regarding an antivirus/spyware software component object.

func (Hardware_SecurityModule750) GetAttachedNetworkStorages 

func (r Hardware_SecurityModule750) GetAttachedNetworkStorages(nasType *string) (resp []datatypes.Network_Storage, err error)

This method is retrieve a list of SoftLayer_Network_Storage volumes that are authorized access to this SoftLayer_Hardware.

func (Hardware_SecurityModule750) GetAttributes 

func (r Hardware_SecurityModule750) GetAttributes() (resp []datatypes.Hardware_Attribute, err error)

Retrieve Information regarding a piece of hardware's specific attributes.

func (Hardware_SecurityModule750) GetAvailableBillingTermChangePrices added in v1.0.4 

func (r Hardware_SecurityModule750) GetAvailableBillingTermChangePrices() (resp []datatypes.Product_Item_Price, err error)

Retrieves a list of available term prices to this hardware. Currently, price terms are only available for increasing term length to monthly billed servers.

func (Hardware_SecurityModule750) GetAvailableMonitoring 

func (r Hardware_SecurityModule750) GetAvailableMonitoring() (resp []datatypes.Network_Monitor_Version1_Query_Host_Stratum, err error)

Retrieve An object that stores the maximum level for the monitoring query types and response types.

func (Hardware_SecurityModule750) GetAvailableNetworkStorages 

func (r Hardware_SecurityModule750) GetAvailableNetworkStorages(nasType *string) (resp []datatypes.Network_Storage, err error)

This method retrieves a list of SoftLayer_Network_Storage volumes that can be authorized to this SoftLayer_Hardware.

func (Hardware_SecurityModule750) GetAverageDailyBandwidthUsage 

func (r Hardware_SecurityModule750) GetAverageDailyBandwidthUsage() (resp datatypes.Float64, err error)

Retrieve The average daily total bandwidth usage for the current billing cycle.

func (Hardware_SecurityModule750) GetAverageDailyPrivateBandwidthUsage 

func (r Hardware_SecurityModule750) GetAverageDailyPrivateBandwidthUsage() (resp datatypes.Float64, err error)

Retrieve The average daily private bandwidth usage for the current billing cycle.

func (Hardware_SecurityModule750) GetAverageDailyPublicBandwidthUsage 

func (r Hardware_SecurityModule750) GetAverageDailyPublicBandwidthUsage() (resp datatypes.Float64, err error)

Retrieve The average daily public bandwidth usage for the current billing cycle.

func (Hardware_SecurityModule750) GetBackendBandwidthUsage 

func (r Hardware_SecurityModule750) GetBackendBandwidthUsage(startDate *datatypes.Time, endDate *datatypes.Time) (resp []datatypes.Metric_Tracking_Object_Data, err error)

Use this method to return an array of private bandwidth utilization records between a given date range.

This method represents the NEW version of getFrontendBandwidthUse

func (Hardware_SecurityModule750) GetBackendIncomingBandwidth 

func (r Hardware_SecurityModule750) GetBackendIncomingBandwidth(startDate *datatypes.Time, endDate *datatypes.Time) (resp datatypes.Float64, err error)

The ”'getBackendIncomingBandwidth”' method retrieves the amount of incoming private network traffic used between the given start date and end date parameters. When entering start and end dates, only the month, day and year are used to calculate bandwidth totals - the time (HH:MM:SS) is ignored and defaults to midnight. The amount of bandwidth retrieved is measured in gigabytes.

func (Hardware_SecurityModule750) GetBackendNetworkComponents 

func (r Hardware_SecurityModule750) GetBackendNetworkComponents() (resp []datatypes.Network_Component, err error)

Retrieve A piece of hardware's back-end or private network components.

func (Hardware_SecurityModule750) GetBackendOutgoingBandwidth 

func (r Hardware_SecurityModule750) GetBackendOutgoingBandwidth(startDate *datatypes.Time, endDate *datatypes.Time) (resp datatypes.Float64, err error)

The ”'getBackendOutgoingBandwidth”' method retrieves the amount of outgoing private network traffic used between the given start date and end date parameters. When entering start and end dates, only the month, day and year are used to calculate bandwidth totals - the time (HH:MM:SS) is ignored and defaults to midnight. The amount of bandwidth retrieved is measured in gigabytes.

func (Hardware_SecurityModule750) GetBackendRouters 

func (r Hardware_SecurityModule750) GetBackendRouters() (resp []datatypes.Hardware, err error)

Retrieve A hardware's backend or private router.

func (Hardware_SecurityModule750) GetBandwidthAllocation 

func (r Hardware_SecurityModule750) GetBandwidthAllocation() (resp datatypes.Float64, err error)

Retrieve A hardware's allotted bandwidth (measured in GB).

func (Hardware_SecurityModule750) GetBandwidthAllotmentDetail 

func (r Hardware_SecurityModule750) GetBandwidthAllotmentDetail() (resp datatypes.Network_Bandwidth_Version1_Allotment_Detail, err error)

Retrieve A hardware's allotted detail record. Allotment details link bandwidth allocation with allotments.

func (Hardware_SecurityModule750) GetBandwidthForDateRange 

func (r Hardware_SecurityModule750) GetBandwidthForDateRange(startDate *datatypes.Time, endDate *datatypes.Time) (resp []datatypes.Metric_Tracking_Object_Data, err error)

Retrieve a collection of bandwidth data from an individual public or private network tracking object. Data is ideal if you with to employ your own traffic storage and graphing systems.

func (Hardware_SecurityModule750) GetBenchmarkCertifications 

func (r Hardware_SecurityModule750) GetBenchmarkCertifications() (resp []datatypes.Hardware_Benchmark_Certification, err error)

Retrieve Information regarding a piece of hardware's benchmark certifications.

func (Hardware_SecurityModule750) GetBillingCycleBandwidthUsage 

func (r Hardware_SecurityModule750) GetBillingCycleBandwidthUsage() (resp []datatypes.Network_Bandwidth_Usage, err error)

Retrieve The raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to.

func (Hardware_SecurityModule750) GetBillingCyclePrivateBandwidthUsage 

func (r Hardware_SecurityModule750) GetBillingCyclePrivateBandwidthUsage() (resp datatypes.Network_Bandwidth_Usage, err error)

Retrieve The raw private bandwidth usage data for the current billing cycle.

func (Hardware_SecurityModule750) GetBillingCyclePublicBandwidthUsage 

func (r Hardware_SecurityModule750) GetBillingCyclePublicBandwidthUsage() (resp datatypes.Network_Bandwidth_Usage, err error)

Retrieve The raw public bandwidth usage data for the current billing cycle.

func (Hardware_SecurityModule750) GetBillingItem 

func (r Hardware_SecurityModule750) GetBillingItem() (resp datatypes.Billing_Item_Hardware, err error)

Retrieve Information regarding the billing item for a server.

func (Hardware_SecurityModule750) GetBillingItemFlag 

func (r Hardware_SecurityModule750) GetBillingItemFlag() (resp bool, err error)

Retrieve A flag indicating that a billing item exists.

func (Hardware_SecurityModule750) GetBiosPasswordNullFlag 

func (r Hardware_SecurityModule750) GetBiosPasswordNullFlag() (resp bool, err error)

Retrieve Determine if BIOS password should be left as null.

func (Hardware_SecurityModule750) GetBlockCancelBecauseDisconnectedFlag 

func (r Hardware_SecurityModule750) GetBlockCancelBecauseDisconnectedFlag() (resp bool, err error)

Retrieve Determines whether the hardware is ineligible for cancellation because it is disconnected.

func (Hardware_SecurityModule750) GetBootModeOptions 

func (r Hardware_SecurityModule750) GetBootModeOptions() (resp []string, err error)

Retrieve the valid boot modes for this server

func (Hardware_SecurityModule750) GetBusinessContinuanceInsuranceFlag 

func (r Hardware_SecurityModule750) GetBusinessContinuanceInsuranceFlag() (resp bool, err error)

Retrieve Status indicating whether or not a piece of hardware has business continuance insurance.

func (Hardware_SecurityModule750) GetCaptureEnabledFlag added in v1.0.1 

func (r Hardware_SecurityModule750) GetCaptureEnabledFlag() (resp datatypes.Container_Hardware_CaptureEnabled, err error)

Retrieve Determine if the server is able to be image captured. If unable to image capture a reason will be provided.

func (Hardware_SecurityModule750) GetChildrenHardware 

func (r Hardware_SecurityModule750) GetChildrenHardware() (resp []datatypes.Hardware, err error)

Retrieve Child hardware.

func (Hardware_SecurityModule750) GetComponentDetailsXML 

func (r Hardware_SecurityModule750) GetComponentDetailsXML() (resp string, err error)

no documentation yet

func (Hardware_SecurityModule750) GetComponents 

func (r Hardware_SecurityModule750) GetComponents() (resp []datatypes.Hardware_Component, err error)

Retrieve A piece of hardware's components.

func (Hardware_SecurityModule750) GetContainsSolidStateDrivesFlag 

func (r Hardware_SecurityModule750) GetContainsSolidStateDrivesFlag() (resp bool, err error)

Retrieve

func (Hardware_SecurityModule750) GetContinuousDataProtectionSoftwareComponent 

func (r Hardware_SecurityModule750) GetContinuousDataProtectionSoftwareComponent() (resp datatypes.Software_Component, err error)

Retrieve A continuous data protection/server backup software component object.

func (Hardware_SecurityModule750) GetControlPanel 

func (r Hardware_SecurityModule750) GetControlPanel() (resp datatypes.Software_Component_ControlPanel, err error)

Retrieve A server's control panel.

func (Hardware_SecurityModule750) GetCost 

func (r Hardware_SecurityModule750) GetCost() (resp datatypes.Float64, err error)

Retrieve The total cost of a server, measured in US Dollars ($USD).

func (Hardware_SecurityModule750) GetCreateObjectOptions 

func (r Hardware_SecurityModule750) GetCreateObjectOptions() (resp datatypes.Container_Hardware_Configuration, err error)

There are many options that may be provided while ordering a server, this method can be used to determine what these options are.

Detailed information on the return value can be found on the data type page for [[SoftLayer_Container_Hardware_Configuration (type)]].

func (Hardware_SecurityModule750) GetCurrentBandwidthSummary 

func (r Hardware_SecurityModule750) GetCurrentBandwidthSummary() (resp datatypes.Metric_Tracking_Object_Bandwidth_Summary, err error)

Retrieve An object that provides commonly used bandwidth summary components for the current billing cycle.

func (Hardware_SecurityModule750) GetCurrentBenchmarkCertificationResultFile 

func (r Hardware_SecurityModule750) GetCurrentBenchmarkCertificationResultFile() (resp []byte, err error)

Attempt to retrieve the file associated with the current benchmark certification result, if such a file exists. If there is no file for this benchmark certification result, calling this method throws an exception.

func (Hardware_SecurityModule750) GetCurrentBillableBandwidthUsage 

func (r Hardware_SecurityModule750) GetCurrentBillableBandwidthUsage() (resp datatypes.Float64, err error)

Retrieve The current billable public outbound bandwidth for this hardware for the current billing cycle.

func (Hardware_SecurityModule750) GetCurrentBillingDetail 

func (r Hardware_SecurityModule750) GetCurrentBillingDetail() (resp []datatypes.Billing_Item, err error)

Get the billing detail for this hardware for the current billing period. This does not include bandwidth usage.

func (Hardware_SecurityModule750) GetCurrentBillingTotal 

func (r Hardware_SecurityModule750) GetCurrentBillingTotal() (resp datatypes.Float64, err error)

Get the total bill amount in US Dollars ($) for this hardware in the current billing period. This includes all bandwidth used up to the point the method is called on the hardware.

func (Hardware_SecurityModule750) GetCustomerInstalledOperatingSystemFlag 

func (r Hardware_SecurityModule750) GetCustomerInstalledOperatingSystemFlag() (resp bool, err error)

Retrieve Indicates if a server has a Customer Installed OS

func (Hardware_SecurityModule750) GetCustomerOwnedFlag 

func (r Hardware_SecurityModule750) GetCustomerOwnedFlag() (resp bool, err error)

Retrieve Indicates if a server is a customer owned device.

func (Hardware_SecurityModule750) GetDailyAverage 

func (r Hardware_SecurityModule750) GetDailyAverage(startDate *datatypes.Time, endDate *datatypes.Time) (resp datatypes.Float64, err error)

The ”'getDailyAverage”' method calculates the average daily network traffic used by the selected server. Using the required parameter ”dateTime” to enter a start and end date, the user retrieves this average, measure in gigabytes (GB) for the specified date range. When entering parameters, only the month, day and year are required - time entries are omitted as this method defaults the time to midnight in order to account for the entire day.

func (Hardware_SecurityModule750) GetDatacenter 

func (r Hardware_SecurityModule750) GetDatacenter() (resp datatypes.Location, err error)

Retrieve Information regarding the datacenter in which a piece of hardware resides.

func (Hardware_SecurityModule750) GetDatacenterName 

func (r Hardware_SecurityModule750) GetDatacenterName() (resp string, err error)

Retrieve The name of the datacenter in which a piece of hardware resides.

func (Hardware_SecurityModule750) GetDaysInSparePool 

func (r Hardware_SecurityModule750) GetDaysInSparePool() (resp int, err error)

Retrieve Number of day(s) a server have been in spare pool.

func (Hardware_SecurityModule750) GetDownlinkHardware 

func (r Hardware_SecurityModule750) GetDownlinkHardware() (resp []datatypes.Hardware, err error)

Retrieve All hardware that has uplink network connections to a piece of hardware.

func (Hardware_SecurityModule750) GetDownlinkNetworkHardware 

func (r Hardware_SecurityModule750) GetDownlinkNetworkHardware() (resp []datatypes.Hardware, err error)

Retrieve All hardware that has uplink network connections to a piece of hardware.

func (Hardware_SecurityModule750) GetDownlinkServers 

func (r Hardware_SecurityModule750) GetDownlinkServers() (resp []datatypes.Hardware, err error)

Retrieve Information regarding all servers attached to a piece of network hardware.

func (Hardware_SecurityModule750) GetDownlinkVirtualGuests 

func (r Hardware_SecurityModule750) GetDownlinkVirtualGuests() (resp []datatypes.Virtual_Guest, err error)

Retrieve Information regarding all virtual guests attached to a piece of network hardware.

func (Hardware_SecurityModule750) GetDownstreamHardwareBindings 

func (r Hardware_SecurityModule750) GetDownstreamHardwareBindings() (resp []datatypes.Network_Component_Uplink_Hardware, err error)

Retrieve All hardware downstream from a network device.

func (Hardware_SecurityModule750) GetDownstreamNetworkHardware 

func (r Hardware_SecurityModule750) GetDownstreamNetworkHardware() (resp []datatypes.Hardware, err error)

Retrieve All network hardware downstream from the selected piece of hardware.

func (Hardware_SecurityModule750) GetDownstreamNetworkHardwareWithIncidents 

func (r Hardware_SecurityModule750) GetDownstreamNetworkHardwareWithIncidents() (resp []datatypes.Hardware, err error)

Retrieve All network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. [DEPRECATED]

func (Hardware_SecurityModule750) GetDownstreamServers 

func (r Hardware_SecurityModule750) GetDownstreamServers() (resp []datatypes.Hardware, err error)

Retrieve Information regarding all servers attached downstream to a piece of network hardware.

func (Hardware_SecurityModule750) GetDownstreamVirtualGuests 

func (r Hardware_SecurityModule750) GetDownstreamVirtualGuests() (resp []datatypes.Virtual_Guest, err error)

Retrieve Information regarding all virtual guests attached to a piece of network hardware.

func (Hardware_SecurityModule750) GetDriveControllers 

func (r Hardware_SecurityModule750) GetDriveControllers() (resp []datatypes.Hardware_Component, err error)

Retrieve The drive controllers contained within a piece of hardware.

func (Hardware_SecurityModule750) GetEvaultNetworkStorage 

func (r Hardware_SecurityModule750) GetEvaultNetworkStorage() (resp []datatypes.Network_Storage, err error)

Retrieve Information regarding a piece of hardware's associated EVault network storage service account.

func (Hardware_SecurityModule750) GetFirewallProtectableSubnets 

func (r Hardware_SecurityModule750) GetFirewallProtectableSubnets() (resp []datatypes.Network_Subnet, err error)

Get the subnets associated with this server that are protectable by a network component firewall.

func (Hardware_SecurityModule750) GetFirewallServiceComponent 

func (r Hardware_SecurityModule750) GetFirewallServiceComponent() (resp datatypes.Network_Component_Firewall, err error)

Retrieve Information regarding a piece of hardware's firewall services.

func (Hardware_SecurityModule750) GetFixedConfigurationPreset 

func (r Hardware_SecurityModule750) GetFixedConfigurationPreset() (resp datatypes.Product_Package_Preset, err error)

Retrieve Defines the fixed components in a fixed configuration bare metal server.

func (Hardware_SecurityModule750) GetFrontendBandwidthUsage 

func (r Hardware_SecurityModule750) GetFrontendBandwidthUsage(startDate *datatypes.Time, endDate *datatypes.Time) (resp []datatypes.Metric_Tracking_Object_Data, err error)

Use this method to return an array of public bandwidth utilization records between a given date range.

This method represents the NEW version of getFrontendBandwidthUse

func (Hardware_SecurityModule750) GetFrontendIncomingBandwidth 

func (r Hardware_SecurityModule750) GetFrontendIncomingBandwidth(startDate *datatypes.Time, endDate *datatypes.Time) (resp datatypes.Float64, err error)

The ”'getFrontendIncomingBandwidth”' method retrieves the amount of incoming public network traffic used by a server between the given start and end date parameters. When entering the ”dateTime” parameter, only the month, day and year of the start and end dates are required - the time (hour, minute and second) are set to midnight by default and cannot be changed. The amount of bandwidth retrieved is measured in gigabytes (GB).

func (Hardware_SecurityModule750) GetFrontendNetworkComponents 

func (r Hardware_SecurityModule750) GetFrontendNetworkComponents() (resp []datatypes.Network_Component, err error)

Retrieve A piece of hardware's front-end or public network components.

func (Hardware_SecurityModule750) GetFrontendOutgoingBandwidth 

func (r Hardware_SecurityModule750) GetFrontendOutgoingBandwidth(startDate *datatypes.Time, endDate *datatypes.Time) (resp datatypes.Float64, err error)

The ”'getFrontendOutgoingBandwidth”' method retrieves the amount of outgoing public network traffic used by a server between the given start and end date parameters. The ”dateTime” parameter requires only the day, month and year to be entered - the time (hour, minute and second) are set to midnight be default in order to gather the data for the entire start and end date indicated in the parameter. The amount of bandwidth retrieved is measured in gigabytes (GB).

func (Hardware_SecurityModule750) GetFrontendRouters 

func (r Hardware_SecurityModule750) GetFrontendRouters() (resp []datatypes.Hardware, err error)

Retrieve A hardware's frontend or public router.

func (Hardware_SecurityModule750) GetFutureBillingItem added in v1.0.4 

func (r Hardware_SecurityModule750) GetFutureBillingItem() (resp datatypes.Billing_Item_Hardware, err error)

Retrieve Information regarding the future billing item for a server.

func (Hardware_SecurityModule750) GetGlobalIdentifier 

func (r Hardware_SecurityModule750) GetGlobalIdentifier() (resp string, err error)

Retrieve A hardware's universally unique identifier.

func (Hardware_SecurityModule750) GetHardDrives 

func (r Hardware_SecurityModule750) GetHardDrives() (resp []datatypes.Hardware_Component, err error)

Retrieve The hard drives contained within a piece of hardware.

func (Hardware_SecurityModule750) GetHardwareByIpAddress 

func (r Hardware_SecurityModule750) GetHardwareByIpAddress(ipAddress *string) (resp datatypes.Hardware_Server, err error)

Retrieve a server by searching for the primary IP address.

func (Hardware_SecurityModule750) GetHardwareChassis 

func (r Hardware_SecurityModule750) GetHardwareChassis() (resp datatypes.Hardware_Chassis, err error)

Retrieve The chassis that a piece of hardware is housed in.

func (Hardware_SecurityModule750) GetHardwareFunction 

func (r Hardware_SecurityModule750) GetHardwareFunction() (resp datatypes.Hardware_Function, err error)

Retrieve A hardware's function.

func (Hardware_SecurityModule750) GetHardwareFunctionDescription 

func (r Hardware_SecurityModule750) GetHardwareFunctionDescription() (resp string, err error)

Retrieve A hardware's function.

func (Hardware_SecurityModule750) GetHardwareState added in v1.0.4 

func (r Hardware_SecurityModule750) GetHardwareState() (resp datatypes.Hardware_State, err error)

Retrieve A hardware's power/transaction state.

func (Hardware_SecurityModule750) GetHardwareStatus 

func (r Hardware_SecurityModule750) GetHardwareStatus() (resp datatypes.Hardware_Status, err error)

Retrieve A hardware's status.

func (Hardware_SecurityModule750) GetHasSingleRootVirtualizationBillingItemFlag 

func (r Hardware_SecurityModule750) GetHasSingleRootVirtualizationBillingItemFlag() (resp bool, err error)

Retrieve Determine if hardware has Single Root IO VIrtualization (SR-IOV) billing item.

func (Hardware_SecurityModule750) GetHasTrustedPlatformModuleBillingItemFlag 

func (r Hardware_SecurityModule750) GetHasTrustedPlatformModuleBillingItemFlag() (resp bool, err error)

Retrieve Determine in hardware object has TPM enabled.

func (Hardware_SecurityModule750) GetHostIpsSoftwareComponent 

func (r Hardware_SecurityModule750) GetHostIpsSoftwareComponent() (resp datatypes.Software_Component, err error)

Retrieve Information regarding a host IPS software component object.

func (Hardware_SecurityModule750) GetHourlyBandwidth 

func (r Hardware_SecurityModule750) GetHourlyBandwidth(mode *string, day *datatypes.Time) (resp []datatypes.Metric_Tracking_Object_Data, err error)

The ”'getHourlyBandwidth”' method retrieves all bandwidth updates hourly for the specified hardware. Because the potential number of data points can become excessive, the method limits the user to obtain data in 24-hour intervals. The required ”dateTime” parameter is used as the starting point for the query and will be calculated for the 24-hour period starting with the specified date and time. For example, entering a parameter of

'02/01/2008 0:00'

results in a return of all bandwidth data for the entire day of February 1, 2008, as 0:00 specifies a midnight start date. Please note that the time entered should be completed using a 24-hour clock (military time, astronomical time).

For data spanning more than a single 24-hour period, refer to the getBandwidthData function on the metricTrackingObject for the piece of hardware.

func (Hardware_SecurityModule750) GetHourlyBillingFlag 

func (r Hardware_SecurityModule750) GetHourlyBillingFlag() (resp bool, err error)

Retrieve A server's hourly billing status.

func (Hardware_SecurityModule750) GetInboundBandwidthUsage 

func (r Hardware_SecurityModule750) GetInboundBandwidthUsage() (resp datatypes.Float64, err error)

Retrieve The sum of all the inbound network traffic data for the last 30 days.

func (Hardware_SecurityModule750) GetInboundPrivateBandwidthUsage 

func (r Hardware_SecurityModule750) GetInboundPrivateBandwidthUsage() (resp datatypes.Float64, err error)

Retrieve The total private inbound bandwidth for this hardware for the current billing cycle.

func (Hardware_SecurityModule750) GetInboundPublicBandwidthUsage 

func (r Hardware_SecurityModule750) GetInboundPublicBandwidthUsage() (resp datatypes.Float64, err error)

Retrieve The total public inbound bandwidth for this hardware for the current billing cycle.

func (Hardware_SecurityModule750) GetIsBillingTermChangeAvailableFlag added in v1.0.4 

func (r Hardware_SecurityModule750) GetIsBillingTermChangeAvailableFlag() (resp bool, err error)

Retrieve Whether or not this hardware object is eligible to change to term billing.

func (Hardware_SecurityModule750) GetIsCloudReadyNodeCertified 

func (r Hardware_SecurityModule750) GetIsCloudReadyNodeCertified() (resp bool, err error)

Retrieve Determine if hardware object has the IBM_CLOUD_READY_NODE_CERTIFIED attribute.

func (Hardware_SecurityModule750) GetIsIpmiDisabled 

func (r Hardware_SecurityModule750) GetIsIpmiDisabled() (resp bool, err error)

Retrieve Determine if remote management has been disabled due to port speed.

func (Hardware_SecurityModule750) GetIsNfsOnly added in v1.1.6 

func (r Hardware_SecurityModule750) GetIsNfsOnly() (resp string, err error)

Retrieve A server that has nfs only drive.

func (Hardware_SecurityModule750) GetIsQeInternalServer added in v1.1.3 

func (r Hardware_SecurityModule750) GetIsQeInternalServer() (resp bool, err error)

Retrieve Determine if hardware object has the QE_INTERNAL_SERVER attribute.

func (Hardware_SecurityModule750) GetIsVirtualPrivateCloudNode 

func (r Hardware_SecurityModule750) GetIsVirtualPrivateCloudNode() (resp bool, err error)

Retrieve Determine if hardware object is a Virtual Private Cloud node.

func (Hardware_SecurityModule750) GetItemPricesFromSoftwareDescriptions 

func (r Hardware_SecurityModule750) GetItemPricesFromSoftwareDescriptions(softwareDescriptions []datatypes.Software_Description, includeTranslationsFlag *bool, returnAllPricesFlag *bool) (resp []datatypes.Product_Item, err error)

Return a collection of SoftLayer_Item_Price objects from a collection of SoftLayer_Software_Description

func (Hardware_SecurityModule750) GetLastOperatingSystemReload 

func (r Hardware_SecurityModule750) GetLastOperatingSystemReload() (resp datatypes.Provisioning_Version1_Transaction, err error)

Retrieve The last transaction that a server's operating system was loaded.

func (Hardware_SecurityModule750) GetLastTransaction 

func (r Hardware_SecurityModule750) GetLastTransaction() (resp datatypes.Provisioning_Version1_Transaction, err error)

Retrieve Information regarding the last transaction a server performed.

func (Hardware_SecurityModule750) GetLatestNetworkMonitorIncident 

func (r Hardware_SecurityModule750) GetLatestNetworkMonitorIncident() (resp datatypes.Network_Monitor_Version1_Incident, err error)

Retrieve A piece of hardware's latest network monitoring incident.

func (Hardware_SecurityModule750) GetLocation 

func (r Hardware_SecurityModule750) GetLocation() (resp datatypes.Location, err error)

Retrieve Where a piece of hardware is located within SoftLayer's location hierarchy.

func (Hardware_SecurityModule750) GetLocationPathString 

func (r Hardware_SecurityModule750) GetLocationPathString() (resp string, err error)

Retrieve

func (Hardware_SecurityModule750) GetLockboxNetworkStorage 

func (r Hardware_SecurityModule750) GetLockboxNetworkStorage() (resp datatypes.Network_Storage, err error)

Retrieve Information regarding a lockbox account associated with a server.

func (Hardware_SecurityModule750) GetLogicalVolumeStorageGroups added in v1.0.2 

func (r Hardware_SecurityModule750) GetLogicalVolumeStorageGroups() (resp []datatypes.Configuration_Storage_Group, err error)

Retrieve Returns a list of logical volumes on the physical machine.

func (Hardware_SecurityModule750) GetManagedResourceFlag 

func (r Hardware_SecurityModule750) GetManagedResourceFlag() (resp bool, err error)

Retrieve A flag indicating that the hardware is a managed resource.

func (Hardware_SecurityModule750) GetManagementNetworkComponent 

func (r Hardware_SecurityModule750) GetManagementNetworkComponent() (resp datatypes.Network_Component, err error)

Retrieve the remote management network component attached with this server.

func (Hardware_SecurityModule750) GetMemory 

func (r Hardware_SecurityModule750) GetMemory() (resp []datatypes.Hardware_Component, err error)

Retrieve Information regarding a piece of hardware's memory.

func (Hardware_SecurityModule750) GetMemoryCapacity 

func (r Hardware_SecurityModule750) GetMemoryCapacity() (resp uint, err error)

Retrieve The amount of memory a piece of hardware has, measured in gigabytes.

func (Hardware_SecurityModule750) GetMetricTrackingObject 

func (r Hardware_SecurityModule750) GetMetricTrackingObject() (resp datatypes.Metric_Tracking_Object, err error)

Retrieve A piece of hardware's metric tracking object.

func (Hardware_SecurityModule750) GetMetricTrackingObjectId 

func (r Hardware_SecurityModule750) GetMetricTrackingObjectId() (resp int, err error)

Retrieve The metric tracking object id for this server.

func (Hardware_SecurityModule750) GetModules 

func (r Hardware_SecurityModule750) GetModules() (resp []datatypes.Hardware_Component, err error)

Retrieve

func (Hardware_SecurityModule750) GetMonitoringRobot 

func (r Hardware_SecurityModule750) GetMonitoringRobot() (resp datatypes.Monitoring_Robot, err error)

Retrieve

func (Hardware_SecurityModule750) GetMonitoringServiceComponent 

func (r Hardware_SecurityModule750) GetMonitoringServiceComponent() (resp datatypes.Network_Monitor_Version1_Query_Host_Stratum, err error)

Retrieve Information regarding a piece of hardware's network monitoring services.

func (Hardware_SecurityModule750) GetMonitoringServiceEligibilityFlag 

func (r Hardware_SecurityModule750) GetMonitoringServiceEligibilityFlag() (resp bool, err error)

Retrieve

func (Hardware_SecurityModule750) GetMonitoringUserNotification 

func (r Hardware_SecurityModule750) GetMonitoringUserNotification() (resp []datatypes.User_Customer_Notification_Hardware, err error)

Retrieve The monitoring notification objects for this hardware. Each object links this hardware instance to a user account that will be notified if monitoring on this hardware object fails

func (Hardware_SecurityModule750) GetMotherboard 

func (r Hardware_SecurityModule750) GetMotherboard() (resp datatypes.Hardware_Component, err error)

Retrieve Information regarding a piece of hardware's motherboard.

func (Hardware_SecurityModule750) GetNetworkCards 

func (r Hardware_SecurityModule750) GetNetworkCards() (resp []datatypes.Hardware_Component, err error)

Retrieve Information regarding a piece of hardware's network cards.

func (Hardware_SecurityModule750) GetNetworkComponentFirewallProtectableIpAddresses 

func (r Hardware_SecurityModule750) GetNetworkComponentFirewallProtectableIpAddresses() (resp []datatypes.Network_Subnet_IpAddress, err error)

Get the IP addresses associated with this server that are protectable by a network component firewall. Note, this may not return all values for IPv6 subnets for this server. Please use getFirewallProtectableSubnets to get all protectable subnets.

func (Hardware_SecurityModule750) GetNetworkComponents 

func (r Hardware_SecurityModule750) GetNetworkComponents() (resp []datatypes.Network_Component, err error)

Retrieve Returns a hardware's network components.

func (Hardware_SecurityModule750) GetNetworkGatewayMember 

func (r Hardware_SecurityModule750) GetNetworkGatewayMember() (resp datatypes.Network_Gateway_Member, err error)

Retrieve The gateway member if this device is part of a network gateway.

func (Hardware_SecurityModule750) GetNetworkGatewayMemberFlag 

func (r Hardware_SecurityModule750) GetNetworkGatewayMemberFlag() (resp bool, err error)

Retrieve Whether or not this device is part of a network gateway.

func (Hardware_SecurityModule750) GetNetworkManagementIpAddress 

func (r Hardware_SecurityModule750) GetNetworkManagementIpAddress() (resp string, err error)

Retrieve A piece of hardware's network management IP address.

func (Hardware_SecurityModule750) GetNetworkMonitorAttachedDownHardware 

func (r Hardware_SecurityModule750) GetNetworkMonitorAttachedDownHardware() (resp []datatypes.Hardware, err error)

Retrieve All servers with failed monitoring that are attached downstream to a piece of hardware.

func (Hardware_SecurityModule750) GetNetworkMonitorAttachedDownVirtualGuests 

func (r Hardware_SecurityModule750) GetNetworkMonitorAttachedDownVirtualGuests() (resp []datatypes.Virtual_Guest, err error)

Retrieve Virtual guests that are attached downstream to a hardware that have failed monitoring

func (Hardware_SecurityModule750) GetNetworkMonitorIncidents 

func (r Hardware_SecurityModule750) GetNetworkMonitorIncidents() (resp []datatypes.Network_Monitor_Version1_Incident, err error)

Retrieve The status of all of a piece of hardware's network monitoring incidents.

func (Hardware_SecurityModule750) GetNetworkMonitors 

func (r Hardware_SecurityModule750) GetNetworkMonitors() (resp []datatypes.Network_Monitor_Version1_Query_Host, err error)

Retrieve Information regarding a piece of hardware's network monitors.

func (Hardware_SecurityModule750) GetNetworkStatus 

func (r Hardware_SecurityModule750) GetNetworkStatus() (resp string, err error)

Retrieve The value of a hardware's network status attribute. [DEPRECATED]

func (Hardware_SecurityModule750) GetNetworkStatusAttribute 

func (r Hardware_SecurityModule750) GetNetworkStatusAttribute() (resp datatypes.Hardware_Attribute, err error)

Retrieve The hardware's related network status attribute. [DEPRECATED]

func (Hardware_SecurityModule750) GetNetworkStorage 

func (r Hardware_SecurityModule750) GetNetworkStorage() (resp []datatypes.Network_Storage, err error)

Retrieve Information regarding a piece of hardware's associated network storage service account.

func (Hardware_SecurityModule750) GetNetworkVlans 

func (r Hardware_SecurityModule750) GetNetworkVlans() (resp []datatypes.Network_Vlan, err error)

Retrieve The network virtual LANs (VLANs) associated with a piece of hardware's network components.

func (Hardware_SecurityModule750) GetNextBillingCycleBandwidthAllocation 

func (r Hardware_SecurityModule750) GetNextBillingCycleBandwidthAllocation() (resp datatypes.Float64, err error)

Retrieve A hardware's allotted bandwidth for the next billing cycle (measured in GB).

func (Hardware_SecurityModule750) GetNotesHistory 

func (r Hardware_SecurityModule750) GetNotesHistory() (resp []datatypes.Hardware_Note, err error)

Retrieve

func (Hardware_SecurityModule750) GetNvRamCapacity 

func (r Hardware_SecurityModule750) GetNvRamCapacity() (resp uint, err error)

Retrieve The amount of non-volatile memory a piece of hardware has, measured in gigabytes.

func (Hardware_SecurityModule750) GetNvRamComponentModels 

func (r Hardware_SecurityModule750) GetNvRamComponentModels() (resp []datatypes.Hardware_Component_Model, err error)

Retrieve

func (Hardware_SecurityModule750) GetObject 

func (r Hardware_SecurityModule750) GetObject() (resp datatypes.Hardware_SecurityModule750, err error)

no documentation yet

func (Hardware_SecurityModule750) GetOpenCancellationTicket 

func (r Hardware_SecurityModule750) GetOpenCancellationTicket() (resp datatypes.Ticket, err error)

Retrieve An open ticket requesting cancellation of this server, if one exists.

func (Hardware_SecurityModule750) GetOperatingSystem 

func (r Hardware_SecurityModule750) GetOperatingSystem() (resp datatypes.Software_Component_OperatingSystem, err error)

Retrieve Information regarding a piece of hardware's operating system.

func (Hardware_SecurityModule750) GetOperatingSystemReferenceCode 

func (r Hardware_SecurityModule750) GetOperatingSystemReferenceCode() (resp string, err error)

Retrieve A hardware's operating system software description.

func (Hardware_SecurityModule750) GetOutboundBandwidthUsage 

func (r Hardware_SecurityModule750) GetOutboundBandwidthUsage() (resp datatypes.Float64, err error)

Retrieve The sum of all the outbound network traffic data for the last 30 days.

func (Hardware_SecurityModule750) GetOutboundPrivateBandwidthUsage 

func (r Hardware_SecurityModule750) GetOutboundPrivateBandwidthUsage() (resp datatypes.Float64, err error)

Retrieve The total private outbound bandwidth for this hardware for the current billing cycle.

func (Hardware_SecurityModule750) GetOutboundPublicBandwidthUsage 

func (r Hardware_SecurityModule750) GetOutboundPublicBandwidthUsage() (resp datatypes.Float64, err error)

Retrieve The total public outbound bandwidth for this hardware for the current billing cycle.

func (Hardware_SecurityModule750) GetOverBandwidthAllocationFlag 

func (r Hardware_SecurityModule750) GetOverBandwidthAllocationFlag() (resp int, err error)

Retrieve Whether the bandwidth usage for this hardware for the current billing cycle exceeds the allocation.

func (Hardware_SecurityModule750) GetPMInfo 

func (r Hardware_SecurityModule750) GetPMInfo() (resp []datatypes.Container_RemoteManagement_PmInfo, err error)

Retrieve a server's hardware state via its internal sensors. Remote sensor data is transmitted to the SoftLayer API by way of the server's remote management card. Sensor data measures system temperatures, voltages, and other local server settings. Sensor data is cached for 30 seconds. Calls made to getSensorData for the same server within 30 seconds of each other will return the same data. Subsequent calls will return new data once the cache expires.

func (Hardware_SecurityModule750) GetParentBay 

func (r Hardware_SecurityModule750) GetParentBay() (resp datatypes.Hardware_Blade, err error)

Retrieve Blade Bay

func (Hardware_SecurityModule750) GetParentHardware 

func (r Hardware_SecurityModule750) GetParentHardware() (resp datatypes.Hardware, err error)

Retrieve Parent Hardware.

func (Hardware_SecurityModule750) GetPartitions added in v1.0.3 

func (r Hardware_SecurityModule750) GetPartitions() (resp []datatypes.Hardware_Server_Partition, err error)

Retrieve

func (Hardware_SecurityModule750) GetPointOfPresenceLocation 

func (r Hardware_SecurityModule750) GetPointOfPresenceLocation() (resp datatypes.Location, err error)

Retrieve Information regarding the Point of Presence (PoP) location in which a piece of hardware resides.

func (Hardware_SecurityModule750) GetPowerComponents 

func (r Hardware_SecurityModule750) GetPowerComponents() (resp []datatypes.Hardware_Power_Component, err error)

Retrieve The power components for a hardware object.

func (Hardware_SecurityModule750) GetPowerSupply 

func (r Hardware_SecurityModule750) GetPowerSupply() (resp []datatypes.Hardware_Component, err error)

Retrieve Information regarding a piece of hardware's power supply.

func (Hardware_SecurityModule750) GetPrimaryBackendIpAddress 

func (r Hardware_SecurityModule750) GetPrimaryBackendIpAddress() (resp string, err error)

Retrieve The hardware's primary private IP address.

func (Hardware_SecurityModule750) GetPrimaryBackendNetworkComponent 

func (r Hardware_SecurityModule750) GetPrimaryBackendNetworkComponent() (resp datatypes.Network_Component, err error)

Retrieve Information regarding the hardware's primary back-end network component.

func (Hardware_SecurityModule750) GetPrimaryDriveSize 

func (r Hardware_SecurityModule750) GetPrimaryDriveSize() (resp int, err error)

no documentation yet

func (Hardware_SecurityModule750) GetPrimaryIpAddress 

func (r Hardware_SecurityModule750) GetPrimaryIpAddress() (resp string, err error)

Retrieve The hardware's primary public IP address.

func (Hardware_SecurityModule750) GetPrimaryNetworkComponent 

func (r Hardware_SecurityModule750) GetPrimaryNetworkComponent() (resp datatypes.Network_Component, err error)

Retrieve Information regarding the hardware's primary public network component.

func (Hardware_SecurityModule750) GetPrivateBackendNetworkComponents added in v1.0.6 

func (r Hardware_SecurityModule750) GetPrivateBackendNetworkComponents() (resp []datatypes.Network_Component, err error)

Retrieve A collection of backendNetwork components

func (Hardware_SecurityModule750) GetPrivateBandwidthData 

func (r Hardware_SecurityModule750) GetPrivateBandwidthData(startTime *int, endTime *int) (resp []datatypes.Metric_Tracking_Object_Data, err error)

Retrieve this server's private bandwidth data. If no timeframe is specified then getPrivateBandwidthData retrieves the last 24 hours of public bandwidth usage.

func (Hardware_SecurityModule750) GetPrivateBandwidthDataSummary 

func (r Hardware_SecurityModule750) GetPrivateBandwidthDataSummary() (resp datatypes.Container_Network_Bandwidth_Data_Summary, err error)

Retrieve a brief summary of a server's private network bandwidth usage. getPrivateBandwidthDataSummary retrieves a server's bandwidth allocation for its billing period, its estimated usage during its billing period, and an estimation of how much bandwidth it will use during its billing period based on its current usage. A server's projected bandwidth usage increases in accuracy as it progresses through its billing period.

func (Hardware_SecurityModule750) GetPrivateIpAddress 

func (r Hardware_SecurityModule750) GetPrivateIpAddress() (resp string, err error)

Retrieve A server's primary private IP address.

func (Hardware_SecurityModule750) GetPrivateNetworkComponent 

func (r Hardware_SecurityModule750) GetPrivateNetworkComponent() (resp datatypes.Network_Component, err error)

Retrieve the private network component attached with this server.

func (Hardware_SecurityModule750) GetPrivateNetworkOnlyFlag 

func (r Hardware_SecurityModule750) GetPrivateNetworkOnlyFlag() (resp bool, err error)

Retrieve Whether the hardware only has access to the private network.

func (Hardware_SecurityModule750) GetPrivateVlan 

func (r Hardware_SecurityModule750) GetPrivateVlan() (resp datatypes.Network_Vlan, err error)

Retrieve the backend VLAN for the primary IP address of the server

func (Hardware_SecurityModule750) GetProcessorCoreAmount 

func (r Hardware_SecurityModule750) GetProcessorCoreAmount() (resp uint, err error)

Retrieve The total number of processor cores, summed from all processors that are attached to a piece of hardware

func (Hardware_SecurityModule750) GetProcessorPhysicalCoreAmount 

func (r Hardware_SecurityModule750) GetProcessorPhysicalCoreAmount() (resp uint, err error)

Retrieve The total number of physical processor cores, summed from all processors that are attached to a piece of hardware

func (Hardware_SecurityModule750) GetProcessors 

func (r Hardware_SecurityModule750) GetProcessors() (resp []datatypes.Hardware_Component, err error)

Retrieve Information regarding a piece of hardware's processors.

func (Hardware_SecurityModule750) GetProjectedOverBandwidthAllocationFlag 

func (r Hardware_SecurityModule750) GetProjectedOverBandwidthAllocationFlag() (resp int, err error)

Retrieve Whether the bandwidth usage for this hardware for the current billing cycle is projected to exceed the allocation.

func (Hardware_SecurityModule750) GetProjectedPublicBandwidthUsage 

func (r Hardware_SecurityModule750) GetProjectedPublicBandwidthUsage() (resp datatypes.Float64, err error)

Retrieve The projected public outbound bandwidth for this hardware for the current billing cycle.

func (Hardware_SecurityModule750) GetProvisionDate 

func (r Hardware_SecurityModule750) GetProvisionDate() (resp datatypes.Time, err error)

no documentation yet

func (Hardware_SecurityModule750) GetPublicBandwidthData 

func (r Hardware_SecurityModule750) GetPublicBandwidthData(startTime *int, endTime *int) (resp []datatypes.Metric_Tracking_Object_Data, err error)

Retrieve this server's public bandwidth data. If no timeframe is specified then getPublicBandwidthData retrieves the last 24 hours of public bandwidth usage.

func (Hardware_SecurityModule750) GetPublicBandwidthDataSummary 

func (r Hardware_SecurityModule750) GetPublicBandwidthDataSummary() (resp datatypes.Container_Network_Bandwidth_Data_Summary, err error)

Retrieve a brief summary of a server's public network bandwidth usage. getPublicBandwidthDataSummary retrieves a server's bandwidth allocation for its billing period, its estimated usage during its billing period, and an estimation of how much bandwidth it will use during its billing period based on its current usage. A server's projected bandwidth usage increases in accuracy as it progresses through its billing period.

func (Hardware_SecurityModule750) GetPublicBandwidthTotal 

func (r Hardware_SecurityModule750) GetPublicBandwidthTotal(startTime *int, endTime *int) (resp uint, err error)

Retrieve the total number of bytes used by a server over a specified time period via the data warehouse tracking objects for this hardware.

func (Hardware_SecurityModule750) GetPublicNetworkComponent 

func (r Hardware_SecurityModule750) GetPublicNetworkComponent() (resp datatypes.Network_Component, err error)

Retrieve a SoftLayer server's public network component. Some servers are only connected to the private network and may not have a public network component. In that case getPublicNetworkComponent returns a null object.

func (Hardware_SecurityModule750) GetPublicVlan 

func (r Hardware_SecurityModule750) GetPublicVlan() (resp datatypes.Network_Vlan, err error)

Retrieve the frontend VLAN for the primary IP address of the server

func (Hardware_SecurityModule750) GetPublicVlanByHostname 

func (r Hardware_SecurityModule750) GetPublicVlanByHostname(hostname *string) (resp datatypes.Network_Vlan, err error)

Retrieve the frontend network Vlan by searching the hostname of a server

func (Hardware_SecurityModule750) GetRack 

func (r Hardware_SecurityModule750) GetRack() (resp datatypes.Location, err error)

Retrieve

func (Hardware_SecurityModule750) GetRaidControllers 

func (r Hardware_SecurityModule750) GetRaidControllers() (resp []datatypes.Hardware_Component, err error)

Retrieve The RAID controllers contained within a piece of hardware.

func (Hardware_SecurityModule750) GetReadyNodeFlag 

func (r Hardware_SecurityModule750) GetReadyNodeFlag() (resp bool, err error)

Retrieve Determine if hardware object is vSan Ready Node.

func (Hardware_SecurityModule750) GetRecentEvents 

func (r Hardware_SecurityModule750) GetRecentEvents() (resp []datatypes.Notification_Occurrence_Event, err error)

Retrieve Recent events that impact this hardware.

func (Hardware_SecurityModule750) GetRecentRemoteManagementCommands 

func (r Hardware_SecurityModule750) GetRecentRemoteManagementCommands() (resp []datatypes.Hardware_Component_RemoteManagement_Command_Request, err error)

Retrieve The last five commands issued to the server's remote management card.

func (Hardware_SecurityModule750) GetRedfishPowerState added in v1.1.4 

func (r Hardware_SecurityModule750) GetRedfishPowerState() (resp string, err error)

Retrieves the power state for the server. The server's power status is retrieved from its remote management card. This will return 'on' or 'off'.

func (Hardware_SecurityModule750) GetRegionalInternetRegistry 

func (r Hardware_SecurityModule750) GetRegionalInternetRegistry() (resp datatypes.Network_Regional_Internet_Registry, err error)

Retrieve

func (Hardware_SecurityModule750) GetRemoteManagement 

func (r Hardware_SecurityModule750) GetRemoteManagement() (resp datatypes.Hardware_Component_RemoteManagement, err error)

Retrieve A server's remote management card.

func (Hardware_SecurityModule750) GetRemoteManagementAccounts 

func (r Hardware_SecurityModule750) GetRemoteManagementAccounts() (resp []datatypes.Hardware_Component_RemoteManagement_User, err error)

Retrieve User credentials to issue commands and/or interact with the server's remote management card.

func (Hardware_SecurityModule750) GetRemoteManagementComponent 

func (r Hardware_SecurityModule750) GetRemoteManagementComponent() (resp datatypes.Network_Component, err error)

Retrieve A hardware's associated remote management component. This is normally IPMI.

func (Hardware_SecurityModule750) GetRemoteManagementUsers 

func (r Hardware_SecurityModule750) GetRemoteManagementUsers() (resp []datatypes.Hardware_Component_RemoteManagement_User, err error)

Retrieve User(s) who have access to issue commands and/or interact with the server's remote management card.

func (Hardware_SecurityModule750) GetResourceConfigurations 

func (r Hardware_SecurityModule750) GetResourceConfigurations() (resp []datatypes.Hardware_Resource_Configuration, err error)

Retrieve

func (Hardware_SecurityModule750) GetResourceGroupMemberReferences 

func (r Hardware_SecurityModule750) GetResourceGroupMemberReferences() (resp []datatypes.Resource_Group_Member, err error)

Retrieve

func (Hardware_SecurityModule750) GetResourceGroupRoles 

func (r Hardware_SecurityModule750) GetResourceGroupRoles() (resp []datatypes.Resource_Group_Role, err error)

Retrieve

func (Hardware_SecurityModule750) GetResourceGroups 

func (r Hardware_SecurityModule750) GetResourceGroups() (resp []datatypes.Resource_Group, err error)

Retrieve The resource groups in which this hardware is a member.

func (Hardware_SecurityModule750) GetReverseDomainRecords 

func (r Hardware_SecurityModule750) GetReverseDomainRecords() (resp []datatypes.Dns_Domain, err error)

Retrieve the reverse domain records associated with this server.

func (Hardware_SecurityModule750) GetRouters 

func (r Hardware_SecurityModule750) GetRouters() (resp []datatypes.Hardware, err error)

Retrieve A hardware's routers.

func (Hardware_SecurityModule750) GetSecurityScanRequests 

func (r Hardware_SecurityModule750) GetSecurityScanRequests() (resp []datatypes.Network_Security_Scanner_Request, err error)

Retrieve Information regarding a piece of hardware's vulnerability scan requests.

func (Hardware_SecurityModule750) GetSensorData 

func (r Hardware_SecurityModule750) GetSensorData() (resp []datatypes.Container_RemoteManagement_SensorReading, err error)

Retrieve a server's hardware state via its internal sensors. Remote sensor data is transmitted to the SoftLayer API by way of the server's remote management card. Sensor data measures system temperatures, voltages, and other local server settings. Sensor data is cached for 30 seconds. Calls made to getSensorData for the same server within 30 seconds of each other will return the same data. Subsequent calls will return new data once the cache expires.

func (Hardware_SecurityModule750) GetSensorDataWithGraphs 

func (r Hardware_SecurityModule750) GetSensorDataWithGraphs() (resp datatypes.Container_RemoteManagement_SensorReadingsWithGraphs, err error)

Retrieves the raw data returned from the server's remote management card. For more details of what is returned please refer to the getSensorData method. Along with the raw data, graphs for the cpu and system temperatures and fan speeds are also returned.

func (Hardware_SecurityModule750) GetServerDetails 

func (r Hardware_SecurityModule750) GetServerDetails() (resp datatypes.Container_Hardware_Server_Details, err error)

Retrieve a server's hardware components, software, and network components. getServerDetails is an aggregation function that combines the results of [[SoftLayer_Hardware_Server::getComponents]], [[SoftLayer_Hardware_Server::getSoftware]], and [[SoftLayer_Hardware_Server::getNetworkComponents]] in a single container.

func (Hardware_SecurityModule750) GetServerFanSpeedGraphs 

func (r Hardware_SecurityModule750) GetServerFanSpeedGraphs() (resp []datatypes.Container_RemoteManagement_Graphs_SensorSpeed, err error)

Retrieve the server's fan speeds and displays them using tachometer graphs. Data used to construct graphs is retrieved from the server's remote management card. All graphs returned will have a title associated with it.

func (Hardware_SecurityModule750) GetServerPowerState 

func (r Hardware_SecurityModule750) GetServerPowerState() (resp string, err error)

Retrieves the power state for the server. The server's power status is retrieved from its remote management card. This will return 'on' or 'off'.

func (Hardware_SecurityModule750) GetServerRoom 

func (r Hardware_SecurityModule750) GetServerRoom() (resp datatypes.Location, err error)

Retrieve Information regarding the server room in which the hardware is located.

func (Hardware_SecurityModule750) GetServerTemperatureGraphs 

func (r Hardware_SecurityModule750) GetServerTemperatureGraphs() (resp []datatypes.Container_RemoteManagement_Graphs_SensorTemperature, err error)

Retrieve the server's temperature and displays them using thermometer graphs. Temperatures retrieved are CPU(s) and system temperatures. Data used to construct graphs is retrieved from the server's remote management card. All graphs returned will have a title associated with it.

func (Hardware_SecurityModule750) GetServiceProvider 

func (r Hardware_SecurityModule750) GetServiceProvider() (resp datatypes.Service_Provider, err error)

Retrieve Information regarding the piece of hardware's service provider.

func (Hardware_SecurityModule750) GetSoftwareComponents 

func (r Hardware_SecurityModule750) GetSoftwareComponents() (resp []datatypes.Software_Component, err error)

Retrieve Information regarding a piece of hardware's installed software.

func (Hardware_SecurityModule750) GetSoftwareGuardExtensionEnabled 

func (r Hardware_SecurityModule750) GetSoftwareGuardExtensionEnabled() (resp bool, err error)

Retrieve Determine if hardware object has Software Guard Extension (SGX) enabled.

func (Hardware_SecurityModule750) GetSparePoolBillingItem 

func (r Hardware_SecurityModule750) GetSparePoolBillingItem() (resp datatypes.Billing_Item_Hardware, err error)

Retrieve Information regarding the billing item for a spare pool server.

func (Hardware_SecurityModule750) GetSshKeys 

func (r Hardware_SecurityModule750) GetSshKeys() (resp []datatypes.Security_Ssh_Key, err error)

Retrieve SSH keys to be installed on the server during provisioning or an OS reload.

func (Hardware_SecurityModule750) GetStatisticsRemoteManagement 

func (r Hardware_SecurityModule750) GetStatisticsRemoteManagement() (resp datatypes.Hardware_Component_RemoteManagement, err error)

Retrieve A server's remote management card used for statistics.

func (Hardware_SecurityModule750) GetStorageGroups added in v1.0.2 

func (r Hardware_SecurityModule750) GetStorageGroups() (resp []datatypes.Configuration_Storage_Group, err error)

Retrieve

func (Hardware_SecurityModule750) GetStorageNetworkComponents 

func (r Hardware_SecurityModule750) GetStorageNetworkComponents() (resp []datatypes.Network_Component, err error)

Retrieve A piece of hardware's private storage network components. [Deprecated]

func (Hardware_SecurityModule750) GetTagReferences 

func (r Hardware_SecurityModule750) GetTagReferences() (resp []datatypes.Tag_Reference, err error)

Retrieve

func (Hardware_SecurityModule750) GetTopLevelLocation 

func (r Hardware_SecurityModule750) GetTopLevelLocation() (resp datatypes.Location, err error)

Retrieve

func (Hardware_SecurityModule750) GetTransactionHistory 

func (r Hardware_SecurityModule750) GetTransactionHistory() (resp []datatypes.Provisioning_Version1_Transaction_History, err error)

This method will query transaction history for a piece of hardware.

func (Hardware_SecurityModule750) GetUefiBootFlag 

func (r Hardware_SecurityModule750) GetUefiBootFlag() (resp bool, err error)

Retrieve Whether to use UEFI boot instead of BIOS.

func (Hardware_SecurityModule750) GetUpgradeItemPrices 

func (r Hardware_SecurityModule750) GetUpgradeItemPrices() (resp []datatypes.Product_Item_Price, err error)

Retrieve a list of upgradeable items available to this piece of hardware. Currently, getUpgradeItemPrices retrieves upgrades available for a server's memory, hard drives, network port speed, bandwidth allocation and GPUs.

func (Hardware_SecurityModule750) GetUpgradeRequest 

func (r Hardware_SecurityModule750) GetUpgradeRequest() (resp datatypes.Product_Upgrade_Request, err error)

Retrieve An account's associated upgrade request object, if any.

func (Hardware_SecurityModule750) GetUpgradeableActiveComponents added in v1.1.2 

func (r Hardware_SecurityModule750) GetUpgradeableActiveComponents() (resp []datatypes.Hardware_Component, err error)

Retrieve A piece of hardware's active upgradeable physical components.

func (Hardware_SecurityModule750) GetUplinkHardware 

func (r Hardware_SecurityModule750) GetUplinkHardware() (resp datatypes.Hardware, err error)

Retrieve The network device connected to a piece of hardware.

func (Hardware_SecurityModule750) GetUplinkNetworkComponents 

func (r Hardware_SecurityModule750) GetUplinkNetworkComponents() (resp []datatypes.Network_Component, err error)

Retrieve Information regarding the network component that is one level higher than a piece of hardware on the network infrastructure.

func (Hardware_SecurityModule750) GetUserData 

func (r Hardware_SecurityModule750) GetUserData() (resp []datatypes.Hardware_Attribute, err error)

Retrieve An array containing a single string of custom user data for a hardware order. Max size is 16 kb.

func (Hardware_SecurityModule750) GetUsers 

func (r Hardware_SecurityModule750) GetUsers() (resp []datatypes.User_Customer, err error)

Retrieve A list of users that have access to this computing instance.

func (Hardware_SecurityModule750) GetValidBlockDeviceTemplateGroups 

func (r Hardware_SecurityModule750) GetValidBlockDeviceTemplateGroups(visibility *string) (resp []datatypes.Virtual_Guest_Block_Device_Template_Group, err error)

This method will return the list of block device template groups that are valid to the host. For instance, it will only retrieve FLEX images.

func (Hardware_SecurityModule750) GetVirtualChassis 

func (r Hardware_SecurityModule750) GetVirtualChassis() (resp datatypes.Hardware_Group, err error)

Retrieve Information regarding the virtual chassis for a piece of hardware.

func (Hardware_SecurityModule750) GetVirtualChassisSiblings 

func (r Hardware_SecurityModule750) GetVirtualChassisSiblings() (resp []datatypes.Hardware, err error)

Retrieve Information regarding the virtual chassis siblings for a piece of hardware.

func (Hardware_SecurityModule750) GetVirtualGuests 

func (r Hardware_SecurityModule750) GetVirtualGuests() (resp []datatypes.Virtual_Guest, err error)

Retrieve [DEPRECATED] A hardware server's virtual servers.

func (Hardware_SecurityModule750) GetVirtualHost 

func (r Hardware_SecurityModule750) GetVirtualHost() (resp datatypes.Virtual_Host, err error)

Retrieve A piece of hardware's virtual host record.

func (Hardware_SecurityModule750) GetVirtualLicenses 

func (r Hardware_SecurityModule750) GetVirtualLicenses() (resp []datatypes.Software_VirtualLicense, err error)

Retrieve Information regarding a piece of hardware's virtual software licenses.

func (Hardware_SecurityModule750) GetVirtualRack 

func (r Hardware_SecurityModule750) GetVirtualRack() (resp datatypes.Network_Bandwidth_Version1_Allotment, err error)

Retrieve Information regarding the bandwidth allotment to which a piece of hardware belongs.

func (Hardware_SecurityModule750) GetVirtualRackId 

func (r Hardware_SecurityModule750) GetVirtualRackId() (resp int, err error)

Retrieve The name of the bandwidth allotment belonging to a piece of hardware.

func (Hardware_SecurityModule750) GetVirtualRackName 

func (r Hardware_SecurityModule750) GetVirtualRackName() (resp string, err error)

Retrieve The name of the bandwidth allotment belonging to a piece of hardware.

func (Hardware_SecurityModule750) GetVirtualizationPlatform 

func (r Hardware_SecurityModule750) GetVirtualizationPlatform() (resp datatypes.Software_Component, err error)

Retrieve A piece of hardware's virtualization platform software.

func (Hardware_SecurityModule750) GetWindowsUpdateAvailableUpdates 

func (r Hardware_SecurityModule750) GetWindowsUpdateAvailableUpdates() (resp []datatypes.Container_Utility_Microsoft_Windows_UpdateServices_UpdateItem, err error)

Retrieve a list of Windows updates available for a server from the local SoftLayer Windows Server Update Services (WSUS) server. Windows servers provisioned by SoftLayer are configured to use the local WSUS server via the private network by default.

func (Hardware_SecurityModule750) GetWindowsUpdateInstalledUpdates 

func (r Hardware_SecurityModule750) GetWindowsUpdateInstalledUpdates() (resp []datatypes.Container_Utility_Microsoft_Windows_UpdateServices_UpdateItem, err error)

Retrieve a list of Windows updates installed on a server as reported by the local SoftLayer Windows Server Update Services (WSUS) server. Windows servers provisioned by SoftLayer are configured to use the local WSUS server via the private network by default.

func (Hardware_SecurityModule750) GetWindowsUpdateStatus 

func (r Hardware_SecurityModule750) GetWindowsUpdateStatus() (resp datatypes.Container_Utility_Microsoft_Windows_UpdateServices_Status, err error)

This method returns an update status record for this server. That record will specify if the server is missing updates, or has updates that must be reinstalled or require a reboot to go into affect.

func (Hardware_SecurityModule750) Id 

func (r Hardware_SecurityModule750) Id(id int) Hardware_SecurityModule750

func (Hardware_SecurityModule750) ImportVirtualHost 

func (r Hardware_SecurityModule750) ImportVirtualHost() (resp datatypes.Virtual_Host, err error)

The ”'importVirtualHost”' method attempts to import the host record for the virtualization platform running on a server.

func (Hardware_SecurityModule750) InitiateIderaBareMetalRestore 

func (r Hardware_SecurityModule750) InitiateIderaBareMetalRestore() (resp bool, err error)

Idera Bare Metal Server Restore is a backup agent designed specifically for making full system restores made with Idera Server Backup.

func (Hardware_SecurityModule750) InitiateR1SoftBareMetalRestore 

func (r Hardware_SecurityModule750) InitiateR1SoftBareMetalRestore() (resp bool, err error)

R1Soft Bare Metal Server Restore is an R1Soft disk agent designed specifically for making full system restores made with R1Soft CDP Server backup.

func (Hardware_SecurityModule750) IsBackendPingable 

func (r Hardware_SecurityModule750) IsBackendPingable() (resp bool, err error)

Issues a ping command and returns the success (true) or failure (false) of the ping command.

func (Hardware_SecurityModule750) IsPingable 

func (r Hardware_SecurityModule750) IsPingable() (resp bool, err error)

Issues a ping command and returns the success (true) or failure (false) of the ping command.

func (Hardware_SecurityModule750) IsWindowsServer 

func (r Hardware_SecurityModule750) IsWindowsServer() (resp bool, err error)

Determine if the server runs any version of the Microsoft Windows operating systems. Return ”true” if it does and ”false if otherwise.

func (Hardware_SecurityModule750) Limit 

func (r Hardware_SecurityModule750) Limit(limit int) Hardware_SecurityModule750

func (Hardware_SecurityModule750) Mask 

func (r Hardware_SecurityModule750) Mask(mask string) Hardware_SecurityModule750

func (Hardware_SecurityModule750) MassFirmwareReflash 

func (r Hardware_SecurityModule750) MassFirmwareReflash(hardwareIds []int, ipmi *bool, raidController *bool, bios *bool) (resp []datatypes.Container_Hardware_Server_Request, err error)

You can launch firmware reflashes by selecting from your server list. It will bring your server offline for approximately 60 minutes while the reflashes are in progress.

In the event of a hardware failure during this test our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online. They will be contact you to ensure that impact on your server is minimal.

func (Hardware_SecurityModule750) MassFirmwareUpdate 

func (r Hardware_SecurityModule750) MassFirmwareUpdate(hardwareIds []int, ipmi *bool, raidController *bool, bios *bool, harddrive *bool, networkCard *bool) (resp []datatypes.Container_Hardware_Server_Request, err error)

You can launch firmware updates by selecting from your server list. It will bring your server offline for approximately 20 minutes while the updates are in progress.

In the event of a hardware failure during this test our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online, and will be contacting you to ensure that impact on your server is minimal.

func (Hardware_SecurityModule750) MassHyperThreadingUpdate 

func (r Hardware_SecurityModule750) MassHyperThreadingUpdate(hardwareIds []int, disableHyperthreading *bool) (resp []datatypes.Container_Hardware_Server_Request, err error)

You can launch hyper-threading update by selecting from your server list. It will bring your server offline for approximately 60 minutes while the updates are in progress.

In the event of a hardware failure during this update our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online. They will be in contact with you to ensure that impact on your server is minimal.

func (Hardware_SecurityModule750) MassReloadOperatingSystem 

func (r Hardware_SecurityModule750) MassReloadOperatingSystem(hardwareIds []string, token *string, config *datatypes.Container_Hardware_Server_Configuration) (resp string, err error)

Reloads current or customer specified operating system configuration.

This service has a confirmation protocol for proceeding with the reload. To proceed with the reload without confirmation, simply pass in 'FORCE' as the token parameter. To proceed with the reload with confirmation, simply call the service with no parameter. A token string will be returned by this service. The token will remain active for 10 minutes. Use this token as the parameter to confirm that a reload is to be performed for the server.

As a precaution, we strongly recommend backing up all data before reloading the operating system. The reload will format the primary disk and will reconfigure the server to the current specifications on record.

The reload will take AT MINIMUM 66 minutes.

func (Hardware_SecurityModule750) MassSparePool 

func (r Hardware_SecurityModule750) MassSparePool(hardwareIds []string, action *string, newOrder *bool) (resp []datatypes.Container_Hardware_Server_Request, err error)

The ability to place multiple bare metal servers in a state where they are powered down and ports closed yet still allocated to the customer as a part of the Spare Pool program.

func (Hardware_SecurityModule750) Offset 

func (r Hardware_SecurityModule750) Offset(offset int) Hardware_SecurityModule750

func (Hardware_SecurityModule750) Ping 

func (r Hardware_SecurityModule750) Ping() (resp string, err error)

Issues a ping command to the server and returns the ping response.

func (Hardware_SecurityModule750) PopulateServerRam 

func (r Hardware_SecurityModule750) PopulateServerRam(ramSerialString *string) (err error)

no documentation yet

func (Hardware_SecurityModule750) PowerCycle 

func (r Hardware_SecurityModule750) PowerCycle() (resp bool, err error)

Power off then power on the server via powerstrip. The power cycle command is equivalent to unplugging the server from the powerstrip and then plugging the server back into the powerstrip. This should only be used as a last resort. If a reboot command has been issued successfully in the past 20 minutes, another remote management command (rebootSoft, rebootHard, powerOn, powerOff and powerCycle) will not be allowed. This is to avoid any type of server failures.

func (Hardware_SecurityModule750) PowerOff 

func (r Hardware_SecurityModule750) PowerOff() (resp bool, err error)

This method will power off the server via the server's remote management card.

func (Hardware_SecurityModule750) PowerOn 

func (r Hardware_SecurityModule750) PowerOn() (resp bool, err error)

Power on server via its remote management card. If a reboot command has been issued successfully in the past 20 minutes, another remote management command (rebootSoft, rebootHard, powerOn, powerOff and powerCycle) will not be allowed. This is to avoid any type of server failures.

func (Hardware_SecurityModule750) RebootDefault 

func (r Hardware_SecurityModule750) RebootDefault() (resp bool, err error)

Attempts to reboot the server by issuing a reset (soft reboot) command to the server's remote management card. If the reset (soft reboot) attempt is unsuccessful, a power cycle command will be issued via the powerstrip. The power cycle command is equivalent to unplugging the server from the powerstrip and then plugging the server back into the powerstrip. If a reboot command has been issued successfully in the past 20 minutes, another remote management command (rebootSoft, rebootHard, powerOn, powerOff and powerCycle) will not be allowed. This is to avoid any type of server failures.

func (Hardware_SecurityModule750) RebootHard 

func (r Hardware_SecurityModule750) RebootHard() (resp bool, err error)

Reboot the server by issuing a cycle command to the server's remote management card. This is equivalent to pressing the 'Reset' button on the server. This command is issued immediately and will not wait for processes to shutdown. After this command is issued, the server may take a few moments to boot up as server may run system disks checks. If a reboot command has been issued successfully in the past 20 minutes, another remote management command (rebootSoft, rebootHard, powerOn, powerOff and powerCycle) will not be allowed. This is to avoid any type of server failures.

func (Hardware_SecurityModule750) RebootSoft 

func (r Hardware_SecurityModule750) RebootSoft() (resp bool, err error)

Reboot the server by issuing a reset command to the server's remote management card. This is a graceful reboot. The servers will allow all process to shutdown gracefully before rebooting. If a reboot command has been issued successfully in the past 20 minutes, another remote management command (rebootSoft, rebootHard, powerOn, powerOff and powerCycle) will not be allowed. This is to avoid any type of server failures.

func (Hardware_SecurityModule750) RefreshDeviceStatus added in v1.0.5 

func (r Hardware_SecurityModule750) RefreshDeviceStatus() (resp datatypes.Hardware_State, err error)

no documentation yet

func (Hardware_SecurityModule750) ReloadCurrentOperatingSystemConfiguration 

func (r Hardware_SecurityModule750) ReloadCurrentOperatingSystemConfiguration(token *string) (resp string, err error)

Reloads current operating system configuration.

This service has a confirmation protocol for proceeding with the reload. To proceed with the reload without confirmation, simply pass in 'FORCE' as the token parameter. To proceed with the reload with confirmation, simply call the service with no parameter. A token string will be returned by this service. The token will remain active for 10 minutes. Use this token as the parameter to confirm that a reload is to be performed for the server.

As a precaution, we strongly recommend backing up all data before reloading the operating system. The reload will format the primary disk and will reconfigure the server to the current specifications on record.

The reload will take AT MINIMUM 66 minutes.

func (Hardware_SecurityModule750) ReloadOperatingSystem 

func (r Hardware_SecurityModule750) ReloadOperatingSystem(token *string, config *datatypes.Container_Hardware_Server_Configuration) (resp string, err error)

Reloads current or customer specified operating system configuration.

This service has a confirmation protocol for proceeding with the reload. To proceed with the reload without confirmation, simply pass in 'FORCE' as the token parameter. To proceed with the reload with confirmation, simply call the service with no parameter. A token string will be returned by this service. The token will remain active for 10 minutes. Use this token as the parameter to confirm that a reload is to be performed for the server.

As a precaution, we strongly recommend backing up all data before reloading the operating system. The reload will format the primary disk and will reconfigure the server to the current specifications on record.

The reload will take AT MINIMUM 66 minutes.

func (Hardware_SecurityModule750) RemoveAccessToNetworkStorage 

func (r Hardware_SecurityModule750) RemoveAccessToNetworkStorage(networkStorageTemplateObject *datatypes.Network_Storage) (resp bool, err error)

This method is used to remove access to s SoftLayer_Network_Storage volumes that supports host- or network-level access control.

func (Hardware_SecurityModule750) RemoveAccessToNetworkStorageList 

func (r Hardware_SecurityModule750) RemoveAccessToNetworkStorageList(networkStorageTemplateObjects []datatypes.Network_Storage) (resp bool, err error)

This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support host- or network-level access control.

func (Hardware_SecurityModule750) RemoveTags 

func (r Hardware_SecurityModule750) RemoveTags(tags *string) (resp bool, err error)

no documentation yet

func (Hardware_SecurityModule750) RunPassmarkCertificationBenchmark 

func (r Hardware_SecurityModule750) RunPassmarkCertificationBenchmark() (resp bool, err error)

You can launch a new Passmark hardware test by selecting from your server list. It will bring your server offline for approximately 20 minutes while the testing is in progress, and will publish a certificate with the results to your hardware details page.

While the hard drives are tested for the initial deployment, the Passmark Certificate utility will not test the hard drives on your live server. This is to ensure that no data is overwritten. If you would like to test the server's hard drives, you can have the full Passmark suite installed to your server free of charge through a new Support ticket.

While the test itself does not overwrite any data on the server, it is recommended that you make full off-server backups of all data prior to launching the test. The Passmark hardware test is designed to force any latent hardware issues to the surface, so hardware failure is possible.

In the event of a hardware failure during this test our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online, and will be contacting you to ensure that impact on your server is minimal.

func (Hardware_SecurityModule750) SetOperatingSystemPassword 

func (r Hardware_SecurityModule750) SetOperatingSystemPassword(newPassword *string) (resp bool, err error)

Changes the password that we have stored in our database for a servers' Operating System

func (Hardware_SecurityModule750) SetPrivateNetworkInterfaceSpeed 

func (r Hardware_SecurityModule750) SetPrivateNetworkInterfaceSpeed(newSpeed *int, redundancy *string) (resp bool, err error)

Set the private network interface speed and redundancy configuration.

Possible $newSpeed values are -1 (maximum available), 0 (disconnect), 10, 100, 1000, and 10000; not all values are available to every server. The maximum speed is limited by the speed requested during provisioning. All intermediate speeds are limited by the capability of the pod the server is deployed in. No guarantee is made that a speed other than what was requested during provisioning will be available.

If specified, possible $redundancy values are either "redundant" or "degraded". Not specifying a redundancy mode will use the best possible redundancy available to the server. However, specifying a redundacy mode that is not available to the server will result in an error. "redundant" indicates all available interfaces should be active. "degraded" indicates only the primary interface should be active. Irrespective of the number of interfaces available to a server, it is only possible to have either a single interface or all interfaces active.

Receipt of a response does not indicate completion of the configuration change. Any subsequent attempts to request the interface change speed or state, while changes are pending, will result in a busy error.

A response of true indicates a change was required to achieve the desired interface configuration; thus changes are pending. A response of false indicates the current interface configuration matches the desired configuration, and thus no changes are pending.

<h4>Backwards Compatibility Until February 27th, 2019</h4>

In order to provide a period of transition to the new API, some backwards compatible behaviors will be active during this period. <ul> <li> A "doubled" (eg. 200) speed value will be translated to a redundancy value of "redundant". If a redundancy value is specified, it is assumed no translation is needed and will result in an error due to doubled speeds no longer being valid.</li> <li> A non-doubled (eg. 100) speed value <i>without</i> a redundancy value will be translated to a redundancy value of "degraded".</li> </ul> After the compatibility period, a doubled speed value will result in an error, and a non-doubled speed value without a redundancy value specified will result in the best available redundancy state. An exception is made for the new relative speed value -1. When using -1 without a redundancy value, the best possible redundancy will be used. Please transition away from using doubled speed values in favor of specifying redundancy (when applicable) or using relative speed values 0 and -1.

func (Hardware_SecurityModule750) SetPublicNetworkInterfaceSpeed 

func (r Hardware_SecurityModule750) SetPublicNetworkInterfaceSpeed(newSpeed *int, redundancy *string) (resp bool, err error)

Set the public network interface speed and redundancy configuration.

Possible $newSpeed values are -1 (maximum available), 0 (disconnect), 10, 100, 1000, and 10000; not all values are available to every server. The maximum speed is limited by the speed requested during provisioning. All intermediate speeds are limited by the capability of the pod the server is deployed in. No guarantee is made that a speed other than what was requested during provisioning will be available.

If specified, possible $redundancy values are either "redundant" or "degraded". Not specifying a redundancy mode will use the best possible redundancy available to the server. However, specifying a redundacy mode that is not available to the server will result in an error. "redundant" indicates all available interfaces should be active. "degraded" indicates only the primary interface should be active. Irrespective of the number of interfaces available to a server, it is only possible to have either a single interface or all interfaces active.

Receipt of a response does not indicate completion of the configuration change. Any subsequent attempts to request the interface change speed or state, while changes are pending, will result in a busy error.

A response of true indicates a change was required to achieve the desired interface configuration; thus changes are pending. A response of false indicates the current interface configuration matches the desired configuration, and thus no changes are pending.

<h4>Backwards Compatibility Until February 27th, 2019</h4>

In order to provide a period of transition to the new API, some backwards compatible behaviors will be active during this period. <ul> <li> A "doubled" (eg. 200) speed value will be translated to a redundancy value of "redundant". If a redundancy value is specified, it is assumed no translation is needed and will result in an error due to doubled speeds no longer being valid.</li> <li> A non-doubled (eg. 100) speed value <i>without</i> a redundancy value will be translated to a redundancy value of "degraded".</li> </ul> After the compatibility period, a doubled speed value will result in an error, and a non-doubled speed value without a redundancy value specified will result in the best available redundancy state. An exception is made for the new relative speed value -1. When using -1 without a redundancy value, the best possible redundancy will be used. Please transition away from using doubled speed values in favor of specifying redundancy (when applicable) or using relative speed values 0 and -1.

func (Hardware_SecurityModule750) SetTags 

func (r Hardware_SecurityModule750) SetTags(tags *string) (resp bool, err error)

no documentation yet

func (Hardware_SecurityModule750) SetUserMetadata 

func (r Hardware_SecurityModule750) SetUserMetadata(metadata []string) (resp []datatypes.Hardware_Attribute, err error)

Sets the data that will be written to the configuration drive.

func (Hardware_SecurityModule750) ShutdownPrivatePort 

func (r Hardware_SecurityModule750) ShutdownPrivatePort() (resp bool, err error)

Disconnect a server's private network interface. This operation is an alias for calling [SoftLayer_Hardware_Server/setPrivateNetworkInterfaceSpeed] with a $newSpeed of 0 and unspecified $redundancy.

Receipt of a response does not indicate completion of the configuration change. Any subsequent attempts to request the interface change speed or state, while changes are pending, will result in a busy error.

A response of true indicates a change was required to disconnect the interface; thus changes are pending. A response of false indicates the interface was already disconnected, and thus no changes are pending.

func (Hardware_SecurityModule750) ShutdownPublicPort 

func (r Hardware_SecurityModule750) ShutdownPublicPort() (resp bool, err error)

Disconnect a server's public network interface. This operation is an alias for [SoftLayer_Hardware_Server/setPublicNetworkInterfaceSpeed] with a $newSpeed of 0 and unspecified $redundancy.

Receipt of a response does not indicate completion of the configuration change. Any subsequent attempts to request the interface change speed or state, while changes are pending, will result in a busy error.

A response of true indicates a change was required to disconnect the interface; thus changes are pending. A response of false indicates the interface was already disconnected, and thus no changes are pending.

func (Hardware_SecurityModule750) SparePool 

func (r Hardware_SecurityModule750) SparePool(action *string, newOrder *bool) (resp bool, err error)

The ability to place bare metal servers in a state where they are powered down, and ports closed yet still allocated to the customer as a part of the Spare Pool program.

func (Hardware_SecurityModule750) TestRaidAlertService added in v1.0.1 

func (r Hardware_SecurityModule750) TestRaidAlertService() (resp bool, err error)

Test the RAID Alert service by sending the service a request to store a test email for this server. The server must have an account ID and MAC address. A RAID controller must also be installed.

func (Hardware_SecurityModule750) ToggleManagementInterface 

func (r Hardware_SecurityModule750) ToggleManagementInterface(enabled *bool) (resp bool, err error)

Attempt to toggle the IPMI interface. If there is an active transaction on the server, it will throw an exception. This method creates a job to toggle the interface. It is not instant.

func (Hardware_SecurityModule750) UpdateIpmiPassword 

func (r Hardware_SecurityModule750) UpdateIpmiPassword(password *string) (resp bool, err error)

This method will update the root IPMI password on this SoftLayer_Hardware.

func (Hardware_SecurityModule750) ValidatePartitionsForOperatingSystem 

func (r Hardware_SecurityModule750) ValidatePartitionsForOperatingSystem(operatingSystem *datatypes.Software_Description, partitions []datatypes.Hardware_Component_Partition) (resp bool, err error)

Validates a collection of partitions for an operating system

func (Hardware_SecurityModule750) ValidateSecurityLevel added in v1.1.4 

func (r Hardware_SecurityModule750) ValidateSecurityLevel() (err error)

no documentation yet

type Hardware_Server 

type Hardware_Server struct {
	Session session.SLSession
	Options sl.Options
}

The SoftLayer_Hardware_Server data type contains general information relating to a single SoftLayer server.

func GetHardwareServerService 

func GetHardwareServerService(sess session.SLSession) Hardware_Server

GetHardwareServerService returns an instance of the Hardware_Server SoftLayer service

func (Hardware_Server) ActivatePrivatePort 

func (r Hardware_Server) ActivatePrivatePort() (resp bool, err error)

Activate a server's private network interface to the maximum available speed. This operation is an alias for [SoftLayer_Hardware_Server/setPrivateNetworkInterfaceSpeed] with a $newSpeed of -1 and a $redundancy of "redundant" or unspecified (which results in the best available redundancy state).

Receipt of a response does not indicate completion of the configuration change. Any subsequent attempts to request the interface change speed or state, while changes are pending, will result in a busy error.

A response of true indicates a change was required to activate the interface; thus changes are pending. A response of false indicates the interface was already active, and thus no changes are pending.

func (Hardware_Server) ActivatePublicPort 

func (r Hardware_Server) ActivatePublicPort() (resp bool, err error)

Activate a server's public network interface to the maximum available speed. This operation is an alias for [SoftLayer_Hardware_Server/setPublicNetworkInterfaceSpeed] with a $newSpeed of -1 and a $redundancy of "redundant" or unspecified (which results in the best available redundancy state).

Receipt of a response does not indicate completion of the configuration change. Any subsequent attempts to request the interface change speed or state, while changes are pending, will result in a busy error.

A response of true indicates a change was required to activate the interface; thus changes are pending. A response of false indicates the interface was already active, and thus no changes are pending.

func (Hardware_Server) AllowAccessToNetworkStorage 

func (r Hardware_Server) AllowAccessToNetworkStorage(networkStorageTemplateObject *datatypes.Network_Storage) (resp bool, err error)

This method is used to allow access to a SoftLayer_Network_Storage volume that supports host- or network-level access control.

func (Hardware_Server) AllowAccessToNetworkStorageList 

func (r Hardware_Server) AllowAccessToNetworkStorageList(networkStorageTemplateObjects []datatypes.Network_Storage) (resp bool, err error)

This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support host- or network-level access control.

func (Hardware_Server) BootToRescueLayer 

func (r Hardware_Server) BootToRescueLayer(noOsBootEnvironment *string) (resp bool, err error)

The Rescue Kernel is designed to provide you with the ability to bring a server online in order to troubleshoot system problems that would normally only be resolved by an OS Reload. The correct Rescue Kernel will be selected based upon the currently installed operating system. When the rescue kernel process is initiated, the server will shutdown and reboot on to the public network with the same IP's assigned to the server to allow for remote connections. It will bring your server offline for approximately 10 minutes while the rescue is in progress. The root/administrator password will be the same as what is listed in the portal for the server.

func (Hardware_Server) CaptureImage 

func (r Hardware_Server) CaptureImage(captureTemplate *datatypes.Container_Disk_Image_Capture_Template) (resp datatypes.Virtual_Guest_Block_Device_Template_Group, err error)

Captures an Image of the hard disk on the physical machine, based on the capture template parameter. Returns the image template group containing the disk image.

func (Hardware_Server) ChangeRedfishPowerState added in v1.1.4 

func (r Hardware_Server) ChangeRedfishPowerState(state *string) (resp bool, err error)

Changes the power state for the server. The server's power status is changed from its remote management card.

func (Hardware_Server) CreateFirmwareReflashTransaction 

func (r Hardware_Server) CreateFirmwareReflashTransaction(ipmi *int, raidController *int, bios *int) (resp bool, err error)

You can launch firmware reflash by selecting from your server list. It will bring your server offline for approximately 60 minutes while the flashes are in progress.

In the event of a hardware failure during this our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online, and will be contacting you to ensure that impact on your server is minimal.

func (Hardware_Server) CreateFirmwareUpdateTransaction 

func (r Hardware_Server) CreateFirmwareUpdateTransaction(ipmi *int, raidController *int, bios *int, harddrive *int, networkCard *int) (resp bool, err error)

You can launch firmware updates by selecting from your server list. It will bring your server offline for approximately 20 minutes while the updates are in progress.

In the event of a hardware failure during this test our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online, and will be contacting you to ensure that impact on your server is minimal.

func (Hardware_Server) CreateHyperThreadingUpdateTransaction 

func (r Hardware_Server) CreateHyperThreadingUpdateTransaction(disableHyperthreading *int) (resp bool, err error)

You can launch hyper-threading update by selecting from your server list. It will bring your server offline for approximately 60 minutes while the update is in progress.

In the event of a hardware failure during this our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online, and will be contacting you to ensure that impact on your server is minimal.

func (Hardware_Server) CreateObject 

func (r Hardware_Server) CreateObject(templateObject *datatypes.Hardware_Server) (resp datatypes.Hardware_Server, err error)

<style type="text/css">.create_object > li > div { padding-top: .5em; padding-bottom: .5em}</style> createObject() enables the creation of servers on an account. This method is a simplified alternative to interacting with the ordering system directly.

In order to create a server, a template object must be sent in with a few required values.

When this method returns an order will have been placed for a server of the specified configuration.

To determine when the server is available you can poll the server via [[SoftLayer_Hardware/getObject|getObject]], checking the <code>provisionDate</code> property. When <code>provisionDate</code> is not null, the server will be ready. Be sure to use the <code>globalIdentifier</code> as your initialization parameter.

<b>Warning:</b> Servers created via this method will incur charges on your account. For testing input parameters see [[SoftLayer_Hardware/generateOrderTemplate|generateOrderTemplate]].

<b>Input</b> - [[SoftLayer_Hardware (type)|SoftLayer_Hardware]] <ul class="create_object"> 

    <li><code>hostname</code>
        <div>Hostname for the server.</div><ul>
            <li><b>Required</b></li>
            <li><b>Type</b> - string</li>
        </ul>
        <br />
    </li>
    <li><code>domain</code>
        <div>Domain for the server.</div><ul>
            <li><b>Required</b></li>
            <li><b>Type</b> - string</li>
        </ul>
        <br />
    </li>
    <li><code>processorCoreAmount</code>
        <div>The number of logical CPU cores to allocate.</div><ul>
            <li><b>Required</b></li>
            <li><b>Type</b> - int</li>
            <li>See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.</li>
        </ul>
        <br />
    </li>
    <li><code>memoryCapacity</code>
        <div>The amount of memory to allocate in gigabytes.</div><ul>
            <li><b>Required</b></li>
            <li><b>Type</b> - int</li>
            <li>See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.</li>
        </ul>
        <br />
    </li>
    <li><code>hourlyBillingFlag</code>
        <div>Specifies the billing type for the server.</div><ul>
            <li><b>Required</b></li>
            <li><b>Type</b> - boolean</li>
            <li>When true the server will be billed on hourly usage, otherwise it will be billed on a monthly basis.</li>
        </ul>
        <br />
    </li>
    <li><code>operatingSystemReferenceCode</code>
        <div>An identifier for the operating system to provision the server with.</div><ul>
            <li><b>Required</b></li>
            <li><b>Type</b> - string</li>
            <li>See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.</li>
        </ul>
        <br />
    </li>
    <li><code>datacenter.name</code>
        <div>Specifies which datacenter the server is to be provisioned in.</div><ul>
            <li><b>Required</b></li>
            <li><b>Type</b> - string</li>
            <li>The <code>datacenter</code> property is a [[SoftLayer_Location (type)|location]] structure with the <code>name</code> field set.</li>
            <li>See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.</li>
        </ul>
        <http title="Example">{
    "datacenter": {
        "name": "dal05"
    }
}</http>

        <br />
    </li>
    <li><code>networkComponents.maxSpeed</code>
        <div>Specifies the connection speed for the server's network components.</div><ul>
            <li><b>Optional</b></li>
            <li><b>Type</b> - int</li>
            <li><b>Default</b> - The highest available zero cost port speed will be used.</li>
            <li><b>Description</b> - The <code>networkComponents</code> property is an array with a single [[SoftLayer_Network_Component (type)|network component]] structure. The <code>maxSpeed</code> property must be set to specify the network uplink speed, in megabits per second, of the server.</li>
            <li>See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.</li>
        </ul>
            <http title="Example">{
    "networkComponents": [
        {
            "maxSpeed": 1000
        }
    ]
}</http>

        <br />
    </li>
    <li><code>networkComponents.redundancyEnabledFlag</code>
        <div>Specifies whether or not the server's network components should be in redundancy groups.</div><ul>
            <li><b>Optional</b></li>
            <li><b>Type</b> - bool</li>
            <li><b>Default</b> - <code>false</code></li>
            <li><b>Description</b> - The <code>networkComponents</code> property is an array with a single [[SoftLayer_Network_Component (type)|network component]] structure. When the <code>redundancyEnabledFlag</code> property is true the server's network components will be in redundancy groups.</li>
        </ul>
            <http title="Example">{
    "networkComponents": [
        {
            "redundancyEnabledFlag": false
        }
    ]
}</http>

        <br />
    </li>
    <li><code>privateNetworkOnlyFlag</code>
        <div>Specifies whether or not the server only has access to the private network</div><ul>
            <li><b>Optional</b></li>
            <li><b>Type</b> - boolean</li>
            <li><b>Default</b> - <code>false</code></li>
            <li>When true this flag specifies that a server is to only have access to the private network.</li>
        </ul>
        <br />
    </li>
    <li><code>primaryNetworkComponent.networkVlan.id</code>
        <div>Specifies the network vlan which is to be used for the frontend interface of the server.</div><ul>
            <li><b>Optional</b></li>
            <li><b>Type</b> - int</li>
            <li><b>Description</b> - The <code>primaryNetworkComponent</code> property is a [[SoftLayer_Network_Component (type)|network component]] structure with the <code>networkVlan</code> property populated with a [[SoftLayer_Network_Vlan (type)|vlan]] structure. The <code>id</code> property must be set to specify the frontend network vlan of the server.</li>
        </ul>
        <http title="Example">{
    "primaryNetworkComponent": {
        "networkVlan": {
            "id": 1
        }
    }
}</http>

        <br />
    </li>
    <li><code>primaryBackendNetworkComponent.networkVlan.id</code>
        <div>Specifies the network vlan which is to be used for the backend interface of the server.</div><ul>
            <li><b>Optional</b></li>
            <li><b>Type</b> - int</li>
            <li><b>Description</b> - The <code>primaryBackendNetworkComponent</code> property is a [[SoftLayer_Network_Component (type)|network component]] structure with the <code>networkVlan</code> property populated with a [[SoftLayer_Network_Vlan (type)|vlan]] structure. The <code>id</code> property must be set to specify the backend network vlan of the server.</li>
        </ul>
        <http title="Example">{
    "primaryBackendNetworkComponent": {
        "networkVlan": {
            "id": 2
        }
    }
}</http>

        <br />
    </li>
    <li><code>fixedConfigurationPreset.keyName</code>
        <div></div><ul>
            <li><b>Optional</b></li>
            <li><b>Type</b> - string</li>
            <li><b>Description</b> - The <code>fixedConfigurationPreset</code> property is a [[SoftLayer_Product_Package_Preset (type)|fixed configuration preset]] structure. The <code>keyName</code> property must be set to specify preset to use.</li>
            <li>If a fixed configuration preset is used <code>processorCoreAmount</code>, <code>memoryCapacity</code> and <code>hardDrives</code> properties must not be set.</li>
            <li>See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.</li>
        </ul>
        <http title="Example">{
    "fixedConfigurationPreset": {
        "keyName": "SOME_KEY_NAME"
    }
}</http>

        <br />
    </li>
    <li><code>userData.value</code>
        <div>Arbitrary data to be made available to the server.</div><ul>
            <li><b>Optional</b></li>
            <li><b>Type</b> - string</li>
            <li><b>Description</b> - The <code>userData</code> property is an array with a single [[SoftLayer_Hardware_Attribute (type)|attribute]] structure with the <code>value</code> property set to an arbitrary value.</li>
            <li>This value can be retrieved via the [[SoftLayer_Resource_Metadata/getUserMetadata|getUserMetadata]] method from a request originating from the server. This is primarily useful for providing data to software that may be on the server and configured to execute upon first boot.</li>
        </ul>
        <http title="Example">{
    "userData": [
        {
            "value": "someValue"
        }
    ]
}</http>

        <br />
    </li>
    <li><code>hardDrives</code>
        <div>Hard drive settings for the server</div><ul>
            <li><b>Optional</b></li>
            <li><b>Type</b> - SoftLayer_Hardware_Component</li>
            <li><b>Default</b> - The largest available capacity for a zero cost primary disk will be used.</li>
            <li><b>Description</b> - The <code>hardDrives</code> property is an array of [[SoftLayer_Hardware_Component (type)|hardware component]] structures.</i>
            <li>Each hard drive must specify the <code>capacity</code> property.</li>
            <li>See [[SoftLayer_Hardware/getCreateObjectOptions|getCreateObjectOptions]] for available options.</li>
        </ul>
        <http title="Example">{
    "hardDrives": [
        {
            "capacity": 500
        }
    ]
}</http>

        <br />
    </li>
    <li id="hardware-create-object-ssh-keys"><code>sshKeys</code>
        <div>SSH keys to install on the server upon provisioning.</div><ul>
            <li><b>Optional</b></li>
            <li><b>Type</b> - array of [[SoftLayer_Security_Ssh_Key (type)|SoftLayer_Security_Ssh_Key]]</li>
            <li><b>Description</b> - The <code>sshKeys</code> property is an array of [[SoftLayer_Security_Ssh_Key (type)|SSH Key]] structures with the <code>id</code> property set to the value of an existing SSH key.</li>
            <li>To create a new SSH key, call [[SoftLayer_Security_Ssh_Key/createObject|createObject]] on the [[SoftLayer_Security_Ssh_Key]] service.</li>
            <li>To obtain a list of existing SSH keys, call [[SoftLayer_Account/getSshKeys|getSshKeys]] on the [[SoftLayer_Account]] service.
        </ul>
        <http title="Example">{
    "sshKeys": [
        {
            "id": 123
        }
    ]
}</http>

    <br />
</li>
<li><code>postInstallScriptUri</code>
    <div>Specifies the uri location of the script to be downloaded and run after installation is complete.</div><ul>
        <li><b>Optional</b></li>
        <li><b>Type</b> - string</li>
    </ul>
    <br />
</li>

</ul>

<h1>REST Example</h1> 

<http title="Request">curl -X POST -d '{
 "parameters":[
     {
         "hostname": "host1",
         "domain": "example.com",
         "processorCoreAmount": 2,
         "memoryCapacity": 2,
         "hourlyBillingFlag": true,
         "operatingSystemReferenceCode": "UBUNTU_LATEST"
     }
 ]
}' https://api.softlayer.com/rest/v3/SoftLayer_Hardware.json

</http> <http title="Response">HTTP/1.1 201 Created Location: https://api.softlayer.com/rest/v3/SoftLayer_Hardware/f5a3fcff-db1d-4b7c-9fa0-0349e41c29c5/getObject 

{
    "accountId": 232298,
    "bareMetalInstanceFlag": null,
    "domain": "example.com",
    "hardwareStatusId": null,
    "hostname": "host1",
    "id": null,
    "serviceProviderId": null,
    "serviceProviderResourceId": null,
    "globalIdentifier": "f5a3fcff-db1d-4b7c-9fa0-0349e41c29c5",
    "hourlyBillingFlag": true,
    "memoryCapacity": 2,
    "operatingSystemReferenceCode": "UBUNTU_LATEST",
    "processorCoreAmount": 2
}

</http>

func (Hardware_Server) CreatePostSoftwareInstallTransaction 

func (r Hardware_Server) CreatePostSoftwareInstallTransaction(installCodes []string, returnBoolean *bool) (resp bool, err error)

no documentation yet

func (Hardware_Server) DeleteObject 

func (r Hardware_Server) DeleteObject() (resp bool, err error)

This method will cancel a server effective immediately. For servers billed hourly, the charges will stop immediately after the method returns.

func (Hardware_Server) DeleteSoftwareComponentPasswords 

func (r Hardware_Server) DeleteSoftwareComponentPasswords(softwareComponentPasswords []datatypes.Software_Component_Password) (resp bool, err error)

Delete software component passwords.

func (Hardware_Server) DeleteTag 

func (r Hardware_Server) DeleteTag(tagName *string) (resp bool, err error)

Delete an existing tag. If there are any references on the tag, an exception will be thrown.

func (Hardware_Server) EditObject 

func (r Hardware_Server) EditObject(templateObject *datatypes.Hardware_Server) (resp bool, err error)

Edit a server's properties

func (Hardware_Server) EditSoftwareComponentPasswords 

func (r Hardware_Server) EditSoftwareComponentPasswords(softwareComponentPasswords []datatypes.Software_Component_Password) (resp bool, err error)

Edit the properties of a software component password such as the username, password, and notes.

func (Hardware_Server) ExecuteRemoteScript 

func (r Hardware_Server) ExecuteRemoteScript(uri *string) (err error)

Download and run remote script from uri on the hardware.

func (Hardware_Server) Filter 

func (r Hardware_Server) Filter(filter string) Hardware_Server

func (Hardware_Server) FindByIpAddress 

func (r Hardware_Server) FindByIpAddress(ipAddress *string) (resp datatypes.Hardware, err error)

The ”'findByIpAddress”' method finds hardware using its primary public or private IP address. IP addresses that have a secondary subnet tied to the hardware will not return the hardware. If no hardware is found, no errors are generated and no data is returned.

func (Hardware_Server) GenerateOrderTemplate 

func (r Hardware_Server) GenerateOrderTemplate(templateObject *datatypes.Hardware) (resp datatypes.Container_Product_Order, err error)

Obtain an [[SoftLayer_Container_Product_Order_Hardware_Server (type)|order container]] that can be sent to [[SoftLayer_Product_Order/verifyOrder|verifyOrder]] or [[SoftLayer_Product_Order/placeOrder|placeOrder]].

This is primarily useful when there is a necessity to confirm the price which will be charged for an order.

See [[SoftLayer_Hardware/createObject|createObject]] for specifics on the requirements of the template object parameter.

func (Hardware_Server) GetAccount 

func (r Hardware_Server) GetAccount() (resp datatypes.Account, err error)

Retrieve The account associated with a piece of hardware.

func (Hardware_Server) GetActiveComponents 

func (r Hardware_Server) GetActiveComponents() (resp []datatypes.Hardware_Component, err error)

Retrieve A piece of hardware's active physical components.

func (Hardware_Server) GetActiveNetworkFirewallBillingItem 

func (r Hardware_Server) GetActiveNetworkFirewallBillingItem() (resp datatypes.Billing_Item, err error)

Retrieve The billing item for a server's attached network firewall.

func (Hardware_Server) GetActiveNetworkMonitorIncident 

func (r Hardware_Server) GetActiveNetworkMonitorIncident() (resp []datatypes.Network_Monitor_Version1_Incident, err error)

Retrieve A piece of hardware's active network monitoring incidents.

func (Hardware_Server) GetActiveTickets 

func (r Hardware_Server) GetActiveTickets() (resp []datatypes.Ticket, err error)

Retrieve

func (Hardware_Server) GetActiveTransaction 

func (r Hardware_Server) GetActiveTransaction() (resp datatypes.Provisioning_Version1_Transaction, err error)

Retrieve Transaction currently running for server.

func (Hardware_Server) GetActiveTransactions 

func (r Hardware_Server) GetActiveTransactions() (resp []datatypes.Provisioning_Version1_Transaction, err error)

Retrieve Any active transaction(s) that are currently running for the server (example: os reload).

func (Hardware_Server) GetAllPowerComponents 

func (r Hardware_Server) GetAllPowerComponents() (resp []datatypes.Hardware_Power_Component, err error)

Retrieve

func (Hardware_Server) GetAllowedHost 

func (r Hardware_Server) GetAllowedHost() (resp datatypes.Network_Storage_Allowed_Host, err error)

Retrieve The SoftLayer_Network_Storage_Allowed_Host information to connect this server to Network Storage volumes that require access control lists.

func (Hardware_Server) GetAllowedNetworkStorage 

func (r Hardware_Server) GetAllowedNetworkStorage() (resp []datatypes.Network_Storage, err error)

Retrieve The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to.

func (Hardware_Server) GetAllowedNetworkStorageReplicas 

func (r Hardware_Server) GetAllowedNetworkStorageReplicas() (resp []datatypes.Network_Storage, err error)

Retrieve The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to.

func (Hardware_Server) GetAntivirusSpywareSoftwareComponent 

func (r Hardware_Server) GetAntivirusSpywareSoftwareComponent() (resp datatypes.Software_Component, err error)

Retrieve Information regarding an antivirus/spyware software component object.

func (Hardware_Server) GetAttachedNetworkStorages 

func (r Hardware_Server) GetAttachedNetworkStorages(nasType *string) (resp []datatypes.Network_Storage, err error)

This method is retrieve a list of SoftLayer_Network_Storage volumes that are authorized access to this SoftLayer_Hardware.

func (Hardware_Server) GetAttributes 

func (r Hardware_Server) GetAttributes() (resp []datatypes.Hardware_Attribute, err error)

Retrieve Information regarding a piece of hardware's specific attributes.

func (Hardware_Server) GetAvailableBillingTermChangePrices added in v1.0.4 

func (r Hardware_Server) GetAvailableBillingTermChangePrices() (resp []datatypes.Product_Item_Price, err error)

Retrieves a list of available term prices to this hardware. Currently, price terms are only available for increasing term length to monthly billed servers.

func (Hardware_Server) GetAvailableMonitoring 

func (r Hardware_Server) GetAvailableMonitoring() (resp []datatypes.Network_Monitor_Version1_Query_Host_Stratum, err error)

Retrieve An object that stores the maximum level for the monitoring query types and response types.

func (Hardware_Server) GetAvailableNetworkStorages 

func (r Hardware_Server) GetAvailableNetworkStorages(nasType *string) (resp []datatypes.Network_Storage, err error)

This method retrieves a list of SoftLayer_Network_Storage volumes that can be authorized to this SoftLayer_Hardware.

func (Hardware_Server) GetAverageDailyBandwidthUsage 

func (r Hardware_Server) GetAverageDailyBandwidthUsage() (resp datatypes.Float64, err error)

Retrieve The average daily total bandwidth usage for the current billing cycle.

func (Hardware_Server) GetAverageDailyPrivateBandwidthUsage 

func (r Hardware_Server) GetAverageDailyPrivateBandwidthUsage() (resp datatypes.Float64, err error)

Retrieve The average daily private bandwidth usage for the current billing cycle.

func (Hardware_Server) GetAverageDailyPublicBandwidthUsage 

func (r Hardware_Server) GetAverageDailyPublicBandwidthUsage() (resp datatypes.Float64, err error)

Retrieve The average daily public bandwidth usage for the current billing cycle.

func (Hardware_Server) GetBackendBandwidthUsage 

func (r Hardware_Server) GetBackendBandwidthUsage(startDate *datatypes.Time, endDate *datatypes.Time) (resp []datatypes.Metric_Tracking_Object_Data, err error)

Use this method to return an array of private bandwidth utilization records between a given date range.

This method represents the NEW version of getFrontendBandwidthUse

func (Hardware_Server) GetBackendIncomingBandwidth 

func (r Hardware_Server) GetBackendIncomingBandwidth(startDate *datatypes.Time, endDate *datatypes.Time) (resp datatypes.Float64, err error)

The ”'getBackendIncomingBandwidth”' method retrieves the amount of incoming private network traffic used between the given start date and end date parameters. When entering start and end dates, only the month, day and year are used to calculate bandwidth totals - the time (HH:MM:SS) is ignored and defaults to midnight. The amount of bandwidth retrieved is measured in gigabytes.

func (Hardware_Server) GetBackendNetworkComponents 

func (r Hardware_Server) GetBackendNetworkComponents() (resp []datatypes.Network_Component, err error)

Retrieve A piece of hardware's back-end or private network components.

func (Hardware_Server) GetBackendOutgoingBandwidth 

func (r Hardware_Server) GetBackendOutgoingBandwidth(startDate *datatypes.Time, endDate *datatypes.Time) (resp datatypes.Float64, err error)

The ”'getBackendOutgoingBandwidth”' method retrieves the amount of outgoing private network traffic used between the given start date and end date parameters. When entering start and end dates, only the month, day and year are used to calculate bandwidth totals - the time (HH:MM:SS) is ignored and defaults to midnight. The amount of bandwidth retrieved is measured in gigabytes.

func (Hardware_Server) GetBackendRouters 

func (r Hardware_Server) GetBackendRouters() (resp []datatypes.Hardware, err error)

Retrieve A hardware's backend or private router.

func (Hardware_Server) GetBandwidthAllocation 

func (r Hardware_Server) GetBandwidthAllocation() (resp datatypes.Float64, err error)

Retrieve A hardware's allotted bandwidth (measured in GB).

func (Hardware_Server) GetBandwidthAllotmentDetail 

func (r Hardware_Server) GetBandwidthAllotmentDetail() (resp datatypes.Network_Bandwidth_Version1_Allotment_Detail, err error)

Retrieve A hardware's allotted detail record. Allotment details link bandwidth allocation with allotments.

func (Hardware_Server) GetBandwidthForDateRange 

func (r Hardware_Server) GetBandwidthForDateRange(startDate *datatypes.Time, endDate *datatypes.Time) (resp []datatypes.Metric_Tracking_Object_Data, err error)

Retrieve a collection of bandwidth data from an individual public or private network tracking object. Data is ideal if you with to employ your own traffic storage and graphing systems.

func (Hardware_Server) GetBenchmarkCertifications 

func (r Hardware_Server) GetBenchmarkCertifications() (resp []datatypes.Hardware_Benchmark_Certification, err error)

Retrieve Information regarding a piece of hardware's benchmark certifications.

func (Hardware_Server) GetBillingCycleBandwidthUsage 

func (r Hardware_Server) GetBillingCycleBandwidthUsage() (resp []datatypes.Network_Bandwidth_Usage, err error)

Retrieve The raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to.

func (Hardware_Server) GetBillingCyclePrivateBandwidthUsage 

func (r Hardware_Server) GetBillingCyclePrivateBandwidthUsage() (resp datatypes.Network_Bandwidth_Usage, err error)

Retrieve The raw private bandwidth usage data for the current billing cycle.

func (Hardware_Server) GetBillingCyclePublicBandwidthUsage 

func (r Hardware_Server) GetBillingCyclePublicBandwidthUsage() (resp datatypes.Network_Bandwidth_Usage, err error)

Retrieve The raw public bandwidth usage data for the current billing cycle.

func (Hardware_Server) GetBillingItem 

func (r Hardware_Server) GetBillingItem() (resp datatypes.Billing_Item_Hardware, err error)

Retrieve Information regarding the billing item for a server.

func (Hardware_Server) GetBillingItemFlag 

func (r Hardware_Server) GetBillingItemFlag() (resp bool, err error)

Retrieve A flag indicating that a billing item exists.

func (Hardware_Server) GetBiosPasswordNullFlag 

func (r Hardware_Server) GetBiosPasswordNullFlag() (resp bool, err error)

Retrieve Determine if BIOS password should be left as null.

func (Hardware_Server) GetBlockCancelBecauseDisconnectedFlag 

func (r Hardware_Server) GetBlockCancelBecauseDisconnectedFlag() (resp bool, err error)

Retrieve Determines whether the hardware is ineligible for cancellation because it is disconnected.

func (Hardware_Server) GetBootModeOptions 

func (r Hardware_Server) GetBootModeOptions() (resp []string, err error)

Retrieve the valid boot modes for this server

func (Hardware_Server) GetBusinessContinuanceInsuranceFlag 

func (r Hardware_Server) GetBusinessContinuanceInsuranceFlag() (resp bool, err error)

Retrieve Status indicating whether or not a piece of hardware has business continuance insurance.

func (Hardware_Server) GetCaptureEnabledFlag added in v1.0.1 

func (r Hardware_Server) GetCaptureEnabledFlag() (resp datatypes.Container_Hardware_CaptureEnabled, err error)

Retrieve Determine if the server is able to be image captured. If unable to image capture a reason will be provided.

func (Hardware_Server) GetChildrenHardware 

func (r Hardware_Server) GetChildrenHardware() (resp []datatypes.Hardware, err error)

Retrieve Child hardware.

func (Hardware_Server) GetComponentDetailsXML 

func (r Hardware_Server) GetComponentDetailsXML() (resp string, err error)

no documentation yet

func (Hardware_Server) GetComponents 

func (r Hardware_Server) GetComponents() (resp []datatypes.Hardware_Component, err error)

Retrieve A piece of hardware's components.

func (Hardware_Server) GetContainsSolidStateDrivesFlag 

func (r Hardware_Server) GetContainsSolidStateDrivesFlag() (resp bool, err error)

Retrieve

func (Hardware_Server) GetContinuousDataProtectionSoftwareComponent 

func (r Hardware_Server) GetContinuousDataProtectionSoftwareComponent() (resp datatypes.Software_Component, err error)

Retrieve A continuous data protection/server backup software component object.

func (Hardware_Server) GetControlPanel 

func (r Hardware_Server) GetControlPanel() (resp datatypes.Software_Component_ControlPanel, err error)

Retrieve A server's control panel.

func (Hardware_Server) GetCost 

func (r Hardware_Server) GetCost() (resp datatypes.Float64, err error)

Retrieve The total cost of a server, measured in US Dollars ($USD).

func (Hardware_Server) GetCreateObjectOptions 

func (r Hardware_Server) GetCreateObjectOptions() (resp datatypes.Container_Hardware_Configuration, err error)

There are many options that may be provided while ordering a server, this method can be used to determine what these options are.

Detailed information on the return value can be found on the data type page for [[SoftLayer_Container_Hardware_Configuration (type)]].

func (Hardware_Server) GetCurrentBandwidthSummary 

func (r Hardware_Server) GetCurrentBandwidthSummary() (resp datatypes.Metric_Tracking_Object_Bandwidth_Summary, err error)

Retrieve An object that provides commonly used bandwidth summary components for the current billing cycle.

func (Hardware_Server) GetCurrentBenchmarkCertificationResultFile 

func (r Hardware_Server) GetCurrentBenchmarkCertificationResultFile() (resp []byte, err error)

Attempt to retrieve the file associated with the current benchmark certification result, if such a file exists. If there is no file for this benchmark certification result, calling this method throws an exception.

func (Hardware_Server) GetCurrentBillableBandwidthUsage 

func (r Hardware_Server) GetCurrentBillableBandwidthUsage() (resp datatypes.Float64, err error)

Retrieve The current billable public outbound bandwidth for this hardware for the current billing cycle.

func (Hardware_Server) GetCurrentBillingDetail 

func (r Hardware_Server) GetCurrentBillingDetail() (resp []datatypes.Billing_Item, err error)

Get the billing detail for this hardware for the current billing period. This does not include bandwidth usage.

func (Hardware_Server) GetCurrentBillingTotal 

func (r Hardware_Server) GetCurrentBillingTotal() (resp datatypes.Float64, err error)

Get the total bill amount in US Dollars ($) for this hardware in the current billing period. This includes all bandwidth used up to the point the method is called on the hardware.

func (Hardware_Server) GetCustomerInstalledOperatingSystemFlag 

func (r Hardware_Server) GetCustomerInstalledOperatingSystemFlag() (resp bool, err error)

Retrieve Indicates if a server has a Customer Installed OS

func (Hardware_Server) GetCustomerOwnedFlag 

func (r Hardware_Server) GetCustomerOwnedFlag() (resp bool, err error)

Retrieve Indicates if a server is a customer owned device.

func (Hardware_Server) GetDailyAverage 

func (r Hardware_Server) GetDailyAverage(startDate *datatypes.Time, endDate *datatypes.Time) (resp datatypes.Float64, err error)

The ”'getDailyAverage”' method calculates the average daily network traffic used by the selected server. Using the required parameter ”dateTime” to enter a start and end date, the user retrieves this average, measure in gigabytes (GB) for the specified date range. When entering parameters, only the month, day and year are required - time entries are omitted as this method defaults the time to midnight in order to account for the entire day.

func (Hardware_Server) GetDatacenter 

func (r Hardware_Server) GetDatacenter() (resp datatypes.Location, err error)

Retrieve Information regarding the datacenter in which a piece of hardware resides.

func (Hardware_Server) GetDatacenterName 

func (r Hardware_Server) GetDatacenterName() (resp string, err error)

Retrieve The name of the datacenter in which a piece of hardware resides.

func (Hardware_Server) GetDaysInSparePool 

func (r Hardware_Server) GetDaysInSparePool() (resp int, err error)

Retrieve Number of day(s) a server have been in spare pool.

func (Hardware_Server) GetDownlinkHardware 

func (r Hardware_Server) GetDownlinkHardware() (resp []datatypes.Hardware, err error)

Retrieve All hardware that has uplink network connections to a piece of hardware.

func (Hardware_Server) GetDownlinkNetworkHardware 

func (r Hardware_Server) GetDownlinkNetworkHardware() (resp []datatypes.Hardware, err error)

Retrieve All hardware that has uplink network connections to a piece of hardware.

func (Hardware_Server) GetDownlinkServers 

func (r Hardware_Server) GetDownlinkServers() (resp []datatypes.Hardware, err error)

Retrieve Information regarding all servers attached to a piece of network hardware.

func (Hardware_Server) GetDownlinkVirtualGuests 

func (r Hardware_Server) GetDownlinkVirtualGuests() (resp []datatypes.Virtual_Guest, err error)

Retrieve Information regarding all virtual guests attached to a piece of network hardware.

func (Hardware_Server) GetDownstreamHardwareBindings 

func (r Hardware_Server) GetDownstreamHardwareBindings() (resp []datatypes.Network_Component_Uplink_Hardware, err error)

Retrieve All hardware downstream from a network device.

func (Hardware_Server) GetDownstreamNetworkHardware 

func (r Hardware_Server) GetDownstreamNetworkHardware() (resp []datatypes.Hardware, err error)

Retrieve All network hardware downstream from the selected piece of hardware.

func (Hardware_Server) GetDownstreamNetworkHardwareWithIncidents 

func (r Hardware_Server) GetDownstreamNetworkHardwareWithIncidents() (resp []datatypes.Hardware, err error)

Retrieve All network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware. [DEPRECATED]

func (Hardware_Server) GetDownstreamServers 

func (r Hardware_Server) GetDownstreamServers() (resp []datatypes.Hardware, err error)

Retrieve Information regarding all servers attached downstream to a piece of network hardware.

func (Hardware_Server) GetDownstreamVirtualGuests 

func (r Hardware_Server) GetDownstreamVirtualGuests() (resp []datatypes.Virtual_Guest, err error)

Retrieve Information regarding all virtual guests attached to a piece of network hardware.

func (Hardware_Server) GetDriveControllers 

func (r Hardware_Server) GetDriveControllers() (resp []datatypes.Hardware_Component, err error)

Retrieve The drive controllers contained within a piece of hardware.

func (Hardware_Server) GetEvaultNetworkStorage 

func (r Hardware_Server) GetEvaultNetworkStorage() (resp []datatypes.Network_Storage, err error)

Retrieve Information regarding a piece of hardware's associated EVault network storage service account.

func (Hardware_Server) GetFirewallProtectableSubnets 

func (r Hardware_Server) GetFirewallProtectableSubnets() (resp []datatypes.Network_Subnet, err error)

Get the subnets associated with this server that are protectable by a network component firewall.

func (Hardware_Server) GetFirewallServiceComponent 

func (r Hardware_Server) GetFirewallServiceComponent() (resp datatypes.Network_Component_Firewall, err error)

Retrieve Information regarding a piece of hardware's firewall services.

func (Hardware_Server) GetFixedConfigurationPreset 

func (r Hardware_Server) GetFixedConfigurationPreset() (resp datatypes.Product_Package_Preset, err error)

Retrieve Defines the fixed components in a fixed configuration bare metal server.

func (Hardware_Server) GetFrontendBandwidthUsage 

func (r Hardware_Server) GetFrontendBandwidthUsage(startDate *datatypes.Time, endDate *datatypes.Time) (resp []datatypes.Metric_Tracking_Object_Data, err error)

Use this method to return an array of public bandwidth utilization records between a given date range.

This method represents the NEW version of getFrontendBandwidthUse

func (Hardware_Server) GetFrontendIncomingBandwidth 

func (r Hardware_Server) GetFrontendIncomingBandwidth(startDate *datatypes.Time, endDate *datatypes.Time) (resp datatypes.Float64, err error)

The ”'getFrontendIncomingBandwidth”' method retrieves the amount of incoming public network traffic used by a server between the given start and end date parameters. When entering the ”dateTime” parameter, only the month, day and year of the start and end dates are required - the time (hour, minute and second) are set to midnight by default and cannot be changed. The amount of bandwidth retrieved is measured in gigabytes (GB).

func (Hardware_Server) GetFrontendNetworkComponents 

func (r Hardware_Server) GetFrontendNetworkComponents() (resp []datatypes.Network_Component, err error)

Retrieve A piece of hardware's front-end or public network components.

func (Hardware_Server) GetFrontendOutgoingBandwidth 

func (r Hardware_Server) GetFrontendOutgoingBandwidth(startDate *datatypes.Time, endDate *datatypes.Time) (resp datatypes.Float64, err error)

The ”'getFrontendOutgoingBandwidth”' method retrieves the amount of outgoing public network traffic used by a server between the given start and end date parameters. The ”dateTime” parameter requires only the day, month and year to be entered - the time (hour, minute and second) are set to midnight be default in order to gather the data for the entire start and end date indicated in the parameter. The amount of bandwidth retrieved is measured in gigabytes (GB).

func (Hardware_Server) GetFrontendRouters 

func (r Hardware_Server) GetFrontendRouters() (resp []datatypes.Hardware, err error)

Retrieve A hardware's frontend or public router.

func (Hardware_Server) GetFutureBillingItem added in v1.0.4 

func (r Hardware_Server) GetFutureBillingItem() (resp datatypes.Billing_Item_Hardware, err error)

Retrieve Information regarding the future billing item for a server.

func (Hardware_Server) GetGlobalIdentifier 

func (r Hardware_Server) GetGlobalIdentifier() (resp string, err error)

Retrieve A hardware's universally unique identifier.

func (Hardware_Server) GetHardDrives 

func (r Hardware_Server) GetHardDrives() (resp []datatypes.Hardware_Component, err error)

Retrieve The hard drives contained within a piece of hardware.

func (Hardware_Server) GetHardwareByIpAddress 

func (r Hardware_Server) GetHardwareByIpAddress(ipAddress *string) (resp datatypes.Hardware_Server, err error)

Retrieve a server by searching for the primary IP address.

func (Hardware_Server) GetHardwareChassis 

func (r Hardware_Server) GetHardwareChassis() (resp datatypes.Hardware_Chassis, err error)

Retrieve The chassis that a piece of hardware is housed in.

func (Hardware_Server) GetHardwareFunction 

func (r Hardware_Server) GetHardwareFunction() (resp datatypes.Hardware_Function, err error)

Retrieve A hardware's function.

func (Hardware_Server) GetHardwareFunctionDescription 

func (r Hardware_Server) GetHardwareFunctionDescription() (resp string, err error)

Retrieve A hardware's function.

func (Hardware_Server) GetHardwareState added in v1.0.4 

func (r Hardware_Server) GetHardwareState() (resp datatypes.Hardware_State, err error)

Retrieve A hardware's power/transaction state.

func (Hardware_Server) GetHardwareStatus 

func (r Hardware_Server) GetHardwareStatus() (resp datatypes.Hardware_Status, err error)

Retrieve A hardware's status.

func (Hardware_Server) GetHasSingleRootVirtualizationBillingItemFlag 

func (r Hardware_Server) GetHasSingleRootVirtualizationBillingItemFlag() (resp bool, err error)

Retrieve Determine if hardware has Single Root IO VIrtualization (SR-IOV) billing item.

func (Hardware_Server) GetHasTrustedPlatformModuleBillingItemFlag 

func (r Hardware_Server) GetHasTrustedPlatformModuleBillingItemFlag() (resp bool, err error)

Retrieve Determine in hardware object has TPM enabled.

func (Hardware_Server) GetHostIpsSoftwareComponent 

func (r Hardware_Server) GetHostIpsSoftwareComponent() (resp datatypes.Software_Component, err error)

Retrieve Information regarding a host IPS software component object.

func (Hardware_Server) GetHourlyBandwidth 

func (r Hardware_Server) GetHourlyBandwidth(mode *string, day *datatypes.Time) (resp []datatypes.Metric_Tracking_Object_Data, err error)

The ”'getHourlyBandwidth”' method retrieves all bandwidth updates hourly for the specified hardware. Because the potential number of data points can become excessive, the method limits the user to obtain data in 24-hour intervals. The required ”dateTime” parameter is used as the starting point for the query and will be calculated for the 24-hour period starting with the specified date and time. For example, entering a parameter of

'02/01/2008 0:00'

results in a return of all bandwidth data for the entire day of February 1, 2008, as 0:00 specifies a midnight start date. Please note that the time entered should be completed using a 24-hour clock (military time, astronomical time).

For data spanning more than a single 24-hour period, refer to the getBandwidthData function on the metricTrackingObject for the piece of hardware.

func (Hardware_Server) GetHourlyBillingFlag 

func (r Hardware_Server) GetHourlyBillingFlag() (resp bool, err error)

Retrieve A server's hourly billing status.

func (Hardware_Server) GetInboundBandwidthUsage 

func (r Hardware_Server) GetInboundBandwidthUsage() (resp datatypes.Float64, err error)

Retrieve The sum of all the inbound network traffic data for the last 30 days.

func (Hardware_Server) GetInboundPrivateBandwidthUsage 

func (r Hardware_Server) GetInboundPrivateBandwidthUsage() (resp datatypes.Float64, err error)

Retrieve The total private inbound bandwidth for this hardware for the current billing cycle.

func (Hardware_Server) GetInboundPublicBandwidthUsage 

func (r Hardware_Server) GetInboundPublicBandwidthUsage() (resp datatypes.Float64, err error)

Retrieve The total public inbound bandwidth for this hardware for the current billing cycle.

func (Hardware_Server) GetIsBillingTermChangeAvailableFlag added in v1.0.4 

func (r Hardware_Server) GetIsBillingTermChangeAvailableFlag() (resp bool, err error)

Retrieve Whether or not this hardware object is eligible to change to term billing.

func (Hardware_Server) GetIsCloudReadyNodeCertified 

func (r Hardware_Server) GetIsCloudReadyNodeCertified() (resp bool, err error)

Retrieve Determine if hardware object has the IBM_CLOUD_READY_NODE_CERTIFIED attribute.

func (Hardware_Server) GetIsIpmiDisabled 

func (r Hardware_Server) GetIsIpmiDisabled() (resp bool, err error)

Retrieve Determine if remote management has been disabled due to port speed.

func (Hardware_Server) GetIsNfsOnly added in v1.1.6 

func (r Hardware_Server) GetIsNfsOnly() (resp string, err error)

Retrieve A server that has nfs only drive.

func (Hardware_Server) GetIsQeInternalServer added in v1.1.3 

func (r Hardware_Server) GetIsQeInternalServer() (resp bool, err error)

Retrieve Determine if hardware object has the QE_INTERNAL_SERVER attribute.

func (Hardware_Server) GetIsVirtualPrivateCloudNode 

func (r Hardware_Server) GetIsVirtualPrivateCloudNode() (resp bool, err error)

Retrieve Determine if hardware object is a Virtual Private Cloud node.

func (Hardware_Server) GetItemPricesFromSoftwareDescriptions 

func (r Hardware_Server) GetItemPricesFromSoftwareDescriptions(softwareDescriptions []datatypes.Software_Description, includeTranslationsFlag *bool, returnAllPricesFlag *bool) (resp []datatypes.Product_Item, err error)

Return a collection of SoftLayer_Item_Price objects from a collection of SoftLayer_Software_Description

func (Hardware_Server) GetLastOperatingSystemReload 

func (r Hardware_Server) GetLastOperatingSystemReload() (resp datatypes.Provisioning_Version1_Transaction, err error)

Retrieve The last transaction that a server's operating system was loaded.

func (Hardware_Server) GetLastTransaction 

func (r Hardware_Server) GetLastTransaction() (resp datatypes.Provisioning_Version1_Transaction, err error)

Retrieve Information regarding the last transaction a server performed.

func (Hardware_Server) GetLatestNetworkMonitorIncident 

func (r Hardware_Server) GetLatestNetworkMonitorIncident() (resp datatypes.Network_Monitor_Version1_Incident, err error)

Retrieve A piece of hardware's latest network monitoring incident.

func (Hardware_Server) GetLocation 

func (r Hardware_Server) GetLocation() (resp datatypes.Location, err error)

Retrieve Where a piece of hardware is located within SoftLayer's location hierarchy.

func (Hardware_Server) GetLocationPathString 

func (r Hardware_Server) GetLocationPathString() (resp string, err error)

Retrieve

func (Hardware_Server) GetLockboxNetworkStorage 

func (r Hardware_Server) GetLockboxNetworkStorage() (resp datatypes.Network_Storage, err error)

Retrieve Information regarding a lockbox account associated with a server.

func (Hardware_Server) GetLogicalVolumeStorageGroups added in v1.0.2 

func (r Hardware_Server) GetLogicalVolumeStorageGroups() (resp []datatypes.Configuration_Storage_Group, err error)

Retrieve Returns a list of logical volumes on the physical machine.

func (Hardware_Server) GetManagedResourceFlag 

func (r Hardware_Server) GetManagedResourceFlag() (resp bool, err error)

Retrieve A flag indicating that the hardware is a managed resource.

func (Hardware_Server) GetManagementNetworkComponent 

func (r Hardware_Server) GetManagementNetworkComponent() (resp datatypes.Network_Component, err error)

Retrieve the remote management network component attached with this server.

func (Hardware_Server) GetMemory 

func (r Hardware_Server) GetMemory() (resp []datatypes.Hardware_Component, err error)

Retrieve Information regarding a piece of hardware's memory.

func (Hardware_Server) GetMemoryCapacity 

func (r Hardware_Server) GetMemoryCapacity() (resp uint, err error)

Retrieve The amount of memory a piece of hardware has, measured in gigabytes.

func (Hardware_Server) GetMetricTrackingObject 

func (r Hardware_Server) GetMetricTrackingObject() (resp datatypes.Metric_Tracking_Object, err error)

Retrieve A piece of hardware's metric tracking object.

func (Hardware_Server) GetMetricTrackingObjectId 

func (r Hardware_Server) GetMetricTrackingObjectId() (resp int, err error)

Retrieve The metric tracking object id for this server.

func (Hardware_Server) GetModules 

func (r Hardware_Server) GetModules() (resp []datatypes.Hardware_Component, err error)

Retrieve

func (Hardware_Server) GetMonitoringRobot 

func (r Hardware_Server) GetMonitoringRobot() (resp datatypes.Monitoring_Robot, err error)

Retrieve

func (Hardware_Server) GetMonitoringServiceComponent 

func (r Hardware_Server) GetMonitoringServiceComponent() (resp datatypes.Network_Monitor_Version1_Query_Host_Stratum, err error)

Retrieve Information regarding a piece of hardware's network monitoring services.

func (Hardware_Server) GetMonitoringServiceEligibilityFlag 

func (r Hardware_Server) GetMonitoringServiceEligibilityFlag() (resp bool, err error)

Retrieve

func (Hardware_Server) GetMonitoringUserNotification 

func (r Hardware_Server) GetMonitoringUserNotification() (resp []datatypes.User_Customer_Notification_Hardware, err error)

Retrieve The monitoring notification objects for this hardware. Each object links this hardware instance to a user account that will be notified if monitoring on this hardware object fails

func (Hardware_Server) GetMotherboard 

func (r Hardware_Server) GetMotherboard() (resp datatypes.Hardware_Component, err error)

Retrieve Information regarding a piece of hardware's motherboard.

func (Hardware_Server) GetNetworkCards 

func (r Hardware_Server) GetNetworkCards() (resp []datatypes.Hardware_Component, err error)

Retrieve Information regarding a piece of hardware's network cards.

func (Hardware_Server) GetNetworkComponentFirewallProtectableIpAddresses 

func (r Hardware_Server) GetNetworkComponentFirewallProtectableIpAddresses() (resp []datatypes.Network_Subnet_IpAddress, err error)

Get the IP addresses associated with this server that are protectable by a network component firewall. Note, this may not return all values for IPv6 subnets for this server. Please use getFirewallProtectableSubnets to get all protectable subnets.

func (Hardware_Server) GetNetworkComponents 

func (r Hardware_Server) GetNetworkComponents() (resp []datatypes.Network_Component, err error)

Retrieve Returns a hardware's network components.

func (Hardware_Server) GetNetworkGatewayMember 

func (r Hardware_Server) GetNetworkGatewayMember() (resp datatypes.Network_Gateway_Member, err error)

Retrieve The gateway member if this device is part of a network gateway.

func (Hardware_Server) GetNetworkGatewayMemberFlag 

func (r Hardware_Server) GetNetworkGatewayMemberFlag() (resp bool, err error)

Retrieve Whether or not this device is part of a network gateway.

func (Hardware_Server) GetNetworkManagementIpAddress 

func (r Hardware_Server) GetNetworkManagementIpAddress() (resp string, err error)

Retrieve A piece of hardware's network management IP address.

func (Hardware_Server) GetNetworkMonitorAttachedDownHardware 

func (r Hardware_Server) GetNetworkMonitorAttachedDownHardware() (resp []datatypes.Hardware, err error)

Retrieve All servers with failed monitoring that are attached downstream to a piece of hardware.

func (Hardware_Server) GetNetworkMonitorAttachedDownVirtualGuests 

func (r Hardware_Server) GetNetworkMonitorAttachedDownVirtualGuests() (resp []datatypes.Virtual_Guest, err error)

Retrieve Virtual guests that are attached downstream to a hardware that have failed monitoring

func (Hardware_Server) GetNetworkMonitorIncidents 

func (r Hardware_Server) GetNetworkMonitorIncidents() (resp []datatypes.Network_Monitor_Version1_Incident, err error)

Retrieve The status of all of a piece of hardware's network monitoring incidents.

func (Hardware_Server) GetNetworkMonitors 

func (r Hardware_Server) GetNetworkMonitors() (resp []datatypes.Network_Monitor_Version1_Query_Host, err error)

Retrieve Information regarding a piece of hardware's network monitors.

func (Hardware_Server) GetNetworkStatus 

func (r Hardware_Server) GetNetworkStatus() (resp string, err error)

Retrieve The value of a hardware's network status attribute. [DEPRECATED]

func (Hardware_Server) GetNetworkStatusAttribute 

func (r Hardware_Server) GetNetworkStatusAttribute() (resp datatypes.Hardware_Attribute, err error)

Retrieve The hardware's related network status attribute. [DEPRECATED]

func (Hardware_Server) GetNetworkStorage 

func (r Hardware_Server) GetNetworkStorage() (resp []datatypes.Network_Storage, err error)

Retrieve Information regarding a piece of hardware's associated network storage service account.

func (Hardware_Server) GetNetworkVlans 

func (r Hardware_Server) GetNetworkVlans() (resp []datatypes.Network_Vlan, err error)

Retrieve The network virtual LANs (VLANs) associated with a piece of hardware's network components.

func (Hardware_Server) GetNextBillingCycleBandwidthAllocation 

func (r Hardware_Server) GetNextBillingCycleBandwidthAllocation() (resp datatypes.Float64, err error)

Retrieve A hardware's allotted bandwidth for the next billing cycle (measured in GB).

func (Hardware_Server) GetNotesHistory 

func (r Hardware_Server) GetNotesHistory() (resp []datatypes.Hardware_Note, err error)

Retrieve

func (Hardware_Server) GetNvRamCapacity 

func (r Hardware_Server) GetNvRamCapacity() (resp uint, err error)

Retrieve The amount of non-volatile memory a piece of hardware has, measured in gigabytes.

func (Hardware_Server) GetNvRamComponentModels 

func (r Hardware_Server) GetNvRamComponentModels() (resp []datatypes.Hardware_Component_Model, err error)

Retrieve

func (Hardware_Server) GetObject 

func (r Hardware_Server) GetObject() (resp datatypes.Hardware_Server, err error)

getObject retrieves the SoftLayer_Hardware_Server object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Hardware service. You can only retrieve servers from the account that your portal user is assigned to.

func (Hardware_Server) GetOpenCancellationTicket 

func (r Hardware_Server) GetOpenCancellationTicket() (resp datatypes.Ticket, err error)

Retrieve An open ticket requesting cancellation of this server, if one exists.

func (Hardware_Server) GetOperatingSystem 

func (r Hardware_Server) GetOperatingSystem() (resp datatypes.Software_Component_OperatingSystem, err error)

Retrieve Information regarding a piece of hardware's operating system.

func (Hardware_Server) GetOperatingSystemReferenceCode 

func (r Hardware_Server) GetOperatingSystemReferenceCode() (resp string, err error)

Retrieve A hardware's operating system software description.

func (Hardware_Server) GetOutboundBandwidthUsage 

func (r Hardware_Server) GetOutboundBandwidthUsage() (resp datatypes.Float64, err error)

Retrieve The sum of all the outbound network traffic data for the last 30 days.

func (Hardware_Server) GetOutboundPrivateBandwidthUsage 

func (r Hardware_Server) GetOutboundPrivateBandwidthUsage() (resp datatypes.Float64, err error)

Retrieve The total private outbound bandwidth for this hardware for the current billing cycle.

func (Hardware_Server) GetOutboundPublicBandwidthUsage 

func (r Hardware_Server) GetOutboundPublicBandwidthUsage() (resp datatypes.Float64, err error)

Retrieve The total public outbound bandwidth for this hardware for the current billing cycle.

func (Hardware_Server) GetOverBandwidthAllocationFlag 

func (r Hardware_Server) GetOverBandwidthAllocationFlag() (resp int, err error)

Retrieve Whether the bandwidth usage for this hardware for the current billing cycle exceeds the allocation.

func (Hardware_Server) GetPMInfo 

func (r Hardware_Server) GetPMInfo() (resp []datatypes.Container_RemoteManagement_PmInfo, err error)

Retrieve a server's hardware state via its internal sensors. Remote sensor data is transmitted to the SoftLayer API by way of the server's remote management card. Sensor data measures system temperatures, voltages, and other local server settings. Sensor data is cached for 30 seconds. Calls made to getSensorData for the same server within 30 seconds of each other will return the same data. Subsequent calls will return new data once the cache expires.

func (Hardware_Server) GetParentBay 

func (r Hardware_Server) GetParentBay() (resp datatypes.Hardware_Blade, err error)

Retrieve Blade Bay

func (Hardware_Server) GetParentHardware 

func (r Hardware_Server) GetParentHardware() (resp datatypes.Hardware, err error)

Retrieve Parent Hardware.

func (Hardware_Server) GetPartitions added in v1.0.3 

func (r Hardware_Server) GetPartitions() (resp []datatypes.Hardware_Server_Partition, err error)

Retrieve

func (Hardware_Server) GetPointOfPresenceLocation 

func (r Hardware_Server) GetPointOfPresenceLocation() (resp datatypes.Location, err error)

Retrieve Information regarding the Point of Presence (PoP) location in which a piece of hardware resides.

func (Hardware_Server) GetPowerComponents 

func (r Hardware_Server) GetPowerComponents() (resp []datatypes.Hardware_Power_Component, err error)

Retrieve The power components for a hardware object.

func (Hardware_Server) GetPowerSupply 

func (r Hardware_Server) GetPowerSupply() (resp []datatypes.Hardware_Component, err error)

Retrieve Information regarding a piece of hardware's power supply.

func (Hardware_Server) GetPrimaryBackendIpAddress 

func (r Hardware_Server) GetPrimaryBackendIpAddress() (resp string, err error)

Retrieve The hardware's primary private IP address.

func (Hardware_Server) GetPrimaryBackendNetworkComponent 

func (r Hardware_Server) GetPrimaryBackendNetworkComponent() (resp datatypes.Network_Component, err error)

Retrieve Information regarding the hardware's primary back-end network component.

func (Hardware_Server) GetPrimaryDriveSize 

func (r Hardware_Server) GetPrimaryDriveSize() (resp int, err error)

no documentation yet

func (Hardware_Server) GetPrimaryIpAddress 

func (r Hardware_Server) GetPrimaryIpAddress() (resp string, err error)

Retrieve The hardware's primary public IP address.

func (Hardware_Server) GetPrimaryNetworkComponent 

func (r Hardware_Server) GetPrimaryNetworkComponent() (resp datatypes.Network_Component, err error)

Retrieve Information regarding the hardware's primary public network component.

func (Hardware_Server) GetPrivateBackendNetworkComponents added in v1.0.6 

func (r Hardware_Server) GetPrivateBackendNetworkComponents() (resp []datatypes.Network_Component, err error)

Retrieve A collection of backendNetwork components

func (Hardware_Server) GetPrivateBandwidthData 

func (r Hardware_Server) GetPrivateBandwidthData(startTime *int, endTime *int) (resp []datatypes.Metric_Tracking_Object_Data, err error)

Retrieve this server's private bandwidth data. If no timeframe is specified then getPrivateBandwidthData retrieves the last 24 hours of public bandwidth usage.

func (Hardware_Server) GetPrivateBandwidthDataSummary 

func (r Hardware_Server) GetPrivateBandwidthDataSummary() (resp datatypes.Container_Network_Bandwidth_Data_Summary, err error)

Retrieve a brief summary of a server's private network bandwidth usage. getPrivateBandwidthDataSummary retrieves a server's bandwidth allocation for its billing period, its estimated usage during its billing period, and an estimation of how much bandwidth it will use during its billing period based on its current usage. A server's projected bandwidth usage increases in accuracy as it progresses through its billing period.

func (Hardware_Server) GetPrivateIpAddress 

func (r Hardware_Server) GetPrivateIpAddress() (resp string, err error)

Retrieve A server's primary private IP address.

func (Hardware_Server) GetPrivateNetworkComponent 

func (r Hardware_Server) GetPrivateNetworkComponent() (resp datatypes.Network_Component, err error)

Retrieve the private network component attached with this server.

func (Hardware_Server) GetPrivateNetworkOnlyFlag 

func (r Hardware_Server) GetPrivateNetworkOnlyFlag() (resp bool, err error)

Retrieve Whether the hardware only has access to the private network.

func (Hardware_Server) GetPrivateVlan 

func (r Hardware_Server) GetPrivateVlan() (resp datatypes.Network_Vlan, err error)

Retrieve the backend VLAN for the primary IP address of the server

func (Hardware_Server) GetProcessorCoreAmount 

func (r Hardware_Server) GetProcessorCoreAmount() (resp uint, err error)

Retrieve The total number of processor cores, summed from all processors that are attached to a piece of hardware

func (Hardware_Server) GetProcessorPhysicalCoreAmount 

func (r Hardware_Server) GetProcessorPhysicalCoreAmount() (resp uint, err error)

Retrieve The total number of physical processor cores, summed from all processors that are attached to a piece of hardware

func (Hardware_Server) GetProcessors 

func (r Hardware_Server) GetProcessors() (resp []datatypes.Hardware_Component, err error)

Retrieve Information regarding a piece of hardware's processors.

func (Hardware_Server) GetProjectedOverBandwidthAllocationFlag 

func (r Hardware_Server) GetProjectedOverBandwidthAllocationFlag() (resp int, err error)

Retrieve Whether the bandwidth usage for this hardware for the current billing cycle is projected to exceed the allocation.

func (Hardware_Server) GetProjectedPublicBandwidthUsage 

func (r Hardware_Server) GetProjectedPublicBandwidthUsage() (resp datatypes.Float64, err error)

Retrieve The projected public outbound bandwidth for this hardware for the current billing cycle.

func (Hardware_Server) GetProvisionDate 

func (r Hardware_Server) GetProvisionDate() (resp datatypes.Time, err error)

no documentation yet

func (Hardware_Server) GetPublicBandwidthData 

func (r Hardware_Server) GetPublicBandwidthData(startTime *int, endTime *int) (resp []datatypes.Metric_Tracking_Object_Data, err error)

Retrieve this server's public bandwidth data. If no timeframe is specified then getPublicBandwidthData retrieves the last 24 hours of public bandwidth usage.

func (Hardware_Server) GetPublicBandwidthDataSummary 

func (r Hardware_Server) GetPublicBandwidthDataSummary() (resp datatypes.Container_Network_Bandwidth_Data_Summary, err error)

Retrieve a brief summary of a server's public network bandwidth usage. getPublicBandwidthDataSummary retrieves a server's bandwidth allocation for its billing period, its estimated usage during its billing period, and an estimation of how much bandwidth it will use during its billing period based on its current usage. A server's projected bandwidth usage increases in accuracy as it progresses through its billing period.

func (Hardware_Server) GetPublicBandwidthTotal 

func (r Hardware_Server) GetPublicBandwidthTotal(startTime *int, endTime *int) (resp uint, err error)

Retrieve the total number of bytes used by a server over a specified time period via the data warehouse tracking objects for this hardware.

func (Hardware_Server) GetPublicNetworkComponent 

func (r Hardware_Server) GetPublicNetworkComponent() (resp datatypes.Network_Component, err error)

Retrieve a SoftLayer server's public network component. Some servers are only connected to the private network and may not have a public network component. In that case getPublicNetworkComponent returns a null object.

func (Hardware_Server) GetPublicVlan 

func (r Hardware_Server) GetPublicVlan() (resp datatypes.Network_Vlan, err error)

Retrieve the frontend VLAN for the primary IP address of the server

func (Hardware_Server) GetPublicVlanByHostname 

func (r Hardware_Server) GetPublicVlanByHostname(hostname *string) (resp datatypes.Network_Vlan, err error)

Retrieve the frontend network Vlan by searching the hostname of a server

func (Hardware_Server) GetRack 

func (r Hardware_Server) GetRack() (resp datatypes.Location, err error)

Retrieve

func (Hardware_Server) GetRaidControllers 

func (r Hardware_Server) GetRaidControllers() (resp []datatypes.Hardware_Component, err error)

Retrieve The RAID controllers contained within a piece of hardware.

func (Hardware_Server) GetReadyNodeFlag 

func (r Hardware_Server) GetReadyNodeFlag() (resp bool, err error)

Retrieve Determine if hardware object is vSan Ready Node.

func (Hardware_Server) GetRecentEvents 

func (r Hardware_Server) GetRecentEvents() (resp []datatypes.Notification_Occurrence_Event, err error)

Retrieve Recent events that impact this hardware.

func (Hardware_Server) GetRecentRemoteManagementCommands 

func (r Hardware_Server) GetRecentRemoteManagementCommands() (resp []datatypes.Hardware_Component_RemoteManagement_Command_Request, err error)

Retrieve The last five commands issued to the server's remote management card.

func (Hardware_Server) GetRedfishPowerState added in v1.1.4 

func (r Hardware_Server) GetRedfishPowerState() (resp string, err error)

Retrieves the power state for the server. The server's power status is retrieved from its remote management card. This will return 'on' or 'off'.

func (Hardware_Server) GetRegionalInternetRegistry 

func (r Hardware_Server) GetRegionalInternetRegistry() (resp datatypes.Network_Regional_Internet_Registry, err error)

Retrieve

func (Hardware_Server) GetRemoteManagement 

func (r Hardware_Server) GetRemoteManagement() (resp datatypes.Hardware_Component_RemoteManagement, err error)

Retrieve A server's remote management card.

func (Hardware_Server) GetRemoteManagementAccounts 

func (r Hardware_Server) GetRemoteManagementAccounts() (resp []datatypes.Hardware_Component_RemoteManagement_User, err error)

Retrieve User credentials to issue commands and/or interact with the server's remote management card.

func (Hardware_Server) GetRemoteManagementComponent 

func (r Hardware_Server) GetRemoteManagementComponent() (resp datatypes.Network_Component, err error)

Retrieve A hardware's associated remote management component. This is normally IPMI.

func (Hardware_Server) GetRemoteManagementUsers 

func (r Hardware_Server) GetRemoteManagementUsers() (resp []datatypes.Hardware_Component_RemoteManagement_User, err error)

Retrieve User(s) who have access to issue commands and/or interact with the server's remote management card.

func (Hardware_Server) GetResourceConfigurations 

func (r Hardware_Server) GetResourceConfigurations() (resp []datatypes.Hardware_Resource_Configuration, err error)

Retrieve

func (Hardware_Server) GetResourceGroupMemberReferences 

func (r Hardware_Server) GetResourceGroupMemberReferences() (resp []datatypes.Resource_Group_Member, err error)

Retrieve

func (Hardware_Server) GetResourceGroupRoles 

func (r Hardware_Server) GetResourceGroupRoles() (resp []datatypes.Resource_Group_Role, err error)

Retrieve

func (Hardware_Server) GetResourceGroups 

func (r Hardware_Server) GetResourceGroups() (resp []datatypes.Resource_Group, err error)

Retrieve The resource groups in which this hardware is a member.

func (Hardware_Server) GetReverseDomainRecords 

func (r Hardware_Server) GetReverseDomainRecords() (resp []datatypes.Dns_Domain, err error)

Retrieve the reverse domain records associated with this server.

func (Hardware_Server) GetRouters 

func (r Hardware_Server) GetRouters() (resp []datatypes.Hardware, err error)

Retrieve A hardware's routers.

func (Hardware_Server) GetSecurityScanRequests 

func (r Hardware_Server) GetSecurityScanRequests() (resp []datatypes.Network_Security_Scanner_Request, err error)

Retrieve Information regarding a piece of hardware's vulnerability scan requests.

func (Hardware_Server) GetSensorData 

func (r Hardware_Server) GetSensorData() (resp []datatypes.Container_RemoteManagement_SensorReading, err error)

Retrieve a server's hardware state via its internal sensors. Remote sensor data is transmitted to the SoftLayer API by way of the server's remote management card. Sensor data measures system temperatures, voltages, and other local server settings. Sensor data is cached for 30 seconds. Calls made to getSensorData for the same server within 30 seconds of each other will return the same data. Subsequent calls will return new data once the cache expires.

func (Hardware_Server) GetSensorDataWithGraphs 

func (r Hardware_Server) GetSensorDataWithGraphs() (resp datatypes.Container_RemoteManagement_SensorReadingsWithGraphs, err error)

Retrieves the raw data returned from the server's remote management card. For more details of what is returned please refer to the getSensorData method. Along with the raw data, graphs for the cpu and system temperatures and fan speeds are also returned.

func (Hardware_Server) GetServerDetails 

func (r Hardware_Server) GetServerDetails() (resp datatypes.Container_Hardware_Server_Details, err error)

Retrieve a server's hardware components, software, and network components. getServerDetails is an aggregation function that combines the results of [[SoftLayer_Hardware_Server::getComponents]], [[SoftLayer_Hardware_Server::getSoftware]], and [[SoftLayer_Hardware_Server::getNetworkComponents]] in a single container.

func (Hardware_Server) GetServerFanSpeedGraphs 

func (r Hardware_Server) GetServerFanSpeedGraphs() (resp []datatypes.Container_RemoteManagement_Graphs_SensorSpeed, err error)

Retrieve the server's fan speeds and displays them using tachometer graphs. Data used to construct graphs is retrieved from the server's remote management card. All graphs returned will have a title associated with it.

func (Hardware_Server) GetServerPowerState 

func (r Hardware_Server) GetServerPowerState() (resp string, err error)

Retrieves the power state for the server. The server's power status is retrieved from its remote management card. This will return 'on' or 'off'.

func (Hardware_Server) GetServerRoom 

func (r Hardware_Server) GetServerRoom() (resp datatypes.Location, err error)

Retrieve Information regarding the server room in which the hardware is located.

func (Hardware_Server) GetServerTemperatureGraphs 

func (r Hardware_Server) GetServerTemperatureGraphs() (resp []datatypes.Container_RemoteManagement_Graphs_SensorTemperature, err error)

Retrieve the server's temperature and displays them using thermometer graphs. Temperatures retrieved are CPU(s) and system temperatures. Data used to construct graphs is retrieved from the server's remote management card. All graphs returned will have a title associated with it.

func (Hardware_Server) GetServiceProvider 

func (r Hardware_Server) GetServiceProvider() (resp datatypes.Service_Provider, err error)

Retrieve Information regarding the piece of hardware's service provider.

func (Hardware_Server) GetSoftwareComponents 

func (r Hardware_Server) GetSoftwareComponents() (resp []datatypes.Software_Component, err error)

Retrieve Information regarding a piece of hardware's installed software.

func (Hardware_Server) GetSoftwareGuardExtensionEnabled 

func (r Hardware_Server) GetSoftwareGuardExtensionEnabled() (resp bool, err error)

Retrieve Determine if hardware object has Software Guard Extension (SGX) enabled.

func (Hardware_Server) GetSparePoolBillingItem 

func (r Hardware_Server) GetSparePoolBillingItem() (resp datatypes.Billing_Item_Hardware, err error)

Retrieve Information regarding the billing item for a spare pool server.

func (Hardware_Server) GetSshKeys 

func (r Hardware_Server) GetSshKeys() (resp []datatypes.Security_Ssh_Key, err error)

Retrieve SSH keys to be installed on the server during provisioning or an OS reload.

func (Hardware_Server) GetStatisticsRemoteManagement 

func (r Hardware_Server) GetStatisticsRemoteManagement() (resp datatypes.Hardware_Component_RemoteManagement, err error)

Retrieve A server's remote management card used for statistics.

func (Hardware_Server) GetStorageGroups added in v1.0.2 

func (r Hardware_Server) GetStorageGroups() (resp []datatypes.Configuration_Storage_Group, err error)

Retrieve

func (Hardware_Server) GetStorageNetworkComponents 

func (r Hardware_Server) GetStorageNetworkComponents() (resp []datatypes.Network_Component, err error)

Retrieve A piece of hardware's private storage network components. [Deprecated]

func (Hardware_Server) GetTagReferences 

func (r Hardware_Server) GetTagReferences() (resp []datatypes.Tag_Reference, err error)

Retrieve

func (Hardware_Server) GetTopLevelLocation 

func (r Hardware_Server) GetTopLevelLocation() (resp datatypes.Location, err error)

Retrieve

func (Hardware_Server) GetTransactionHistory 

func (r Hardware_Server) GetTransactionHistory() (resp []datatypes.Provisioning_Version1_Transaction_History, err error)

This method will query transaction history for a piece of hardware.

func (Hardware_Server) GetUefiBootFlag 

func (r Hardware_Server) GetUefiBootFlag() (resp bool, err error)

Retrieve Whether to use UEFI boot instead of BIOS.

func (Hardware_Server) GetUpgradeItemPrices 

func (r Hardware_Server) GetUpgradeItemPrices() (resp []datatypes.Product_Item_Price, err error)

Retrieve a list of upgradeable items available to this piece of hardware. Currently, getUpgradeItemPrices retrieves upgrades available for a server's memory, hard drives, network port speed, bandwidth allocation and GPUs.

func (Hardware_Server) GetUpgradeRequest 

func (r Hardware_Server) GetUpgradeRequest() (resp datatypes.Product_Upgrade_Request, err error)

Retrieve An account's associated upgrade request object, if any.

func (Hardware_Server) GetUpgradeableActiveComponents added in v1.1.2 

func (r Hardware_Server) GetUpgradeableActiveComponents() (resp []datatypes.Hardware_Component, err error)

Retrieve A piece of hardware's active upgradeable physical components.

func (Hardware_Server) GetUplinkHardware 

func (r Hardware_Server) GetUplinkHardware() (resp datatypes.Hardware, err error)

Retrieve The network device connected to a piece of hardware.

func (Hardware_Server) GetUplinkNetworkComponents 

func (r Hardware_Server) GetUplinkNetworkComponents() (resp []datatypes.Network_Component, err error)

Retrieve Information regarding the network component that is one level higher than a piece of hardware on the network infrastructure.

func (Hardware_Server) GetUserData 

func (r Hardware_Server) GetUserData() (resp []datatypes.Hardware_Attribute, err error)

Retrieve An array containing a single string of custom user data for a hardware order. Max size is 16 kb.

func (Hardware_Server) GetUsers 

func (r Hardware_Server) GetUsers() (resp []datatypes.User_Customer, err error)

Retrieve A list of users that have access to this computing instance.

func (Hardware_Server) GetValidBlockDeviceTemplateGroups 

func (r Hardware_Server) GetValidBlockDeviceTemplateGroups(visibility *string) (resp []datatypes.Virtual_Guest_Block_Device_Template_Group, err error)

This method will return the list of block device template groups that are valid to the host. For instance, it will only retrieve FLEX images.

func (Hardware_Server) GetVirtualChassis 

func (r Hardware_Server) GetVirtualChassis() (resp datatypes.Hardware_Group, err error)

Retrieve Information regarding the virtual chassis for a piece of hardware.

func (Hardware_Server) GetVirtualChassisSiblings 

func (r Hardware_Server) GetVirtualChassisSiblings() (resp []datatypes.Hardware, err error)

Retrieve Information regarding the virtual chassis siblings for a piece of hardware.

func (Hardware_Server) GetVirtualGuests 

func (r Hardware_Server) GetVirtualGuests() (resp []datatypes.Virtual_Guest, err error)

Retrieve [DEPRECATED] A hardware server's virtual servers.

func (Hardware_Server) GetVirtualHost 

func (r Hardware_Server) GetVirtualHost() (resp datatypes.Virtual_Host, err error)

Retrieve A piece of hardware's virtual host record.

func (Hardware_Server) GetVirtualLicenses 

func (r Hardware_Server) GetVirtualLicenses() (resp []datatypes.Software_VirtualLicense, err error)

Retrieve Information regarding a piece of hardware's virtual software licenses.

func (Hardware_Server) GetVirtualRack 

func (r Hardware_Server) GetVirtualRack() (resp datatypes.Network_Bandwidth_Version1_Allotment, err error)

Retrieve Information regarding the bandwidth allotment to which a piece of hardware belongs.

func (Hardware_Server) GetVirtualRackId 

func (r Hardware_Server) GetVirtualRackId() (resp int, err error)

Retrieve The name of the bandwidth allotment belonging to a piece of hardware.

func (Hardware_Server) GetVirtualRackName 

func (r Hardware_Server) GetVirtualRackName() (resp string, err error)

Retrieve The name of the bandwidth allotment belonging to a piece of hardware.

func (Hardware_Server) GetVirtualizationPlatform 

func (r Hardware_Server) GetVirtualizationPlatform() (resp datatypes.Software_Component, err error)

Retrieve A piece of hardware's virtualization platform software.

func (Hardware_Server) GetWindowsUpdateAvailableUpdates 

func (r Hardware_Server) GetWindowsUpdateAvailableUpdates() (resp []datatypes.Container_Utility_Microsoft_Windows_UpdateServices_UpdateItem, err error)

Retrieve a list of Windows updates available for a server from the local SoftLayer Windows Server Update Services (WSUS) server. Windows servers provisioned by SoftLayer are configured to use the local WSUS server via the private network by default.

func (Hardware_Server) GetWindowsUpdateInstalledUpdates 

func (r Hardware_Server) GetWindowsUpdateInstalledUpdates() (resp []datatypes.Container_Utility_Microsoft_Windows_UpdateServices_UpdateItem, err error)

Retrieve a list of Windows updates installed on a server as reported by the local SoftLayer Windows Server Update Services (WSUS) server. Windows servers provisioned by SoftLayer are configured to use the local WSUS server via the private network by default.

func (Hardware_Server) GetWindowsUpdateStatus 

func (r Hardware_Server) GetWindowsUpdateStatus() (resp datatypes.Container_Utility_Microsoft_Windows_UpdateServices_Status, err error)

This method returns an update status record for this server. That record will specify if the server is missing updates, or has updates that must be reinstalled or require a reboot to go into affect.

func (Hardware_Server) Id 

func (r Hardware_Server) Id(id int) Hardware_Server

func (Hardware_Server) ImportVirtualHost 

func (r Hardware_Server) ImportVirtualHost() (resp datatypes.Virtual_Host, err error)

The ”'importVirtualHost”' method attempts to import the host record for the virtualization platform running on a server.

func (Hardware_Server) InitiateIderaBareMetalRestore 

func (r Hardware_Server) InitiateIderaBareMetalRestore() (resp bool, err error)

Idera Bare Metal Server Restore is a backup agent designed specifically for making full system restores made with Idera Server Backup.

func (Hardware_Server) InitiateR1SoftBareMetalRestore 

func (r Hardware_Server) InitiateR1SoftBareMetalRestore() (resp bool, err error)

R1Soft Bare Metal Server Restore is an R1Soft disk agent designed specifically for making full system restores made with R1Soft CDP Server backup.

func (Hardware_Server) IsBackendPingable 

func (r Hardware_Server) IsBackendPingable() (resp bool, err error)

Issues a ping command and returns the success (true) or failure (false) of the ping command.

func (Hardware_Server) IsPingable 

func (r Hardware_Server) IsPingable() (resp bool, err error)

Issues a ping command and returns the success (true) or failure (false) of the ping command.

func (Hardware_Server) IsWindowsServer 

func (r Hardware_Server) IsWindowsServer() (resp bool, err error)

Determine if the server runs any version of the Microsoft Windows operating systems. Return ”true” if it does and ”false if otherwise.

func (Hardware_Server) Limit 

func (r Hardware_Server) Limit(limit int) Hardware_Server

func (Hardware_Server) Mask 

func (r Hardware_Server) Mask(mask string) Hardware_Server

func (Hardware_Server) MassFirmwareReflash 

func (r Hardware_Server) MassFirmwareReflash(hardwareIds []int, ipmi *bool, raidController *bool, bios *bool) (resp []datatypes.Container_Hardware_Server_Request, err error)

You can launch firmware reflashes by selecting from your server list. It will bring your server offline for approximately 60 minutes while the reflashes are in progress.

In the event of a hardware failure during this test our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online. They will be contact you to ensure that impact on your server is minimal.

func (Hardware_Server) MassFirmwareUpdate 

func (r Hardware_Server) MassFirmwareUpdate(hardwareIds []int, ipmi *bool, raidController *bool, bios *bool, harddrive *bool, networkCard *bool) (resp []datatypes.Container_Hardware_Server_Request, err error)

You can launch firmware updates by selecting from your server list. It will bring your server offline for approximately 20 minutes while the updates are in progress.

In the event of a hardware failure during this test our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online, and will be contacting you to ensure that impact on your server is minimal.

func (Hardware_Server) MassHyperThreadingUpdate 

func (r Hardware_Server) MassHyperThreadingUpdate(hardwareIds []int, disableHyperthreading *bool) (resp []datatypes.Container_Hardware_Server_Request, err error)

You can launch hyper-threading update by selecting from your server list. It will bring your server offline for approximately 60 minutes while the updates are in progress.

In the event of a hardware failure during this update our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online. They will be in contact with you to ensure that impact on your server is minimal.

func (Hardware_Server) MassReloadOperatingSystem 

func (r Hardware_Server) MassReloadOperatingSystem(hardwareIds []string, token *string, config *datatypes.Container_Hardware_Server_Configuration) (resp string, err error)

Reloads current or customer specified operating system configuration.

This service has a confirmation protocol for proceeding with the reload. To proceed with the reload without confirmation, simply pass in 'FORCE' as the token parameter. To proceed with the reload with confirmation, simply call the service with no parameter. A token string will be returned by this service. The token will remain active for 10 minutes. Use this token as the parameter to confirm that a reload is to be performed for the server.

As a precaution, we strongly recommend backing up all data before reloading the operating system. The reload will format the primary disk and will reconfigure the server to the current specifications on record.

The reload will take AT MINIMUM 66 minutes.

func (Hardware_Server) MassSparePool 

func (r Hardware_Server) MassSparePool(hardwareIds []string, action *string, newOrder *bool) (resp []datatypes.Container_Hardware_Server_Request, err error)

The ability to place multiple bare metal servers in a state where they are powered down and ports closed yet still allocated to the customer as a part of the Spare Pool program.

func (Hardware_Server) Offset 

func (r Hardware_Server) Offset(offset int) Hardware_Server

func (Hardware_Server) Ping 

func (r Hardware_Server) Ping() (resp string, err error)

Issues a ping command to the server and returns the ping response.

func (Hardware_Server) PopulateServerRam 

func (r Hardware_Server) PopulateServerRam(ramSerialString *string) (err error)

no documentation yet

func (Hardware_Server) PowerCycle 

func (r Hardware_Server) PowerCycle() (resp bool, err error)

Power off then power on the server via powerstrip. The power cycle command is equivalent to unplugging the server from the powerstrip and then plugging the server back into the powerstrip. This should only be used as a last resort. If a reboot command has been issued successfully in the past 20 minutes, another remote management command (rebootSoft, rebootHard, powerOn, powerOff and powerCycle) will not be allowed. This is to avoid any type of server failures.

func (Hardware_Server) PowerOff 

func (r Hardware_Server) PowerOff() (resp bool, err error)

This method will power off the server via the server's remote management card.

func (Hardware_Server) PowerOn 

func (r Hardware_Server) PowerOn() (resp bool, err error)

Power on server via its remote management card. If a reboot command has been issued successfully in the past 20 minutes, another remote management command (rebootSoft, rebootHard, powerOn, powerOff and powerCycle) will not be allowed. This is to avoid any type of server failures.

func (Hardware_Server) RebootDefault 

func (r Hardware_Server) RebootDefault() (resp bool, err error)

Attempts to reboot the server by issuing a reset (soft reboot) command to the server's remote management card. If the reset (soft reboot) attempt is unsuccessful, a power cycle command will be issued via the powerstrip. The power cycle command is equivalent to unplugging the server from the powerstrip and then plugging the server back into the powerstrip. If a reboot command has been issued successfully in the past 20 minutes, another remote management command (rebootSoft, rebootHard, powerOn, powerOff and powerCycle) will not be allowed. This is to avoid any type of server failures.

func (Hardware_Server) RebootHard 

func (r Hardware_Server) RebootHard() (resp bool, err error)

Reboot the server by issuing a cycle command to the server's remote management card. This is equivalent to pressing the 'Reset' button on the server. This command is issued immediately and will not wait for processes to shutdown. After this command is issued, the server may take a few moments to boot up as server may run system disks checks. If a reboot command has been issued successfully in the past 20 minutes, another remote management command (rebootSoft, rebootHard, powerOn, powerOff and powerCycle) will not be allowed. This is to avoid any type of server failures.

func (Hardware_Server) RebootSoft 

func (r Hardware_Server) RebootSoft() (resp bool, err error)

Reboot the server by issuing a reset command to the server's remote management card. This is a graceful reboot. The servers will allow all process to shutdown gracefully before rebooting. If a reboot command has been issued successfully in the past 20 minutes, another remote management command (rebootSoft, rebootHard, powerOn, powerOff and powerCycle) will not be allowed. This is to avoid any type of server failures.

func (Hardware_Server) RefreshDeviceStatus added in v1.0.5 

func (r Hardware_Server) RefreshDeviceStatus() (resp datatypes.Hardware_State, err error)

no documentation yet

func (Hardware_Server) ReloadCurrentOperatingSystemConfiguration 

func (r Hardware_Server) ReloadCurrentOperatingSystemConfiguration(token *string) (resp string, err error)

Reloads current operating system configuration.

This service has a confirmation protocol for proceeding with the reload. To proceed with the reload without confirmation, simply pass in 'FORCE' as the token parameter. To proceed with the reload with confirmation, simply call the service with no parameter. A token string will be returned by this service. The token will remain active for 10 minutes. Use this token as the parameter to confirm that a reload is to be performed for the server.

As a precaution, we strongly recommend backing up all data before reloading the operating system. The reload will format the primary disk and will reconfigure the server to the current specifications on record.

The reload will take AT MINIMUM 66 minutes.

func (Hardware_Server) ReloadOperatingSystem 

func (r Hardware_Server) ReloadOperatingSystem(token *string, config *datatypes.Container_Hardware_Server_Configuration) (resp string, err error)

Reloads current or customer specified operating system configuration.

This service has a confirmation protocol for proceeding with the reload. To proceed with the reload without confirmation, simply pass in 'FORCE' as the token parameter. To proceed with the reload with confirmation, simply call the service with no parameter. A token string will be returned by this service. The token will remain active for 10 minutes. Use this token as the parameter to confirm that a reload is to be performed for the server.

As a precaution, we strongly recommend backing up all data before reloading the operating system. The reload will format the primary disk and will reconfigure the server to the current specifications on record.

The reload will take AT MINIMUM 66 minutes.

func (Hardware_Server) RemoveAccessToNetworkStorage 

func (r Hardware_Server) RemoveAccessToNetworkStorage(networkStorageTemplateObject *datatypes.Network_Storage) (resp bool, err error)

This method is used to remove access to s SoftLayer_Network_Storage volumes that supports host- or network-level access control.

func (Hardware_Server) RemoveAccessToNetworkStorageList 

func (r Hardware_Server) RemoveAccessToNetworkStorageList(networkStorageTemplateObjects []datatypes.Network_Storage) (resp bool, err error)

This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support host- or network-level access control.

func (Hardware_Server) RemoveTags 

func (r Hardware_Server) RemoveTags(tags *string) (resp bool, err error)

no documentation yet

func (Hardware_Server) RunPassmarkCertificationBenchmark 

func (r Hardware_Server) RunPassmarkCertificationBenchmark() (resp bool, err error)

You can launch a new Passmark hardware test by selecting from your server list. It will bring your server offline for approximately 20 minutes while the testing is in progress, and will publish a certificate with the results to your hardware details page.

While the hard drives are tested for the initial deployment, the Passmark Certificate utility will not test the hard drives on your live server. This is to ensure that no data is overwritten. If you would like to test the server's hard drives, you can have the full Passmark suite installed to your server free of charge through a new Support ticket.

While the test itself does not overwrite any data on the server, it is recommended that you make full off-server backups of all data prior to launching the test. The Passmark hardware test is designed to force any latent hardware issues to the surface, so hardware failure is possible.

In the event of a hardware failure during this test our datacenter engineers will be notified of the problem automatically. They will then replace any failed components to bring your server back online, and will be contacting you to ensure that impact on your server is minimal.

func (Hardware_Server) SetOperatingSystemPassword 

func (r Hardware_Server) SetOperatingSystemPassword(newPassword *string) (resp bool, err error)

Changes the password that we have stored in our database for a servers' Operating System

func (Hardware_Server) SetPrivateNetworkInterfaceSpeed 

func (r Hardware_Server) SetPrivateNetworkInterfaceSpeed(newSpeed *int, redundancy *string) (resp bool, err error)

Set the private network interface speed and redundancy configuration.

Possible $newSpeed values are -1 (maximum available), 0 (disconnect), 10, 100, 1000, and 10000; not all values are available to every server. The maximum speed is limited by the speed requested during provisioning. All intermediate speeds are limited by the capability of the pod the server is deployed in. No guarantee is made that a speed other than what was requested during provisioning will be available.

If specified, possible $redundancy values are either "redundant" or "degraded". Not specifying a redundancy mode will use the best possible redundancy available to the server. However, specifying a redundacy mode that is not available to the server will result in an error. "redundant" indicates all available interfaces should be active. "degraded" indicates only the primary interface should be active. Irrespective of the number of interfaces available to a server, it is only possible to have either a single interface or all interfaces active.

Receipt of a response does not indicate completion of the configuration change. Any subsequent attempts to request the interface change speed or state, while changes are pending, will result in a busy error.

A response of true indicates a change was required to achieve the desired interface configuration; thus changes are pending. A response of false indicates the current interface configuration matches the desired configuration, and thus no changes are pending.

<h4>Backwards Compatibility Until February 27th, 2019</h4>

In order to provide a period of transition to the new API, some backwards compatible behaviors will be active during this period. <ul> <li> A "doubled" (eg. 200) speed value will be translated to a redundancy value of "redundant". If a redundancy value is specified, it is assumed no translation is needed and will result in an error due to doubled speeds no longer being valid.</li> <li> A non-doubled (eg. 100) speed value <i>without</i> a redundancy value will be translated to a redundancy value of "degraded".</li> </ul> After the compatibility period, a doubled speed value will result in an error, and a non-doubled speed value without a redundancy value specified will result in the best available redundancy state. An exception is made for the new relative speed value -1. When using -1 without a redundancy value, the best possible redundancy will be used. Please transition away from using doubled speed values in favor of specifying redundancy (when applicable) or using relative speed values 0 and -1.

func (Hardware_Server) SetPublicNetworkInterfaceSpeed 

func (r Hardware_Server) SetPublicNetworkInterfaceSpeed(newSpeed *int, redundancy *string) (resp bool, err error)

Set the public network interface speed and redundancy configuration.

Possible $newSpeed values are -1 (maximum available), 0 (disconnect), 10, 100, 1000, and 10000; not all values are available to every server. The maximum speed is limited by the speed requested during provisioning. All intermediate speeds are limited by the capability of the pod the server is deployed in. No guarantee is made that a speed other than what was requested during provisioning will be available.

If specified, possible $redundancy values are either "redundant" or "degraded". Not specifying a redundancy mode will use the best possible redundancy available to the server. However, specifying a redundacy mode that is not available to the server will result in an error. "redundant" indicates all available interfaces should be active. "degraded" indicates only the primary interface should be active. Irrespective of the number of interfaces available to a server, it is only possible to have either a single interface or all interfaces active.

Receipt of a response does not indicate completion of the configuration change. Any subsequent attempts to request the interface change speed or state, while changes are pending, will result in a busy error.

A response of true indicates a change was required to achieve the desired interface configuration; thus changes are pending. A response of false indicates the current interface configuration matches the desired configuration, and thus no changes are pending.

<h4>Backwards Compatibility Until February 27th, 2019</h4>

In order to provide a period of transition to the new API, some backwards compatible behaviors will be active during this period. <ul> <li> A "doubled" (eg. 200) speed value will be translated to a redundancy value of "redundant". If a redundancy value is specified, it is assumed no translation is needed and will result in an error due to doubled speeds no longer being valid.</li> <li> A non-doubled (eg. 100) speed value <i>without</i> a redundancy value will be translated to a redundancy value of "degraded".</li> </ul> After the compatibility period, a doubled speed value will result in an error, and a non-doubled speed value without a redundancy value specified will result in the best available redundancy state. An exception is made for the new relative speed value -1. When using -1 without a redundancy value, the best possible redundancy will be used. Please transition away from using doubled speed values in favor of specifying redundancy (when applicable) or using relative speed values 0 and -1.

func (Hardware_Server) SetTags 

func (r Hardware_Server) SetTags(tags *string) (resp bool, err error)

no documentation yet

func (Hardware_Server) SetUserMetadata 

func (r Hardware_Server) SetUserMetadata(metadata []string) (resp []datatypes.Hardware_Attribute, err error)

Sets the data that will be written to the configuration drive.

func (Hardware_Server) ShutdownPrivatePort 

func (r Hardware_Server) ShutdownPrivatePort() (resp bool, err error)

Disconnect a server's private network interface. This operation is an alias for calling [SoftLayer_Hardware_Server/setPrivateNetworkInterfaceSpeed] with a $newSpeed of 0 and unspecified $redundancy.

Receipt of a response does not indicate completion of the configuration change. Any subsequent attempts to request the interface change speed or state, while changes are pending, will result in a busy error.

A response of true indicates a change was required to disconnect the interface; thus changes are pending. A response of false indicates the interface was already disconnected, and thus no changes are pending.

func (Hardware_Server) ShutdownPublicPort 

func (r Hardware_Server) ShutdownPublicPort() (resp bool, err error)

Disconnect a server's public network interface. This operation is an alias for [SoftLayer_Hardware_Server/setPublicNetworkInterfaceSpeed] with a $newSpeed of 0 and unspecified $redundancy.

Receipt of a response does not indicate completion of the configuration change. Any subsequent attempts to request the interface change speed or state, while changes are pending, will result in a busy error.

A response of true indicates a change was required to disconnect the interface; thus changes are pending. A response of false indicates the interface was already disconnected, and thus no changes are pending.

func (Hardware_Server) SparePool 

func (r Hardware_Server) SparePool(action *string, newOrder *bool) (resp bool, err error)

The ability to place bare metal servers in a state where they are powered down, and ports closed yet still allocated to the customer as a part of the Spare Pool program.

func (Hardware_Server) TestRaidAlertService added in v1.0.1 

func (r Hardware_Server) TestRaidAlertService() (resp bool, err error)

Test the RAID Alert service by sending the service a request to store a test email for this server. The server must have an account ID and MAC address. A RAID controller must also be installed.

func (Hardware_Server) ToggleManagementInterface 

func (r Hardware_Server) ToggleManagementInterface(enabled *bool) (resp bool, err error)

Attempt to toggle the IPMI interface. If there is an active transaction on the server, it will throw an exception. This method creates a job to toggle the interface. It is not instant.

func (Hardware_Server) UpdateIpmiPassword 

func (r Hardware_Server) UpdateIpmiPassword(password *string) (resp bool, err error)

This method will update the root IPMI password on this SoftLayer_Hardware.

func (Hardware_Server) ValidatePartitionsForOperatingSystem 

func (r Hardware_Server) ValidatePartitionsForOperatingSystem(operatingSystem *datatypes.Software_Description, partitions []datatypes.Hardware_Component_Partition) (resp bool, err error)

Validates a collection of partitions for an operating system

func (Hardware_Server) ValidateSecurityLevel added in v1.1.4 

func (r Hardware_Server) ValidateSecurityLevel() (err error)

no documentation yet

type Layout_Container 

type Layout_Container struct {
	Session session.SLSession
	Options sl.Options
}

The SoftLayer_Layout_Container contains definitions for default page layouts

func GetLayoutContainerService 

func GetLayoutContainerService(sess session.SLSession) Layout_Container

GetLayoutContainerService returns an instance of the Layout_Container SoftLayer service

func (Layout_Container) Filter 

func (r Layout_Container) Filter(filter string) Layout_Container

func (Layout_Container) GetAllObjects 

func (r Layout_Container) GetAllObjects() (resp []datatypes.Layout_Container, err error)

Use this method to retrieve all active layout containers that can be customized.

func (Layout_Container) GetLayoutContainerType 

func (r Layout_Container) GetLayoutContainerType() (resp datatypes.Layout_Container_Type, err error)

Retrieve The type of the layout container object

func (Layout_Container) GetLayoutItems 

func (r Layout_Container) GetLayoutItems() (resp []datatypes.Layout_Item, err error)

Retrieve The layout items assigned to this layout container

func (Layout_Container) GetObject 

func (r Layout_Container) GetObject() (resp datatypes.Layout_Container, err error)

no documentation yet

func (Layout_Container) Id 

func (r Layout_Container) Id(id int) Layout_Container

func (Layout_Container) Limit 

func (r Layout_Container) Limit(limit int) Layout_Container

func (Layout_Container) Mask 

func (r Layout_Container) Mask(mask string) Layout_Container

func (Layout_Container) Offset 

func (r Layout_Container) Offset(offset int) Layout_Container

type Layout_Item 

type Layout_Item struct {
	Session session.SLSession
	Options sl.Options
}

The SoftLayer_Layout_Item contains definitions for default layout items

func GetLayoutItemService 

func GetLayoutItemService(sess session.SLSession) Layout_Item

GetLayoutItemService returns an instance of the Layout_Item SoftLayer service

func (Layout_Item) Filter 

func (r Layout_Item) Filter(filter string) Layout_Item

func (Layout_Item) GetLayoutItemPreferences 

func (r Layout_Item) GetLayoutItemPreferences() (resp []datatypes.Layout_Preference, err error)

Retrieve The layout preferences assigned to this layout item

func (Layout_Item) GetLayoutItemType 

func (r Layout_Item) GetLayoutItemType() (resp datatypes.Layout_Item_Type, err error)

Retrieve The type of the layout item object

func (Layout_Item) GetObject 

func (r Layout_Item) GetObject() (resp datatypes.Layout_Item, err error)

no documentation yet

func (Layout_Item) Id 

func (r Layout_Item) Id(id int) Layout_Item

func (Layout_Item) Limit 

func (r Layout_Item) Limit(limit int) Layout_Item

func (Layout_Item) Mask 

func (r Layout_Item) Mask(mask string) Layout_Item

func (Layout_Item) Offset 

func (r Layout_Item) Offset(offset int) Layout_Item

type Layout_Profile 

type Layout_Profile struct {
	Session session.SLSession
	Options sl.Options
}

The SoftLayer_Layout_Profile contains the definition of the layout profile

func GetLayoutProfileService 

func GetLayoutProfileService(sess session.SLSession) Layout_Profile

GetLayoutProfileService returns an instance of the Layout_Profile SoftLayer service

func (Layout_Profile) CreateObject 

func (r Layout_Profile) CreateObject(templateObject *datatypes.Layout_Profile) (resp bool, err error)

This method creates a new layout profile object.

func (Layout_Profile) DeleteObject 

func (r Layout_Profile) DeleteObject() (resp bool, err error)

This method deletes an existing layout profile and associated custom preferences

func (Layout_Profile) EditObject 

func (r Layout_Profile) EditObject(templateObject *datatypes.Layout_Profile) (resp bool, err error)

This method edits an existing layout profile object by passing in a modified instance of the object.

func (Layout_Profile) Filter 

func (r Layout_Profile) Filter(filter string) Layout_Profile

func (Layout_Profile) GetLayoutContainers 

func (r Layout_Profile) GetLayoutContainers() (resp []datatypes.Layout_Container, err error)

Retrieve

func (Layout_Profile) GetLayoutPreferences 

func (r Layout_Profile) GetLayoutPreferences() (resp []datatypes.Layout_Profile_Preference, err error)

Retrieve

func (Layout_Profile) GetObject 

func (r Layout_Profile) GetObject() (resp datatypes.Layout_Profile, err error)

no documentation yet

func (Layout_Profile) Id 

func (r Layout_Profile) Id(id int) Layout_Profile

func (Layout_Profile) Limit 

func (r Layout_Profile) Limit(limit int) Layout_Profile

func (Layout_Profile) Mask 

func (r Layout_Profile) Mask(mask string) Layout_Profile

func (Layout_Profile) ModifyPreference 

func (r Layout_Profile) ModifyPreference(templateObject *datatypes.Layout_Profile_Preference) (resp datatypes.Layout_Profile_Preference, err error)

This method modifies an existing associated [[SoftLayer_Layout_Profile_Preference]] object. If the preference object being modified is a default value object, a new record is created to override the default value.

Only preferences that are assigned to a profile may be updated. Attempts to update a non-existent preference object will result in an exception being thrown.

func (Layout_Profile) ModifyPreferences 

func (r Layout_Profile) ModifyPreferences(layoutPreferenceObjects []datatypes.Layout_Profile_Preference) (resp []datatypes.Layout_Profile_Preference, err error)

Using this method, multiple [[SoftLayer_Layout_Profile_Preference]] objects may be updated at once.

Refer to [[SoftLayer_Layout_Profile::modifyPreference()]] for more information.

func (Layout_Profile) Offset 

func (r Layout_Profile) Offset(offset int) Layout_Profile

type Layout_Profile_Containers 

type Layout_Profile_Containers struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetLayoutProfileContainersService 

func GetLayoutProfileContainersService(sess session.SLSession) Layout_Profile_Containers

GetLayoutProfileContainersService returns an instance of the Layout_Profile_Containers SoftLayer service

func (Layout_Profile_Containers) CreateObject 

func (r Layout_Profile_Containers) CreateObject(templateObject *datatypes.Layout_Profile_Containers) (resp datatypes.Layout_Profile_Containers, err error)

no documentation yet

func (Layout_Profile_Containers) EditObject 

func (r Layout_Profile_Containers) EditObject(templateObject *datatypes.Layout_Profile_Containers) (resp bool, err error)

no documentation yet

func (Layout_Profile_Containers) Filter 

func (r Layout_Profile_Containers) Filter(filter string) Layout_Profile_Containers

func (Layout_Profile_Containers) GetLayoutContainerType 

func (r Layout_Profile_Containers) GetLayoutContainerType() (resp datatypes.Layout_Container, err error)

Retrieve The container to be contained

func (Layout_Profile_Containers) GetLayoutProfile 

func (r Layout_Profile_Containers) GetLayoutProfile() (resp datatypes.Layout_Profile, err error)

Retrieve The profile containing this container

func (Layout_Profile_Containers) GetObject 

func (r Layout_Profile_Containers) GetObject() (resp datatypes.Layout_Profile_Containers, err error)

no documentation yet

func (Layout_Profile_Containers) Id 

func (r Layout_Profile_Containers) Id(id int) Layout_Profile_Containers

func (Layout_Profile_Containers) Limit 

func (r Layout_Profile_Containers) Limit(limit int) Layout_Profile_Containers

func (Layout_Profile_Containers) Mask 

func (r Layout_Profile_Containers) Mask(mask string) Layout_Profile_Containers

func (Layout_Profile_Containers) Offset 

func (r Layout_Profile_Containers) Offset(offset int) Layout_Profile_Containers

type Layout_Profile_Customer 

type Layout_Profile_Customer struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetLayoutProfileCustomerService 

func GetLayoutProfileCustomerService(sess session.SLSession) Layout_Profile_Customer

GetLayoutProfileCustomerService returns an instance of the Layout_Profile_Customer SoftLayer service

func (Layout_Profile_Customer) CreateObject 

func (r Layout_Profile_Customer) CreateObject(templateObject *datatypes.Layout_Profile) (resp bool, err error)

This method creates a new layout profile object.

func (Layout_Profile_Customer) DeleteObject 

func (r Layout_Profile_Customer) DeleteObject() (resp bool, err error)

This method deletes an existing layout profile and associated custom preferences

func (Layout_Profile_Customer) EditObject 

func (r Layout_Profile_Customer) EditObject(templateObject *datatypes.Layout_Profile) (resp bool, err error)

This method edits an existing layout profile object by passing in a modified instance of the object.

func (Layout_Profile_Customer) Filter 

func (r Layout_Profile_Customer) Filter(filter string) Layout_Profile_Customer

func (Layout_Profile_Customer) GetLayoutContainers 

func (r Layout_Profile_Customer) GetLayoutContainers() (resp []datatypes.Layout_Container, err error)

Retrieve

func (Layout_Profile_Customer) GetLayoutPreferences 

func (r Layout_Profile_Customer) GetLayoutPreferences() (resp []datatypes.Layout_Profile_Preference, err error)

Retrieve

func (Layout_Profile_Customer) GetObject 

func (r Layout_Profile_Customer) GetObject() (resp datatypes.Layout_Profile_Customer, err error)

no documentation yet

func (Layout_Profile_Customer) GetUserRecord 

func (r Layout_Profile_Customer) GetUserRecord() (resp datatypes.User_Customer, err error)

Retrieve

func (Layout_Profile_Customer) Id 

func (r Layout_Profile_Customer) Id(id int) Layout_Profile_Customer

func (Layout_Profile_Customer) Limit 

func (r Layout_Profile_Customer) Limit(limit int) Layout_Profile_Customer

func (Layout_Profile_Customer) Mask 

func (r Layout_Profile_Customer) Mask(mask string) Layout_Profile_Customer

func (Layout_Profile_Customer) ModifyPreference 

func (r Layout_Profile_Customer) ModifyPreference(templateObject *datatypes.Layout_Profile_Preference) (resp datatypes.Layout_Profile_Preference, err error)

This method modifies an existing associated [[SoftLayer_Layout_Profile_Preference]] object. If the preference object being modified is a default value object, a new record is created to override the default value.

Only preferences that are assigned to a profile may be updated. Attempts to update a non-existent preference object will result in an exception being thrown.

func (Layout_Profile_Customer) ModifyPreferences 

func (r Layout_Profile_Customer) ModifyPreferences(layoutPreferenceObjects []datatypes.Layout_Profile_Preference) (resp []datatypes.Layout_Profile_Preference, err error)

Using this method, multiple [[SoftLayer_Layout_Profile_Preference]] objects may be updated at once.

Refer to [[SoftLayer_Layout_Profile::modifyPreference()]] for more information.

func (Layout_Profile_Customer) Offset 

func (r Layout_Profile_Customer) Offset(offset int) Layout_Profile_Customer

type Layout_Profile_Preference 

type Layout_Profile_Preference struct {
	Session session.SLSession
	Options sl.Options
}

The SoftLayer_Layout_Profile_Preference contains definitions for layout preferences

func GetLayoutProfilePreferenceService 

func GetLayoutProfilePreferenceService(sess session.SLSession) Layout_Profile_Preference

GetLayoutProfilePreferenceService returns an instance of the Layout_Profile_Preference SoftLayer service

func (Layout_Profile_Preference) Filter 

func (r Layout_Profile_Preference) Filter(filter string) Layout_Profile_Preference

func (Layout_Profile_Preference) GetLayoutContainer 

func (r Layout_Profile_Preference) GetLayoutContainer() (resp datatypes.Layout_Container, err error)

Retrieve

func (Layout_Profile_Preference) GetLayoutItem 

func (r Layout_Profile_Preference) GetLayoutItem() (resp datatypes.Layout_Item, err error)

Retrieve

func (Layout_Profile_Preference) GetLayoutPreference 

func (r Layout_Profile_Preference) GetLayoutPreference() (resp datatypes.Layout_Preference, err error)

Retrieve

func (Layout_Profile_Preference) GetLayoutProfile 

func (r Layout_Profile_Preference) GetLayoutProfile() (resp datatypes.Layout_Profile, err error)

Retrieve

func (Layout_Profile_Preference) GetObject 

func (r Layout_Profile_Preference) GetObject() (resp datatypes.Layout_Profile_Preference, err error)

no documentation yet

func (Layout_Profile_Preference) Id 

func (r Layout_Profile_Preference) Id(id int) Layout_Profile_Preference

func (Layout_Profile_Preference) Limit 

func (r Layout_Profile_Preference) Limit(limit int) Layout_Profile_Preference

func (Layout_Profile_Preference) Mask 

func (r Layout_Profile_Preference) Mask(mask string) Layout_Profile_Preference

func (Layout_Profile_Preference) Offset 

func (r Layout_Profile_Preference) Offset(offset int) Layout_Profile_Preference

type Locale 

type Locale struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetLocaleService 

func GetLocaleService(sess session.SLSession) Locale

GetLocaleService returns an instance of the Locale SoftLayer service

func (Locale) Filter 

func (r Locale) Filter(filter string) Locale

func (Locale) GetClosestToLanguageTag 

func (r Locale) GetClosestToLanguageTag(languageTag *string) (resp datatypes.Locale, err error)

no documentation yet

func (Locale) GetObject 

func (r Locale) GetObject() (resp datatypes.Locale, err error)

no documentation yet

func (Locale) Id 

func (r Locale) Id(id int) Locale

func (Locale) Limit 

func (r Locale) Limit(limit int) Locale

func (Locale) Mask 

func (r Locale) Mask(mask string) Locale

func (Locale) Offset 

func (r Locale) Offset(offset int) Locale

type Locale_Country 

type Locale_Country struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetLocaleCountryService 

func GetLocaleCountryService(sess session.SLSession) Locale_Country

GetLocaleCountryService returns an instance of the Locale_Country SoftLayer service

func (Locale_Country) Filter 

func (r Locale_Country) Filter(filter string) Locale_Country

func (Locale_Country) GetAllVatCountryCodesAndVatIdRegexes 

func (r Locale_Country) GetAllVatCountryCodesAndVatIdRegexes() (resp []datatypes.Container_Collection_Locale_VatCountryCodeAndFormat, err error)

This method is to get the collection of VAT country codes and VAT ID Regexes.

func (Locale_Country) GetAvailableCountries 

func (r Locale_Country) GetAvailableCountries() (resp []datatypes.Locale_Country, err error)

Use this method to retrieve a list of countries and locale information available to the current user.

func (Locale_Country) GetCountries 

func (r Locale_Country) GetCountries() (resp []datatypes.Locale_Country, err error)

Use this method to retrieve a list of countries and locale information such as country code and state/provinces.

func (Locale_Country) GetCountriesAndStates 

func (r Locale_Country) GetCountriesAndStates(usFirstFlag *bool) (resp []datatypes.Container_Collection_Locale_CountryCode, err error)

This method will return a collection of [[SoftLayer_Container_Collection_Locale_CountryCode]] objects. If the country has states, a [[SoftLayer_Container_Collection_Locale_StateCode]] collection will be provided with the country.

func (Locale_Country) GetObject 

func (r Locale_Country) GetObject() (resp datatypes.Locale_Country, err error)

no documentation yet

func (Locale_Country) GetPostalCodeRequiredCountryCodes added in v1.0.2 

func (r Locale_Country) GetPostalCodeRequiredCountryCodes() (resp []string, err error)

This method will return an array of country codes that require postal code

func (Locale_Country) GetStates 

func (r Locale_Country) GetStates() (resp []datatypes.Locale_StateProvince, err error)

Retrieve States that belong to this country.

func (Locale_Country) GetVatCountries added in v1.0.2 

func (r Locale_Country) GetVatCountries() (resp []string, err error)

This method will return an array of ISO 3166 Alpha-2 country codes that use a Value-Added Tax (VAT) ID. Note the difference between [SoftLayer_Locale_Country/getVatRequiredCountryCodes] - this method will provide <strong>all</strong> country codes that use VAT ID, including those which are required.

func (Locale_Country) GetVatRequiredCountryCodes added in v1.0.2 

func (r Locale_Country) GetVatRequiredCountryCodes() (resp []string, err error)

This method will return an array of ISO 3166 Alpha-2 country codes that use a Value-Added Tax (VAT) ID. Note the difference between [SoftLayer_Locale_Country/getVatCountries] - this method will provide country codes where a VAT ID is required for onboarding to IBM Cloud.

func (Locale_Country) Id 

func (r Locale_Country) Id(id int) Locale_Country

func (Locale_Country) IsEuropeanUnionCountry 

func (r Locale_Country) IsEuropeanUnionCountry(iso2CountryCode *string) (resp bool, err error)

Returns true if the country code is in the European Union (EU), false otherwise.

func (Locale_Country) Limit 

func (r Locale_Country) Limit(limit int) Locale_Country

func (Locale_Country) Mask 

func (r Locale_Country) Mask(mask string) Locale_Country

func (Locale_Country) Offset 

func (r Locale_Country) Offset(offset int) Locale_Country

type Locale_Timezone 

type Locale_Timezone struct {
	Session session.SLSession
	Options sl.Options
}

Each User is assigned a timezone allowing for a precise local timestamp.

func GetLocaleTimezoneService 

func GetLocaleTimezoneService(sess session.SLSession) Locale_Timezone

GetLocaleTimezoneService returns an instance of the Locale_Timezone SoftLayer service

func (Locale_Timezone) Filter 

func (r Locale_Timezone) Filter(filter string) Locale_Timezone

func (Locale_Timezone) GetAllObjects 

func (r Locale_Timezone) GetAllObjects() (resp []datatypes.Locale_Timezone, err error)

Retrieve all timezone objects.

func (Locale_Timezone) GetObject 

func (r Locale_Timezone) GetObject() (resp datatypes.Locale_Timezone, err error)

getObject retrieves the SoftLayer_Locale_Timezone object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Locale_Timezone service.

func (Locale_Timezone) Id 

func (r Locale_Timezone) Id(id int) Locale_Timezone

func (Locale_Timezone) Limit 

func (r Locale_Timezone) Limit(limit int) Locale_Timezone

func (Locale_Timezone) Mask 

func (r Locale_Timezone) Mask(mask string) Locale_Timezone

func (Locale_Timezone) Offset 

func (r Locale_Timezone) Offset(offset int) Locale_Timezone

type Location 

type Location struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetLocationService 

func GetLocationService(sess session.SLSession) Location

GetLocationService returns an instance of the Location SoftLayer service

func (Location) Filter 

func (r Location) Filter(filter string) Location

func (Location) GetActivePresaleEvents 

func (r Location) GetActivePresaleEvents() (resp []datatypes.Sales_Presale_Event, err error)

Retrieve

func (Location) GetAvailableObjectStorageDatacenters 

func (r Location) GetAvailableObjectStorageDatacenters() (resp []datatypes.Location, err error)

Object Storage is only available in select datacenters. This method will return all the datacenters where object storage is available.

func (Location) GetBnppCompliantFlag added in v1.0.2 

func (r Location) GetBnppCompliantFlag() (resp bool, err error)

Retrieve A flag indicating whether or not the datacenter/location is BNPP compliant.

func (Location) GetDatacenters 

func (r Location) GetDatacenters() (resp []datatypes.Location, err error)

Retrieve all datacenter locations. SoftLayer's datacenters exist in various cities and each contain one or more server rooms which house network and server infrastructure.

func (Location) GetDatacentersWithVirtualImageStoreServiceResourceRecord 

func (r Location) GetDatacentersWithVirtualImageStoreServiceResourceRecord() (resp []datatypes.Location, err error)

no documentation yet

func (Location) GetEuCompliantFlag 

func (r Location) GetEuCompliantFlag() (resp bool, err error)

Retrieve A flag indicating whether or not the datacenter/location is EU compliant.

func (Location) GetGroups 

func (r Location) GetGroups() (resp []datatypes.Location_Group, err error)

Retrieve A location can be a member of 1 or more groups. This will show which groups to which a location belongs.

func (Location) GetHardwareFirewalls 

func (r Location) GetHardwareFirewalls() (resp []datatypes.Hardware, err error)

Retrieve

func (Location) GetLocationAddress 

func (r Location) GetLocationAddress() (resp datatypes.Account_Address, err error)

Retrieve A location's physical address.

func (Location) GetLocationAddresses 

func (r Location) GetLocationAddresses() (resp []datatypes.Account_Address, err error)

Retrieve A location's physical addresses.

func (Location) GetLocationReservationMember 

func (r Location) GetLocationReservationMember() (resp datatypes.Location_Reservation_Rack_Member, err error)

Retrieve A location's Dedicated Rack member

func (Location) GetLocationStatus 

func (r Location) GetLocationStatus() (resp datatypes.Location_Status, err error)

Retrieve The current locations status.

func (Location) GetNetworkConfigurationAttribute 

func (r Location) GetNetworkConfigurationAttribute() (resp datatypes.Hardware_Attribute, err error)

Retrieve

func (Location) GetObject 

func (r Location) GetObject() (resp datatypes.Location, err error)

no documentation yet

func (Location) GetOnlineSslVpnUserCount 

func (r Location) GetOnlineSslVpnUserCount() (resp int, err error)

Retrieve The total number of users online using SoftLayer's SSL VPN service for a location.

func (Location) GetPathString 

func (r Location) GetPathString() (resp string, err error)

Retrieve

func (Location) GetPriceGroups 

func (r Location) GetPriceGroups() (resp []datatypes.Location_Group, err error)

Retrieve A location can be a member of 1 or more Price Groups. This will show which groups to which a location belongs.

func (Location) GetRegions 

func (r Location) GetRegions() (resp []datatypes.Location_Region, err error)

Retrieve A location can be a member of 1 or more regions. This will show which regions to which a location belongs.

func (Location) GetTimezone 

func (r Location) GetTimezone() (resp datatypes.Locale_Timezone, err error)

Retrieve

func (Location) GetVdrGroup 

func (r Location) GetVdrGroup() (resp datatypes.Location_Group_Location_CrossReference, err error)

Retrieve A location can be a member of 1 Bandwidth Pooling Group. This will show which group to which a location belongs.

func (Location) GetViewableDatacenters 

func (r Location) GetViewableDatacenters() (resp []datatypes.Location, err error)

Retrieve all datacenter locations. SoftLayer's datacenters exist in various cities and each contain one or more server rooms which house network and server infrastructure.

func (Location) GetViewablePopsAndDataCenters 

func (r Location) GetViewablePopsAndDataCenters() (resp []datatypes.Location, err error)

Retrieve all viewable pop and datacenter locations.

func (Location) GetViewablepointOfPresence 

func (r Location) GetViewablepointOfPresence() (resp []datatypes.Location, err error)

Retrieve all viewable network locations.

func (Location) GetpointOfPresence 

func (r Location) GetpointOfPresence() (resp []datatypes.Location, err error)

Retrieve all point of presence locations.

func (Location) Id 

func (r Location) Id(id int) Location

func (Location) Limit 

func (r Location) Limit(limit int) Location

func (Location) Mask 

func (r Location) Mask(mask string) Location

func (Location) Offset 

func (r Location) Offset(offset int) Location

type Location_Datacenter 

type Location_Datacenter struct {
	Session session.SLSession
	Options sl.Options
}

SoftLayer_Location_Datacenter extends the [[SoftLayer_Location]] data type to include datacenter-specific properties.

func GetLocationDatacenterService 

func GetLocationDatacenterService(sess session.SLSession) Location_Datacenter

GetLocationDatacenterService returns an instance of the Location_Datacenter SoftLayer service

func (Location_Datacenter) Filter 

func (r Location_Datacenter) Filter(filter string) Location_Datacenter

func (Location_Datacenter) GetActiveItemPresaleEvents 

func (r Location_Datacenter) GetActiveItemPresaleEvents() (resp []datatypes.Sales_Presale_Event, err error)

Retrieve

func (Location_Datacenter) GetActivePresaleEvents 

func (r Location_Datacenter) GetActivePresaleEvents() (resp []datatypes.Sales_Presale_Event, err error)

Retrieve

func (Location_Datacenter) GetAvailableObjectStorageDatacenters 

func (r Location_Datacenter) GetAvailableObjectStorageDatacenters() (resp []datatypes.Location, err error)

Object Storage is only available in select datacenters. This method will return all the datacenters where object storage is available.

func (Location_Datacenter) GetBackendHardwareRouters 

func (r Location_Datacenter) GetBackendHardwareRouters() (resp []datatypes.Hardware, err error)

Retrieve

func (Location_Datacenter) GetBnppCompliantFlag added in v1.0.2 

func (r Location_Datacenter) GetBnppCompliantFlag() (resp bool, err error)

Retrieve A flag indicating whether or not the datacenter/location is BNPP compliant.

func (Location_Datacenter) GetBoundSubnets 

func (r Location_Datacenter) GetBoundSubnets() (resp []datatypes.Network_Subnet, err error)

Retrieve Subnets which are directly bound in a given datacenter, and currently allow routing.

func (Location_Datacenter) GetBrandCountryRestrictions 

func (r Location_Datacenter) GetBrandCountryRestrictions() (resp []datatypes.Brand_Restriction_Location_CustomerCountry, err error)

Retrieve This references relationship between brands, locations and countries associated with a user's account that are ineligible when ordering products. For example, the India datacenter may not be available on this brand for customers that live in Great Britain.

func (Location_Datacenter) GetDatacenters 

func (r Location_Datacenter) GetDatacenters() (resp []datatypes.Location, err error)

Retrieve all datacenter locations. SoftLayer's datacenters exist in various cities and each contain one or more server rooms which house network and server infrastructure.

func (Location_Datacenter) GetDatacentersWithVirtualImageStoreServiceResourceRecord 

func (r Location_Datacenter) GetDatacentersWithVirtualImageStoreServiceResourceRecord() (resp []datatypes.Location, err error)

no documentation yet

func (Location_Datacenter) GetEuCompliantFlag 

func (r Location_Datacenter) GetEuCompliantFlag() (resp bool, err error)

Retrieve A flag indicating whether or not the datacenter/location is EU compliant.

func (Location_Datacenter) GetFrontendHardwareRouters 

func (r Location_Datacenter) GetFrontendHardwareRouters() (resp []datatypes.Hardware, err error)

Retrieve

func (Location_Datacenter) GetGroups 

func (r Location_Datacenter) GetGroups() (resp []datatypes.Location_Group, err error)

Retrieve A location can be a member of 1 or more groups. This will show which groups to which a location belongs.

func (Location_Datacenter) GetHardwareFirewalls 

func (r Location_Datacenter) GetHardwareFirewalls() (resp []datatypes.Hardware, err error)

Retrieve

func (Location_Datacenter) GetHardwareRouters 

func (r Location_Datacenter) GetHardwareRouters() (resp []datatypes.Hardware, err error)

Retrieve

func (Location_Datacenter) GetLocationAddress 

func (r Location_Datacenter) GetLocationAddress() (resp datatypes.Account_Address, err error)

Retrieve A location's physical address.

func (Location_Datacenter) GetLocationAddresses 

func (r Location_Datacenter) GetLocationAddresses() (resp []datatypes.Account_Address, err error)

Retrieve A location's physical addresses.

func (Location_Datacenter) GetLocationReservationMember 

func (r Location_Datacenter) GetLocationReservationMember() (resp datatypes.Location_Reservation_Rack_Member, err error)

Retrieve A location's Dedicated Rack member

func (Location_Datacenter) GetLocationStatus 

func (r Location_Datacenter) GetLocationStatus() (resp datatypes.Location_Status, err error)

Retrieve The current locations status.

func (Location_Datacenter) GetNetworkConfigurationAttribute 

func (r Location_Datacenter) GetNetworkConfigurationAttribute() (resp datatypes.Hardware_Attribute, err error)

Retrieve

func (Location_Datacenter) GetObject 

func (r Location_Datacenter) GetObject() (resp datatypes.Location_Datacenter, err error)

no documentation yet

func (Location_Datacenter) GetOnlineSslVpnUserCount 

func (r Location_Datacenter) GetOnlineSslVpnUserCount() (resp int, err error)

Retrieve The total number of users online using SoftLayer's SSL VPN service for a location.

func (Location_Datacenter) GetPathString 

func (r Location_Datacenter) GetPathString() (resp string, err error)

Retrieve

func (Location_Datacenter) GetPresaleEvents 

func (r Location_Datacenter) GetPresaleEvents() (resp []datatypes.Sales_Presale_Event, err error)

Retrieve

func (Location_Datacenter) GetPriceGroups 

func (r Location_Datacenter) GetPriceGroups() (resp []datatypes.Location_Group, err error)

Retrieve A location can be a member of 1 or more Price Groups. This will show which groups to which a location belongs.

func (Location_Datacenter) GetRegionalGroup 

func (r Location_Datacenter) GetRegionalGroup() (resp datatypes.Location_Group_Regional, err error)

Retrieve The regional group this datacenter belongs to.

func (Location_Datacenter) GetRegionalInternetRegistry 

func (r Location_Datacenter) GetRegionalInternetRegistry() (resp datatypes.Network_Regional_Internet_Registry, err error)

Retrieve

func (Location_Datacenter) GetRegions 

func (r Location_Datacenter) GetRegions() (resp []datatypes.Location_Region, err error)

Retrieve A location can be a member of 1 or more regions. This will show which regions to which a location belongs.

func (Location_Datacenter) GetStatisticsGraphImage 

func (r Location_Datacenter) GetStatisticsGraphImage() (resp []byte, err error)

Retrieve a graph of a SoftLayer datacenter's last 48 hours of network activity. Statistics graphs show traffic outbound from a datacenter on top and inbound traffic on the bottom followed by a legend of the network services tracked in the graph. getStatisticsGraphImage returns a PNG image of variable width and height depending on the number of services reported in the image.

func (Location_Datacenter) GetTimezone 

func (r Location_Datacenter) GetTimezone() (resp datatypes.Locale_Timezone, err error)

Retrieve

func (Location_Datacenter) GetVdrGroup 

func (r Location_Datacenter) GetVdrGroup() (resp datatypes.Location_Group_Location_CrossReference, err error)

Retrieve A location can be a member of 1 Bandwidth Pooling Group. This will show which group to which a location belongs.

func (Location_Datacenter) GetViewableDatacenters 

func (r Location_Datacenter) GetViewableDatacenters() (resp []datatypes.Location, err error)

Retrieve all datacenter locations. SoftLayer's datacenters exist in various cities and each contain one or more server rooms which house network and server infrastructure.

func (Location_Datacenter) GetViewablePopsAndDataCenters 

func (r Location_Datacenter) GetViewablePopsAndDataCenters() (resp []datatypes.Location, err error)

Retrieve all viewable pop and datacenter locations.

func (Location_Datacenter) GetViewablepointOfPresence 

func (r Location_Datacenter) GetViewablepointOfPresence() (resp []datatypes.Location, err error)

Retrieve all viewable network locations.

func (Location_Datacenter) GetpointOfPresence 

func (r Location_Datacenter) GetpointOfPresence() (resp []datatypes.Location, err error)

Retrieve all point of presence locations.

func (Location_Datacenter) Id 

func (r Location_Datacenter) Id(id int) Location_Datacenter

func (Location_Datacenter) Limit 

func (r Location_Datacenter) Limit(limit int) Location_Datacenter

func (Location_Datacenter) Mask 

func (r Location_Datacenter) Mask(mask string) Location_Datacenter

func (Location_Datacenter) Offset 

func (r Location_Datacenter) Offset(offset int) Location_Datacenter

type Location_Group 

type Location_Group struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetLocationGroupService 

func GetLocationGroupService(sess session.SLSession) Location_Group

GetLocationGroupService returns an instance of the Location_Group SoftLayer service

func (Location_Group) Filter 

func (r Location_Group) Filter(filter string) Location_Group

func (Location_Group) GetAllObjects 

func (r Location_Group) GetAllObjects() (resp []datatypes.Location_Group, err error)

no documentation yet

func (Location_Group) GetLocationGroupType 

func (r Location_Group) GetLocationGroupType() (resp datatypes.Location_Group_Type, err error)

Retrieve The type for this location group.

func (Location_Group) GetLocations 

func (r Location_Group) GetLocations() (resp []datatypes.Location, err error)

Retrieve The locations in a group.

func (Location_Group) GetObject 

func (r Location_Group) GetObject() (resp datatypes.Location_Group, err error)

no documentation yet

func (Location_Group) Id 

func (r Location_Group) Id(id int) Location_Group

func (Location_Group) Limit 

func (r Location_Group) Limit(limit int) Location_Group

func (Location_Group) Mask 

func (r Location_Group) Mask(mask string) Location_Group

func (Location_Group) Offset 

func (r Location_Group) Offset(offset int) Location_Group

type Location_Group_Pricing 

type Location_Group_Pricing struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetLocationGroupPricingService 

func GetLocationGroupPricingService(sess session.SLSession) Location_Group_Pricing

GetLocationGroupPricingService returns an instance of the Location_Group_Pricing SoftLayer service

func (Location_Group_Pricing) Filter 

func (r Location_Group_Pricing) Filter(filter string) Location_Group_Pricing

func (Location_Group_Pricing) GetAllObjects 

func (r Location_Group_Pricing) GetAllObjects() (resp []datatypes.Location_Group, err error)

no documentation yet

func (Location_Group_Pricing) GetLocationGroupType 

func (r Location_Group_Pricing) GetLocationGroupType() (resp datatypes.Location_Group_Type, err error)

Retrieve The type for this location group.

func (Location_Group_Pricing) GetLocations 

func (r Location_Group_Pricing) GetLocations() (resp []datatypes.Location, err error)

Retrieve The locations in a group.

func (Location_Group_Pricing) GetObject 

func (r Location_Group_Pricing) GetObject() (resp datatypes.Location_Group_Pricing, err error)

no documentation yet

func (Location_Group_Pricing) GetPrices 

func (r Location_Group_Pricing) GetPrices() (resp []datatypes.Product_Item_Price, err error)

Retrieve The prices that this pricing location group limits. All of these prices will only be available in the locations defined by this pricing location group.

func (Location_Group_Pricing) Id 

func (r Location_Group_Pricing) Id(id int) Location_Group_Pricing

func (Location_Group_Pricing) Limit 

func (r Location_Group_Pricing) Limit(limit int) Location_Group_Pricing

func (Location_Group_Pricing) Mask 

func (r Location_Group_Pricing) Mask(mask string) Location_Group_Pricing

func (Location_Group_Pricing) Offset 

func (r Location_Group_Pricing) Offset(offset int) Location_Group_Pricing

type Location_Group_Regional 

type Location_Group_Regional struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetLocationGroupRegionalService 

func GetLocationGroupRegionalService(sess session.SLSession) Location_Group_Regional

GetLocationGroupRegionalService returns an instance of the Location_Group_Regional SoftLayer service

func (Location_Group_Regional) Filter 

func (r Location_Group_Regional) Filter(filter string) Location_Group_Regional

func (Location_Group_Regional) GetAllObjects 

func (r Location_Group_Regional) GetAllObjects() (resp []datatypes.Location_Group, err error)

no documentation yet

func (Location_Group_Regional) GetDatacenters 

func (r Location_Group_Regional) GetDatacenters() (resp []datatypes.Location, err error)

Retrieve The datacenters in a group.

func (Location_Group_Regional) GetLocationGroupType 

func (r Location_Group_Regional) GetLocationGroupType() (resp datatypes.Location_Group_Type, err error)

Retrieve The type for this location group.

func (Location_Group_Regional) GetLocations 

func (r Location_Group_Regional) GetLocations() (resp []datatypes.Location, err error)

Retrieve The locations in a group.

func (Location_Group_Regional) GetObject 

func (r Location_Group_Regional) GetObject() (resp datatypes.Location_Group_Regional, err error)

no documentation yet

func (Location_Group_Regional) GetPreferredDatacenter 

func (r Location_Group_Regional) GetPreferredDatacenter() (resp datatypes.Location_Datacenter, err error)

Retrieve The preferred datacenters of a group.

func (Location_Group_Regional) Id 

func (r Location_Group_Regional) Id(id int) Location_Group_Regional

func (Location_Group_Regional) Limit 

func (r Location_Group_Regional) Limit(limit int) Location_Group_Regional

func (Location_Group_Regional) Mask 

func (r Location_Group_Regional) Mask(mask string) Location_Group_Regional

func (Location_Group_Regional) Offset 

func (r Location_Group_Regional) Offset(offset int) Location_Group_Regional

type Location_Reservation 

type Location_Reservation struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetLocationReservationService 

func GetLocationReservationService(sess session.SLSession) Location_Reservation

GetLocationReservationService returns an instance of the Location_Reservation SoftLayer service

func (Location_Reservation) Filter 

func (r Location_Reservation) Filter(filter string) Location_Reservation

func (Location_Reservation) GetAccount 

func (r Location_Reservation) GetAccount() (resp datatypes.Account, err error)

Retrieve The account that a billing item belongs to.

func (Location_Reservation) GetAccountReservations 

func (r Location_Reservation) GetAccountReservations() (resp []datatypes.Location_Reservation, err error)

no documentation yet

func (Location_Reservation) GetAllotment 

func (r Location_Reservation) GetAllotment() (resp datatypes.Network_Bandwidth_Version1_Allotment, err error)

Retrieve The bandwidth allotment that the reservation belongs to.

func (Location_Reservation) GetBillingItem 

func (r Location_Reservation) GetBillingItem() (resp datatypes.Billing_Item, err error)

Retrieve The bandwidth allotment that the reservation belongs to.

func (Location_Reservation) GetLocation 

func (r Location_Reservation) GetLocation() (resp datatypes.Location, err error)

Retrieve The datacenter location that the reservation belongs to.

func (Location_Reservation) GetLocationReservationRack 

func (r Location_Reservation) GetLocationReservationRack() (resp datatypes.Location_Reservation_Rack, err error)

Retrieve Rack information for the reservation

func (Location_Reservation) GetObject 

func (r Location_Reservation) GetObject() (resp datatypes.Location_Reservation, err error)

no documentation yet

func (Location_Reservation) Id 

func (r Location_Reservation) Id(id int) Location_Reservation

func (Location_Reservation) Limit 

func (r Location_Reservation) Limit(limit int) Location_Reservation

func (Location_Reservation) Mask 

func (r Location_Reservation) Mask(mask string) Location_Reservation

func (Location_Reservation) Offset 

func (r Location_Reservation) Offset(offset int) Location_Reservation

type Location_Reservation_Rack 

type Location_Reservation_Rack struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetLocationReservationRackService 

func GetLocationReservationRackService(sess session.SLSession) Location_Reservation_Rack

GetLocationReservationRackService returns an instance of the Location_Reservation_Rack SoftLayer service

func (Location_Reservation_Rack) Filter 

func (r Location_Reservation_Rack) Filter(filter string) Location_Reservation_Rack

func (Location_Reservation_Rack) GetAllotment 

func (r Location_Reservation_Rack) GetAllotment() (resp datatypes.Network_Bandwidth_Version1_Allotment, err error)

Retrieve The bandwidth allotment that the reservation belongs to.

func (Location_Reservation_Rack) GetChildren 

func (r Location_Reservation_Rack) GetChildren() (resp []datatypes.Location_Reservation_Rack_Member, err error)

Retrieve Members of the rack.

func (Location_Reservation_Rack) GetLocation 

func (r Location_Reservation_Rack) GetLocation() (resp datatypes.Location, err error)

Retrieve

func (Location_Reservation_Rack) GetLocationReservation 

func (r Location_Reservation_Rack) GetLocationReservation() (resp datatypes.Location_Reservation, err error)

Retrieve

func (Location_Reservation_Rack) GetObject 

func (r Location_Reservation_Rack) GetObject() (resp datatypes.Location_Reservation_Rack, err error)

no documentation yet

func (Location_Reservation_Rack) Id 

func (r Location_Reservation_Rack) Id(id int) Location_Reservation_Rack

func (Location_Reservation_Rack) Limit 

func (r Location_Reservation_Rack) Limit(limit int) Location_Reservation_Rack

func (Location_Reservation_Rack) Mask 

func (r Location_Reservation_Rack) Mask(mask string) Location_Reservation_Rack

func (Location_Reservation_Rack) Offset 

func (r Location_Reservation_Rack) Offset(offset int) Location_Reservation_Rack

type Location_Reservation_Rack_Member 

type Location_Reservation_Rack_Member struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetLocationReservationRackMemberService 

func GetLocationReservationRackMemberService(sess session.SLSession) Location_Reservation_Rack_Member

GetLocationReservationRackMemberService returns an instance of the Location_Reservation_Rack_Member SoftLayer service

func (Location_Reservation_Rack_Member) Filter 

func (r Location_Reservation_Rack_Member) Filter(filter string) Location_Reservation_Rack_Member

func (Location_Reservation_Rack_Member) GetLocation 

func (r Location_Reservation_Rack_Member) GetLocation() (resp datatypes.Location, err error)

Retrieve Location relation for the rack member

func (Location_Reservation_Rack_Member) GetLocationReservationRack 

func (r Location_Reservation_Rack_Member) GetLocationReservationRack() (resp datatypes.Location_Reservation_Rack, err error)

Retrieve

func (Location_Reservation_Rack_Member) GetObject 

func (r Location_Reservation_Rack_Member) GetObject() (resp datatypes.Location_Reservation_Rack_Member, err error)

no documentation yet

func (Location_Reservation_Rack_Member) Id 

func (r Location_Reservation_Rack_Member) Id(id int) Location_Reservation_Rack_Member

func (Location_Reservation_Rack_Member) Limit 

func (r Location_Reservation_Rack_Member) Limit(limit int) Location_Reservation_Rack_Member

func (Location_Reservation_Rack_Member) Mask 

func (r Location_Reservation_Rack_Member) Mask(mask string) Location_Reservation_Rack_Member

func (Location_Reservation_Rack_Member) Offset 

func (r Location_Reservation_Rack_Member) Offset(offset int) Location_Reservation_Rack_Member

type Marketplace_Partner 

type Marketplace_Partner struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet Deprecated: This function has been marked as deprecated.

func GetMarketplacePartnerService 

func GetMarketplacePartnerService(sess session.SLSession) Marketplace_Partner

GetMarketplacePartnerService returns an instance of the Marketplace_Partner SoftLayer service

func (Marketplace_Partner) Filter 

func (r Marketplace_Partner) Filter(filter string) Marketplace_Partner

func (Marketplace_Partner) GetAllObjects 

func (r Marketplace_Partner) GetAllObjects() (resp []datatypes.Marketplace_Partner, err error)

no documentation yet

func (Marketplace_Partner) GetAllPublishedPartners 

func (r Marketplace_Partner) GetAllPublishedPartners(searchTerm *string) (resp []datatypes.Marketplace_Partner, err error)

no documentation yet Deprecated: This function has been marked as deprecated.

func (Marketplace_Partner) GetAttachments 

func (r Marketplace_Partner) GetAttachments() (resp []datatypes.Marketplace_Partner_Attachment, err error)

Retrieve

func (Marketplace_Partner) GetFeaturedPartners 

func (r Marketplace_Partner) GetFeaturedPartners(non *bool) (resp []datatypes.Marketplace_Partner, err error)

no documentation yet Deprecated: This function has been marked as deprecated.

func (Marketplace_Partner) GetFile 

func (r Marketplace_Partner) GetFile(name *string) (resp datatypes.Marketplace_Partner_File, err error)

no documentation yet Deprecated: This function has been marked as deprecated.

func (Marketplace_Partner) GetLogoMedium 

func (r Marketplace_Partner) GetLogoMedium() (resp datatypes.Marketplace_Partner_Attachment, err error)

Retrieve

func (Marketplace_Partner) GetLogoMediumTemp 

func (r Marketplace_Partner) GetLogoMediumTemp() (resp datatypes.Marketplace_Partner_Attachment, err error)

Retrieve

func (Marketplace_Partner) GetLogoSmall 

func (r Marketplace_Partner) GetLogoSmall() (resp datatypes.Marketplace_Partner_Attachment, err error)

Retrieve

func (Marketplace_Partner) GetLogoSmallTemp 

func (r Marketplace_Partner) GetLogoSmallTemp() (resp datatypes.Marketplace_Partner_Attachment, err error)

Retrieve

func (Marketplace_Partner) GetObject 

func (r Marketplace_Partner) GetObject() (resp datatypes.Marketplace_Partner, err error)

no documentation yet

func (Marketplace_Partner) GetPartnerByUrlIdentifier 

func (r Marketplace_Partner) GetPartnerByUrlIdentifier(urlIdentifier *string) (resp datatypes.Marketplace_Partner, err error)

no documentation yet

func (Marketplace_Partner) Id 

func (r Marketplace_Partner) Id(id int) Marketplace_Partner

func (Marketplace_Partner) Limit 

func (r Marketplace_Partner) Limit(limit int) Marketplace_Partner

func (Marketplace_Partner) Mask 

func (r Marketplace_Partner) Mask(mask string) Marketplace_Partner

func (Marketplace_Partner) Offset 

func (r Marketplace_Partner) Offset(offset int) Marketplace_Partner

type Metric_Tracking_Object 

type Metric_Tracking_Object struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetMetricTrackingObjectService 

func GetMetricTrackingObjectService(sess session.SLSession) Metric_Tracking_Object

GetMetricTrackingObjectService returns an instance of the Metric_Tracking_Object SoftLayer service

func (Metric_Tracking_Object) Filter 

func (r Metric_Tracking_Object) Filter(filter string) Metric_Tracking_Object

func (Metric_Tracking_Object) GetBandwidthData 

func (r Metric_Tracking_Object) GetBandwidthData(startDateTime *datatypes.Time, endDateTime *datatypes.Time, typ *string, rollupSeconds *int) (resp []datatypes.Metric_Tracking_Object_Data, err error)

Retrieve a collection of raw bandwidth data from an individual public or private network tracking object. Raw data is ideal if you with to employ your own traffic storage and graphing systems.

func (Metric_Tracking_Object) GetBandwidthTotal 

func (r Metric_Tracking_Object) GetBandwidthTotal(startDateTime *datatypes.Time, endDateTime *datatypes.Time, direction *string, typ *string) (resp uint, err error)

Retrieve the total amount of bandwidth recorded by a tracking object within the given date range. This method will only work on SoftLayer_Metric_Tracking_Object for SoftLayer_Hardware objects, and SoftLayer_Virtual_Guest objects.

func (Metric_Tracking_Object) GetMetricDataTypes 

func (r Metric_Tracking_Object) GetMetricDataTypes() (resp []datatypes.Container_Metric_Data_Type, err error)

Returns a collection of metric data types that can be retrieved for a metric tracking object.

func (Metric_Tracking_Object) GetObject 

func (r Metric_Tracking_Object) GetObject() (resp datatypes.Metric_Tracking_Object, err error)

getObject retrieves the SoftLayer_Metric_Tracking_Object object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Metric_Tracking_Object service. You can only tracking objects that are associated with your SoftLayer account or services.

func (Metric_Tracking_Object) GetSummaryData 

func (r Metric_Tracking_Object) GetSummaryData(startDateTime *datatypes.Time, endDateTime *datatypes.Time, validTypes []datatypes.Container_Metric_Data_Type, summaryPeriod *int) (resp []datatypes.Metric_Tracking_Object_Data, err error)

Returns summarized metric data for the date range, metric type and summary period provided.

func (Metric_Tracking_Object) GetType 

func (r Metric_Tracking_Object) GetType() (resp datatypes.Metric_Tracking_Object_Type, err error)

Retrieve The type of data that a tracking object polls.

func (Metric_Tracking_Object) Id 

func (r Metric_Tracking_Object) Id(id int) Metric_Tracking_Object

func (Metric_Tracking_Object) Limit 

func (r Metric_Tracking_Object) Limit(limit int) Metric_Tracking_Object

func (Metric_Tracking_Object) Mask 

func (r Metric_Tracking_Object) Mask(mask string) Metric_Tracking_Object

func (Metric_Tracking_Object) Offset 

func (r Metric_Tracking_Object) Offset(offset int) Metric_Tracking_Object

type Metric_Tracking_Object_Bandwidth_Summary 

type Metric_Tracking_Object_Bandwidth_Summary struct {
	Session session.SLSession
	Options sl.Options
}

This data type provides commonly used bandwidth summary components for the current billing cycle.

func GetMetricTrackingObjectBandwidthSummaryService 

func GetMetricTrackingObjectBandwidthSummaryService(sess session.SLSession) Metric_Tracking_Object_Bandwidth_Summary

GetMetricTrackingObjectBandwidthSummaryService returns an instance of the Metric_Tracking_Object_Bandwidth_Summary SoftLayer service

func (Metric_Tracking_Object_Bandwidth_Summary) Filter 

func (r Metric_Tracking_Object_Bandwidth_Summary) Filter(filter string) Metric_Tracking_Object_Bandwidth_Summary

func (Metric_Tracking_Object_Bandwidth_Summary) GetObject 

func (r Metric_Tracking_Object_Bandwidth_Summary) GetObject() (resp datatypes.Metric_Tracking_Object_Bandwidth_Summary, err error)

no documentation yet

func (Metric_Tracking_Object_Bandwidth_Summary) Id 

func (r Metric_Tracking_Object_Bandwidth_Summary) Id(id int) Metric_Tracking_Object_Bandwidth_Summary

func (Metric_Tracking_Object_Bandwidth_Summary) Limit 

func (r Metric_Tracking_Object_Bandwidth_Summary) Limit(limit int) Metric_Tracking_Object_Bandwidth_Summary

func (Metric_Tracking_Object_Bandwidth_Summary) Mask 

func (r Metric_Tracking_Object_Bandwidth_Summary) Mask(mask string) Metric_Tracking_Object_Bandwidth_Summary

func (Metric_Tracking_Object_Bandwidth_Summary) Offset 

func (r Metric_Tracking_Object_Bandwidth_Summary) Offset(offset int) Metric_Tracking_Object_Bandwidth_Summary

type Monitoring_Robot 

type Monitoring_Robot struct {
	Session session.SLSession
	Options sl.Options
}

DEPRECATED. The SoftLayer_Monitoring_Robot data type contains general information relating to a monitoring robot. Deprecated: This function has been marked as deprecated.

func GetMonitoringRobotService 

func GetMonitoringRobotService(sess session.SLSession) Monitoring_Robot

GetMonitoringRobotService returns an instance of the Monitoring_Robot SoftLayer service

func (Monitoring_Robot) CheckConnection 

func (r Monitoring_Robot) CheckConnection() (resp bool, err error)

DEPRECATED. Checks if a monitoring robot can communicate with SoftLayer monitoring management system via the private network.

TCP port 48000 - 48002 must be open on your server or your virtual server in order for this test to succeed. Deprecated: This function has been marked as deprecated.

func (Monitoring_Robot) Filter 

func (r Monitoring_Robot) Filter(filter string) Monitoring_Robot

func (Monitoring_Robot) GetObject 

func (r Monitoring_Robot) GetObject() (resp datatypes.Monitoring_Robot, err error)

no documentation yet

func (Monitoring_Robot) Id 

func (r Monitoring_Robot) Id(id int) Monitoring_Robot

func (Monitoring_Robot) Limit 

func (r Monitoring_Robot) Limit(limit int) Monitoring_Robot

func (Monitoring_Robot) Mask 

func (r Monitoring_Robot) Mask(mask string) Monitoring_Robot

func (Monitoring_Robot) Offset 

func (r Monitoring_Robot) Offset(offset int) Monitoring_Robot

type Network 

type Network struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetNetworkService 

func GetNetworkService(sess session.SLSession) Network

GetNetworkService returns an instance of the Network SoftLayer service

func (Network) ConnectPrivateEndpointService 

func (r Network) ConnectPrivateEndpointService() (resp bool, err error)

Initiate the automated process to establish connectivity granting the account private back-end network access to the services available through IBM Cloud Service Endpoint. Once initiated, the configuration process occurs asynchronously in the background.

<h2>Responses</h2>

<code>True</code> The request to connect was successfully initiated.

<code>False</code> The account and Service Endpoint networks are already connected.

<h2>Exceptions</h2>

<code>SoftLayer_Exception_NotReady</code> Thrown when the current network configuration will not support connection alteration.

func (Network) DisconnectPrivateEndpointService 

func (r Network) DisconnectPrivateEndpointService() (resp bool, err error)

Initiate the automated process to revoke mutual connectivity from the account network and IBM Cloud Service Endpoint network. Once initiated, the configuration process occurs asynchronously in the background.

<h2>Responses</h2>

<code>True</code> The request to disconnect was successfully initiated.

<code>False</code> The account and Service Endpoint networks are already disconnected.

<h2>Exceptions</h2>

<code>SoftLayer_Exception_NotReady</code> Thrown when the current network configuration will not support connection alteration.

func (Network) EnableVrf added in v1.1.4 

func (r Network) EnableVrf() (resp bool, err error)

Initiate the change of the private network to VRF, which will cause a brief private network outage.

@SLDNDocumentation Method Permissions NETWORK_VLAN_SPANNING

<h2>Responses</h2>

<code>True</code> The request to change the private network has been accepted and the change will begin immediately.

<code>False</code> The request had no change because the private network is already in a VRF or in the process of converting to VRF.

<h2>Exceptions</h2>

<code>SoftLayer_Exception_NotReady</code> Thrown when the current private network cannot be converted to VRF without specialized assistance.

func (Network) Filter 

func (r Network) Filter(filter string) Network

func (Network) Id 

func (r Network) Id(id int) Network

func (Network) IsConnectedToPrivateEndpointService 

func (r Network) IsConnectedToPrivateEndpointService() (resp bool, err error)

Accessing select IBM Cloud services attached to the private back-end network is made possible by establishing a network relationship between an account's private network and the Service Endpoint network.

<h2>Responses</h2>

<code>True</code> The account and Service Endpoint networks are currently connected.

<code>False</code> The account and Service Endpoint networks are not connected; both networks are properly configured to connect.

<h2>Exceptions</h2>

<code>SoftLayer_Exception_NotReady</code> Thrown when the current network configuration will not support connection alteration.

func (Network) Limit 

func (r Network) Limit(limit int) Network

func (Network) Mask 

func (r Network) Mask(mask string) Network

func (Network) Offset 

func (r Network) Offset(offset int) Network

type Network_Application_Delivery_Controller 

type Network_Application_Delivery_Controller struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetNetworkApplicationDeliveryControllerService 

func GetNetworkApplicationDeliveryControllerService(sess session.SLSession) Network_Application_Delivery_Controller

GetNetworkApplicationDeliveryControllerService returns an instance of the Network_Application_Delivery_Controller SoftLayer service

func (Network_Application_Delivery_Controller) CreateLiveLoadBalancer 

func (r Network_Application_Delivery_Controller) CreateLiveLoadBalancer(loadBalancer *datatypes.Network_LoadBalancer_VirtualIpAddress) (resp bool, err error)

Create or add to an application delivery controller based load balancer service. The loadBalancer parameter must have its ”name”, ”type”, ”sourcePort”, and ”virtualIpAddress” properties populated. Changes are reflected immediately in the application delivery controller.

func (Network_Application_Delivery_Controller) DeleteLiveLoadBalancer 

func (r Network_Application_Delivery_Controller) DeleteLiveLoadBalancer(loadBalancer *datatypes.Network_LoadBalancer_VirtualIpAddress) (resp bool, err error)

Remove a virtual IP address from an application delivery controller based load balancer. Only the ”name” property in the loadBalancer parameter must be populated. Changes are reflected immediately in the application delivery controller.

func (Network_Application_Delivery_Controller) DeleteLiveLoadBalancerService 

func (r Network_Application_Delivery_Controller) DeleteLiveLoadBalancerService(service *datatypes.Network_LoadBalancer_Service) (err error)

Remove an entire load balancer service, including all virtual IP addresses, from and application delivery controller based load balancer. The ”name” property the and ”name” property within the ”vip” property of the service parameter must be provided. Changes are reflected immediately in the application delivery controller.

func (Network_Application_Delivery_Controller) EditObject 

func (r Network_Application_Delivery_Controller) EditObject(templateObject *datatypes.Network_Application_Delivery_Controller) (resp bool, err error)

Edit an applications delivery controller record. Currently only a controller's notes property is editable.

func (Network_Application_Delivery_Controller) Filter 

func (r Network_Application_Delivery_Controller) Filter(filter string) Network_Application_Delivery_Controller

func (Network_Application_Delivery_Controller) GetAccount 

func (r Network_Application_Delivery_Controller) GetAccount() (resp datatypes.Account, err error)

Retrieve The SoftLayer customer account that owns an application delivery controller record.

func (Network_Application_Delivery_Controller) GetAverageDailyPublicBandwidthUsage 

func (r Network_Application_Delivery_Controller) GetAverageDailyPublicBandwidthUsage() (resp datatypes.Float64, err error)

Retrieve The average daily public bandwidth usage for the current billing cycle.

func (Network_Application_Delivery_Controller) GetBandwidthDataByDate 

func (r Network_Application_Delivery_Controller) GetBandwidthDataByDate(startDateTime *datatypes.Time, endDateTime *datatypes.Time, networkType *string) (resp []datatypes.Metric_Tracking_Object_Data, err error)

no documentation yet

func (Network_Application_Delivery_Controller) GetBillingItem 

func (r Network_Application_Delivery_Controller) GetBillingItem() (resp datatypes.Billing_Item_Network_Application_Delivery_Controller, err error)

Retrieve The billing item for a Application Delivery Controller.

func (Network_Application_Delivery_Controller) GetConfigurationHistory 

func (r Network_Application_Delivery_Controller) GetConfigurationHistory() (resp []datatypes.Network_Application_Delivery_Controller_Configuration_History, err error)

Retrieve Previous configurations for an Application Delivery Controller.

func (Network_Application_Delivery_Controller) GetDatacenter 

func (r Network_Application_Delivery_Controller) GetDatacenter() (resp datatypes.Location, err error)

Retrieve The datacenter that the application delivery controller resides in.

func (Network_Application_Delivery_Controller) GetDescription 

func (r Network_Application_Delivery_Controller) GetDescription() (resp string, err error)

Retrieve A brief description of an application delivery controller record.

func (Network_Application_Delivery_Controller) GetInboundPublicBandwidthUsage added in v1.1.3 

func (r Network_Application_Delivery_Controller) GetInboundPublicBandwidthUsage() (resp datatypes.Float64, err error)

Retrieve The total public inbound bandwidth for the current billing cycle.

func (Network_Application_Delivery_Controller) GetLicenseExpirationDate 

func (r Network_Application_Delivery_Controller) GetLicenseExpirationDate() (resp datatypes.Time, err error)

Retrieve The date in which the license for this application delivery controller will expire.

func (Network_Application_Delivery_Controller) GetLoadBalancers 

func (r Network_Application_Delivery_Controller) GetLoadBalancers() (resp []datatypes.Network_LoadBalancer_VirtualIpAddress, err error)

Retrieve The virtual IP address records that belong to an application delivery controller based load balancer.

func (Network_Application_Delivery_Controller) GetManagedResourceFlag 

func (r Network_Application_Delivery_Controller) GetManagedResourceFlag() (resp bool, err error)

Retrieve A flag indicating that this Application Delivery Controller is a managed resource.

func (Network_Application_Delivery_Controller) GetManagementIpAddress 

func (r Network_Application_Delivery_Controller) GetManagementIpAddress() (resp string, err error)

Retrieve An application delivery controller's management ip address.

func (Network_Application_Delivery_Controller) GetNetworkVlan 

func (r Network_Application_Delivery_Controller) GetNetworkVlan() (resp datatypes.Network_Vlan, err error)

Retrieve The network VLAN that an application delivery controller resides on.

func (Network_Application_Delivery_Controller) GetNetworkVlans 

func (r Network_Application_Delivery_Controller) GetNetworkVlans() (resp []datatypes.Network_Vlan, err error)

Retrieve The network VLANs that an application delivery controller resides on.

func (Network_Application_Delivery_Controller) GetObject 

func (r Network_Application_Delivery_Controller) GetObject() (resp datatypes.Network_Application_Delivery_Controller, err error)

getObject retrieves the SoftLayer_Network_Application_Delivery_Controller object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Network_Application_Delivery_Controller service. You can only retrieve application delivery controllers that are associated with your SoftLayer customer account.

func (Network_Application_Delivery_Controller) GetOutboundPublicBandwidthUsage 

func (r Network_Application_Delivery_Controller) GetOutboundPublicBandwidthUsage() (resp datatypes.Float64, err error)

Retrieve The total public outbound bandwidth for the current billing cycle.

func (Network_Application_Delivery_Controller) GetPassword 

func (r Network_Application_Delivery_Controller) GetPassword() (resp datatypes.Software_Component_Password, err error)

Retrieve The password used to connect to an application delivery controller's management interface when it is operating in advanced view mode.

func (Network_Application_Delivery_Controller) GetPrimaryIpAddress 

func (r Network_Application_Delivery_Controller) GetPrimaryIpAddress() (resp string, err error)

Retrieve An application delivery controller's primary public IP address.

func (Network_Application_Delivery_Controller) GetProjectedPublicBandwidthUsage 

func (r Network_Application_Delivery_Controller) GetProjectedPublicBandwidthUsage() (resp datatypes.Float64, err error)

Retrieve The projected public outbound bandwidth for the current billing cycle.

func (Network_Application_Delivery_Controller) GetSubnets 

func (r Network_Application_Delivery_Controller) GetSubnets() (resp []datatypes.Network_Subnet, err error)

Retrieve A network application controller's subnets. A subnet is a group of IP addresses

func (Network_Application_Delivery_Controller) GetTagReferences 

func (r Network_Application_Delivery_Controller) GetTagReferences() (resp []datatypes.Tag_Reference, err error)

Retrieve

func (Network_Application_Delivery_Controller) GetType 

func (r Network_Application_Delivery_Controller) GetType() (resp datatypes.Network_Application_Delivery_Controller_Type, err error)

Retrieve

func (Network_Application_Delivery_Controller) GetVirtualIpAddresses 

func (r Network_Application_Delivery_Controller) GetVirtualIpAddresses() (resp []datatypes.Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress, err error)

Retrieve

func (Network_Application_Delivery_Controller) Id 

func (r Network_Application_Delivery_Controller) Id(id int) Network_Application_Delivery_Controller

func (Network_Application_Delivery_Controller) Limit 

func (r Network_Application_Delivery_Controller) Limit(limit int) Network_Application_Delivery_Controller

func (Network_Application_Delivery_Controller) Mask 

func (r Network_Application_Delivery_Controller) Mask(mask string) Network_Application_Delivery_Controller

func (Network_Application_Delivery_Controller) Offset 

func (r Network_Application_Delivery_Controller) Offset(offset int) Network_Application_Delivery_Controller

func (Network_Application_Delivery_Controller) RestoreBaseConfiguration 

func (r Network_Application_Delivery_Controller) RestoreBaseConfiguration() (resp bool, err error)

Restore an application delivery controller's base configuration state. The configuration will be set to what it was when initially provisioned.

func (Network_Application_Delivery_Controller) RestoreConfiguration 

func (r Network_Application_Delivery_Controller) RestoreConfiguration(configurationHistoryId *int) (resp bool, err error)

Restore an application delivery controller's configuration state.

func (Network_Application_Delivery_Controller) SaveCurrentConfiguration 

func (r Network_Application_Delivery_Controller) SaveCurrentConfiguration(notes *string) (resp datatypes.Network_Application_Delivery_Controller_Configuration_History, err error)

Save an application delivery controller's configuration state. The notes property for this method is optional.

func (Network_Application_Delivery_Controller) UpdateLiveLoadBalancer 

func (r Network_Application_Delivery_Controller) UpdateLiveLoadBalancer(loadBalancer *datatypes.Network_LoadBalancer_VirtualIpAddress) (resp bool, err error)

Update the the virtual IP address interface within an application delivery controller based load balancer identified by the ”name” property in the loadBalancer parameter. You only need to set the properties in the loadBalancer parameter that you wish to change. Any virtual IP properties omitted or left empty are ignored. Changes are reflected immediately in the application delivery controller.

func (Network_Application_Delivery_Controller) UpdateNetScalerLicense 

func (r Network_Application_Delivery_Controller) UpdateNetScalerLicense() (resp datatypes.Provisioning_Version1_Transaction, err error)

Update the NetScaler VPX License.

This service will create a transaction to update a NetScaler VPX License. After the license is updated the load balancer will reboot in order to apply the newly issued license

The load balancer will be unavailable during the reboot.

type Network_Application_Delivery_Controller_Configuration_History 

type Network_Application_Delivery_Controller_Configuration_History struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetNetworkApplicationDeliveryControllerConfigurationHistoryService 

func GetNetworkApplicationDeliveryControllerConfigurationHistoryService(sess session.SLSession) Network_Application_Delivery_Controller_Configuration_History

GetNetworkApplicationDeliveryControllerConfigurationHistoryService returns an instance of the Network_Application_Delivery_Controller_Configuration_History SoftLayer service

func (Network_Application_Delivery_Controller_Configuration_History) DeleteObject 

func (r Network_Application_Delivery_Controller_Configuration_History) DeleteObject() (resp bool, err error)

deleteObject permanently removes a configuration history record

func (Network_Application_Delivery_Controller_Configuration_History) Filter 

func (r Network_Application_Delivery_Controller_Configuration_History) Filter(filter string) Network_Application_Delivery_Controller_Configuration_History

func (Network_Application_Delivery_Controller_Configuration_History) GetController 

func (r Network_Application_Delivery_Controller_Configuration_History) GetController() (resp datatypes.Network_Application_Delivery_Controller, err error)

Retrieve The application delivery controller that a configuration history record belongs to.

func (Network_Application_Delivery_Controller_Configuration_History) GetObject 

func (r Network_Application_Delivery_Controller_Configuration_History) GetObject() (resp datatypes.Network_Application_Delivery_Controller_Configuration_History, err error)

no documentation yet

func (Network_Application_Delivery_Controller_Configuration_History) Id 

func (r Network_Application_Delivery_Controller_Configuration_History) Id(id int) Network_Application_Delivery_Controller_Configuration_History

func (Network_Application_Delivery_Controller_Configuration_History) Limit 

func (r Network_Application_Delivery_Controller_Configuration_History) Limit(limit int) Network_Application_Delivery_Controller_Configuration_History

func (Network_Application_Delivery_Controller_Configuration_History) Mask 

func (r Network_Application_Delivery_Controller_Configuration_History) Mask(mask string) Network_Application_Delivery_Controller_Configuration_History

func (Network_Application_Delivery_Controller_Configuration_History) Offset 

func (r Network_Application_Delivery_Controller_Configuration_History) Offset(offset int) Network_Application_Delivery_Controller_Configuration_History

type Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute 

type Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet Deprecated: This function has been marked as deprecated.

func GetNetworkApplicationDeliveryControllerLoadBalancerHealthAttributeService 

func GetNetworkApplicationDeliveryControllerLoadBalancerHealthAttributeService(sess session.SLSession) Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute

GetNetworkApplicationDeliveryControllerLoadBalancerHealthAttributeService returns an instance of the Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute SoftLayer service

func (Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute) Filter 

func (r Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute) Filter(filter string) Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute

func (Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute) GetHealthCheck 

func (r Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute) GetHealthCheck() (resp datatypes.Network_Application_Delivery_Controller_LoadBalancer_Health_Check, err error)

Retrieve

func (Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute) GetObject 

func (r Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute) GetObject() (resp datatypes.Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute, err error)

no documentation yet

func (Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute) GetType 

func (r Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute) GetType() (resp datatypes.Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type, err error)

Retrieve

func (Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute) Id 

func (r Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute) Id(id int) Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute

func (Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute) Limit 

func (r Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute) Limit(limit int) Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute

func (Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute) Mask 

func (r Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute) Mask(mask string) Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute

func (Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute) Offset 

func (r Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute) Offset(offset int) Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute

type Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type 

type Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet Deprecated: This function has been marked as deprecated.

func GetNetworkApplicationDeliveryControllerLoadBalancerHealthAttributeTypeService 

func GetNetworkApplicationDeliveryControllerLoadBalancerHealthAttributeTypeService(sess session.SLSession) Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type

GetNetworkApplicationDeliveryControllerLoadBalancerHealthAttributeTypeService returns an instance of the Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type SoftLayer service

func (Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type) Filter 

func (r Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type) Filter(filter string) Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type

func (Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type) GetAllObjects 

func (r Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type) GetAllObjects() (resp []datatypes.Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type, err error)

no documentation yet

func (Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type) GetObject 

func (r Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type) GetObject() (resp datatypes.Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type, err error)

no documentation yet

func (Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type) Id 

func (r Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type) Id(id int) Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type

func (Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type) Limit 

func (r Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type) Limit(limit int) Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type

func (Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type) Mask 

func (r Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type) Mask(mask string) Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type

func (Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type) Offset 

func (r Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type) Offset(offset int) Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute_Type

type Network_Application_Delivery_Controller_LoadBalancer_Health_Check 

type Network_Application_Delivery_Controller_LoadBalancer_Health_Check struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet Deprecated: This function has been marked as deprecated.

func GetNetworkApplicationDeliveryControllerLoadBalancerHealthCheckService 

func GetNetworkApplicationDeliveryControllerLoadBalancerHealthCheckService(sess session.SLSession) Network_Application_Delivery_Controller_LoadBalancer_Health_Check

GetNetworkApplicationDeliveryControllerLoadBalancerHealthCheckService returns an instance of the Network_Application_Delivery_Controller_LoadBalancer_Health_Check SoftLayer service

func (Network_Application_Delivery_Controller_LoadBalancer_Health_Check) Filter 

func (r Network_Application_Delivery_Controller_LoadBalancer_Health_Check) Filter(filter string) Network_Application_Delivery_Controller_LoadBalancer_Health_Check

func (Network_Application_Delivery_Controller_LoadBalancer_Health_Check) GetAttributes 

func (r Network_Application_Delivery_Controller_LoadBalancer_Health_Check) GetAttributes() (resp []datatypes.Network_Application_Delivery_Controller_LoadBalancer_Health_Attribute, err error)

Retrieve

func (Network_Application_Delivery_Controller_LoadBalancer_Health_Check) GetObject 

func (r Network_Application_Delivery_Controller_LoadBalancer_Health_Check) GetObject() (resp datatypes.Network_Application_Delivery_Controller_LoadBalancer_Health_Check, err error)

no documentation yet

func (Network_Application_Delivery_Controller_LoadBalancer_Health_Check) GetServices 

func (r Network_Application_Delivery_Controller_LoadBalancer_Health_Check) GetServices() (resp []datatypes.Network_Application_Delivery_Controller_LoadBalancer_Service, err error)

Retrieve

func (Network_Application_Delivery_Controller_LoadBalancer_Health_Check) GetType 

func (r Network_Application_Delivery_Controller_LoadBalancer_Health_Check) GetType() (resp datatypes.Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type, err error)

Retrieve

func (Network_Application_Delivery_Controller_LoadBalancer_Health_Check) Id 

func (r Network_Application_Delivery_Controller_LoadBalancer_Health_Check) Id(id int) Network_Application_Delivery_Controller_LoadBalancer_Health_Check

func (Network_Application_Delivery_Controller_LoadBalancer_Health_Check) Limit 

func (r Network_Application_Delivery_Controller_LoadBalancer_Health_Check) Limit(limit int) Network_Application_Delivery_Controller_LoadBalancer_Health_Check

func (Network_Application_Delivery_Controller_LoadBalancer_Health_Check) Mask 

func (r Network_Application_Delivery_Controller_LoadBalancer_Health_Check) Mask(mask string) Network_Application_Delivery_Controller_LoadBalancer_Health_Check

func (Network_Application_Delivery_Controller_LoadBalancer_Health_Check) Offset 

func (r Network_Application_Delivery_Controller_LoadBalancer_Health_Check) Offset(offset int) Network_Application_Delivery_Controller_LoadBalancer_Health_Check

type Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type 

type Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet Deprecated: This function has been marked as deprecated.

func GetNetworkApplicationDeliveryControllerLoadBalancerHealthCheckTypeService 

func GetNetworkApplicationDeliveryControllerLoadBalancerHealthCheckTypeService(sess session.SLSession) Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type

GetNetworkApplicationDeliveryControllerLoadBalancerHealthCheckTypeService returns an instance of the Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type SoftLayer service

func (Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type) Filter 

func (r Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type) Filter(filter string) Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type

func (Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type) GetAllObjects 

func (r Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type) GetAllObjects() (resp []datatypes.Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type, err error)

no documentation yet

func (Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type) GetObject 

func (r Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type) GetObject() (resp datatypes.Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type, err error)

no documentation yet

func (Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type) Id 

func (r Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type) Id(id int) Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type

func (Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type) Limit 

func (r Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type) Limit(limit int) Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type

func (Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type) Mask 

func (r Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type) Mask(mask string) Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type

func (Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type) Offset 

func (r Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type) Offset(offset int) Network_Application_Delivery_Controller_LoadBalancer_Health_Check_Type

type Network_Application_Delivery_Controller_LoadBalancer_Routing_Method 

type Network_Application_Delivery_Controller_LoadBalancer_Routing_Method struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet Deprecated: This function has been marked as deprecated.

func GetNetworkApplicationDeliveryControllerLoadBalancerRoutingMethodService 

func GetNetworkApplicationDeliveryControllerLoadBalancerRoutingMethodService(sess session.SLSession) Network_Application_Delivery_Controller_LoadBalancer_Routing_Method

GetNetworkApplicationDeliveryControllerLoadBalancerRoutingMethodService returns an instance of the Network_Application_Delivery_Controller_LoadBalancer_Routing_Method SoftLayer service

func (Network_Application_Delivery_Controller_LoadBalancer_Routing_Method) Filter 

func (r Network_Application_Delivery_Controller_LoadBalancer_Routing_Method) Filter(filter string) Network_Application_Delivery_Controller_LoadBalancer_Routing_Method

func (Network_Application_Delivery_Controller_LoadBalancer_Routing_Method) GetAllObjects 

func (r Network_Application_Delivery_Controller_LoadBalancer_Routing_Method) GetAllObjects() (resp []datatypes.Network_Application_Delivery_Controller_LoadBalancer_Routing_Method, err error)

no documentation yet

func (Network_Application_Delivery_Controller_LoadBalancer_Routing_Method) GetObject 

func (r Network_Application_Delivery_Controller_LoadBalancer_Routing_Method) GetObject() (resp datatypes.Network_Application_Delivery_Controller_LoadBalancer_Routing_Method, err error)

no documentation yet

func (Network_Application_Delivery_Controller_LoadBalancer_Routing_Method) Id 

func (r Network_Application_Delivery_Controller_LoadBalancer_Routing_Method) Id(id int) Network_Application_Delivery_Controller_LoadBalancer_Routing_Method

func (Network_Application_Delivery_Controller_LoadBalancer_Routing_Method) Limit 

func (r Network_Application_Delivery_Controller_LoadBalancer_Routing_Method) Limit(limit int) Network_Application_Delivery_Controller_LoadBalancer_Routing_Method

func (Network_Application_Delivery_Controller_LoadBalancer_Routing_Method) Mask 

func (r Network_Application_Delivery_Controller_LoadBalancer_Routing_Method) Mask(mask string) Network_Application_Delivery_Controller_LoadBalancer_Routing_Method

func (Network_Application_Delivery_Controller_LoadBalancer_Routing_Method) Offset 

func (r Network_Application_Delivery_Controller_LoadBalancer_Routing_Method) Offset(offset int) Network_Application_Delivery_Controller_LoadBalancer_Routing_Method

type Network_Application_Delivery_Controller_LoadBalancer_Routing_Type 

type Network_Application_Delivery_Controller_LoadBalancer_Routing_Type struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet Deprecated: This function has been marked as deprecated.

func GetNetworkApplicationDeliveryControllerLoadBalancerRoutingTypeService 

func GetNetworkApplicationDeliveryControllerLoadBalancerRoutingTypeService(sess session.SLSession) Network_Application_Delivery_Controller_LoadBalancer_Routing_Type

GetNetworkApplicationDeliveryControllerLoadBalancerRoutingTypeService returns an instance of the Network_Application_Delivery_Controller_LoadBalancer_Routing_Type SoftLayer service

func (Network_Application_Delivery_Controller_LoadBalancer_Routing_Type) Filter 

func (r Network_Application_Delivery_Controller_LoadBalancer_Routing_Type) Filter(filter string) Network_Application_Delivery_Controller_LoadBalancer_Routing_Type

func (Network_Application_Delivery_Controller_LoadBalancer_Routing_Type) GetAllObjects 

func (r Network_Application_Delivery_Controller_LoadBalancer_Routing_Type) GetAllObjects() (resp []datatypes.Network_Application_Delivery_Controller_LoadBalancer_Routing_Type, err error)

no documentation yet

func (Network_Application_Delivery_Controller_LoadBalancer_Routing_Type) GetObject 

func (r Network_Application_Delivery_Controller_LoadBalancer_Routing_Type) GetObject() (resp datatypes.Network_Application_Delivery_Controller_LoadBalancer_Routing_Type, err error)

no documentation yet

func (Network_Application_Delivery_Controller_LoadBalancer_Routing_Type) Id 

func (r Network_Application_Delivery_Controller_LoadBalancer_Routing_Type) Id(id int) Network_Application_Delivery_Controller_LoadBalancer_Routing_Type

func (Network_Application_Delivery_Controller_LoadBalancer_Routing_Type) Limit 

func (r Network_Application_Delivery_Controller_LoadBalancer_Routing_Type) Limit(limit int) Network_Application_Delivery_Controller_LoadBalancer_Routing_Type

func (Network_Application_Delivery_Controller_LoadBalancer_Routing_Type) Mask 

func (r Network_Application_Delivery_Controller_LoadBalancer_Routing_Type) Mask(mask string) Network_Application_Delivery_Controller_LoadBalancer_Routing_Type

func (Network_Application_Delivery_Controller_LoadBalancer_Routing_Type) Offset 

func (r Network_Application_Delivery_Controller_LoadBalancer_Routing_Type) Offset(offset int) Network_Application_Delivery_Controller_LoadBalancer_Routing_Type

type Network_Application_Delivery_Controller_LoadBalancer_Service 

type Network_Application_Delivery_Controller_LoadBalancer_Service struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet Deprecated: This function has been marked as deprecated.

func GetNetworkApplicationDeliveryControllerLoadBalancerServiceService 

func GetNetworkApplicationDeliveryControllerLoadBalancerServiceService(sess session.SLSession) Network_Application_Delivery_Controller_LoadBalancer_Service

GetNetworkApplicationDeliveryControllerLoadBalancerServiceService returns an instance of the Network_Application_Delivery_Controller_LoadBalancer_Service SoftLayer service

func (Network_Application_Delivery_Controller_LoadBalancer_Service) DeleteObject 

func (r Network_Application_Delivery_Controller_LoadBalancer_Service) DeleteObject() (err error)

no documentation yet Deprecated: This function has been marked as deprecated.

func (Network_Application_Delivery_Controller_LoadBalancer_Service) Filter 

func (r Network_Application_Delivery_Controller_LoadBalancer_Service) Filter(filter string) Network_Application_Delivery_Controller_LoadBalancer_Service

func (Network_Application_Delivery_Controller_LoadBalancer_Service) GetGraphImage 

func (r Network_Application_Delivery_Controller_LoadBalancer_Service) GetGraphImage(graphType *string, metric *string) (resp []byte, err error)

Deprecated Deprecated: This function has been marked as deprecated.

func (Network_Application_Delivery_Controller_LoadBalancer_Service) GetGroupReferences 

func (r Network_Application_Delivery_Controller_LoadBalancer_Service) GetGroupReferences() (resp []datatypes.Network_Application_Delivery_Controller_LoadBalancer_Service_Group_CrossReference, err error)

Retrieve

func (Network_Application_Delivery_Controller_LoadBalancer_Service) GetGroups 

func (r Network_Application_Delivery_Controller_LoadBalancer_Service) GetGroups() (resp []datatypes.Network_Application_Delivery_Controller_LoadBalancer_Service_Group, err error)

Retrieve

func (Network_Application_Delivery_Controller_LoadBalancer_Service) GetHealthCheck 

func (r Network_Application_Delivery_Controller_LoadBalancer_Service) GetHealthCheck() (resp datatypes.Network_Application_Delivery_Controller_LoadBalancer_Health_Check, err error)

Retrieve

func (Network_Application_Delivery_Controller_LoadBalancer_Service) GetHealthChecks 

func (r Network_Application_Delivery_Controller_LoadBalancer_Service) GetHealthChecks() (resp []datatypes.Network_Application_Delivery_Controller_LoadBalancer_Health_Check, err error)

Retrieve

func (Network_Application_Delivery_Controller_LoadBalancer_Service) GetIpAddress 

func (r Network_Application_Delivery_Controller_LoadBalancer_Service) GetIpAddress() (resp datatypes.Network_Subnet_IpAddress, err error)

Retrieve

func (Network_Application_Delivery_Controller_LoadBalancer_Service) GetObject 

func (r Network_Application_Delivery_Controller_LoadBalancer_Service) GetObject() (resp datatypes.Network_Application_Delivery_Controller_LoadBalancer_Service, err error)

no documentation yet

func (Network_Application_Delivery_Controller_LoadBalancer_Service) GetServiceGroup 

func (r Network_Application_Delivery_Controller_LoadBalancer_Service) GetServiceGroup() (resp datatypes.Network_Application_Delivery_Controller_LoadBalancer_Service_Group, err error)

Retrieve

func (Network_Application_Delivery_Controller_LoadBalancer_Service) Id 

func (r Network_Application_Delivery_Controller_LoadBalancer_Service) Id(id int) Network_Application_Delivery_Controller_LoadBalancer_Service

func (Network_Application_Delivery_Controller_LoadBalancer_Service) Limit 

func (r Network_Application_Delivery_Controller_LoadBalancer_Service) Limit(limit int) Network_Application_Delivery_Controller_LoadBalancer_Service

func (Network_Application_Delivery_Controller_LoadBalancer_Service) Mask 

func (r Network_Application_Delivery_Controller_LoadBalancer_Service) Mask(mask string) Network_Application_Delivery_Controller_LoadBalancer_Service

func (Network_Application_Delivery_Controller_LoadBalancer_Service) Offset 

func (r Network_Application_Delivery_Controller_LoadBalancer_Service) Offset(offset int) Network_Application_Delivery_Controller_LoadBalancer_Service

func (Network_Application_Delivery_Controller_LoadBalancer_Service) ToggleStatus 

func (r Network_Application_Delivery_Controller_LoadBalancer_Service) ToggleStatus() (resp bool, err error)

no documentation yet Deprecated: This function has been marked as deprecated.

type Network_Application_Delivery_Controller_LoadBalancer_Service_Group 

type Network_Application_Delivery_Controller_LoadBalancer_Service_Group struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet Deprecated: This function has been marked as deprecated.

func GetNetworkApplicationDeliveryControllerLoadBalancerServiceGroupService 

func GetNetworkApplicationDeliveryControllerLoadBalancerServiceGroupService(sess session.SLSession) Network_Application_Delivery_Controller_LoadBalancer_Service_Group

GetNetworkApplicationDeliveryControllerLoadBalancerServiceGroupService returns an instance of the Network_Application_Delivery_Controller_LoadBalancer_Service_Group SoftLayer service

func (Network_Application_Delivery_Controller_LoadBalancer_Service_Group) Filter 

func (r Network_Application_Delivery_Controller_LoadBalancer_Service_Group) Filter(filter string) Network_Application_Delivery_Controller_LoadBalancer_Service_Group

func (Network_Application_Delivery_Controller_LoadBalancer_Service_Group) GetGraphImage 

func (r Network_Application_Delivery_Controller_LoadBalancer_Service_Group) GetGraphImage(graphType *string, metric *string) (resp []byte, err error)

Deprecated Deprecated: This function has been marked as deprecated.

func (Network_Application_Delivery_Controller_LoadBalancer_Service_Group) GetObject 

func (r Network_Application_Delivery_Controller_LoadBalancer_Service_Group) GetObject() (resp datatypes.Network_Application_Delivery_Controller_LoadBalancer_Service_Group, err error)

no documentation yet

func (Network_Application_Delivery_Controller_LoadBalancer_Service_Group) GetRoutingMethod 

func (r Network_Application_Delivery_Controller_LoadBalancer_Service_Group) GetRoutingMethod() (resp datatypes.Network_Application_Delivery_Controller_LoadBalancer_Routing_Method, err error)

Retrieve

func (Network_Application_Delivery_Controller_LoadBalancer_Service_Group) GetRoutingType 

func (r Network_Application_Delivery_Controller_LoadBalancer_Service_Group) GetRoutingType() (resp datatypes.Network_Application_Delivery_Controller_LoadBalancer_Routing_Type, err error)

Retrieve

func (Network_Application_Delivery_Controller_LoadBalancer_Service_Group) GetServiceReferences 

func (r Network_Application_Delivery_Controller_LoadBalancer_Service_Group) GetServiceReferences() (resp []datatypes.Network_Application_Delivery_Controller_LoadBalancer_Service_Group_CrossReference, err error)

Retrieve

func (Network_Application_Delivery_Controller_LoadBalancer_Service_Group) GetServices 

func (r Network_Application_Delivery_Controller_LoadBalancer_Service_Group) GetServices() (resp []datatypes.Network_Application_Delivery_Controller_LoadBalancer_Service, err error)

Retrieve

func (Network_Application_Delivery_Controller_LoadBalancer_Service_Group) GetVirtualServer 

func (r Network_Application_Delivery_Controller_LoadBalancer_Service_Group) GetVirtualServer() (resp datatypes.Network_Application_Delivery_Controller_LoadBalancer_VirtualServer, err error)

Retrieve

func (Network_Application_Delivery_Controller_LoadBalancer_Service_Group) GetVirtualServers 

func (r Network_Application_Delivery_Controller_LoadBalancer_Service_Group) GetVirtualServers() (resp []datatypes.Network_Application_Delivery_Controller_LoadBalancer_VirtualServer, err error)

Retrieve

func (Network_Application_Delivery_Controller_LoadBalancer_Service_Group) Id 

func (r Network_Application_Delivery_Controller_LoadBalancer_Service_Group) Id(id int) Network_Application_Delivery_Controller_LoadBalancer_Service_Group

func (Network_Application_Delivery_Controller_LoadBalancer_Service_Group) KickAllConnections 

func (r Network_Application_Delivery_Controller_LoadBalancer_Service_Group) KickAllConnections() (resp bool, err error)

no documentation yet Deprecated: This function has been marked as deprecated.

func (Network_Application_Delivery_Controller_LoadBalancer_Service_Group) Limit 

func (r Network_Application_Delivery_Controller_LoadBalancer_Service_Group) Limit(limit int) Network_Application_Delivery_Controller_LoadBalancer_Service_Group

func (Network_Application_Delivery_Controller_LoadBalancer_Service_Group) Mask 

func (r Network_Application_Delivery_Controller_LoadBalancer_Service_Group) Mask(mask string) Network_Application_Delivery_Controller_LoadBalancer_Service_Group

func (Network_Application_Delivery_Controller_LoadBalancer_Service_Group) Offset 

func (r Network_Application_Delivery_Controller_LoadBalancer_Service_Group) Offset(offset int) Network_Application_Delivery_Controller_LoadBalancer_Service_Group

type Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress 

type Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet Deprecated: This function has been marked as deprecated.

func GetNetworkApplicationDeliveryControllerLoadBalancerVirtualIpAddressService 

func GetNetworkApplicationDeliveryControllerLoadBalancerVirtualIpAddressService(sess session.SLSession) Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress

GetNetworkApplicationDeliveryControllerLoadBalancerVirtualIpAddressService returns an instance of the Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress SoftLayer service

func (Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress) EditObject 

func (r Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress) EditObject(templateObject *datatypes.Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress) (resp bool, err error)

Deprecated Deprecated: This function has been marked as deprecated.

func (Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress) Filter 

func (r Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress) Filter(filter string) Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress

func (Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress) GetAccount 

func (r Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress) GetAccount() (resp datatypes.Account, err error)

Retrieve

func (Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress) GetApplicationDeliveryController 

func (r Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress) GetApplicationDeliveryController() (resp datatypes.Network_Application_Delivery_Controller, err error)

Retrieve A virtual IP address's associated application delivery controller.

func (Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress) GetApplicationDeliveryControllers 

func (r Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress) GetApplicationDeliveryControllers() (resp []datatypes.Network_Application_Delivery_Controller, err error)

Retrieve A virtual IP address's associated application delivery controllers.

func (Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress) GetAvailableSecureTransportCiphers 

func (r Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress) GetAvailableSecureTransportCiphers() (resp []datatypes.Security_SecureTransportCipher, err error)

Deprecated Deprecated: This function has been marked as deprecated.

func (Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress) GetAvailableSecureTransportProtocols 

func (r Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress) GetAvailableSecureTransportProtocols() (resp []datatypes.Security_SecureTransportProtocol, err error)

Deprecated

func (Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress) GetBillingItem 

func (r Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress) GetBillingItem() (resp datatypes.Billing_Item, err error)

Retrieve The current billing item for the load balancer virtual IP. This is only valid when dedicatedFlag is false. This is an independent virtual IP, and if canceled, will only affect the associated virtual IP.

func (Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress) GetDedicatedBillingItem 

func (r Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress) GetDedicatedBillingItem() (resp datatypes.Billing_Item_Network_LoadBalancer, err error)

Retrieve The current billing item for the load balancing device housing the virtual IP. This billing item represents a device which could contain other virtual IPs. Caution should be taken when canceling. This is only valid when dedicatedFlag is true.

func (Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress) GetHighAvailabilityFlag 

func (r Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress) GetHighAvailabilityFlag() (resp bool, err error)

Retrieve Denotes whether the virtual IP is configured within a high availability cluster.

func (Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress) GetIpAddress 

func (r Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress) GetIpAddress() (resp datatypes.Network_Subnet_IpAddress, err error)

Retrieve

func (Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress) GetLoadBalancerHardware 

func (r Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress) GetLoadBalancerHardware() (resp []datatypes.Hardware, err error)

Retrieve

func (Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress) GetManagedResourceFlag 

func (r Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress) GetManagedResourceFlag() (resp bool, err error)

Retrieve A flag indicating that the load balancer is a managed resource.

func (Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress) GetObject 

func (r Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress) GetObject() (resp datatypes.Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress, err error)

no documentation yet

func (Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress) GetSecureTransportCiphers 

func (r Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress) GetSecureTransportCiphers() (resp []datatypes.Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress_SecureTransportCipher, err error)

Retrieve The list of security ciphers enabled for this virtual IP address

func (Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress) GetSecureTransportProtocols 

func (r Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress) GetSecureTransportProtocols() (resp []datatypes.Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress_SecureTransportProtocol, err error)

Retrieve The list of secure transport protocols enabled for this virtual IP address

func (Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress) GetSecurityCertificate 

func (r Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress) GetSecurityCertificate() (resp datatypes.Security_Certificate, err error)

Retrieve The SSL certificate currently associated with the VIP.

func (Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress) GetSecurityCertificateEntry 

func (r Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress) GetSecurityCertificateEntry() (resp datatypes.Security_Certificate, err error)

Retrieve The SSL certificate currently associated with the VIP. Provides chosen certificate visibility to unprivileged users.

func (Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress) GetVirtualServers 

func (r Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress) GetVirtualServers() (resp []datatypes.Network_Application_Delivery_Controller_LoadBalancer_VirtualServer, err error)

Retrieve

func (Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress) Id 

func (r Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress) Id(id int) Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress

func (Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress) Limit 

func (r Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress) Limit(limit int) Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress

func (Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress) Mask 

func (r Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress) Mask(mask string) Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress

func (Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress) Offset 

func (r Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress) Offset(offset int) Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress

func (Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress) StartSsl 

func (r Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress) StartSsl() (resp bool, err error)

Deprecated Deprecated: This function has been marked as deprecated.

func (Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress) StopSsl 

func (r Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress) StopSsl() (resp bool, err error)

Deprecated Deprecated: This function has been marked as deprecated.

func (Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress) UpgradeConnectionLimit 

func (r Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress) UpgradeConnectionLimit() (resp bool, err error)

Deprecated Deprecated: This function has been marked as deprecated.

type Network_Application_Delivery_Controller_LoadBalancer_VirtualServer 

type Network_Application_Delivery_Controller_LoadBalancer_VirtualServer struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet Deprecated: This function has been marked as deprecated.

func GetNetworkApplicationDeliveryControllerLoadBalancerVirtualServerService 

func GetNetworkApplicationDeliveryControllerLoadBalancerVirtualServerService(sess session.SLSession) Network_Application_Delivery_Controller_LoadBalancer_VirtualServer

GetNetworkApplicationDeliveryControllerLoadBalancerVirtualServerService returns an instance of the Network_Application_Delivery_Controller_LoadBalancer_VirtualServer SoftLayer service

func (Network_Application_Delivery_Controller_LoadBalancer_VirtualServer) DeleteObject 

func (r Network_Application_Delivery_Controller_LoadBalancer_VirtualServer) DeleteObject() (err error)

no documentation yet Deprecated: This function has been marked as deprecated.

func (Network_Application_Delivery_Controller_LoadBalancer_VirtualServer) Filter 

func (r Network_Application_Delivery_Controller_LoadBalancer_VirtualServer) Filter(filter string) Network_Application_Delivery_Controller_LoadBalancer_VirtualServer

func (Network_Application_Delivery_Controller_LoadBalancer_VirtualServer) GetObject 

func (r Network_Application_Delivery_Controller_LoadBalancer_VirtualServer) GetObject() (resp datatypes.Network_Application_Delivery_Controller_LoadBalancer_VirtualServer, err error)

no documentation yet

func (Network_Application_Delivery_Controller_LoadBalancer_VirtualServer) GetRoutingMethod 

func (r Network_Application_Delivery_Controller_LoadBalancer_VirtualServer) GetRoutingMethod() (resp datatypes.Network_Application_Delivery_Controller_LoadBalancer_Routing_Method, err error)

Retrieve

func (Network_Application_Delivery_Controller_LoadBalancer_VirtualServer) GetServiceGroups 

func (r Network_Application_Delivery_Controller_LoadBalancer_VirtualServer) GetServiceGroups() (resp []datatypes.Network_Application_Delivery_Controller_LoadBalancer_Service_Group, err error)

Retrieve

func (Network_Application_Delivery_Controller_LoadBalancer_VirtualServer) GetVirtualIpAddress 

func (r Network_Application_Delivery_Controller_LoadBalancer_VirtualServer) GetVirtualIpAddress() (resp datatypes.Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress, err error)

Retrieve

func (Network_Application_Delivery_Controller_LoadBalancer_VirtualServer) Id 

func (r Network_Application_Delivery_Controller_LoadBalancer_VirtualServer) Id(id int) Network_Application_Delivery_Controller_LoadBalancer_VirtualServer

func (Network_Application_Delivery_Controller_LoadBalancer_VirtualServer) Limit 

func (r Network_Application_Delivery_Controller_LoadBalancer_VirtualServer) Limit(limit int) Network_Application_Delivery_Controller_LoadBalancer_VirtualServer

func (Network_Application_Delivery_Controller_LoadBalancer_VirtualServer) Mask 

func (r Network_Application_Delivery_Controller_LoadBalancer_VirtualServer) Mask(mask string) Network_Application_Delivery_Controller_LoadBalancer_VirtualServer

func (Network_Application_Delivery_Controller_LoadBalancer_VirtualServer) Offset 

func (r Network_Application_Delivery_Controller_LoadBalancer_VirtualServer) Offset(offset int) Network_Application_Delivery_Controller_LoadBalancer_VirtualServer

func (Network_Application_Delivery_Controller_LoadBalancer_VirtualServer) StartSsl 

func (r Network_Application_Delivery_Controller_LoadBalancer_VirtualServer) StartSsl() (resp bool, err error)

Deprecated Deprecated: This function has been marked as deprecated.

func (Network_Application_Delivery_Controller_LoadBalancer_VirtualServer) StopSsl 

func (r Network_Application_Delivery_Controller_LoadBalancer_VirtualServer) StopSsl() (resp bool, err error)

Deprecated Deprecated: This function has been marked as deprecated.

type Network_Bandwidth_Version1_Allotment 

type Network_Bandwidth_Version1_Allotment struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetNetworkBandwidthVersion1AllotmentService 

func GetNetworkBandwidthVersion1AllotmentService(sess session.SLSession) Network_Bandwidth_Version1_Allotment

GetNetworkBandwidthVersion1AllotmentService returns an instance of the Network_Bandwidth_Version1_Allotment SoftLayer service

func (Network_Bandwidth_Version1_Allotment) CreateObject 

func (r Network_Bandwidth_Version1_Allotment) CreateObject(templateObject *datatypes.Network_Bandwidth_Version1_Allotment) (resp datatypes.Network_Bandwidth_Version1_Allotment, err error)

Create a allotment for servers to pool bandwidth and avoid overages in billing if they use more than there allocated bandwidth.

func (Network_Bandwidth_Version1_Allotment) EditObject 

func (r Network_Bandwidth_Version1_Allotment) EditObject(templateObject *datatypes.Network_Bandwidth_Version1_Allotment) (resp bool, err error)

Edit a bandwidth allotment's local properties. Currently you may only change an allotment's name. Use the [[SoftLayer_Network_Bandwidth_Version1_Allotment::setVdrContent|setVdrContent()]] and [[SoftLayer_Network_Bandwidth_Version1_Allotment::requestVdrContentUpdates|requestVdrContentUpdates()]] methods to move servers in and out of your allotments.

func (Network_Bandwidth_Version1_Allotment) Filter 

func (r Network_Bandwidth_Version1_Allotment) Filter(filter string) Network_Bandwidth_Version1_Allotment

func (Network_Bandwidth_Version1_Allotment) GetAccount 

func (r Network_Bandwidth_Version1_Allotment) GetAccount() (resp datatypes.Account, err error)

Retrieve The account associated with this virtual rack.

func (Network_Bandwidth_Version1_Allotment) GetActiveDetails 

func (r Network_Bandwidth_Version1_Allotment) GetActiveDetails() (resp []datatypes.Network_Bandwidth_Version1_Allotment_Detail, err error)

Retrieve The bandwidth allotment detail records associated with this virtual rack.

func (Network_Bandwidth_Version1_Allotment) GetApplicationDeliveryControllers 

func (r Network_Bandwidth_Version1_Allotment) GetApplicationDeliveryControllers() (resp []datatypes.Network_Application_Delivery_Controller, err error)

Retrieve The Application Delivery Controller contained within a virtual rack.

func (Network_Bandwidth_Version1_Allotment) GetAverageDailyPublicBandwidthUsage 

func (r Network_Bandwidth_Version1_Allotment) GetAverageDailyPublicBandwidthUsage() (resp datatypes.Float64, err error)

Retrieve The average daily public bandwidth usage for the current billing cycle.

func (Network_Bandwidth_Version1_Allotment) GetBandwidthAllotmentType 

func (r Network_Bandwidth_Version1_Allotment) GetBandwidthAllotmentType() (resp datatypes.Network_Bandwidth_Version1_Allotment_Type, err error)

Retrieve The bandwidth allotment type of this virtual rack.

func (Network_Bandwidth_Version1_Allotment) GetBandwidthForDateRange 

func (r Network_Bandwidth_Version1_Allotment) GetBandwidthForDateRange(startDate *datatypes.Time, endDate *datatypes.Time) (resp []datatypes.Metric_Tracking_Object_Data, err error)

Retrieve a collection of bandwidth data from an individual public or private network tracking object. Data is ideal if you with to employ your own traffic storage and graphing systems.

func (Network_Bandwidth_Version1_Allotment) GetBareMetalInstances 

func (r Network_Bandwidth_Version1_Allotment) GetBareMetalInstances() (resp []datatypes.Hardware, err error)

Retrieve The bare metal server instances contained within a virtual rack.

func (Network_Bandwidth_Version1_Allotment) GetBillingCycleBandwidthUsage 

func (r Network_Bandwidth_Version1_Allotment) GetBillingCycleBandwidthUsage() (resp []datatypes.Network_Bandwidth_Usage, err error)

Retrieve A virtual rack's raw bandwidth usage data for an account's current billing cycle. One object is returned for each network this server is attached to.

func (Network_Bandwidth_Version1_Allotment) GetBillingCyclePrivateBandwidthUsage 

func (r Network_Bandwidth_Version1_Allotment) GetBillingCyclePrivateBandwidthUsage() (resp datatypes.Network_Bandwidth_Usage, err error)

Retrieve A virtual rack's raw private network bandwidth usage data for an account's current billing cycle.

func (Network_Bandwidth_Version1_Allotment) GetBillingCyclePublicBandwidthUsage 

func (r Network_Bandwidth_Version1_Allotment) GetBillingCyclePublicBandwidthUsage() (resp datatypes.Network_Bandwidth_Usage, err error)

Retrieve A virtual rack's raw public network bandwidth usage data for an account's current billing cycle.

func (Network_Bandwidth_Version1_Allotment) GetBillingCyclePublicUsageTotal 

func (r Network_Bandwidth_Version1_Allotment) GetBillingCyclePublicUsageTotal() (resp uint, err error)

Retrieve The total public bandwidth used in this virtual rack for an account's current billing cycle.

func (Network_Bandwidth_Version1_Allotment) GetBillingItem 

func (r Network_Bandwidth_Version1_Allotment) GetBillingItem() (resp datatypes.Billing_Item, err error)

Retrieve A virtual rack's billing item.

func (Network_Bandwidth_Version1_Allotment) GetCurrentBandwidthSummary 

func (r Network_Bandwidth_Version1_Allotment) GetCurrentBandwidthSummary() (resp datatypes.Metric_Tracking_Object_Bandwidth_Summary, err error)

Retrieve An object that provides commonly used bandwidth summary components for the current billing cycle.

func (Network_Bandwidth_Version1_Allotment) GetDetails 

func (r Network_Bandwidth_Version1_Allotment) GetDetails() (resp []datatypes.Network_Bandwidth_Version1_Allotment_Detail, err error)

Retrieve The bandwidth allotment detail records associated with this virtual rack.

func (Network_Bandwidth_Version1_Allotment) GetHardware 

func (r Network_Bandwidth_Version1_Allotment) GetHardware() (resp []datatypes.Hardware, err error)

Retrieve The hardware contained within a virtual rack.

func (Network_Bandwidth_Version1_Allotment) GetInboundPublicBandwidthUsage 

func (r Network_Bandwidth_Version1_Allotment) GetInboundPublicBandwidthUsage() (resp datatypes.Float64, err error)

Retrieve The total public inbound bandwidth used in this virtual rack for an account's current billing cycle.

func (Network_Bandwidth_Version1_Allotment) GetLocationGroup 

func (r Network_Bandwidth_Version1_Allotment) GetLocationGroup() (resp datatypes.Location_Group, err error)

Retrieve The location group associated with this virtual rack.

func (Network_Bandwidth_Version1_Allotment) GetMetricTrackingObject 

func (r Network_Bandwidth_Version1_Allotment) GetMetricTrackingObject() (resp datatypes.Metric_Tracking_Object, err error)

Retrieve A virtual rack's metric tracking object. This object records all periodic polled data available to this rack.

func (Network_Bandwidth_Version1_Allotment) GetMetricTrackingObjectId 

func (r Network_Bandwidth_Version1_Allotment) GetMetricTrackingObjectId() (resp int, err error)

Retrieve The metric tracking object id for this allotment.

func (Network_Bandwidth_Version1_Allotment) GetObject 

func (r Network_Bandwidth_Version1_Allotment) GetObject() (resp datatypes.Network_Bandwidth_Version1_Allotment, err error)

getObject retrieves the SoftLayer_Network_Bandwidth_Version1_Allotment object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Hardware service. You can only retrieve an allotment associated with the account that your portal user is assigned to.

func (Network_Bandwidth_Version1_Allotment) GetOutboundPublicBandwidthUsage 

func (r Network_Bandwidth_Version1_Allotment) GetOutboundPublicBandwidthUsage() (resp datatypes.Float64, err error)

Retrieve The total public outbound bandwidth used in this virtual rack for an account's current billing cycle.

func (Network_Bandwidth_Version1_Allotment) GetOverBandwidthAllocationFlag 

func (r Network_Bandwidth_Version1_Allotment) GetOverBandwidthAllocationFlag() (resp int, err error)

Retrieve Whether the bandwidth usage for this bandwidth pool for the current billing cycle exceeds the allocation.

func (Network_Bandwidth_Version1_Allotment) GetPrivateNetworkOnlyHardware 

func (r Network_Bandwidth_Version1_Allotment) GetPrivateNetworkOnlyHardware() (resp []datatypes.Hardware, err error)

Retrieve The private network only hardware contained within a virtual rack.

func (Network_Bandwidth_Version1_Allotment) GetProjectedOverBandwidthAllocationFlag 

func (r Network_Bandwidth_Version1_Allotment) GetProjectedOverBandwidthAllocationFlag() (resp int, err error)

Retrieve Whether the bandwidth usage for this bandwidth pool for the current billing cycle is projected to exceed the allocation.

func (Network_Bandwidth_Version1_Allotment) GetProjectedPublicBandwidthUsage 

func (r Network_Bandwidth_Version1_Allotment) GetProjectedPublicBandwidthUsage() (resp datatypes.Float64, err error)

Retrieve The projected public outbound bandwidth for this virtual server for the current billing cycle.

func (Network_Bandwidth_Version1_Allotment) GetServiceProvider 

func (r Network_Bandwidth_Version1_Allotment) GetServiceProvider() (resp datatypes.Service_Provider, err error)

Retrieve

func (Network_Bandwidth_Version1_Allotment) GetTotalBandwidthAllocated 

func (r Network_Bandwidth_Version1_Allotment) GetTotalBandwidthAllocated() (resp uint, err error)

Retrieve The combined allocated bandwidth for all servers in a virtual rack.

func (Network_Bandwidth_Version1_Allotment) GetVdrMemberRecurringFee 

func (r Network_Bandwidth_Version1_Allotment) GetVdrMemberRecurringFee() (resp datatypes.Float64, err error)

Gets the monthly recurring fee of a pooled server.

func (Network_Bandwidth_Version1_Allotment) GetVirtualGuests 

func (r Network_Bandwidth_Version1_Allotment) GetVirtualGuests() (resp []datatypes.Virtual_Guest, err error)

Retrieve The Virtual Server contained within a virtual rack.

func (Network_Bandwidth_Version1_Allotment) Id 

func (r Network_Bandwidth_Version1_Allotment) Id(id int) Network_Bandwidth_Version1_Allotment

func (Network_Bandwidth_Version1_Allotment) Limit 

func (r Network_Bandwidth_Version1_Allotment) Limit(limit int) Network_Bandwidth_Version1_Allotment

func (Network_Bandwidth_Version1_Allotment) Mask 

func (r Network_Bandwidth_Version1_Allotment) Mask(mask string) Network_Bandwidth_Version1_Allotment

func (Network_Bandwidth_Version1_Allotment) Offset 

func (r Network_Bandwidth_Version1_Allotment) Offset(offset int) Network_Bandwidth_Version1_Allotment

func (Network_Bandwidth_Version1_Allotment) ReassignServers 

func (r Network_Bandwidth_Version1_Allotment) ReassignServers(templateObjects []datatypes.Hardware, newAllotmentId *int) (resp bool, err error)

[DEPRECATED] This method will reassign a collection of SoftLayer hardware to a bandwidth allotment Bandwidth Pool. Deprecated: This function has been marked as deprecated.

func (Network_Bandwidth_Version1_Allotment) RequestVdrCancellation 

func (r Network_Bandwidth_Version1_Allotment) RequestVdrCancellation() (resp bool, err error)

This will remove a bandwidth pooling from a customer's allotments by cancelling the billing item. All servers in that allotment will get moved to the account's vpr.

func (Network_Bandwidth_Version1_Allotment) RequestVdrContentUpdates 

func (r Network_Bandwidth_Version1_Allotment) RequestVdrContentUpdates(hardwareToAdd []datatypes.Hardware, hardwareToRemove []datatypes.Hardware, cloudsToAdd []datatypes.Virtual_Guest, cloudsToRemove []datatypes.Virtual_Guest, optionalAllotmentId *int, adcToAdd []datatypes.Network_Application_Delivery_Controller, adcToRemove []datatypes.Network_Application_Delivery_Controller) (resp bool, err error)

This will move servers into a bandwidth pool, removing them from their previous bandwidth pool and optionally remove the bandwidth pool on completion.

func (Network_Bandwidth_Version1_Allotment) SetVdrContent 

func (r Network_Bandwidth_Version1_Allotment) SetVdrContent(hardware []datatypes.Hardware, bareMetalServers []datatypes.Hardware, virtualServerInstance []datatypes.Virtual_Guest, adc []datatypes.Network_Application_Delivery_Controller, optionalAllotmentId *int) (resp bool, err error)

This will update the bandwidth pool to the servers provided. Servers currently in the bandwidth pool not provided on update will be removed. Servers provided on update not currently in the bandwidth pool will be added. If all servers are removed, this removes the bandwidth pool on completion.

func (Network_Bandwidth_Version1_Allotment) UnassignServers 

func (r Network_Bandwidth_Version1_Allotment) UnassignServers(templateObjects []datatypes.Hardware) (resp bool, err error)

[DEPRECATED] This method will reassign a collection of SoftLayer hardware to the virtual private rack Deprecated: This function has been marked as deprecated.

func (Network_Bandwidth_Version1_Allotment) VoidPendingServerMove 

func (r Network_Bandwidth_Version1_Allotment) VoidPendingServerMove(id *int, typ *string) (resp bool, err error)

This method will void a pending server removal from this bandwidth pooling. Pass in the id of the hardware object or virtual guest you wish to update. Assuming that object is currently pending removal from the bandwidth pool at the start of the next billing cycle, the bandwidth pool member status will be restored and the pending cancellation removed.

func (Network_Bandwidth_Version1_Allotment) VoidPendingVdrCancellation 

func (r Network_Bandwidth_Version1_Allotment) VoidPendingVdrCancellation() (resp bool, err error)

This method will void a pending cancellation on a bandwidth pool. Note however any servers that belonged to the rack will have to be restored individually using the method voidPendingServerMove($id, $type).

type Network_Component 

type Network_Component struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetNetworkComponentService 

func GetNetworkComponentService(sess session.SLSession) Network_Component

GetNetworkComponentService returns an instance of the Network_Component SoftLayer service

func (Network_Component) AddNetworkVlanTrunks 

func (r Network_Component) AddNetworkVlanTrunks(networkVlans []datatypes.Network_Vlan) (resp []datatypes.Network_Vlan, err error)

Add VLANs as trunks to a network component. The VLANs given must be assigned to your account and belong to the same pod in which this network component and its hardware reside. The current native VLAN cannot be added as a trunk.

This method should be called on a network component of assigned hardware. A current list of VLAN trunks for a network component on a customer server can be found at 'uplinkComponent->networkVlanTrunks'.

This method returns an array of SoftLayer_Network_Vlans which were added as trunks. Any requested VLANs which are already trunked will be ignored and will not be returned.

Affected VLANs will not yet be operational as trunks on the network upon return of this call, but activation will have been scheduled and should be considered imminent. The trunking records associated with the affected VLANs will maintain an 'isUpdating' value of '1' so long as this is the case.

Note that in the event of an "internal system error" some VLANs may still have been affected and scheduled for activation.

func (Network_Component) ClearNetworkVlanTrunks 

func (r Network_Component) ClearNetworkVlanTrunks() (resp []datatypes.Network_Vlan, err error)

Remove all VLANs currently attached as trunks to this network component.

This method should be called on a network component of assigned hardware. A current list of VLAN trunks for a network component on a customer server can be found at 'uplinkComponent->networkVlanTrunks'.

This method returns an array of SoftLayer_Network_Vlans which will be removed as trunks.

Affected VLANs will not yet be removed as trunks upon return of this call, but deactivation and removal will have been scheduled and should be considered imminent. The trunking records associated with the affected VLANs will maintain an 'isUpdating' value of '1' so long as this is the case.

Note that in the event of a "pending API request" error some VLANs may still have been affected and scheduled for deactivation.

func (Network_Component) Filter 

func (r Network_Component) Filter(filter string) Network_Component

func (Network_Component) GetActiveCommand 

func (r Network_Component) GetActiveCommand() (resp datatypes.Hardware_Component_RemoteManagement_Command_Request, err error)

Retrieve Reboot/power (rebootDefault, rebootSoft, rebootHard, powerOn, powerOff and powerCycle) command currently executing by the server's remote management card.

func (Network_Component) GetDownlinkComponent 

func (r Network_Component) GetDownlinkComponent() (resp datatypes.Network_Component, err error)

Retrieve The network component linking this object to a child device

func (Network_Component) GetDuplexMode 

func (r Network_Component) GetDuplexMode() (resp datatypes.Network_Component_Duplex_Mode, err error)

Retrieve The duplex mode of a network component.

func (Network_Component) GetHardware 

func (r Network_Component) GetHardware() (resp datatypes.Hardware, err error)

Retrieve The hardware that a network component resides in.

func (Network_Component) GetHighAvailabilityFirewallFlag 

func (r Network_Component) GetHighAvailabilityFirewallFlag() (resp bool, err error)

Retrieve

func (Network_Component) GetIpAddressBindings 

func (r Network_Component) GetIpAddressBindings() (resp []datatypes.Network_Component_IpAddress, err error)

Retrieve The records of all IP addresses bound to a network component.

func (Network_Component) GetIpAddresses 

func (r Network_Component) GetIpAddresses() (resp []datatypes.Network_Subnet_IpAddress, err error)

Retrieve

func (Network_Component) GetLastCommand 

func (r Network_Component) GetLastCommand() (resp datatypes.Hardware_Component_RemoteManagement_Command_Request, err error)

Retrieve Last reboot/power (rebootDefault, rebootSoft, rebootHard, powerOn, powerOff and powerCycle) command issued to the server's remote management card.

func (Network_Component) GetMetricTrackingObject 

func (r Network_Component) GetMetricTrackingObject() (resp datatypes.Metric_Tracking_Object, err error)

Retrieve The metric tracking object for this network component.

func (Network_Component) GetNetworkComponentFirewall 

func (r Network_Component) GetNetworkComponentFirewall() (resp datatypes.Network_Component_Firewall, err error)

Retrieve The upstream network component firewall.

func (Network_Component) GetNetworkComponentGroup 

func (r Network_Component) GetNetworkComponentGroup() (resp datatypes.Network_Component_Group, err error)

Retrieve A network component's associated group.

func (Network_Component) GetNetworkHardware 

func (r Network_Component) GetNetworkHardware() (resp []datatypes.Hardware, err error)

Retrieve All network devices in SoftLayer's network hierarchy that this device is connected to.

func (Network_Component) GetNetworkVlan 

func (r Network_Component) GetNetworkVlan() (resp datatypes.Network_Vlan, err error)

Retrieve The VLAN that a network component's subnet is associated with.

func (Network_Component) GetNetworkVlanTrunks 

func (r Network_Component) GetNetworkVlanTrunks() (resp []datatypes.Network_Component_Network_Vlan_Trunk, err error)

Retrieve The VLANs that are trunked to this network component.

func (Network_Component) GetNetworkVlansTrunkable added in v1.1.2 

func (r Network_Component) GetNetworkVlansTrunkable() (resp []datatypes.Network_Vlan, err error)

Retrieve 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.

func (Network_Component) GetObject 

func (r Network_Component) GetObject() (resp datatypes.Network_Component, err error)

no documentation yet

func (Network_Component) GetPortStatistics 

func (r Network_Component) GetPortStatistics() (resp datatypes.Container_Network_Port_Statistic, err error)

**DEPRECATED - This operation will cease to function after April 4th, 2016 and will be removed from v3.2** Retrieve various network statistics. The network statistics are retrieved from the network device using snmpget. Below is a list of statistics retrieved: * Administrative Status * Operational Status * Maximum Transmission Unit * In Octets * Out Octets * In Unicast Packets * Out Unicast Packets * In Multicast Packets * Out Multicast Packets Deprecated: This function has been marked as deprecated.

func (Network_Component) GetPrimaryIpAddressRecord 

func (r Network_Component) GetPrimaryIpAddressRecord() (resp datatypes.Network_Subnet_IpAddress, err error)

Retrieve The primary IPv4 Address record for a network component.

func (Network_Component) GetPrimarySubnet 

func (r Network_Component) GetPrimarySubnet() (resp datatypes.Network_Subnet, err error)

Retrieve The subnet of the primary IP address assigned to this network component.

func (Network_Component) GetPrimaryVersion6IpAddressRecord 

func (r Network_Component) GetPrimaryVersion6IpAddressRecord() (resp datatypes.Network_Subnet_IpAddress, err error)

Retrieve The primary IPv6 Address record for a network component.

func (Network_Component) GetRecentCommands 

func (r Network_Component) GetRecentCommands() (resp []datatypes.Hardware_Component_RemoteManagement_Command_Request, err error)

Retrieve The last five reboot/power (rebootDefault, rebootSoft, rebootHard, powerOn, powerOff and powerCycle) commands issued to the server's remote management card.

func (Network_Component) GetRedundancyCapableFlag 

func (r Network_Component) GetRedundancyCapableFlag() (resp bool, err error)

Retrieve Indicates whether the network component is participating in a group of two or more components capable of being operationally redundant, if enabled.

func (Network_Component) GetRedundancyEnabledFlag 

func (r Network_Component) GetRedundancyEnabledFlag() (resp bool, err error)

Retrieve Indicates whether the network component is participating in a group of two or more components which is actively providing link redundancy.

func (Network_Component) GetRemoteManagementUsers 

func (r Network_Component) GetRemoteManagementUsers() (resp []datatypes.Hardware_Component_RemoteManagement_User, err error)

Retrieve User(s) credentials to issue commands and/or interact with the server's remote management card.

func (Network_Component) GetRouter 

func (r Network_Component) GetRouter() (resp datatypes.Hardware, err error)

Retrieve A network component's routers.

func (Network_Component) GetStorageNetworkFlag 

func (r Network_Component) GetStorageNetworkFlag() (resp bool, err error)

Retrieve Whether a network component's primary ip address is from a storage network subnet or not. [Deprecated]

func (Network_Component) GetSubnets 

func (r Network_Component) GetSubnets() (resp []datatypes.Network_Subnet, err error)

Retrieve A network component's subnets. A subnet is a group of IP addresses

func (Network_Component) GetUplinkComponent 

func (r Network_Component) GetUplinkComponent() (resp datatypes.Network_Component, err error)

Retrieve The network component linking this object to parent

func (Network_Component) GetUplinkDuplexMode 

func (r Network_Component) GetUplinkDuplexMode() (resp datatypes.Network_Component_Duplex_Mode, err error)

Retrieve The duplex mode of the uplink network component linking to this object

func (Network_Component) Id 

func (r Network_Component) Id(id int) Network_Component

func (Network_Component) Limit 

func (r Network_Component) Limit(limit int) Network_Component

func (Network_Component) Mask 

func (r Network_Component) Mask(mask string) Network_Component

func (Network_Component) Offset 

func (r Network_Component) Offset(offset int) Network_Component

func (Network_Component) RemoveNetworkVlanTrunks 

func (r Network_Component) RemoveNetworkVlanTrunks(networkVlans []datatypes.Network_Vlan) (resp []datatypes.Network_Vlan, err error)

Remove one or more VLANs currently attached as trunks to this network component.

If any VLANs are given which are not attached as trunks, they will be ignored.

This method should be called on a network component of assigned hardware. A current list of VLAN trunks for a network component on a customer server can be found at 'uplinkComponent->networkVlanTrunks'.

This method returns an array of SoftLayer_Network_Vlans which will be removed as trunks. Any requested VLANs which were not trunked will be ignored and will not be returned.

Affected VLANs will not yet be removed as trunks upon return of this call, but deactivation and removal will have been scheduled and should be considered imminent. The trunking records associated with the affected VLANs will maintain an 'isUpdating' value of '1' so long as this is the case.

Note that in the event of a "pending API request" error some VLANs may still have been affected and scheduled for deactivation.

type Network_Component_Firewall 

type Network_Component_Firewall struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetNetworkComponentFirewallService 

func GetNetworkComponentFirewallService(sess session.SLSession) Network_Component_Firewall

GetNetworkComponentFirewallService returns an instance of the Network_Component_Firewall SoftLayer service

func (Network_Component_Firewall) Filter 

func (r Network_Component_Firewall) Filter(filter string) Network_Component_Firewall

func (Network_Component_Firewall) GetApplyServerRuleSubnets 

func (r Network_Component_Firewall) GetApplyServerRuleSubnets() (resp []datatypes.Network_Subnet, err error)

Retrieve The additional subnets linked to this network component firewall, that inherit rules from the host that the context slot is attached to.

func (Network_Component_Firewall) GetBillingItem 

func (r Network_Component_Firewall) GetBillingItem() (resp datatypes.Billing_Item, err error)

Retrieve The billing item for a Hardware Firewall (Dedicated).

func (Network_Component_Firewall) GetGuestNetworkComponent 

func (r Network_Component_Firewall) GetGuestNetworkComponent() (resp datatypes.Virtual_Guest_Network_Component, err error)

Retrieve The network component of the guest virtual server that this network component firewall belongs to.

func (Network_Component_Firewall) GetNetworkComponent 

func (r Network_Component_Firewall) GetNetworkComponent() (resp datatypes.Network_Component, err error)

Retrieve The network component of the switch interface that this network component firewall belongs to.

func (Network_Component_Firewall) GetNetworkFirewallUpdateRequest 

func (r Network_Component_Firewall) GetNetworkFirewallUpdateRequest() (resp []datatypes.Network_Firewall_Update_Request, err error)

Retrieve The update requests made for this firewall.

func (Network_Component_Firewall) GetObject 

func (r Network_Component_Firewall) GetObject() (resp datatypes.Network_Component_Firewall, err error)

getObject returns a SoftLayer_Network_Firewall_Module_Context_Interface_AccessControlList_Network_Component object. You can only get objects for servers attached to your account that have a network firewall enabled.

func (Network_Component_Firewall) GetRules 

func (r Network_Component_Firewall) GetRules() (resp []datatypes.Network_Component_Firewall_Rule, err error)

Retrieve The currently running rule set of this network component firewall.

func (Network_Component_Firewall) GetSubnets 

func (r Network_Component_Firewall) GetSubnets() (resp []datatypes.Network_Subnet, err error)

Retrieve The additional subnets linked to this network component firewall.

func (Network_Component_Firewall) HasActiveTransactions added in v1.0.4 

func (r Network_Component_Firewall) HasActiveTransactions() (resp bool, err error)

Check for active transactions for the shared Firewall.

func (Network_Component_Firewall) Id 

func (r Network_Component_Firewall) Id(id int) Network_Component_Firewall

func (Network_Component_Firewall) Limit 

func (r Network_Component_Firewall) Limit(limit int) Network_Component_Firewall

func (Network_Component_Firewall) Mask 

func (r Network_Component_Firewall) Mask(mask string) Network_Component_Firewall

func (Network_Component_Firewall) Offset 

func (r Network_Component_Firewall) Offset(offset int) Network_Component_Firewall

type Network_Customer_Subnet 

type Network_Customer_Subnet struct {
	Session session.SLSession
	Options sl.Options
}

DEPRECATED Deprecated: This function has been marked as deprecated.

func GetNetworkCustomerSubnetService 

func GetNetworkCustomerSubnetService(sess session.SLSession) Network_Customer_Subnet

GetNetworkCustomerSubnetService returns an instance of the Network_Customer_Subnet SoftLayer service

func (Network_Customer_Subnet) CreateObject 

func (r Network_Customer_Subnet) CreateObject(templateObject *datatypes.Network_Customer_Subnet) (resp datatypes.Network_Customer_Subnet, err error)

DEPRECATED

func (Network_Customer_Subnet) Filter 

func (r Network_Customer_Subnet) Filter(filter string) Network_Customer_Subnet

func (Network_Customer_Subnet) GetIpAddresses 

func (r Network_Customer_Subnet) GetIpAddresses() (resp []datatypes.Network_Customer_Subnet_IpAddress, err error)

Retrieve All ip addresses associated with a subnet.

func (Network_Customer_Subnet) GetObject 

func (r Network_Customer_Subnet) GetObject() (resp datatypes.Network_Customer_Subnet, err error)

DEPRECATED

func (Network_Customer_Subnet) Id 

func (r Network_Customer_Subnet) Id(id int) Network_Customer_Subnet

func (Network_Customer_Subnet) Limit 

func (r Network_Customer_Subnet) Limit(limit int) Network_Customer_Subnet

func (Network_Customer_Subnet) Mask 

func (r Network_Customer_Subnet) Mask(mask string) Network_Customer_Subnet

func (Network_Customer_Subnet) Offset 

func (r Network_Customer_Subnet) Offset(offset int) Network_Customer_Subnet
type Network_DirectLink_Location struct {
	Session session.SLSession
	Options sl.Options
}

The SoftLayer_Network_DirectLink_Location presents a structure containing attributes of a Direct Link location, and its related object SoftLayer location.

func GetNetworkDirectLinkLocationService 

func GetNetworkDirectLinkLocationService(sess session.SLSession) Network_DirectLink_Location

GetNetworkDirectLinkLocationService returns an instance of the Network_DirectLink_Location SoftLayer service 

func (r Network_DirectLink_Location) Filter(filter string) Network_DirectLink_Location
func (r Network_DirectLink_Location) GetAllObjects() (resp []datatypes.Network_DirectLink_Location, err error)

Return all existing Direct Link location. 

func (r Network_DirectLink_Location) GetLocation() (resp datatypes.Location, err error)

Retrieve The location of Direct Link facility. 

func (r Network_DirectLink_Location) GetObject() (resp datatypes.Network_DirectLink_Location, err error)

no documentation yet 

func (r Network_DirectLink_Location) GetProvider() (resp datatypes.Network_DirectLink_Provider, err error)

Retrieve The Id of Direct Link provider. 

func (r Network_DirectLink_Location) GetServiceType() (resp datatypes.Network_DirectLink_ServiceType, err error)

Retrieve The Id of Direct Link service type. 

func (r Network_DirectLink_Location) Id(id int) Network_DirectLink_Location
func (r Network_DirectLink_Location) Limit(limit int) Network_DirectLink_Location
func (r Network_DirectLink_Location) Mask(mask string) Network_DirectLink_Location
func (r Network_DirectLink_Location) Offset(offset int) Network_DirectLink_Location
type Network_DirectLink_Provider struct {
	Session session.SLSession
	Options sl.Options
}

The SoftLayer_Network_DirectLink_Provider presents a structure containing attributes of a Direct Link provider.

func GetNetworkDirectLinkProviderService 

func GetNetworkDirectLinkProviderService(sess session.SLSession) Network_DirectLink_Provider

GetNetworkDirectLinkProviderService returns an instance of the Network_DirectLink_Provider SoftLayer service 

func (r Network_DirectLink_Provider) Filter(filter string) Network_DirectLink_Provider
func (r Network_DirectLink_Provider) GetObject() (resp datatypes.Network_DirectLink_Provider, err error)

no documentation yet 

func (r Network_DirectLink_Provider) Id(id int) Network_DirectLink_Provider
func (r Network_DirectLink_Provider) Limit(limit int) Network_DirectLink_Provider
func (r Network_DirectLink_Provider) Mask(mask string) Network_DirectLink_Provider
func (r Network_DirectLink_Provider) Offset(offset int) Network_DirectLink_Provider
type Network_DirectLink_ServiceType struct {
	Session session.SLSession
	Options sl.Options
}

The SoftLayer_Network_DirectLink_ServiceType presents a structure containing attributes of a Direct Link Service Type.

func GetNetworkDirectLinkServiceTypeService 

func GetNetworkDirectLinkServiceTypeService(sess session.SLSession) Network_DirectLink_ServiceType

GetNetworkDirectLinkServiceTypeService returns an instance of the Network_DirectLink_ServiceType SoftLayer service 

func (r Network_DirectLink_ServiceType) Filter(filter string) Network_DirectLink_ServiceType
func (r Network_DirectLink_ServiceType) GetObject() (resp datatypes.Network_DirectLink_ServiceType, err error)

no documentation yet 

func (r Network_DirectLink_ServiceType) Id(id int) Network_DirectLink_ServiceType
func (r Network_DirectLink_ServiceType) Limit(limit int) Network_DirectLink_ServiceType
func (r Network_DirectLink_ServiceType) Mask(mask string) Network_DirectLink_ServiceType
func (r Network_DirectLink_ServiceType) Offset(offset int) Network_DirectLink_ServiceType

type Network_Firewall_AccessControlList 

type Network_Firewall_AccessControlList struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetNetworkFirewallAccessControlListService 

func GetNetworkFirewallAccessControlListService(sess session.SLSession) Network_Firewall_AccessControlList

GetNetworkFirewallAccessControlListService returns an instance of the Network_Firewall_AccessControlList SoftLayer service

func (Network_Firewall_AccessControlList) Filter 

func (r Network_Firewall_AccessControlList) Filter(filter string) Network_Firewall_AccessControlList

func (Network_Firewall_AccessControlList) GetNetworkFirewallUpdateRequests 

func (r Network_Firewall_AccessControlList) GetNetworkFirewallUpdateRequests() (resp []datatypes.Network_Firewall_Update_Request, err error)

Retrieve The update requests made for this firewall.

func (Network_Firewall_AccessControlList) GetNetworkVlan 

func (r Network_Firewall_AccessControlList) GetNetworkVlan() (resp datatypes.Network_Vlan, err error)

Retrieve

func (Network_Firewall_AccessControlList) GetObject 

func (r Network_Firewall_AccessControlList) GetObject() (resp datatypes.Network_Firewall_AccessControlList, err error)

getObject returns a SoftLayer_Network_Firewall_AccessControlList object. You can only get objects for servers attached to your account that have a network firewall enabled.

func (Network_Firewall_AccessControlList) GetRules 

func (r Network_Firewall_AccessControlList) GetRules() (resp []datatypes.Network_Vlan_Firewall_Rule, err error)

Retrieve The currently running rule set of this context access control list firewall.

func (Network_Firewall_AccessControlList) Id 

func (r Network_Firewall_AccessControlList) Id(id int) Network_Firewall_AccessControlList

func (Network_Firewall_AccessControlList) Limit 

func (r Network_Firewall_AccessControlList) Limit(limit int) Network_Firewall_AccessControlList

func (Network_Firewall_AccessControlList) Mask 

func (r Network_Firewall_AccessControlList) Mask(mask string) Network_Firewall_AccessControlList

func (Network_Firewall_AccessControlList) Offset 

func (r Network_Firewall_AccessControlList) Offset(offset int) Network_Firewall_AccessControlList

type Network_Firewall_Interface 

type Network_Firewall_Interface struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetNetworkFirewallInterfaceService 

func GetNetworkFirewallInterfaceService(sess session.SLSession) Network_Firewall_Interface

GetNetworkFirewallInterfaceService returns an instance of the Network_Firewall_Interface SoftLayer service

func (Network_Firewall_Interface) Filter 

func (r Network_Firewall_Interface) Filter(filter string) Network_Firewall_Interface

func (Network_Firewall_Interface) GetFirewallContextAccessControlLists 

func (r Network_Firewall_Interface) GetFirewallContextAccessControlLists() (resp []datatypes.Network_Firewall_AccessControlList, err error)

Retrieve

func (Network_Firewall_Interface) GetNetworkVlan 

func (r Network_Firewall_Interface) GetNetworkVlan() (resp datatypes.Network_Vlan, err error)

Retrieve

func (Network_Firewall_Interface) GetObject 

func (r Network_Firewall_Interface) GetObject() (resp datatypes.Network_Firewall_Interface, err error)

getObject returns a SoftLayer_Network_Firewall_Interface object. You can only get objects for servers attached to your account that have a network firewall enabled.

func (Network_Firewall_Interface) Id 

func (r Network_Firewall_Interface) Id(id int) Network_Firewall_Interface

func (Network_Firewall_Interface) Limit 

func (r Network_Firewall_Interface) Limit(limit int) Network_Firewall_Interface

func (Network_Firewall_Interface) Mask 

func (r Network_Firewall_Interface) Mask(mask string) Network_Firewall_Interface

func (Network_Firewall_Interface) Offset 

func (r Network_Firewall_Interface) Offset(offset int) Network_Firewall_Interface

type Network_Firewall_Module_Context_Interface 

type Network_Firewall_Module_Context_Interface struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetNetworkFirewallModuleContextInterfaceService 

func GetNetworkFirewallModuleContextInterfaceService(sess session.SLSession) Network_Firewall_Module_Context_Interface

GetNetworkFirewallModuleContextInterfaceService returns an instance of the Network_Firewall_Module_Context_Interface SoftLayer service

func (Network_Firewall_Module_Context_Interface) Filter 

func (r Network_Firewall_Module_Context_Interface) Filter(filter string) Network_Firewall_Module_Context_Interface

func (Network_Firewall_Module_Context_Interface) GetFirewallContextAccessControlLists 

func (r Network_Firewall_Module_Context_Interface) GetFirewallContextAccessControlLists() (resp []datatypes.Network_Firewall_AccessControlList, err error)

Retrieve

func (Network_Firewall_Module_Context_Interface) GetNetworkVlan 

func (r Network_Firewall_Module_Context_Interface) GetNetworkVlan() (resp datatypes.Network_Vlan, err error)

Retrieve

func (Network_Firewall_Module_Context_Interface) GetObject 

func (r Network_Firewall_Module_Context_Interface) GetObject() (resp datatypes.Network_Firewall_Module_Context_Interface, err error)

no documentation yet

func (Network_Firewall_Module_Context_Interface) Id 

func (r Network_Firewall_Module_Context_Interface) Id(id int) Network_Firewall_Module_Context_Interface

func (Network_Firewall_Module_Context_Interface) Limit 

func (r Network_Firewall_Module_Context_Interface) Limit(limit int) Network_Firewall_Module_Context_Interface

func (Network_Firewall_Module_Context_Interface) Mask 

func (r Network_Firewall_Module_Context_Interface) Mask(mask string) Network_Firewall_Module_Context_Interface

func (Network_Firewall_Module_Context_Interface) Offset 

func (r Network_Firewall_Module_Context_Interface) Offset(offset int) Network_Firewall_Module_Context_Interface

type Network_Firewall_Template 

type Network_Firewall_Template struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetNetworkFirewallTemplateService 

func GetNetworkFirewallTemplateService(sess session.SLSession) Network_Firewall_Template

GetNetworkFirewallTemplateService returns an instance of the Network_Firewall_Template SoftLayer service

func (Network_Firewall_Template) Filter 

func (r Network_Firewall_Template) Filter(filter string) Network_Firewall_Template

func (Network_Firewall_Template) GetAllObjects 

func (r Network_Firewall_Template) GetAllObjects() (resp []datatypes.Network_Firewall_Template, err error)

Get all available firewall template objects.

”getAllObjects” returns an array of SoftLayer_Network_Firewall_Template objects upon success.

func (Network_Firewall_Template) GetObject 

func (r Network_Firewall_Template) GetObject() (resp datatypes.Network_Firewall_Template, err error)

getObject returns a SoftLayer_Network_Firewall_Template object. You can retrieve all available firewall templates. getAllObjects returns an array of all available SoftLayer_Network_Firewall_Template objects. You can use these templates to generate a [[SoftLayer Network Firewall Update Request]].

@SLDNDocumentation Service See Also SoftLayer_Network_Firewall_Update_Request

func (Network_Firewall_Template) GetRules 

func (r Network_Firewall_Template) GetRules() (resp []datatypes.Network_Firewall_Template_Rule, err error)

Retrieve The rule set that belongs to this firewall rules template.

func (Network_Firewall_Template) Id 

func (r Network_Firewall_Template) Id(id int) Network_Firewall_Template

func (Network_Firewall_Template) Limit 

func (r Network_Firewall_Template) Limit(limit int) Network_Firewall_Template

func (Network_Firewall_Template) Mask 

func (r Network_Firewall_Template) Mask(mask string) Network_Firewall_Template

func (Network_Firewall_Template) Offset 

func (r Network_Firewall_Template) Offset(offset int) Network_Firewall_Template

type Network_Firewall_Update_Request 

type Network_Firewall_Update_Request struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetNetworkFirewallUpdateRequestService 

func GetNetworkFirewallUpdateRequestService(sess session.SLSession) Network_Firewall_Update_Request

GetNetworkFirewallUpdateRequestService returns an instance of the Network_Firewall_Update_Request SoftLayer service

func (Network_Firewall_Update_Request) CreateObject 

func (r Network_Firewall_Update_Request) CreateObject(templateObject *datatypes.Network_Firewall_Update_Request) (resp datatypes.Network_Firewall_Update_Request, err error)

Create a new firewall update request. If the SoftLayer_Network_Firewall_Update_Request object passed to this function has no rule, the firewall be set to bypass state and all the existing firewall rule(s) will be deleted.

”createObject” returns a Boolean ”true” on successful object creation or ”false” if your firewall update request was unable to be created.

func (Network_Firewall_Update_Request) Filter 

func (r Network_Firewall_Update_Request) Filter(filter string) Network_Firewall_Update_Request

func (Network_Firewall_Update_Request) GetAuthorizingUser 

func (r Network_Firewall_Update_Request) GetAuthorizingUser() (resp datatypes.User_Interface, err error)

Retrieve The user that authorized this firewall update request.

func (Network_Firewall_Update_Request) GetFirewallUpdateRequestRuleAttributes 

func (r Network_Firewall_Update_Request) GetFirewallUpdateRequestRuleAttributes() (resp datatypes.Container_Utility_Network_Firewall_Rule_Attribute, err error)

Get the possible attribute values for a firewall update request rule. These are the valid values which may be submitted as rule parameters for a firewall update request.

”getFirewallUpdateRequestRuleAttributes” returns a SoftLayer_Container_Utility_Network_Firewall_Rule_Attribute object upon success.

func (Network_Firewall_Update_Request) GetGuest 

func (r Network_Firewall_Update_Request) GetGuest() (resp datatypes.Virtual_Guest, err error)

Retrieve The downstream virtual server that the rule set will be applied to.

func (Network_Firewall_Update_Request) GetHardware 

func (r Network_Firewall_Update_Request) GetHardware() (resp datatypes.Hardware, err error)

Retrieve The downstream server that the rule set will be applied to.

func (Network_Firewall_Update_Request) GetNetworkComponentFirewall 

func (r Network_Firewall_Update_Request) GetNetworkComponentFirewall() (resp datatypes.Network_Component_Firewall, err error)

Retrieve The network component firewall that the rule set will be applied to.

func (Network_Firewall_Update_Request) GetObject 

func (r Network_Firewall_Update_Request) GetObject() (resp datatypes.Network_Firewall_Update_Request, err error)

”getObject” returns a SoftLayer_Network_Firewall_Update_Request object. You can only get historical objects for servers attached to your account that have a network firewall enabled. ”createObject” inserts a new SoftLayer_Network_Firewall_Update_Request object. You can only insert requests for servers attached to your account that have a network firewall enabled. ”getFirewallUpdateRequestRuleAttributes” Get the possible attribute values for a firewall update request rule.

func (Network_Firewall_Update_Request) GetRules 

func (r Network_Firewall_Update_Request) GetRules() (resp []datatypes.Network_Firewall_Update_Request_Rule, err error)

Retrieve The group of rules contained within the update request.

func (Network_Firewall_Update_Request) Id 

func (r Network_Firewall_Update_Request) Id(id int) Network_Firewall_Update_Request

func (Network_Firewall_Update_Request) Limit 

func (r Network_Firewall_Update_Request) Limit(limit int) Network_Firewall_Update_Request

func (Network_Firewall_Update_Request) Mask 

func (r Network_Firewall_Update_Request) Mask(mask string) Network_Firewall_Update_Request

func (Network_Firewall_Update_Request) Offset 

func (r Network_Firewall_Update_Request) Offset(offset int) Network_Firewall_Update_Request

func (Network_Firewall_Update_Request) UpdateRuleNote 

func (r Network_Firewall_Update_Request) UpdateRuleNote(fwRule *datatypes.Network_Component_Firewall_Rule, note *string) (resp bool, err error)

no documentation yet

type Network_Firewall_Update_Request_Rule 

type Network_Firewall_Update_Request_Rule struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetNetworkFirewallUpdateRequestRuleService 

func GetNetworkFirewallUpdateRequestRuleService(sess session.SLSession) Network_Firewall_Update_Request_Rule

GetNetworkFirewallUpdateRequestRuleService returns an instance of the Network_Firewall_Update_Request_Rule SoftLayer service

func (Network_Firewall_Update_Request_Rule) CreateObject 

func (r Network_Firewall_Update_Request_Rule) CreateObject(templateObject *datatypes.Network_Firewall_Update_Request_Rule) (resp datatypes.Network_Firewall_Update_Request_Rule, err error)

Create a new firewall update request. The SoftLayer_Network_Firewall_Update_Request object passed to this function must have at least one rule.

”createObject” returns a Boolean ”true” on successful object creation or ”false” if your firewall update request was unable to be created..

func (Network_Firewall_Update_Request_Rule) Filter 

func (r Network_Firewall_Update_Request_Rule) Filter(filter string) Network_Firewall_Update_Request_Rule

func (Network_Firewall_Update_Request_Rule) GetFirewallUpdateRequest 

func (r Network_Firewall_Update_Request_Rule) GetFirewallUpdateRequest() (resp datatypes.Network_Firewall_Update_Request, err error)

Retrieve The update request that this rule belongs to.

func (Network_Firewall_Update_Request_Rule) GetObject 

func (r Network_Firewall_Update_Request_Rule) GetObject() (resp datatypes.Network_Firewall_Update_Request_Rule, err error)

getObject returns a SoftLayer_Network_Firewall_Update_Request_Rule object. You can only get historical objects for servers attached to your account that have a network firewall enabled. createObject inserts a new SoftLayer_Network_Firewall_Update_Request_Rule object. Use the SoftLayer_Network_Firewall_Update_Request to create groups of rules for an update request.

func (Network_Firewall_Update_Request_Rule) Id 

func (r Network_Firewall_Update_Request_Rule) Id(id int) Network_Firewall_Update_Request_Rule

func (Network_Firewall_Update_Request_Rule) Limit 

func (r Network_Firewall_Update_Request_Rule) Limit(limit int) Network_Firewall_Update_Request_Rule

func (Network_Firewall_Update_Request_Rule) Mask 

func (r Network_Firewall_Update_Request_Rule) Mask(mask string) Network_Firewall_Update_Request_Rule

func (Network_Firewall_Update_Request_Rule) Offset 

func (r Network_Firewall_Update_Request_Rule) Offset(offset int) Network_Firewall_Update_Request_Rule

func (Network_Firewall_Update_Request_Rule) ValidateRule 

func (r Network_Firewall_Update_Request_Rule) ValidateRule(rule *datatypes.Network_Firewall_Update_Request_Rule, applyToComponentId *int, applyToAclId *int) (err error)

Validate the supplied firewall request rule against the object it will apply to. For IPv4 rules, pass in an instance of SoftLayer_Network_Firewall_Update_Request_Rule. for IPv6 rules, pass in an instance of SoftLayer_Network_Firewall_Update_Request_Rule_Version6. The ID of the applied to object can either be applyToComponentId (an ID of a SoftLayer_Network_Component_Firewall) or applyToAclId (an ID of a SoftLayer_Network_Firewall_Module_Context_Interface_AccessControlList). One, and only one, of applyToComponentId and applyToAclId can be specified.

If validation is successful, nothing is returned. If validation is unsuccessful, an exception is thrown explaining the nature of the validation error.

type Network_Gateway 

type Network_Gateway struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetNetworkGatewayService 

func GetNetworkGatewayService(sess session.SLSession) Network_Gateway

GetNetworkGatewayService returns an instance of the Network_Gateway SoftLayer service

func (Network_Gateway) BypassAllVlans 

func (r Network_Gateway) BypassAllVlans() (err error)

Start the asynchronous process to bypass all VLANs. Any VLANs that are already bypassed will be ignored. The status field can be checked for progress.

func (Network_Gateway) BypassVlans 

func (r Network_Gateway) BypassVlans(vlans []datatypes.Network_Gateway_Vlan) (err error)

Start the asynchronous process to bypass the provided VLANs. The VLANs must already be attached. Any VLANs that are already bypassed will be ignored. The status field can be checked for progress.

func (Network_Gateway) Filter 

func (r Network_Gateway) Filter(filter string) Network_Gateway

func (Network_Gateway) ForceRebuildCluster added in v1.1.3 

func (r Network_Gateway) ForceRebuildCluster(osPriceId *int) (resp bool, err error)

Purpose is to rebuild the target Gateway cluster with the specified OS price id. Method will remove the current OS and apply the default configuration settings. This will result in an extended OUTAGE!! Any custom configuration settings must be re-applied after the forced rebuild is completed. This is a DESTRUCTIVE action, use with caution.

func (Network_Gateway) GetAccount 

func (r Network_Gateway) GetAccount() (resp datatypes.Account, err error)

Retrieve The account for this gateway.

func (Network_Gateway) GetAllowedOsPriceIds added in v1.0.2 

func (r Network_Gateway) GetAllowedOsPriceIds(memberId *int) (resp []int, err error)

Used to get a list of OS prices (ids) which are allowed for the Gateway.

func (Network_Gateway) GetCapacity 

func (r Network_Gateway) GetCapacity() (resp string, err error)

Returns the Gbps capacity of the gateway object

func (Network_Gateway) GetInsideVlans 

func (r Network_Gateway) GetInsideVlans() (resp []datatypes.Network_Gateway_Vlan, err error)

Retrieve All VLANs trunked to this gateway.

func (Network_Gateway) GetManufacturer 

func (r Network_Gateway) GetManufacturer(checkSameOs *bool, checkOsReloadMember *bool) (resp string, err error)

Returns manufacturer name for a given gateway object.

func (Network_Gateway) GetMemberGatewayImagesMatch added in v1.0.1 

func (r Network_Gateway) GetMemberGatewayImagesMatch() (resp bool, err error)

Returns true if no mismatch is found, gateway is not Juniper vSRX or SA gateway

func (Network_Gateway) GetMembers 

func (r Network_Gateway) GetMembers() (resp []datatypes.Network_Gateway_Member, err error)

Retrieve The members for this gateway.

func (Network_Gateway) GetNetworkFirewall 

func (r Network_Gateway) GetNetworkFirewall() (resp datatypes.Network_Vlan_Firewall, err error)

Retrieve The firewall associated with this gateway, if any.

func (Network_Gateway) GetNetworkFirewallFlag 

func (r Network_Gateway) GetNetworkFirewallFlag() (resp bool, err error)

Retrieve Whether or not there is a firewall associated with this gateway.

func (Network_Gateway) GetObject 

func (r Network_Gateway) GetObject() (resp datatypes.Network_Gateway, err error)

no documentation yet

func (Network_Gateway) GetPossibleInsideVlans 

func (r Network_Gateway) GetPossibleInsideVlans() (resp []datatypes.Network_Vlan, err error)

Get all VLANs that can become inside VLANs on this gateway. This means the VLAN must not already be an inside VLAN, on the same router as this gateway, not a gateway transit VLAN, and not firewalled.

func (Network_Gateway) GetPrivateIpAddress 

func (r Network_Gateway) GetPrivateIpAddress() (resp datatypes.Network_Subnet_IpAddress, err error)

Retrieve The private gateway IP address.

func (Network_Gateway) GetPrivateVlan 

func (r Network_Gateway) GetPrivateVlan() (resp datatypes.Network_Vlan, err error)

Retrieve The private VLAN for accessing this gateway.

func (Network_Gateway) GetPublicIpAddress 

func (r Network_Gateway) GetPublicIpAddress() (resp datatypes.Network_Subnet_IpAddress, err error)

Retrieve The public gateway IP address.

func (Network_Gateway) GetPublicIpv6Address 

func (r Network_Gateway) GetPublicIpv6Address() (resp datatypes.Network_Subnet_IpAddress, err error)

Retrieve The public gateway IPv6 address.

func (Network_Gateway) GetPublicVlan 

func (r Network_Gateway) GetPublicVlan() (resp datatypes.Network_Vlan, err error)

Retrieve The public VLAN for accessing this gateway.

func (Network_Gateway) GetRollbackSupport added in v1.0.2 

func (r Network_Gateway) GetRollbackSupport() (resp string, err error)

Returns the following statuses SUPPORTED - rollback is supported and perform automatically UNSUPPORTED - rollback is not supported MANUAL - rollback can be performed but

func (Network_Gateway) GetStatus 

func (r Network_Gateway) GetStatus() (resp datatypes.Network_Gateway_Status, err error)

Retrieve The current status of the gateway.

func (Network_Gateway) GetUpgradeItemPrices added in v1.0.1 

func (r Network_Gateway) GetUpgradeItemPrices() (resp []datatypes.Product_Item_Price, err error)

Retrieve a list of upgradable items available for network gateways.

func (Network_Gateway) Id 

func (r Network_Gateway) Id(id int) Network_Gateway

func (Network_Gateway) IsLicenseServerAllowed added in v1.0.2 

func (r Network_Gateway) IsLicenseServerAllowed(licenseKeyName *string) (resp bool, err error)

no documentation yet

func (Network_Gateway) Limit 

func (r Network_Gateway) Limit(limit int) Network_Gateway

func (Network_Gateway) ManageLicenses added in v1.1.3 

func (r Network_Gateway) ManageLicenses(requiredItemKeyName *string, addOnLicenses *string) (resp bool, err error)

Used to manage gateway require and add on licenses. If license request is valid for the gateway type a Gateway License Manage process will be created if licenses need to be adjusted on the gateway.

requiredItemKeyname - Item Key Name of the required license to be used on the gateway addOnLicenses - Json string containing an Add On license Item Key Name and requested total quantity to exist on each gateway member. Item Key Name must be associated with an Add On license product item and Item Key Name can only exist once in the json structure.

Example : {"ADD_ON_ITEM_KEYNAME_TYPE1":3,"ADD_ON_ITEM_KEYNAME_TYPE2":4}

Note, the quantity is not the requested change but total licences. For example, if current licenses for an Add On e.g. Remote VPN is 3 and the request is to add 1 more license then the quantity would be 4. If the request was to remove 1 license then the quantity would be 2.

func (Network_Gateway) Mask 

func (r Network_Gateway) Mask(mask string) Network_Gateway

func (Network_Gateway) Offset 

func (r Network_Gateway) Offset(offset int) Network_Gateway

func (Network_Gateway) RebuildHACluster added in v1.1.3 

func (r Network_Gateway) RebuildHACluster() (resp bool, err error)

Rebuild a virtual gateway with HA cluster by destroying existing member gateway os and installing new os on both gateway members, then creating HA cluster between 2 members. This is a destructive process which will remove existing configuration and stop all gateway capabilities. vSRX will need to be re-configured after this operation.

func (Network_Gateway) RebuildvSRXHACluster 

func (r Network_Gateway) RebuildvSRXHACluster() (resp bool, err error)

Rebuild a vSRX gateway with HA cluster by destroying existing vSRX and installing new vSRX on both gateway servers, then creating HA cluster between 2 vSRX. This is a destructive process which will remove existing vSRX configuration and stop all gateway capabilities. vSRX will need to be re-configured after this operation.

func (Network_Gateway) RefreshGatewayLicense added in v1.0.4 

func (r Network_Gateway) RefreshGatewayLicense() (resp bool, err error)

Used to refresh the all licenses (Required and add ons) for Virtual gateways. License precheck must be ready.

func (Network_Gateway) Rename added in v1.1.3 

func (r Network_Gateway) Rename(name *string) (resp bool, err error)

Edit the name of this gateway.

func (Network_Gateway) SetGatewayPassword added in v1.0.1 

func (r Network_Gateway) SetGatewayPassword(password *string) (resp bool, err error)

Returns true if password change is successful, false if not successful

func (Network_Gateway) UnbypassAllVlans 

func (r Network_Gateway) UnbypassAllVlans() (err error)

Start the asynchronous process to unbypass all VLANs. Any VLANs that are already unbypassed will be ignored. The status field can be checked for progress.

func (Network_Gateway) UnbypassVlans 

func (r Network_Gateway) UnbypassVlans(vlans []datatypes.Network_Gateway_Vlan) (err error)

Start the asynchronous process to unbypass the provided VLANs. The VLANs must already be attached. Any VLANs that are already unbypassed will be ignored. The status field can be checked for progress.

func (Network_Gateway) UpdateGatewayUserPassword added in v1.0.5 

func (r Network_Gateway) UpdateGatewayUserPassword(record *datatypes.Network_Gateway_Member_Passwords) (resp bool, err error)

The method updates the Gateway password for the provided username. It does not perform any synchronization with the Gateway to update the credentials. The method only updates the IMS db with the username / password record for the Gateway.

The 'username' and 'password' in the record template are required. 'username' must not be blank and must exist in the Gateway password records 'password' must not be blank

Returns true if password change is successful, false if not successful

type Network_Gateway_Member 

type Network_Gateway_Member struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetNetworkGatewayMemberService 

func GetNetworkGatewayMemberService(sess session.SLSession) Network_Gateway_Member

GetNetworkGatewayMemberService returns an instance of the Network_Gateway_Member SoftLayer service

func (Network_Gateway_Member) CreateObject 

func (r Network_Gateway_Member) CreateObject(templateObject *datatypes.Network_Gateway_Member) (resp datatypes.Network_Gateway_Member, err error)

Create a new hardware member on the gateway. This also asynchronously sets up the network for this member. Progress of this process can be monitored via the gateway status. All members created with this object must have no VLANs attached.

func (Network_Gateway_Member) CreateObjects 

func (r Network_Gateway_Member) CreateObjects(templateObjects []datatypes.Network_Gateway_Member) (resp []datatypes.Network_Gateway_Member, err error)

Create multiple new hardware members on the gateway. This also asynchronously sets up the network for the members. Progress of this process can be monitored via the gateway status. All members created with this object must have no VLANs attached.

func (Network_Gateway_Member) EditObject added in v1.1.3 

func (r Network_Gateway_Member) EditObject(templateObject *datatypes.Network_Gateway_Member) (resp bool, err error)

Edit this member, only manufacturer and version can be changed

func (Network_Gateway_Member) Filter 

func (r Network_Gateway_Member) Filter(filter string) Network_Gateway_Member

func (Network_Gateway_Member) GetAttributes 

func (r Network_Gateway_Member) GetAttributes() (resp datatypes.Network_Gateway_Member_Attribute, err error)

Retrieve The attributes for this member.

func (Network_Gateway_Member) GetGatewaySoftwareDescription added in v1.1.3 

func (r Network_Gateway_Member) GetGatewaySoftwareDescription() (resp datatypes.Software_Description, err error)

Retrieve The gateway software description for the member.

func (Network_Gateway_Member) GetHardware 

func (r Network_Gateway_Member) GetHardware() (resp datatypes.Hardware, err error)

Retrieve The device for this member.

func (Network_Gateway_Member) GetLicenses added in v1.0.6 

func (r Network_Gateway_Member) GetLicenses() (resp []datatypes.Network_Gateway_Member_Licenses, err error)

Retrieve The gateway licenses for this member.

func (Network_Gateway_Member) GetNetworkGateway 

func (r Network_Gateway_Member) GetNetworkGateway() (resp datatypes.Network_Gateway, err error)

Retrieve The gateway this member belongs to.

func (Network_Gateway_Member) GetObject 

func (r Network_Gateway_Member) GetObject() (resp datatypes.Network_Gateway_Member, err error)

no documentation yet

func (Network_Gateway_Member) GetPasswords added in v1.0.5 

func (r Network_Gateway_Member) GetPasswords() (resp []datatypes.Network_Gateway_Member_Passwords, err error)

Retrieve The gateway passwords for this member.

func (Network_Gateway_Member) GetPublicIpAddress added in v1.1.3 

func (r Network_Gateway_Member) GetPublicIpAddress() (resp datatypes.Network_Subnet_IpAddress, err error)

Retrieve The public gateway IP address.

func (Network_Gateway_Member) Id 

func (r Network_Gateway_Member) Id(id int) Network_Gateway_Member

func (Network_Gateway_Member) Limit 

func (r Network_Gateway_Member) Limit(limit int) Network_Gateway_Member

func (Network_Gateway_Member) Mask 

func (r Network_Gateway_Member) Mask(mask string) Network_Gateway_Member

func (Network_Gateway_Member) Offset 

func (r Network_Gateway_Member) Offset(offset int) Network_Gateway_Member

type Network_Gateway_Member_Attribute 

type Network_Gateway_Member_Attribute struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetNetworkGatewayMemberAttributeService 

func GetNetworkGatewayMemberAttributeService(sess session.SLSession) Network_Gateway_Member_Attribute

GetNetworkGatewayMemberAttributeService returns an instance of the Network_Gateway_Member_Attribute SoftLayer service

func (Network_Gateway_Member_Attribute) Filter 

func (r Network_Gateway_Member_Attribute) Filter(filter string) Network_Gateway_Member_Attribute

func (Network_Gateway_Member_Attribute) GetGatewayMember 

func (r Network_Gateway_Member_Attribute) GetGatewayMember() (resp datatypes.Network_Gateway_Member, err error)

Retrieve The gateway member has these attributes.

func (Network_Gateway_Member_Attribute) GetObject 

func (r Network_Gateway_Member_Attribute) GetObject() (resp datatypes.Network_Gateway_Member_Attribute, err error)

no documentation yet

func (Network_Gateway_Member_Attribute) Id 

func (r Network_Gateway_Member_Attribute) Id(id int) Network_Gateway_Member_Attribute

func (Network_Gateway_Member_Attribute) Limit 

func (r Network_Gateway_Member_Attribute) Limit(limit int) Network_Gateway_Member_Attribute

func (Network_Gateway_Member_Attribute) Mask 

func (r Network_Gateway_Member_Attribute) Mask(mask string) Network_Gateway_Member_Attribute

func (Network_Gateway_Member_Attribute) Offset 

func (r Network_Gateway_Member_Attribute) Offset(offset int) Network_Gateway_Member_Attribute

type Network_Gateway_Precheck added in v1.0.1 

type Network_Gateway_Precheck struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetNetworkGatewayPrecheckService added in v1.0.1 

func GetNetworkGatewayPrecheckService(sess session.SLSession) Network_Gateway_Precheck

GetNetworkGatewayPrecheckService returns an instance of the Network_Gateway_Precheck SoftLayer service

func (Network_Gateway_Precheck) Filter added in v1.0.1 

func (r Network_Gateway_Precheck) Filter(filter string) Network_Gateway_Precheck

func (Network_Gateway_Precheck) GetObject added in v1.0.1 

func (r Network_Gateway_Precheck) GetObject() (resp datatypes.Network_Gateway_Precheck, err error)

no documentation yet

func (Network_Gateway_Precheck) GetPrecheckStatus added in v1.0.1 

func (r Network_Gateway_Precheck) GetPrecheckStatus(gatewayId *int, getRollbackPrecheck *bool) (resp []datatypes.Network_Gateway_Precheck, err error)

Get the precheck status for all Virtual (Juniper, Fortigate vFSA) Gateway Action categories which require a readiness check before executing. Reference cloud.ibm.com documentation for more details.

Possible precheck readiness values include:

Ready (0): The member or Gateway category is ready. The only state that will be allowed to execute the Action. Not Ready (1): The member or Gateway category is not ready. This could occur because of several reasons. Either a precheck error occur, or the precheck has not run within the precheck timeout window. Check the returnCode for details on the specific error. Reference the cloud.ibm.com documentation for recovery details. Running (2): The precheck is currently running with no errors. Incomplete (3): The other member in the Gateway failed, therefore the current member could not complete it's precheck. Unsupported (4): The category is unsupported for the given member or Gateway. Expired (5) : The precheck record has expired so will need to be run again. Unchecked (6) : The precheck for the category has never been run. Current (7) : The gateway state is current so running precheck is not required. This commonly relates to version upgrade if gateway is in most update version.

Return Values: Array of objects

Object Definition:

category : String : The precheck category which corresponds to one or more executeable actions.

Current categories include: upgrade_precheck : Required for major and minor upgrade version actions. license_precheck : Required for license upgrade and downgrade actions. reload_precheck : Required for OS Reload action. rollback_precheck : Optional and related to upgrade_precheck. Only returned if getRollbackPrecheck is provided and set to True (1).

memberId : Integer : The softlayer member id. memberReadinessValue : String : The precheck readiness state for the member. See possible readiness values above. gatewayReadinessValue : String : The precheck readiness state for the gateway : See possible readiness values above. returnCode : Integer : The return code. 0 if no error. Reference cloud.ibm.com documentation for details.

func (Network_Gateway_Precheck) Id added in v1.0.1 

func (r Network_Gateway_Precheck) Id(id int) Network_Gateway_Precheck

func (Network_Gateway_Precheck) LicenseManagementPrecheck added in v1.0.1 

func (r Network_Gateway_Precheck) LicenseManagementPrecheck(gatewayId *int) (resp bool, err error)

Used to create a License Management Network Gateway Precheck transaction.

func (Network_Gateway_Precheck) Limit added in v1.0.1 

func (r Network_Gateway_Precheck) Limit(limit int) Network_Gateway_Precheck

func (Network_Gateway_Precheck) Mask added in v1.0.1 

func (r Network_Gateway_Precheck) Mask(mask string) Network_Gateway_Precheck

func (Network_Gateway_Precheck) Offset added in v1.0.1 

func (r Network_Gateway_Precheck) Offset(offset int) Network_Gateway_Precheck

func (Network_Gateway_Precheck) OsReloadPrecheck added in v1.0.1 

func (r Network_Gateway_Precheck) OsReloadPrecheck(gatewayId *int) (resp bool, err error)

Create an OS Reload Network Gateway Precheck transaction.

func (Network_Gateway_Precheck) UpgradePrecheck added in v1.0.1 

func (r Network_Gateway_Precheck) UpgradePrecheck(gatewayId *int) (resp bool, err error)

Create a Upgrade Network Gateway Precheck transaction.

type Network_Gateway_Status 

type Network_Gateway_Status struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetNetworkGatewayStatusService 

func GetNetworkGatewayStatusService(sess session.SLSession) Network_Gateway_Status

GetNetworkGatewayStatusService returns an instance of the Network_Gateway_Status SoftLayer service

func (Network_Gateway_Status) Filter 

func (r Network_Gateway_Status) Filter(filter string) Network_Gateway_Status

func (Network_Gateway_Status) GetObject 

func (r Network_Gateway_Status) GetObject() (resp datatypes.Network_Gateway_Status, err error)

no documentation yet

func (Network_Gateway_Status) Id 

func (r Network_Gateway_Status) Id(id int) Network_Gateway_Status

func (Network_Gateway_Status) Limit 

func (r Network_Gateway_Status) Limit(limit int) Network_Gateway_Status

func (Network_Gateway_Status) Mask 

func (r Network_Gateway_Status) Mask(mask string) Network_Gateway_Status

func (Network_Gateway_Status) Offset 

func (r Network_Gateway_Status) Offset(offset int) Network_Gateway_Status

type Network_Gateway_VersionUpgrade 

type Network_Gateway_VersionUpgrade struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetNetworkGatewayVersionUpgradeService 

func GetNetworkGatewayVersionUpgradeService(sess session.SLSession) Network_Gateway_VersionUpgrade

GetNetworkGatewayVersionUpgradeService returns an instance of the Network_Gateway_VersionUpgrade SoftLayer service

func (Network_Gateway_VersionUpgrade) Filter 

func (r Network_Gateway_VersionUpgrade) Filter(filter string) Network_Gateway_VersionUpgrade

func (Network_Gateway_VersionUpgrade) GetAllUpgradesByGatewayId added in v1.0.2 

func (r Network_Gateway_VersionUpgrade) GetAllUpgradesByGatewayId(gatewayId *int) (resp []datatypes.Network_Gateway_VersionUpgrade, err error)

no documentation yet

func (Network_Gateway_VersionUpgrade) GetGwOrdersAllowedLicenses added in v1.1.3 

func (r Network_Gateway_VersionUpgrade) GetGwOrdersAllowedLicenses(accountId *int, manufacturer *string) (resp string, err error)

func (Network_Gateway_VersionUpgrade) GetGwOrdersAllowedOS added in v1.1.3 

func (r Network_Gateway_VersionUpgrade) GetGwOrdersAllowedOS(accountId *int, manufacturer *string) (resp []datatypes.Product_Package_Item_Prices, err error)

Used to get a list per package of prices ids for allowed vSRX or vFSA OS-es for new orders.

func (Network_Gateway_VersionUpgrade) GetObject 

func (r Network_Gateway_VersionUpgrade) GetObject() (resp datatypes.Network_Gateway_VersionUpgrade, err error)

no documentation yet

func (Network_Gateway_VersionUpgrade) Id 

func (r Network_Gateway_VersionUpgrade) Id(id int) Network_Gateway_VersionUpgrade

func (Network_Gateway_VersionUpgrade) Limit 

func (r Network_Gateway_VersionUpgrade) Limit(limit int) Network_Gateway_VersionUpgrade

func (Network_Gateway_VersionUpgrade) Mask 

func (r Network_Gateway_VersionUpgrade) Mask(mask string) Network_Gateway_VersionUpgrade

func (Network_Gateway_VersionUpgrade) Offset 

func (r Network_Gateway_VersionUpgrade) Offset(offset int) Network_Gateway_VersionUpgrade

func (Network_Gateway_VersionUpgrade) ValidateVersionChange 

func (r Network_Gateway_VersionUpgrade) ValidateVersionChange(gatewayId *int, versionUpgradeId *int) (resp bool, err error)

no documentation yet

type Network_Gateway_Vlan 

type Network_Gateway_Vlan struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetNetworkGatewayVlanService 

func GetNetworkGatewayVlanService(sess session.SLSession) Network_Gateway_Vlan

GetNetworkGatewayVlanService returns an instance of the Network_Gateway_Vlan SoftLayer service

func (Network_Gateway_Vlan) Bypass 

func (r Network_Gateway_Vlan) Bypass() (err error)

Start the asynchronous process to bypass/unroute the VLAN from this gateway.

func (Network_Gateway_Vlan) CreateObject 

func (r Network_Gateway_Vlan) CreateObject(templateObject *datatypes.Network_Gateway_Vlan) (resp datatypes.Network_Gateway_Vlan, err error)

Create a new VLAN attachment. If the bypassFlag is false, this will also create an asynchronous process to route the VLAN through the gateway.

func (Network_Gateway_Vlan) CreateObjects 

func (r Network_Gateway_Vlan) CreateObjects(templateObjects []datatypes.Network_Gateway_Vlan) (resp []datatypes.Network_Gateway_Vlan, err error)

Create multiple new VLAN attachments. If the bypassFlag is false, this will also create an asynchronous process to route the VLANs through the gateway.

func (Network_Gateway_Vlan) DeleteObject 

func (r Network_Gateway_Vlan) DeleteObject() (err error)

Start the asynchronous process to detach this VLANs from the gateway.

func (Network_Gateway_Vlan) DeleteObjects 

func (r Network_Gateway_Vlan) DeleteObjects(templateObjects []datatypes.Network_Gateway_Vlan) (resp bool, err error)

Detach several VLANs. This will not detach them right away, but rather start an asynchronous process to detach.

func (Network_Gateway_Vlan) Filter 

func (r Network_Gateway_Vlan) Filter(filter string) Network_Gateway_Vlan

func (Network_Gateway_Vlan) GetNetworkGateway 

func (r Network_Gateway_Vlan) GetNetworkGateway() (resp datatypes.Network_Gateway, err error)

Retrieve The gateway this VLAN is attached to.

func (Network_Gateway_Vlan) GetNetworkVlan 

func (r Network_Gateway_Vlan) GetNetworkVlan() (resp datatypes.Network_Vlan, err error)

Retrieve The network VLAN record.

func (Network_Gateway_Vlan) GetObject 

func (r Network_Gateway_Vlan) GetObject() (resp datatypes.Network_Gateway_Vlan, err error)

no documentation yet

func (Network_Gateway_Vlan) Id 

func (r Network_Gateway_Vlan) Id(id int) Network_Gateway_Vlan

func (Network_Gateway_Vlan) Limit 

func (r Network_Gateway_Vlan) Limit(limit int) Network_Gateway_Vlan

func (Network_Gateway_Vlan) Mask 

func (r Network_Gateway_Vlan) Mask(mask string) Network_Gateway_Vlan

func (Network_Gateway_Vlan) Offset 

func (r Network_Gateway_Vlan) Offset(offset int) Network_Gateway_Vlan

func (Network_Gateway_Vlan) Unbypass 

func (r Network_Gateway_Vlan) Unbypass() (err error)

Start the asynchronous process to route the VLAN to this gateway.

type Network_Interconnect_Tenant 

type Network_Interconnect_Tenant struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetNetworkInterconnectTenantService 

func GetNetworkInterconnectTenantService(sess session.SLSession) Network_Interconnect_Tenant

GetNetworkInterconnectTenantService returns an instance of the Network_Interconnect_Tenant SoftLayer service

func (Network_Interconnect_Tenant) AllowDeleteConnection 

func (r Network_Interconnect_Tenant) AllowDeleteConnection(serviceKey *string) (resp bool, err error)

no documentation yet

func (Network_Interconnect_Tenant) CreateConnection 

func (r Network_Interconnect_Tenant) CreateConnection(templateObject *datatypes.Network_Interconnect_Tenant) (resp string, err error)

no documentation yet

func (Network_Interconnect_Tenant) DeleteConnection 

func (r Network_Interconnect_Tenant) DeleteConnection(receivedObject *datatypes.Network_Interconnect_Tenant) (resp bool, err error)

no documentation yet

func (Network_Interconnect_Tenant) EditConnection 

func (r Network_Interconnect_Tenant) EditConnection(receivedObject *datatypes.Network_Interconnect_Tenant) (resp string, err error)

no documentation yet

func (Network_Interconnect_Tenant) Filter 

func (r Network_Interconnect_Tenant) Filter(filter string) Network_Interconnect_Tenant

func (Network_Interconnect_Tenant) GetAllConnections 

func (r Network_Interconnect_Tenant) GetAllConnections() (resp string, err error)

no documentation yet

func (Network_Interconnect_Tenant) GetAllObjects 

func (r Network_Interconnect_Tenant) GetAllObjects() (resp []datatypes.Network_Interconnect_Tenant, err error)

no documentation yet

func (Network_Interconnect_Tenant) GetAllPortLabelsWithCurrentUsage 

func (r Network_Interconnect_Tenant) GetAllPortLabelsWithCurrentUsage(directLinkLocationId *int) (resp []string, err error)

no documentation yet

func (Network_Interconnect_Tenant) GetBgpIpRange 

func (r Network_Interconnect_Tenant) GetBgpIpRange() (resp string, err error)

no documentation yet

func (Network_Interconnect_Tenant) GetBillingItem 

func (r Network_Interconnect_Tenant) GetBillingItem() (resp datatypes.Billing_Item_Network_Interconnect, err error)

Retrieve The active billing item for a network interconnect.

func (Network_Interconnect_Tenant) GetConnection 

func (r Network_Interconnect_Tenant) GetConnection(serviceKey *string, provider *string) (resp string, err error)

no documentation yet

func (Network_Interconnect_Tenant) GetDatacenterName 

func (r Network_Interconnect_Tenant) GetDatacenterName() (resp string, err error)

Retrieve

func (Network_Interconnect_Tenant) GetDirectLinkSpeeds 

func (r Network_Interconnect_Tenant) GetDirectLinkSpeeds(offeringType *string) (resp string, err error)

no documentation yet

func (Network_Interconnect_Tenant) GetNetworkZones 

func (r Network_Interconnect_Tenant) GetNetworkZones() (resp []string, err error)

no documentation yet

func (Network_Interconnect_Tenant) GetObject 

func (r Network_Interconnect_Tenant) GetObject() (resp datatypes.Network_Interconnect_Tenant, err error)

no documentation yet

func (Network_Interconnect_Tenant) GetPortLabel 

func (r Network_Interconnect_Tenant) GetPortLabel() (resp string, err error)

Retrieve

func (Network_Interconnect_Tenant) GetPorts 

func (r Network_Interconnect_Tenant) GetPorts(provider *string) (resp string, err error)

no documentation yet

func (Network_Interconnect_Tenant) GetServiceType 

func (r Network_Interconnect_Tenant) GetServiceType() (resp datatypes.Network_DirectLink_ServiceType, err error)

Retrieve

func (Network_Interconnect_Tenant) GetVendorName 

func (r Network_Interconnect_Tenant) GetVendorName() (resp string, err error)

Retrieve

func (Network_Interconnect_Tenant) GetZoneName 

func (r Network_Interconnect_Tenant) GetZoneName() (resp string, err error)

Retrieve

func (Network_Interconnect_Tenant) Id 

func (r Network_Interconnect_Tenant) Id(id int) Network_Interconnect_Tenant

func (Network_Interconnect_Tenant) Limit 

func (r Network_Interconnect_Tenant) Limit(limit int) Network_Interconnect_Tenant

func (Network_Interconnect_Tenant) Mask 

func (r Network_Interconnect_Tenant) Mask(mask string) Network_Interconnect_Tenant

func (Network_Interconnect_Tenant) Offset 

func (r Network_Interconnect_Tenant) Offset(offset int) Network_Interconnect_Tenant

func (Network_Interconnect_Tenant) RejectApprovalRequests 

func (r Network_Interconnect_Tenant) RejectApprovalRequests(serviceKey *string) (resp bool, err error)

no documentation yet

func (Network_Interconnect_Tenant) UpdateConnectionStatus 

func (r Network_Interconnect_Tenant) UpdateConnectionStatus(tenantId *int) (resp bool, err error)

no documentation yet

type Network_LBaaS_HealthMonitor 

type Network_LBaaS_HealthMonitor struct {
	Session session.SLSession
	Options sl.Options
}

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

func GetNetworkLBaaSHealthMonitorService 

func GetNetworkLBaaSHealthMonitorService(sess session.SLSession) Network_LBaaS_HealthMonitor

GetNetworkLBaaSHealthMonitorService returns an instance of the Network_LBaaS_HealthMonitor SoftLayer service

func (Network_LBaaS_HealthMonitor) Filter 

func (r Network_LBaaS_HealthMonitor) Filter(filter string) Network_LBaaS_HealthMonitor

func (Network_LBaaS_HealthMonitor) GetObject 

func (r Network_LBaaS_HealthMonitor) GetObject() (resp datatypes.Network_LBaaS_HealthMonitor, err error)

no documentation yet

func (Network_LBaaS_HealthMonitor) Id 

func (r Network_LBaaS_HealthMonitor) Id(id int) Network_LBaaS_HealthMonitor

func (Network_LBaaS_HealthMonitor) Limit 

func (r Network_LBaaS_HealthMonitor) Limit(limit int) Network_LBaaS_HealthMonitor

func (Network_LBaaS_HealthMonitor) Mask 

func (r Network_LBaaS_HealthMonitor) Mask(mask string) Network_LBaaS_HealthMonitor

func (Network_LBaaS_HealthMonitor) Offset 

func (r Network_LBaaS_HealthMonitor) Offset(offset int) Network_LBaaS_HealthMonitor

func (Network_LBaaS_HealthMonitor) UpdateLoadBalancerHealthMonitors 

func (r Network_LBaaS_HealthMonitor) UpdateLoadBalancerHealthMonitors(loadBalancerUuid *string, healthMonitorConfigurations []datatypes.Network_LBaaS_LoadBalancerHealthMonitorConfiguration) (resp datatypes.Network_LBaaS_LoadBalancer, err error)

Update load balancers health monitor and return load balancer object with listeners (frontend), pools (backend), health monitor server instances (members) and datacenter populated

type Network_LBaaS_L7Member 

type Network_LBaaS_L7Member struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetNetworkLBaaSL7MemberService 

func GetNetworkLBaaSL7MemberService(sess session.SLSession) Network_LBaaS_L7Member

GetNetworkLBaaSL7MemberService returns an instance of the Network_LBaaS_L7Member SoftLayer service

func (Network_LBaaS_L7Member) AddL7PoolMembers 

func (r Network_LBaaS_L7Member) AddL7PoolMembers(l7PoolUuid *string, memberInstances []datatypes.Network_LBaaS_L7Member) (resp datatypes.Network_LBaaS_LoadBalancer, err error)

Add server instances as members to a L7pool and return the LoadBalancer Object with listeners, pools and members populated

func (Network_LBaaS_L7Member) DeleteL7PoolMembers 

func (r Network_LBaaS_L7Member) DeleteL7PoolMembers(l7PoolUuid *string, memberUuids []string) (resp datatypes.Network_LBaaS_LoadBalancer, err error)

Delete given members from load balancer and return load balancer object with listeners, pools and members populated

func (Network_LBaaS_L7Member) Filter 

func (r Network_LBaaS_L7Member) Filter(filter string) Network_LBaaS_L7Member

func (Network_LBaaS_L7Member) GetObject 

func (r Network_LBaaS_L7Member) GetObject() (resp datatypes.Network_LBaaS_L7Member, err error)

no documentation yet

func (Network_LBaaS_L7Member) Id 

func (r Network_LBaaS_L7Member) Id(id int) Network_LBaaS_L7Member

func (Network_LBaaS_L7Member) Limit 

func (r Network_LBaaS_L7Member) Limit(limit int) Network_LBaaS_L7Member

func (Network_LBaaS_L7Member) Mask 

func (r Network_LBaaS_L7Member) Mask(mask string) Network_LBaaS_L7Member

func (Network_LBaaS_L7Member) Offset 

func (r Network_LBaaS_L7Member) Offset(offset int) Network_LBaaS_L7Member

func (Network_LBaaS_L7Member) UpdateL7PoolMembers 

func (r Network_LBaaS_L7Member) UpdateL7PoolMembers(l7PoolUuid *string, members []datatypes.Network_LBaaS_L7Member) (resp datatypes.Network_LBaaS_LoadBalancer, err error)

Update L7 members weight and port.

type Network_LBaaS_L7Policy 

type Network_LBaaS_L7Policy struct {
	Session session.SLSession
	Options sl.Options
}

The SoftLayer_Network_LBaaS_L7Policy represents the policy for a listener.

func GetNetworkLBaaSL7PolicyService 

func GetNetworkLBaaSL7PolicyService(sess session.SLSession) Network_LBaaS_L7Policy

GetNetworkLBaaSL7PolicyService returns an instance of the Network_LBaaS_L7Policy SoftLayer service

func (Network_LBaaS_L7Policy) AddL7Policies 

func (r Network_LBaaS_L7Policy) AddL7Policies(listenerUuid *string, policiesRules []datatypes.Network_LBaaS_PolicyRule) (resp datatypes.Network_LBaaS_LoadBalancer, err error)

This function creates multiple policies with rules for the given listener.

func (Network_LBaaS_L7Policy) DeleteObject 

func (r Network_LBaaS_L7Policy) DeleteObject() (resp datatypes.Network_LBaaS_LoadBalancer, err error)

Deletes a l7 policy instance and the rules associated with the policy

func (Network_LBaaS_L7Policy) EditObject 

func (r Network_LBaaS_L7Policy) EditObject(templateObject *datatypes.Network_LBaaS_L7Policy) (resp datatypes.Network_LBaaS_LoadBalancer, err error)

Edit a l7 policy instance's properties

func (Network_LBaaS_L7Policy) Filter 

func (r Network_LBaaS_L7Policy) Filter(filter string) Network_LBaaS_L7Policy

func (Network_LBaaS_L7Policy) GetL7Rules 

func (r Network_LBaaS_L7Policy) GetL7Rules() (resp []datatypes.Network_LBaaS_L7Rule, err error)

Retrieve

func (Network_LBaaS_L7Policy) GetObject 

func (r Network_LBaaS_L7Policy) GetObject() (resp datatypes.Network_LBaaS_L7Policy, err error)

no documentation yet

func (Network_LBaaS_L7Policy) Id 

func (r Network_LBaaS_L7Policy) Id(id int) Network_LBaaS_L7Policy

func (Network_LBaaS_L7Policy) Limit 

func (r Network_LBaaS_L7Policy) Limit(limit int) Network_LBaaS_L7Policy

func (Network_LBaaS_L7Policy) Mask 

func (r Network_LBaaS_L7Policy) Mask(mask string) Network_LBaaS_L7Policy

func (Network_LBaaS_L7Policy) Offset 

func (r Network_LBaaS_L7Policy) Offset(offset int) Network_LBaaS_L7Policy

type Network_LBaaS_L7Pool 

type Network_LBaaS_L7Pool struct {
	Session session.SLSession
	Options sl.Options
}

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

func GetNetworkLBaaSL7PoolService 

func GetNetworkLBaaSL7PoolService(sess session.SLSession) Network_LBaaS_L7Pool

GetNetworkLBaaSL7PoolService returns an instance of the Network_LBaaS_L7Pool SoftLayer service

func (Network_LBaaS_L7Pool) CreateL7Pool 

func (r Network_LBaaS_L7Pool) CreateL7Pool(loadBalancerUuid *string, l7Pool *datatypes.Network_LBaaS_L7Pool, l7Members []datatypes.Network_LBaaS_L7Member, l7HealthMonitor *datatypes.Network_LBaaS_L7HealthMonitor, l7SessionAffinity *datatypes.Network_LBaaS_L7SessionAffinity) (resp datatypes.Network_LBaaS_LoadBalancer, err error)

Create a backend to be used for L7 load balancing. This L7 pool has backend protocol, L7 members, L7 health monitor and session affinity. L7 pool is associated with L7 policies.

func (Network_LBaaS_L7Pool) DeleteObject 

func (r Network_LBaaS_L7Pool) DeleteObject() (resp datatypes.Network_LBaaS_LoadBalancer, err error)

Deletes an existing L7 pool along with L7 members, L7 health monitor, and L7 session affinity.

func (Network_LBaaS_L7Pool) Filter 

func (r Network_LBaaS_L7Pool) Filter(filter string) Network_LBaaS_L7Pool

func (Network_LBaaS_L7Pool) GetL7HealthMonitor 

func (r Network_LBaaS_L7Pool) GetL7HealthMonitor() (resp datatypes.Network_LBaaS_L7HealthMonitor, err error)

Retrieve

func (Network_LBaaS_L7Pool) GetL7Members 

func (r Network_LBaaS_L7Pool) GetL7Members() (resp []datatypes.Network_LBaaS_L7Member, err error)

Retrieve

func (Network_LBaaS_L7Pool) GetL7Policies 

func (r Network_LBaaS_L7Pool) GetL7Policies() (resp []datatypes.Network_LBaaS_L7Policy, err error)

Retrieve

func (Network_LBaaS_L7Pool) GetL7PoolMemberHealth 

func (r Network_LBaaS_L7Pool) GetL7PoolMemberHealth(loadBalancerUuid *string) (resp []datatypes.Network_LBaaS_L7PoolMembersHealth, err error)

Returns the health of all L7 pool's members which are created under load balancer. L7 members health status is available only after a L7 pool is associated with the L7 policy and that L7 policy has at least one L7 rule.

func (Network_LBaaS_L7Pool) GetL7SessionAffinity 

func (r Network_LBaaS_L7Pool) GetL7SessionAffinity() (resp datatypes.Network_LBaaS_L7SessionAffinity, err error)

Retrieve

func (Network_LBaaS_L7Pool) GetObject 

func (r Network_LBaaS_L7Pool) GetObject() (resp datatypes.Network_LBaaS_L7Pool, err error)

no documentation yet

func (Network_LBaaS_L7Pool) Id 

func (r Network_LBaaS_L7Pool) Id(id int) Network_LBaaS_L7Pool

func (Network_LBaaS_L7Pool) Limit 

func (r Network_LBaaS_L7Pool) Limit(limit int) Network_LBaaS_L7Pool

func (Network_LBaaS_L7Pool) Mask 

func (r Network_LBaaS_L7Pool) Mask(mask string) Network_LBaaS_L7Pool

func (Network_LBaaS_L7Pool) Offset 

func (r Network_LBaaS_L7Pool) Offset(offset int) Network_LBaaS_L7Pool

func (Network_LBaaS_L7Pool) UpdateL7Pool 

func (r Network_LBaaS_L7Pool) UpdateL7Pool(l7PoolUuid *string, l7Pool *datatypes.Network_LBaaS_L7Pool, l7HealthMonitor *datatypes.Network_LBaaS_L7HealthMonitor, l7SessionAffinity *datatypes.Network_LBaaS_L7SessionAffinity) (resp datatypes.Network_LBaaS_LoadBalancer, err error)

Updates an existing L7 pool, L7 health monitor and L7 session affinity.

type Network_LBaaS_L7Rule 

type Network_LBaaS_L7Rule struct {
	Session session.SLSession
	Options sl.Options
}

The SoftLayer_Network_LBaaS_L7Rule represents the Rules that can be attached to a a L7 policy.

func GetNetworkLBaaSL7RuleService 

func GetNetworkLBaaSL7RuleService(sess session.SLSession) Network_LBaaS_L7Rule

GetNetworkLBaaSL7RuleService returns an instance of the Network_LBaaS_L7Rule SoftLayer service

func (Network_LBaaS_L7Rule) AddL7Rules 

func (r Network_LBaaS_L7Rule) AddL7Rules(policyUuid *string, rules []datatypes.Network_LBaaS_L7Rule) (resp datatypes.Network_LBaaS_LoadBalancer, err error)

This function creates and adds multiple Rules to a given L7 policy with all the details provided for rules

func (Network_LBaaS_L7Rule) DeleteL7Rules 

func (r Network_LBaaS_L7Rule) DeleteL7Rules(policyUuid *string, ruleUuids []string) (resp datatypes.Network_LBaaS_LoadBalancer, err error)

This function deletes multiple rules aassociated with the same policy.

func (Network_LBaaS_L7Rule) Filter 

func (r Network_LBaaS_L7Rule) Filter(filter string) Network_LBaaS_L7Rule

func (Network_LBaaS_L7Rule) GetObject 

func (r Network_LBaaS_L7Rule) GetObject() (resp datatypes.Network_LBaaS_L7Rule, err error)

no documentation yet

func (Network_LBaaS_L7Rule) Id 

func (r Network_LBaaS_L7Rule) Id(id int) Network_LBaaS_L7Rule

func (Network_LBaaS_L7Rule) Limit 

func (r Network_LBaaS_L7Rule) Limit(limit int) Network_LBaaS_L7Rule

func (Network_LBaaS_L7Rule) Mask 

func (r Network_LBaaS_L7Rule) Mask(mask string) Network_LBaaS_L7Rule

func (Network_LBaaS_L7Rule) Offset 

func (r Network_LBaaS_L7Rule) Offset(offset int) Network_LBaaS_L7Rule

func (Network_LBaaS_L7Rule) UpdateL7Rules 

func (r Network_LBaaS_L7Rule) UpdateL7Rules(policyUuid *string, rules []datatypes.Network_LBaaS_L7Rule) (resp datatypes.Network_LBaaS_LoadBalancer, err error)

This function updates multiple Rules to a given policy with all the details for rules.

type Network_LBaaS_Listener 

type Network_LBaaS_Listener struct {
	Session session.SLSession
	Options sl.Options
}

The SoftLayer_Network_LBaaS_Listener type presents a data structure for a load balancers listener, also called frontend.

func GetNetworkLBaaSListenerService 

func GetNetworkLBaaSListenerService(sess session.SLSession) Network_LBaaS_Listener

GetNetworkLBaaSListenerService returns an instance of the Network_LBaaS_Listener SoftLayer service

func (Network_LBaaS_Listener) DeleteLoadBalancerProtocols 

func (r Network_LBaaS_Listener) DeleteLoadBalancerProtocols(loadBalancerUuid *string, listenerUuids []string) (resp datatypes.Network_LBaaS_LoadBalancer, err error)

Delete load balancers front- and backend protocols and return load balancer object with listeners (frontend), pools (backend), server instances (members) and datacenter populated.

func (Network_LBaaS_Listener) Filter 

func (r Network_LBaaS_Listener) Filter(filter string) Network_LBaaS_Listener

func (Network_LBaaS_Listener) GetDefaultPool 

func (r Network_LBaaS_Listener) GetDefaultPool() (resp datatypes.Network_LBaaS_Pool, err error)

Retrieve

func (Network_LBaaS_Listener) GetL7Policies 

func (r Network_LBaaS_Listener) GetL7Policies() (resp []datatypes.Network_LBaaS_L7Policy, err error)

Retrieve

func (Network_LBaaS_Listener) GetObject 

func (r Network_LBaaS_Listener) GetObject() (resp datatypes.Network_LBaaS_Listener, err error)

no documentation yet

func (Network_LBaaS_Listener) Id 

func (r Network_LBaaS_Listener) Id(id int) Network_LBaaS_Listener

func (Network_LBaaS_Listener) Limit 

func (r Network_LBaaS_Listener) Limit(limit int) Network_LBaaS_Listener

func (Network_LBaaS_Listener) Mask 

func (r Network_LBaaS_Listener) Mask(mask string) Network_LBaaS_Listener

func (Network_LBaaS_Listener) Offset 

func (r Network_LBaaS_Listener) Offset(offset int) Network_LBaaS_Listener

func (Network_LBaaS_Listener) UpdateLoadBalancerProtocols 

func (r Network_LBaaS_Listener) UpdateLoadBalancerProtocols(loadBalancerUuid *string, protocolConfigurations []datatypes.Network_LBaaS_LoadBalancerProtocolConfiguration) (resp datatypes.Network_LBaaS_LoadBalancer, err error)

Update (create) load balancers front- and backend protocols and return load balancer object with listeners (frontend), pools (backend), server instances (members) and datacenter populated. Note if a protocolConfiguration has no listenerUuid set, this function will create the specified front- and backend accordingly. Otherwise the given front- and backend will be updated with the new protocol and port.

type Network_LBaaS_LoadBalancer 

type Network_LBaaS_LoadBalancer struct {
	Session session.SLSession
	Options sl.Options
}

The SoftLayer_Network_LBaaS_LoadBalancer type presents a structure containing attributes of a load balancer, and its related objects including listeners, pools and members.

func GetNetworkLBaaSLoadBalancerService 

func GetNetworkLBaaSLoadBalancerService(sess session.SLSession) Network_LBaaS_LoadBalancer

GetNetworkLBaaSLoadBalancerService returns an instance of the Network_LBaaS_LoadBalancer SoftLayer service

func (Network_LBaaS_LoadBalancer) CancelLoadBalancer 

func (r Network_LBaaS_LoadBalancer) CancelLoadBalancer(uuid *string) (resp bool, err error)

Cancel a load balancer with the given uuid. The billing system will execute the deletion of load balancer and all objects associated with it such as load balancer appliances, listeners, pools and members in the background.

func (Network_LBaaS_LoadBalancer) EnableOrDisableDataLogs 

func (r Network_LBaaS_LoadBalancer) EnableOrDisableDataLogs(uuid *string, enabled *bool) (resp datatypes.Network_LBaaS_LoadBalancer, err error)

When enabled, data log would be forwarded to logging service.

func (Network_LBaaS_LoadBalancer) Filter 

func (r Network_LBaaS_LoadBalancer) Filter(filter string) Network_LBaaS_LoadBalancer

func (Network_LBaaS_LoadBalancer) GetAllObjects 

func (r Network_LBaaS_LoadBalancer) GetAllObjects() (resp []datatypes.Network_LBaaS_LoadBalancer, err error)

Return all existing load balancers

func (Network_LBaaS_LoadBalancer) GetAppliances added in v1.1.3 

func (r Network_LBaaS_LoadBalancer) GetAppliances(lbId *string) (resp []datatypes.Network_LBaaS_LoadBalancerAppliance, err error)

Get the load balancer appliances for the given lb id.

func (Network_LBaaS_LoadBalancer) GetDatacenter 

func (r Network_LBaaS_LoadBalancer) GetDatacenter() (resp datatypes.Location, err error)

Retrieve Datacenter, where load balancer is located.

func (Network_LBaaS_LoadBalancer) GetHealthMonitors 

func (r Network_LBaaS_LoadBalancer) GetHealthMonitors() (resp []datatypes.Network_LBaaS_HealthMonitor, err error)

Retrieve Health monitors for the backend members.

func (Network_LBaaS_LoadBalancer) GetL7Pools 

func (r Network_LBaaS_LoadBalancer) GetL7Pools() (resp []datatypes.Network_LBaaS_L7Pool, err error)

Retrieve L7Pools for load balancer.

func (Network_LBaaS_LoadBalancer) GetListenerTimeSeriesData 

func (r Network_LBaaS_LoadBalancer) GetListenerTimeSeriesData(loadBalancerUuid *string, metricName *string, timeRange *string, listenerUuid *string) (resp []datatypes.Network_LBaaS_LoadBalancerMonitoringMetricDataPoint, err error)

Return listener time series datapoints. The time series data is available for Throughput, ConnectionRate and ActiveConnections. Throughput is in bits per second. The values are an average over the time range. The time series data is available for 1hour, 6hours, 12hours, 1day, 1week or 2weeks.

func (Network_LBaaS_LoadBalancer) GetListeners 

func (r Network_LBaaS_LoadBalancer) GetListeners() (resp []datatypes.Network_LBaaS_Listener, err error)

Retrieve Listeners assigned to load balancer.

func (Network_LBaaS_LoadBalancer) GetLoadBalancer 

func (r Network_LBaaS_LoadBalancer) GetLoadBalancer(uuid *string) (resp datatypes.Network_LBaaS_LoadBalancer, err error)

Get the load balancer object with given uuid.

func (Network_LBaaS_LoadBalancer) GetLoadBalancerMemberHealth 

func (r Network_LBaaS_LoadBalancer) GetLoadBalancerMemberHealth(uuid *string) (resp []datatypes.Network_LBaaS_PoolMembersHealth, err error)

Return load balancer members health

func (Network_LBaaS_LoadBalancer) GetLoadBalancerStatistics 

func (r Network_LBaaS_LoadBalancer) GetLoadBalancerStatistics(uuid *string) (resp datatypes.Network_LBaaS_LoadBalancerStatistics, err error)

Return load balancers statistics such as total number of current sessions and total number of accumulated connections.

func (Network_LBaaS_LoadBalancer) GetLoadBalancers added in v1.1.3 

func (r Network_LBaaS_LoadBalancer) GetLoadBalancers(data *string) (resp []datatypes.Network_LBaaS_LoadBalancer, err error)

Get the load balancer objects for the given user accounts.

func (Network_LBaaS_LoadBalancer) GetMembers 

func (r Network_LBaaS_LoadBalancer) GetMembers() (resp []datatypes.Network_LBaaS_Member, err error)

Retrieve Members assigned to load balancer.

func (Network_LBaaS_LoadBalancer) GetObject 

func (r Network_LBaaS_LoadBalancer) GetObject() (resp datatypes.Network_LBaaS_LoadBalancer, err error)

no documentation yet

func (Network_LBaaS_LoadBalancer) GetSslCiphers 

func (r Network_LBaaS_LoadBalancer) GetSslCiphers() (resp []datatypes.Network_LBaaS_SSLCipher, err error)

Retrieve list of preferred custom ciphers configured for the load balancer.

func (Network_LBaaS_LoadBalancer) Id 

func (r Network_LBaaS_LoadBalancer) Id(id int) Network_LBaaS_LoadBalancer

func (Network_LBaaS_LoadBalancer) Limit 

func (r Network_LBaaS_LoadBalancer) Limit(limit int) Network_LBaaS_LoadBalancer

func (Network_LBaaS_LoadBalancer) Mask 

func (r Network_LBaaS_LoadBalancer) Mask(mask string) Network_LBaaS_LoadBalancer

func (Network_LBaaS_LoadBalancer) Offset 

func (r Network_LBaaS_LoadBalancer) Offset(offset int) Network_LBaaS_LoadBalancer

func (Network_LBaaS_LoadBalancer) ServiceDNS added in v1.1.3 

func (r Network_LBaaS_LoadBalancer) ServiceDNS(data *string) (err error)

no documentation yet

func (Network_LBaaS_LoadBalancer) ServiceLoadBalancer 

func (r Network_LBaaS_LoadBalancer) ServiceLoadBalancer(data *string) (resp datatypes.Network_LBaaS_LoadBalancer, err error)

no documentation yet

func (Network_LBaaS_LoadBalancer) UpdateLoadBalancer 

func (r Network_LBaaS_LoadBalancer) UpdateLoadBalancer(uuid *string, newDescription *string) (resp datatypes.Network_LBaaS_LoadBalancer, err error)

Update load balancer's description, and return the load balancer object containing all listeners, pools, members and datacenter.

func (Network_LBaaS_LoadBalancer) UpdateSslCiphers 

func (r Network_LBaaS_LoadBalancer) UpdateSslCiphers(loadBalancerUuid *string, cipherList []int) (resp datatypes.Network_LBaaS_LoadBalancer, err error)

Updates the load balancer with the new cipher list. All new connections going forward will use the new set of ciphers selected by the user.

type Network_LBaaS_LoadBalancerAppliance added in v1.1.3 

type Network_LBaaS_LoadBalancerAppliance struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetNetworkLBaaSLoadBalancerApplianceService added in v1.1.3 

func GetNetworkLBaaSLoadBalancerApplianceService(sess session.SLSession) Network_LBaaS_LoadBalancerAppliance

GetNetworkLBaaSLoadBalancerApplianceService returns an instance of the Network_LBaaS_LoadBalancerAppliance SoftLayer service

func (Network_LBaaS_LoadBalancerAppliance) Filter added in v1.1.3 

func (r Network_LBaaS_LoadBalancerAppliance) Filter(filter string) Network_LBaaS_LoadBalancerAppliance

func (Network_LBaaS_LoadBalancerAppliance) GetObject added in v1.1.3 

func (r Network_LBaaS_LoadBalancerAppliance) GetObject() (resp datatypes.Network_LBaaS_LoadBalancerAppliance, err error)

no documentation yet

func (Network_LBaaS_LoadBalancerAppliance) Id added in v1.1.3 

func (r Network_LBaaS_LoadBalancerAppliance) Id(id int) Network_LBaaS_LoadBalancerAppliance

func (Network_LBaaS_LoadBalancerAppliance) Limit added in v1.1.3 

func (r Network_LBaaS_LoadBalancerAppliance) Limit(limit int) Network_LBaaS_LoadBalancerAppliance

func (Network_LBaaS_LoadBalancerAppliance) Mask added in v1.1.3 

func (r Network_LBaaS_LoadBalancerAppliance) Mask(mask string) Network_LBaaS_LoadBalancerAppliance

func (Network_LBaaS_LoadBalancerAppliance) Offset added in v1.1.3 

func (r Network_LBaaS_LoadBalancerAppliance) Offset(offset int) Network_LBaaS_LoadBalancerAppliance

type Network_LBaaS_Member 

type Network_LBaaS_Member struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetNetworkLBaaSMemberService 

func GetNetworkLBaaSMemberService(sess session.SLSession) Network_LBaaS_Member

GetNetworkLBaaSMemberService returns an instance of the Network_LBaaS_Member SoftLayer service

func (Network_LBaaS_Member) AddLoadBalancerMembers 

func (r Network_LBaaS_Member) AddLoadBalancerMembers(loadBalancerUuid *string, serverInstances []datatypes.Network_LBaaS_LoadBalancerServerInstanceInfo) (resp datatypes.Network_LBaaS_LoadBalancer, err error)

Add server instances as members to load balancer and return it with listeners, pools and members populated

func (Network_LBaaS_Member) DeleteLoadBalancerMembers 

func (r Network_LBaaS_Member) DeleteLoadBalancerMembers(loadBalancerUuid *string, memberUuids []string) (resp datatypes.Network_LBaaS_LoadBalancer, err error)

Delete given members from load balancer and return load balancer object with listeners, pools and members populated

func (Network_LBaaS_Member) Filter 

func (r Network_LBaaS_Member) Filter(filter string) Network_LBaaS_Member

func (Network_LBaaS_Member) GetObject 

func (r Network_LBaaS_Member) GetObject() (resp datatypes.Network_LBaaS_Member, err error)

no documentation yet

func (Network_LBaaS_Member) Id 

func (r Network_LBaaS_Member) Id(id int) Network_LBaaS_Member

func (Network_LBaaS_Member) Limit 

func (r Network_LBaaS_Member) Limit(limit int) Network_LBaaS_Member

func (Network_LBaaS_Member) Mask 

func (r Network_LBaaS_Member) Mask(mask string) Network_LBaaS_Member

func (Network_LBaaS_Member) Offset 

func (r Network_LBaaS_Member) Offset(offset int) Network_LBaaS_Member

func (Network_LBaaS_Member) UpdateLoadBalancerMembers 

func (r Network_LBaaS_Member) UpdateLoadBalancerMembers(loadBalancerUuid *string, members []datatypes.Network_LBaaS_Member) (resp datatypes.Network_LBaaS_LoadBalancer, err error)

Update members weight and return load balancer object with listeners, pools and members populated

type Network_LBaaS_SSLCipher 

type Network_LBaaS_SSLCipher struct {
	Session session.SLSession
	Options sl.Options
}

The SoftLayer_Network_LBaaS_SSLCipher type presents a structure that contains attributes of load balancer cipher suites.

func GetNetworkLBaaSSSLCipherService 

func GetNetworkLBaaSSSLCipherService(sess session.SLSession) Network_LBaaS_SSLCipher

GetNetworkLBaaSSSLCipherService returns an instance of the Network_LBaaS_SSLCipher SoftLayer service

func (Network_LBaaS_SSLCipher) Filter 

func (r Network_LBaaS_SSLCipher) Filter(filter string) Network_LBaaS_SSLCipher

func (Network_LBaaS_SSLCipher) GetAllObjects 

func (r Network_LBaaS_SSLCipher) GetAllObjects() (resp []datatypes.Network_LBaaS_SSLCipher, err error)

Returns all supported cipher list

func (Network_LBaaS_SSLCipher) GetObject 

func (r Network_LBaaS_SSLCipher) GetObject() (resp datatypes.Network_LBaaS_SSLCipher, err error)

no documentation yet

func (Network_LBaaS_SSLCipher) Id 

func (r Network_LBaaS_SSLCipher) Id(id int) Network_LBaaS_SSLCipher

func (Network_LBaaS_SSLCipher) Limit 

func (r Network_LBaaS_SSLCipher) Limit(limit int) Network_LBaaS_SSLCipher

func (Network_LBaaS_SSLCipher) Mask 

func (r Network_LBaaS_SSLCipher) Mask(mask string) Network_LBaaS_SSLCipher

func (Network_LBaaS_SSLCipher) Offset 

func (r Network_LBaaS_SSLCipher) Offset(offset int) Network_LBaaS_SSLCipher

type Network_LoadBalancer_Service 

type Network_LoadBalancer_Service struct {
	Session session.SLSession
	Options sl.Options
}

Deprecated Deprecated: This function has been marked as deprecated.

func GetNetworkLoadBalancerServiceService 

func GetNetworkLoadBalancerServiceService(sess session.SLSession) Network_LoadBalancer_Service

GetNetworkLoadBalancerServiceService returns an instance of the Network_LoadBalancer_Service SoftLayer service

func (Network_LoadBalancer_Service) DeleteObject 

func (r Network_LoadBalancer_Service) DeleteObject() (resp bool, err error)

Deprecated Deprecated: This function has been marked as deprecated.

func (Network_LoadBalancer_Service) Filter 

func (r Network_LoadBalancer_Service) Filter(filter string) Network_LoadBalancer_Service

func (Network_LoadBalancer_Service) GetGraphImage 

func (r Network_LoadBalancer_Service) GetGraphImage(graphType *string, metric *string) (resp []byte, err error)

Deprecated Deprecated: This function has been marked as deprecated.

func (Network_LoadBalancer_Service) GetObject 

func (r Network_LoadBalancer_Service) GetObject() (resp datatypes.Network_LoadBalancer_Service, err error)

Deprecated

func (Network_LoadBalancer_Service) GetStatus 

func (r Network_LoadBalancer_Service) GetStatus() (resp []datatypes.Container_Network_LoadBalancer_StatusEntry, err error)

Deprecated Deprecated: This function has been marked as deprecated.

func (Network_LoadBalancer_Service) GetVip 

func (r Network_LoadBalancer_Service) GetVip() (resp datatypes.Network_LoadBalancer_VirtualIpAddress, err error)

Retrieve The load balancer that this service belongs to.

func (Network_LoadBalancer_Service) Id 

func (r Network_LoadBalancer_Service) Id(id int) Network_LoadBalancer_Service

func (Network_LoadBalancer_Service) Limit 

func (r Network_LoadBalancer_Service) Limit(limit int) Network_LoadBalancer_Service

func (Network_LoadBalancer_Service) Mask 

func (r Network_LoadBalancer_Service) Mask(mask string) Network_LoadBalancer_Service

func (Network_LoadBalancer_Service) Offset 

func (r Network_LoadBalancer_Service) Offset(offset int) Network_LoadBalancer_Service

func (Network_LoadBalancer_Service) ResetPeakConnections 

func (r Network_LoadBalancer_Service) ResetPeakConnections() (resp bool, err error)

Deprecated Deprecated: This function has been marked as deprecated.

type Network_LoadBalancer_VirtualIpAddress 

type Network_LoadBalancer_VirtualIpAddress struct {
	Session session.SLSession
	Options sl.Options
}

Deprecated Deprecated: This function has been marked as deprecated.

func GetNetworkLoadBalancerVirtualIpAddressService 

func GetNetworkLoadBalancerVirtualIpAddressService(sess session.SLSession) Network_LoadBalancer_VirtualIpAddress

GetNetworkLoadBalancerVirtualIpAddressService returns an instance of the Network_LoadBalancer_VirtualIpAddress SoftLayer service

func (Network_LoadBalancer_VirtualIpAddress) Disable 

func (r Network_LoadBalancer_VirtualIpAddress) Disable() (resp bool, err error)

Deprecated Deprecated: This function has been marked as deprecated.

func (Network_LoadBalancer_VirtualIpAddress) EditObject 

func (r Network_LoadBalancer_VirtualIpAddress) EditObject(templateObject *datatypes.Network_LoadBalancer_VirtualIpAddress) (resp bool, err error)

Deprecated Deprecated: This function has been marked as deprecated.

func (Network_LoadBalancer_VirtualIpAddress) Enable 

func (r Network_LoadBalancer_VirtualIpAddress) Enable() (resp bool, err error)

Deprecated Deprecated: This function has been marked as deprecated.

func (Network_LoadBalancer_VirtualIpAddress) Filter 

func (r Network_LoadBalancer_VirtualIpAddress) Filter(filter string) Network_LoadBalancer_VirtualIpAddress

func (Network_LoadBalancer_VirtualIpAddress) GetAccount 

func (r Network_LoadBalancer_VirtualIpAddress) GetAccount() (resp datatypes.Account, err error)

Retrieve The account that owns this load balancer.

func (Network_LoadBalancer_VirtualIpAddress) GetBillingItem 

func (r Network_LoadBalancer_VirtualIpAddress) GetBillingItem() (resp datatypes.Billing_Item, err error)

Retrieve The current billing item for the Load Balancer.

func (Network_LoadBalancer_VirtualIpAddress) GetCustomerManagedFlag 

func (r Network_LoadBalancer_VirtualIpAddress) GetCustomerManagedFlag() (resp int, err error)

Retrieve If false, this VIP and associated services may be edited via the portal or the API. If true, you must configure this VIP manually on the device.

func (Network_LoadBalancer_VirtualIpAddress) GetManagedResourceFlag 

func (r Network_LoadBalancer_VirtualIpAddress) GetManagedResourceFlag() (resp bool, err error)

Retrieve A flag indicating that the load balancer is a managed resource.

func (Network_LoadBalancer_VirtualIpAddress) GetObject 

func (r Network_LoadBalancer_VirtualIpAddress) GetObject() (resp datatypes.Network_LoadBalancer_VirtualIpAddress, err error)

Deprecated

func (Network_LoadBalancer_VirtualIpAddress) GetServices 

func (r Network_LoadBalancer_VirtualIpAddress) GetServices() (resp []datatypes.Network_LoadBalancer_Service, err error)

Retrieve the services on this load balancer.

func (Network_LoadBalancer_VirtualIpAddress) Id 

func (r Network_LoadBalancer_VirtualIpAddress) Id(id int) Network_LoadBalancer_VirtualIpAddress

func (Network_LoadBalancer_VirtualIpAddress) KickAllConnections 

func (r Network_LoadBalancer_VirtualIpAddress) KickAllConnections() (resp bool, err error)

Deprecated Deprecated: This function has been marked as deprecated.

func (Network_LoadBalancer_VirtualIpAddress) Limit 

func (r Network_LoadBalancer_VirtualIpAddress) Limit(limit int) Network_LoadBalancer_VirtualIpAddress

func (Network_LoadBalancer_VirtualIpAddress) Mask 

func (r Network_LoadBalancer_VirtualIpAddress) Mask(mask string) Network_LoadBalancer_VirtualIpAddress

func (Network_LoadBalancer_VirtualIpAddress) Offset 

func (r Network_LoadBalancer_VirtualIpAddress) Offset(offset int) Network_LoadBalancer_VirtualIpAddress

func (Network_LoadBalancer_VirtualIpAddress) UpgradeConnectionLimit 

func (r Network_LoadBalancer_VirtualIpAddress) UpgradeConnectionLimit() (resp bool, err error)

Deprecated Deprecated: This function has been marked as deprecated.

type Network_Message_Delivery 

type Network_Message_Delivery struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetNetworkMessageDeliveryService 

func GetNetworkMessageDeliveryService(sess session.SLSession) Network_Message_Delivery

GetNetworkMessageDeliveryService returns an instance of the Network_Message_Delivery SoftLayer service

func (Network_Message_Delivery) EditObject 

func (r Network_Message_Delivery) EditObject(templateObject *datatypes.Network_Message_Delivery) (resp bool, err error)

no documentation yet

func (Network_Message_Delivery) Filter 

func (r Network_Message_Delivery) Filter(filter string) Network_Message_Delivery

func (Network_Message_Delivery) GetAccount 

func (r Network_Message_Delivery) GetAccount() (resp datatypes.Account, err error)

Retrieve The SoftLayer customer account that a network message delivery account belongs to.

func (Network_Message_Delivery) GetBillingItem 

func (r Network_Message_Delivery) GetBillingItem() (resp datatypes.Billing_Item, err error)

Retrieve The billing item for a network message delivery account.

func (Network_Message_Delivery) GetObject 

func (r Network_Message_Delivery) GetObject() (resp datatypes.Network_Message_Delivery, err error)

no documentation yet

func (Network_Message_Delivery) GetType 

func (r Network_Message_Delivery) GetType() (resp datatypes.Network_Message_Delivery_Type, err error)

Retrieve The message delivery type of a network message delivery account.

func (Network_Message_Delivery) GetUpgradeItemPrices added in v1.1.2 

func (r Network_Message_Delivery) GetUpgradeItemPrices() (resp []datatypes.Product_Item_Price, err error)

Retrieve a list of upgradable items available for network message delivery.

func (Network_Message_Delivery) GetVendor 

func (r Network_Message_Delivery) GetVendor() (resp datatypes.Network_Message_Delivery_Vendor, err error)

Retrieve The vendor for a network message delivery account.

func (Network_Message_Delivery) Id 

func (r Network_Message_Delivery) Id(id int) Network_Message_Delivery

func (Network_Message_Delivery) Limit 

func (r Network_Message_Delivery) Limit(limit int) Network_Message_Delivery

func (Network_Message_Delivery) Mask 

func (r Network_Message_Delivery) Mask(mask string) Network_Message_Delivery

func (Network_Message_Delivery) Offset 

func (r Network_Message_Delivery) Offset(offset int) Network_Message_Delivery

type Network_Message_Delivery_Email_Sendgrid 

type Network_Message_Delivery_Email_Sendgrid struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetNetworkMessageDeliveryEmailSendgridService 

func GetNetworkMessageDeliveryEmailSendgridService(sess session.SLSession) Network_Message_Delivery_Email_Sendgrid

GetNetworkMessageDeliveryEmailSendgridService returns an instance of the Network_Message_Delivery_Email_Sendgrid SoftLayer service

func (Network_Message_Delivery_Email_Sendgrid) AddUnsubscribeEmailAddress 

func (r Network_Message_Delivery_Email_Sendgrid) AddUnsubscribeEmailAddress(emailAddress *string) (resp bool, err error)

no documentation yet

func (Network_Message_Delivery_Email_Sendgrid) DeleteEmailListEntries 

func (r Network_Message_Delivery_Email_Sendgrid) DeleteEmailListEntries(list *string, entries []string) (resp bool, err error)

no documentation yet

func (Network_Message_Delivery_Email_Sendgrid) DisableSmtpAccess 

func (r Network_Message_Delivery_Email_Sendgrid) DisableSmtpAccess(disable *bool) (resp bool, err error)

no documentation yet

func (Network_Message_Delivery_Email_Sendgrid) EditObject 

func (r Network_Message_Delivery_Email_Sendgrid) EditObject(templateObject *datatypes.Network_Message_Delivery) (resp bool, err error)

no documentation yet

func (Network_Message_Delivery_Email_Sendgrid) EnableSmtpAccess 

func (r Network_Message_Delivery_Email_Sendgrid) EnableSmtpAccess(enable *bool) (resp bool, err error)

no documentation yet

func (Network_Message_Delivery_Email_Sendgrid) Filter 

func (r Network_Message_Delivery_Email_Sendgrid) Filter(filter string) Network_Message_Delivery_Email_Sendgrid

func (Network_Message_Delivery_Email_Sendgrid) GetAccount 

func (r Network_Message_Delivery_Email_Sendgrid) GetAccount() (resp datatypes.Account, err error)

Retrieve The SoftLayer customer account that a network message delivery account belongs to.

func (Network_Message_Delivery_Email_Sendgrid) GetAccountOverview 

func (r Network_Message_Delivery_Email_Sendgrid) GetAccountOverview() (resp datatypes.Container_Network_Message_Delivery_Email_Sendgrid_Account, err error)

no documentation yet

func (Network_Message_Delivery_Email_Sendgrid) GetBillingItem 

func (r Network_Message_Delivery_Email_Sendgrid) GetBillingItem() (resp datatypes.Billing_Item, err error)

Retrieve The billing item for a network message delivery account.

func (Network_Message_Delivery_Email_Sendgrid) GetEmailAddress 

func (r Network_Message_Delivery_Email_Sendgrid) GetEmailAddress() (resp string, err error)

Retrieve The contact e-mail address used by SendGrid.

func (Network_Message_Delivery_Email_Sendgrid) GetEmailList 

func (r Network_Message_Delivery_Email_Sendgrid) GetEmailList(list *string) (resp []datatypes.Container_Network_Message_Delivery_Email_Sendgrid_List_Entry, err error)

no documentation yet

func (Network_Message_Delivery_Email_Sendgrid) GetObject 

func (r Network_Message_Delivery_Email_Sendgrid) GetObject() (resp datatypes.Network_Message_Delivery_Email_Sendgrid, err error)

no documentation yet

func (Network_Message_Delivery_Email_Sendgrid) GetOfferingsList added in v1.0.6 

func (r Network_Message_Delivery_Email_Sendgrid) GetOfferingsList() (resp []datatypes.Container_Network_Message_Delivery_Email_Sendgrid_Catalog_Item, err error)

no documentation yet

func (Network_Message_Delivery_Email_Sendgrid) GetSmtpAccess 

func (r Network_Message_Delivery_Email_Sendgrid) GetSmtpAccess() (resp string, err error)

Retrieve A flag that determines if a SendGrid e-mail delivery account has access to send mail through the SendGrid SMTP server.

func (Network_Message_Delivery_Email_Sendgrid) GetStatistics 

func (r Network_Message_Delivery_Email_Sendgrid) GetStatistics(options *datatypes.Container_Network_Message_Delivery_Email_Sendgrid_Statistics_Options) (resp []datatypes.Container_Network_Message_Delivery_Email_Sendgrid_Statistics, err error)

no documentation yet

func (Network_Message_Delivery_Email_Sendgrid) GetStatisticsGraph 

func (r Network_Message_Delivery_Email_Sendgrid) GetStatisticsGraph(options *datatypes.Container_Network_Message_Delivery_Email_Sendgrid_Statistics_Options) (resp datatypes.Container_Network_Message_Delivery_Email_Sendgrid_Statistics_Graph, err error)

no documentation yet

func (Network_Message_Delivery_Email_Sendgrid) GetType 

func (r Network_Message_Delivery_Email_Sendgrid) GetType() (resp datatypes.Network_Message_Delivery_Type, err error)

Retrieve The message delivery type of a network message delivery account.

func (Network_Message_Delivery_Email_Sendgrid) GetUpgradeItemPrices added in v1.1.2 

func (r Network_Message_Delivery_Email_Sendgrid) GetUpgradeItemPrices() (resp []datatypes.Product_Item_Price, err error)

Retrieve a list of upgradable items available for network message delivery.

func (Network_Message_Delivery_Email_Sendgrid) GetVendor 

func (r Network_Message_Delivery_Email_Sendgrid) GetVendor() (resp datatypes.Network_Message_Delivery_Vendor, err error)

Retrieve The vendor for a network message delivery account.

func (Network_Message_Delivery_Email_Sendgrid) Id 

func (r Network_Message_Delivery_Email_Sendgrid) Id(id int) Network_Message_Delivery_Email_Sendgrid

func (Network_Message_Delivery_Email_Sendgrid) Limit 

func (r Network_Message_Delivery_Email_Sendgrid) Limit(limit int) Network_Message_Delivery_Email_Sendgrid

func (Network_Message_Delivery_Email_Sendgrid) Mask 

func (r Network_Message_Delivery_Email_Sendgrid) Mask(mask string) Network_Message_Delivery_Email_Sendgrid

func (Network_Message_Delivery_Email_Sendgrid) Offset 

func (r Network_Message_Delivery_Email_Sendgrid) Offset(offset int) Network_Message_Delivery_Email_Sendgrid

func (Network_Message_Delivery_Email_Sendgrid) SingleSignOn added in v1.1.2 

func (r Network_Message_Delivery_Email_Sendgrid) SingleSignOn() (resp string, err error)

no documentation yet

func (Network_Message_Delivery_Email_Sendgrid) UpdateEmailAddress 

func (r Network_Message_Delivery_Email_Sendgrid) UpdateEmailAddress(emailAddress *string) (resp bool, err error)

no documentation yet

type Network_Monitor 

type Network_Monitor struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetNetworkMonitorService 

func GetNetworkMonitorService(sess session.SLSession) Network_Monitor

GetNetworkMonitorService returns an instance of the Network_Monitor SoftLayer service

func (Network_Monitor) Filter 

func (r Network_Monitor) Filter(filter string) Network_Monitor

func (Network_Monitor) GetIpAddressesByHardware 

func (r Network_Monitor) GetIpAddressesByHardware(hardware *datatypes.Hardware, partialIpAddress *string) (resp []datatypes.Network_Subnet_IpAddress, err error)

This will return an arrayObject of objects containing the ipaddresses. Using an string parameter you can send a partial ipaddress to search within a given ipaddress. You can also set the max limit as well using the setting the resultLimit.

func (Network_Monitor) GetIpAddressesByVirtualGuest 

func (r Network_Monitor) GetIpAddressesByVirtualGuest(guest *datatypes.Virtual_Guest, partialIpAddress *string) (resp []datatypes.Network_Subnet_IpAddress, err error)

This will return an arrayObject of objects containing the ipaddresses. Using an string parameter you can send a partial ipaddress to search within a given ipaddress. You can also set the max limit as well using the setting the resultLimit.

func (Network_Monitor) Id 

func (r Network_Monitor) Id(id int) Network_Monitor

func (Network_Monitor) Limit 

func (r Network_Monitor) Limit(limit int) Network_Monitor

func (Network_Monitor) Mask 

func (r Network_Monitor) Mask(mask string) Network_Monitor

func (Network_Monitor) Offset 

func (r Network_Monitor) Offset(offset int) Network_Monitor

type Network_Monitor_Version1_Query_Host 

type Network_Monitor_Version1_Query_Host struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetNetworkMonitorVersion1QueryHostService 

func GetNetworkMonitorVersion1QueryHostService(sess session.SLSession) Network_Monitor_Version1_Query_Host

GetNetworkMonitorVersion1QueryHostService returns an instance of the Network_Monitor_Version1_Query_Host SoftLayer service

func (Network_Monitor_Version1_Query_Host) CreateObject 

func (r Network_Monitor_Version1_Query_Host) CreateObject(templateObject *datatypes.Network_Monitor_Version1_Query_Host) (resp datatypes.Network_Monitor_Version1_Query_Host, err error)

Passing in an unsaved instances of a Query_Host object into this function will create the object and return the results to the user.

func (Network_Monitor_Version1_Query_Host) CreateObjects 

func (r Network_Monitor_Version1_Query_Host) CreateObjects(templateObjects []datatypes.Network_Monitor_Version1_Query_Host) (resp []datatypes.Network_Monitor_Version1_Query_Host, err error)

Passing in a collection of unsaved instances of Query_Host objects into this function will create all objects and return the results to the user.

func (Network_Monitor_Version1_Query_Host) DeleteObject 

func (r Network_Monitor_Version1_Query_Host) DeleteObject() (resp bool, err error)

Like any other API object, the monitoring objects can be deleted by passing an instance of them into this function. The ID on the object must be set.

func (Network_Monitor_Version1_Query_Host) DeleteObjects 

func (r Network_Monitor_Version1_Query_Host) DeleteObjects(templateObjects []datatypes.Network_Monitor_Version1_Query_Host) (resp bool, err error)

Like any other API object, the monitoring objects can be deleted by passing an instance of them into this function. The ID on the object must be set.

func (Network_Monitor_Version1_Query_Host) EditObject 

func (r Network_Monitor_Version1_Query_Host) EditObject(templateObject *datatypes.Network_Monitor_Version1_Query_Host) (resp bool, err error)

Like any other API object, the monitoring objects can have their exposed properties edited by passing in a modified version of the object.

func (Network_Monitor_Version1_Query_Host) EditObjects 

func (r Network_Monitor_Version1_Query_Host) EditObjects(templateObjects []datatypes.Network_Monitor_Version1_Query_Host) (resp bool, err error)

Like any other API object, the monitoring objects can have their exposed properties edited by passing in a modified version of the object.

func (Network_Monitor_Version1_Query_Host) Filter 

func (r Network_Monitor_Version1_Query_Host) Filter(filter string) Network_Monitor_Version1_Query_Host

func (Network_Monitor_Version1_Query_Host) FindByHardwareId 

func (r Network_Monitor_Version1_Query_Host) FindByHardwareId(hardwareId *int) (resp []datatypes.Network_Monitor_Version1_Query_Host, err error)

This method returns all Query_Host objects associated with the passed in hardware ID as long as that hardware ID is owned by the current user's account.

This behavior can also be accomplished by simply tapping networkMonitors on the Hardware_Server object.

func (Network_Monitor_Version1_Query_Host) GetHardware 

func (r Network_Monitor_Version1_Query_Host) GetHardware() (resp datatypes.Hardware, err error)

Retrieve The hardware that is being monitored by this monitoring instance

func (Network_Monitor_Version1_Query_Host) GetLastResult 

func (r Network_Monitor_Version1_Query_Host) GetLastResult() (resp datatypes.Network_Monitor_Version1_Query_Result, err error)

Retrieve The most recent result for this particular monitoring instance.

func (Network_Monitor_Version1_Query_Host) GetObject 

func (r Network_Monitor_Version1_Query_Host) GetObject() (resp datatypes.Network_Monitor_Version1_Query_Host, err error)

getObject retrieves the SoftLayer_Network_Monitor_Version1_Query_Host object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Network_Monitor_Version1_Query_Host service. You can only retrieve query hosts attached to hardware that belong to your account.

func (Network_Monitor_Version1_Query_Host) GetQueryType 

func (r Network_Monitor_Version1_Query_Host) GetQueryType() (resp datatypes.Network_Monitor_Version1_Query_Type, err error)

Retrieve The type of monitoring query that is executed when this hardware is monitored.

func (Network_Monitor_Version1_Query_Host) GetResponseAction 

func (r Network_Monitor_Version1_Query_Host) GetResponseAction() (resp datatypes.Network_Monitor_Version1_Query_ResponseType, err error)

Retrieve The action taken when a monitor fails.

func (Network_Monitor_Version1_Query_Host) Id 

func (r Network_Monitor_Version1_Query_Host) Id(id int) Network_Monitor_Version1_Query_Host

func (Network_Monitor_Version1_Query_Host) Limit 

func (r Network_Monitor_Version1_Query_Host) Limit(limit int) Network_Monitor_Version1_Query_Host

func (Network_Monitor_Version1_Query_Host) Mask 

func (r Network_Monitor_Version1_Query_Host) Mask(mask string) Network_Monitor_Version1_Query_Host

func (Network_Monitor_Version1_Query_Host) Offset 

func (r Network_Monitor_Version1_Query_Host) Offset(offset int) Network_Monitor_Version1_Query_Host

type Network_Monitor_Version1_Query_Host_Stratum 

type Network_Monitor_Version1_Query_Host_Stratum struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetNetworkMonitorVersion1QueryHostStratumService 

func GetNetworkMonitorVersion1QueryHostStratumService(sess session.SLSession) Network_Monitor_Version1_Query_Host_Stratum

GetNetworkMonitorVersion1QueryHostStratumService returns an instance of the Network_Monitor_Version1_Query_Host_Stratum SoftLayer service

func (Network_Monitor_Version1_Query_Host_Stratum) Filter 

func (r Network_Monitor_Version1_Query_Host_Stratum) Filter(filter string) Network_Monitor_Version1_Query_Host_Stratum

func (Network_Monitor_Version1_Query_Host_Stratum) GetAllQueryTypes 

func (r Network_Monitor_Version1_Query_Host_Stratum) GetAllQueryTypes() (resp []datatypes.Network_Monitor_Version1_Query_Type, err error)

Calling this function returns all possible query type objects. These objects are to be used to set the values on the SoftLayer_Network_Monitor_Version1_Query_Host when creating new monitoring instances.

func (Network_Monitor_Version1_Query_Host_Stratum) GetAllResponseTypes 

func (r Network_Monitor_Version1_Query_Host_Stratum) GetAllResponseTypes() (resp []datatypes.Network_Monitor_Version1_Query_ResponseType, err error)

Calling this function returns all possible response type objects. These objects are to be used to set the values on the SoftLayer_Network_Monitor_Version1_Query_Host when creating new monitoring instances.

func (Network_Monitor_Version1_Query_Host_Stratum) GetHardware 

func (r Network_Monitor_Version1_Query_Host_Stratum) GetHardware() (resp datatypes.Hardware, err error)

Retrieve The hardware object that these monitoring permissions applies to.

func (Network_Monitor_Version1_Query_Host_Stratum) GetObject 

func (r Network_Monitor_Version1_Query_Host_Stratum) GetObject() (resp datatypes.Network_Monitor_Version1_Query_Host_Stratum, err error)

getObject retrieves the SoftLayer_Network_Monitor_Version1_Query_Host_Stratum object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Network_Monitor_Version1_Query_Host_Stratum service. You can only retrieve strata attached to hardware that belong to your account.

func (Network_Monitor_Version1_Query_Host_Stratum) Id 

func (r Network_Monitor_Version1_Query_Host_Stratum) Id(id int) Network_Monitor_Version1_Query_Host_Stratum

func (Network_Monitor_Version1_Query_Host_Stratum) Limit 

func (r Network_Monitor_Version1_Query_Host_Stratum) Limit(limit int) Network_Monitor_Version1_Query_Host_Stratum

func (Network_Monitor_Version1_Query_Host_Stratum) Mask 

func (r Network_Monitor_Version1_Query_Host_Stratum) Mask(mask string) Network_Monitor_Version1_Query_Host_Stratum

func (Network_Monitor_Version1_Query_Host_Stratum) Offset 

func (r Network_Monitor_Version1_Query_Host_Stratum) Offset(offset int) Network_Monitor_Version1_Query_Host_Stratum

type Network_Pod 

type Network_Pod struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetNetworkPodService 

func GetNetworkPodService(sess session.SLSession) Network_Pod

GetNetworkPodService returns an instance of the Network_Pod SoftLayer service

func (Network_Pod) Filter 

func (r Network_Pod) Filter(filter string) Network_Pod

func (Network_Pod) GetAllObjects 

func (r Network_Pod) GetAllObjects() (resp []datatypes.Network_Pod, err error)

Filtering is supported for “datacenterName“ and “capabilities“. When filtering on capabilities, use the “in“ operation. Pods fulfilling all capabilities provided will be returned. “datacenterName“ represents an operation against “SoftLayer_Location_Datacenter.name`, such as dal05 when referring to Dallas 5.

```Examples:```

List Pods in a specific datacenter. <pre> datacenterName.operation = 'dal06' </pre>

List Pods in a geographical area. <pre> datacenterName.operation = '^= dal' </pre>

List Pods in a region fulfilling capabilities. <pre> datacenterName.operation = '^= dal' capabilities.operation = 'in' capabilities.options = [ { name = data, value = [SOME_CAPABILITY, ANOTHER_CAPABILITY] } ] </pre>

func (Network_Pod) GetCapabilities 

func (r Network_Pod) GetCapabilities() (resp []string, err error)

Provides the list of capabilities a Pod fulfills. See [SoftLayer_Network_Pod/listCapabilities] for more information on capabilities.

func (Network_Pod) GetObject 

func (r Network_Pod) GetObject() (resp datatypes.Network_Pod, err error)

Set the initialization parameter to the “name“ of the Pod to retrieve.

func (Network_Pod) Id 

func (r Network_Pod) Id(id int) Network_Pod

func (Network_Pod) Limit 

func (r Network_Pod) Limit(limit int) Network_Pod

func (Network_Pod) ListCapabilities 

func (r Network_Pod) ListCapabilities() (resp []string, err error)

A capability is simply a string literal that denotes the availability of a feature. Capabilities are generally self describing, but any additional details concerning the implications of a capability will be documented elsewhere; usually by the Service or Operation related to it.

func (Network_Pod) Mask 

func (r Network_Pod) Mask(mask string) Network_Pod

func (Network_Pod) Offset 

func (r Network_Pod) Offset(offset int) Network_Pod

type Network_SecurityGroup 

type Network_SecurityGroup struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetNetworkSecurityGroupService 

func GetNetworkSecurityGroupService(sess session.SLSession) Network_SecurityGroup

GetNetworkSecurityGroupService returns an instance of the Network_SecurityGroup SoftLayer service

func (Network_SecurityGroup) AddRules 

func (r Network_SecurityGroup) AddRules(ruleTemplates []datatypes.Network_SecurityGroup_Rule) (resp datatypes.Network_SecurityGroup_RequestRules, err error)

Add new rules to a security group by sending in an array of template [[SoftLayer_Network_SecurityGroup_Rule (type)]] objects to be created.

func (Network_SecurityGroup) AttachNetworkComponents 

func (r Network_SecurityGroup) AttachNetworkComponents(networkComponentIds []int) (resp datatypes.Network_SecurityGroup_Request, err error)

Attach virtual guest network components to a security group by creating [[SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding (type)]] objects.

func (Network_SecurityGroup) CreateObject 

func (r Network_SecurityGroup) CreateObject(templateObject *datatypes.Network_SecurityGroup) (resp datatypes.Network_SecurityGroup, err error)

Create a new security group.

func (Network_SecurityGroup) CreateObjects 

func (r Network_SecurityGroup) CreateObjects(templateObjects []datatypes.Network_SecurityGroup) (resp []datatypes.Network_SecurityGroup, err error)

Create new security groups.

func (Network_SecurityGroup) DeleteObject 

func (r Network_SecurityGroup) DeleteObject() (resp bool, err error)

Delete a security group for an account. A security group cannot be deleted if any network components are attached or if the security group is a remote security group for a [[SoftLayer_Network_SecurityGroup_Rule (type)|rule]].

func (Network_SecurityGroup) DeleteObjects 

func (r Network_SecurityGroup) DeleteObjects(templateObjects []datatypes.Network_SecurityGroup) (resp bool, err error)

Delete security groups for an account. A security group cannot be deleted if any network components are attached or if the security group is a remote security group for a [[SoftLayer_Network_SecurityGroup_Rule (type)|rule]].

func (Network_SecurityGroup) DetachNetworkComponents 

func (r Network_SecurityGroup) DetachNetworkComponents(networkComponentIds []int) (resp datatypes.Network_SecurityGroup_Request, err error)

Detach virtual guest network components from a security group by deleting its [[SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding (type)]].

func (Network_SecurityGroup) EditObject 

func (r Network_SecurityGroup) EditObject(templateObject *datatypes.Network_SecurityGroup) (resp bool, err error)

Edit a security group.

func (Network_SecurityGroup) EditObjects 

func (r Network_SecurityGroup) EditObjects(templateObjects []datatypes.Network_SecurityGroup) (resp bool, err error)

Edit security groups.

func (Network_SecurityGroup) EditRules 

func (r Network_SecurityGroup) EditRules(ruleTemplates []datatypes.Network_SecurityGroup_Rule) (resp datatypes.Network_SecurityGroup_RequestRules, err error)

Edit rules that belong to the security group. An array of skeleton [[SoftLayer_Network_SecurityGroup_Rule]] objects must be sent in with only the properties defined that you want to change. To edit a property to null, send in -1 for integer properties and "" for string properties. Unchanged properties are left alone.

func (Network_SecurityGroup) Filter 

func (r Network_SecurityGroup) Filter(filter string) Network_SecurityGroup

func (Network_SecurityGroup) GetAccount 

func (r Network_SecurityGroup) GetAccount() (resp datatypes.Account, err error)

Retrieve The account this security group belongs to.

func (Network_SecurityGroup) GetAllObjects 

func (r Network_SecurityGroup) GetAllObjects() (resp []datatypes.Network_SecurityGroup, err error)

no documentation yet

func (Network_SecurityGroup) GetLimits 

func (r Network_SecurityGroup) GetLimits() (resp []datatypes.Container_Network_SecurityGroup_Limit, err error)

List the current security group limits

func (Network_SecurityGroup) GetNetworkComponentBindings 

func (r Network_SecurityGroup) GetNetworkComponentBindings() (resp []datatypes.Virtual_Network_SecurityGroup_NetworkComponentBinding, err error)

Retrieve The network component bindings for this security group.

func (Network_SecurityGroup) GetObject 

func (r Network_SecurityGroup) GetObject() (resp datatypes.Network_SecurityGroup, err error)

no documentation yet

func (Network_SecurityGroup) GetOrderBindings 

func (r Network_SecurityGroup) GetOrderBindings() (resp []datatypes.Network_SecurityGroup_OrderBinding, err error)

Retrieve The order bindings for this security group

func (Network_SecurityGroup) GetRules 

func (r Network_SecurityGroup) GetRules() (resp []datatypes.Network_SecurityGroup_Rule, err error)

Retrieve The rules for this security group.

func (Network_SecurityGroup) GetSupportedDataCenters 

func (r Network_SecurityGroup) GetSupportedDataCenters() (resp []datatypes.Location, err error)

List the data centers that currently support the use of security groups.

func (Network_SecurityGroup) Id 

func (r Network_SecurityGroup) Id(id int) Network_SecurityGroup

func (Network_SecurityGroup) Limit 

func (r Network_SecurityGroup) Limit(limit int) Network_SecurityGroup

func (Network_SecurityGroup) Mask 

func (r Network_SecurityGroup) Mask(mask string) Network_SecurityGroup

func (Network_SecurityGroup) Offset 

func (r Network_SecurityGroup) Offset(offset int) Network_SecurityGroup

func (Network_SecurityGroup) RemoveRules 

func (r Network_SecurityGroup) RemoveRules(ruleIds []int) (resp datatypes.Network_SecurityGroup_RequestRules, err error)

Remove rules from a security group.

type Network_Security_Scanner_Request 

type Network_Security_Scanner_Request struct {
	Session session.SLSession
	Options sl.Options
}

DEPRECATED Deprecated: This function has been marked as deprecated.

func GetNetworkSecurityScannerRequestService 

func GetNetworkSecurityScannerRequestService(sess session.SLSession) Network_Security_Scanner_Request

GetNetworkSecurityScannerRequestService returns an instance of the Network_Security_Scanner_Request SoftLayer service

func (Network_Security_Scanner_Request) CreateObject 

func (r Network_Security_Scanner_Request) CreateObject(templateObject *datatypes.Network_Security_Scanner_Request) (resp datatypes.Network_Security_Scanner_Request, err error)

Create a new vulnerability scan request. New scan requests are picked up every five minutes, and the time to complete an actual scan may vary. Once the scan is finished, it can take up to another five minutes for the report to be generated and accessible. Deprecated: This function has been marked as deprecated.

func (Network_Security_Scanner_Request) Filter 

func (r Network_Security_Scanner_Request) Filter(filter string) Network_Security_Scanner_Request

func (Network_Security_Scanner_Request) GetAccount 

func (r Network_Security_Scanner_Request) GetAccount() (resp datatypes.Account, err error)

Retrieve The account associated with a security scan request.

func (Network_Security_Scanner_Request) GetGuest 

func (r Network_Security_Scanner_Request) GetGuest() (resp datatypes.Virtual_Guest, err error)

Retrieve The virtual guest a security scan is run against.

func (Network_Security_Scanner_Request) GetHardware 

func (r Network_Security_Scanner_Request) GetHardware() (resp datatypes.Hardware, err error)

Retrieve The hardware a security scan is run against.

func (Network_Security_Scanner_Request) GetObject 

func (r Network_Security_Scanner_Request) GetObject() (resp datatypes.Network_Security_Scanner_Request, err error)

DEPRECATED

func (Network_Security_Scanner_Request) GetReport 

func (r Network_Security_Scanner_Request) GetReport() (resp string, err error)

DEPRECATED Deprecated: This function has been marked as deprecated.

func (Network_Security_Scanner_Request) GetRequestorOwnedFlag 

func (r Network_Security_Scanner_Request) GetRequestorOwnedFlag() (resp bool, err error)

Retrieve Flag whether the requestor owns the hardware the scan was run on. This flag will return for hardware servers only, virtual servers will result in a null return even if you have a request out for them.

func (Network_Security_Scanner_Request) GetStatus 

func (r Network_Security_Scanner_Request) GetStatus() (resp datatypes.Network_Security_Scanner_Request_Status, err error)

Retrieve A security scan request's status.

func (Network_Security_Scanner_Request) Id 

func (r Network_Security_Scanner_Request) Id(id int) Network_Security_Scanner_Request

func (Network_Security_Scanner_Request) Limit 

func (r Network_Security_Scanner_Request) Limit(limit int) Network_Security_Scanner_Request

func (Network_Security_Scanner_Request) Mask 

func (r Network_Security_Scanner_Request) Mask(mask string) Network_Security_Scanner_Request

func (Network_Security_Scanner_Request) Offset 

func (r Network_Security_Scanner_Request) Offset(offset int) Network_Security_Scanner_Request

type Network_Service_Vpn_Overrides 

type Network_Service_Vpn_Overrides struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetNetworkServiceVpnOverridesService 

func GetNetworkServiceVpnOverridesService(sess session.SLSession) Network_Service_Vpn_Overrides

GetNetworkServiceVpnOverridesService returns an instance of the Network_Service_Vpn_Overrides SoftLayer service

func (Network_Service_Vpn_Overrides) CreateObjects 

func (r Network_Service_Vpn_Overrides) CreateObjects(templateObjects []datatypes.Network_Service_Vpn_Overrides) (resp bool, err error)

Create Softlayer portal user VPN overrides.

func (Network_Service_Vpn_Overrides) DeleteObject 

func (r Network_Service_Vpn_Overrides) DeleteObject() (resp bool, err error)

Use this method to delete a single SoftLayer portal VPN user subnet override.

func (Network_Service_Vpn_Overrides) DeleteObjects 

func (r Network_Service_Vpn_Overrides) DeleteObjects(templateObjects []datatypes.Network_Service_Vpn_Overrides) (resp bool, err error)

Use this method to delete a collection of SoftLayer portal VPN user subnet overrides.

func (Network_Service_Vpn_Overrides) Filter 

func (r Network_Service_Vpn_Overrides) Filter(filter string) Network_Service_Vpn_Overrides

func (Network_Service_Vpn_Overrides) GetObject 

func (r Network_Service_Vpn_Overrides) GetObject() (resp datatypes.Network_Service_Vpn_Overrides, err error)

no documentation yet

func (Network_Service_Vpn_Overrides) GetSubnet 

func (r Network_Service_Vpn_Overrides) GetSubnet() (resp datatypes.Network_Subnet, err error)

Retrieve Subnet components accessible by a SoftLayer VPN portal user.

func (Network_Service_Vpn_Overrides) GetUser 

func (r Network_Service_Vpn_Overrides) GetUser() (resp datatypes.User_Customer, err error)

Retrieve SoftLayer VPN portal user.

func (Network_Service_Vpn_Overrides) Id 

func (r Network_Service_Vpn_Overrides) Id(id int) Network_Service_Vpn_Overrides

func (Network_Service_Vpn_Overrides) Limit 

func (r Network_Service_Vpn_Overrides) Limit(limit int) Network_Service_Vpn_Overrides

func (Network_Service_Vpn_Overrides) Mask 

func (r Network_Service_Vpn_Overrides) Mask(mask string) Network_Service_Vpn_Overrides

func (Network_Service_Vpn_Overrides) Offset 

func (r Network_Service_Vpn_Overrides) Offset(offset int) Network_Service_Vpn_Overrides

type Network_Storage 

type Network_Storage struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetNetworkStorageService 

func GetNetworkStorageService(sess session.SLSession) Network_Storage

GetNetworkStorageService returns an instance of the Network_Storage SoftLayer service

func (Network_Storage) AllowAccessFromHardware 

func (r Network_Storage) AllowAccessFromHardware(hardwareObjectTemplate *datatypes.Hardware) (resp bool, err error)

This method is used to modify the access control list for this Storage volume. The SoftLayer_Hardware objects which have been allowed access to this storage will be listed in the allowedHardware property of this storage volume.

func (Network_Storage) AllowAccessFromHardwareList 

func (r Network_Storage) AllowAccessFromHardwareList(hardwareObjectTemplates []datatypes.Hardware) (resp bool, err error)

no documentation yet

func (Network_Storage) AllowAccessFromHost 

func (r Network_Storage) AllowAccessFromHost(typeClassName *string, hostId *int) (resp datatypes.Network_Storage_Allowed_Host, err error)

This method is used to modify the access control list for this Storage volume. The [[SoftLayer_Hardware|SoftLayer_Virtual_Guest|SoftLayer_Network_Subnet|SoftLayer_Network_Subnet_IpAddress]] objects which have been allowed access to this storage will be listed in the [[allowedHardware|allowedVirtualGuests|allowedSubnets|allowedIpAddresses]] property of this storage volume.

func (Network_Storage) AllowAccessFromHostList 

func (r Network_Storage) AllowAccessFromHostList(hostObjectTemplates []datatypes.Container_Network_Storage_Host) (resp []datatypes.Network_Storage_Allowed_Host, err error)

This method is used to modify the access control list for this Storage volume. The [[SoftLayer_Hardware|SoftLayer_Virtual_Guest|SoftLayer_Network_Subnet|SoftLayer_Network_Subnet_IpAddress]] objects which have been allowed access to this storage volume will be listed in the [[allowedHardware|allowedVirtualGuests|allowedSubnets|allowedIpAddresses]] property of this storage volume.

func (Network_Storage) AllowAccessFromIpAddress 

func (r Network_Storage) AllowAccessFromIpAddress(ipAddressObjectTemplate *datatypes.Network_Subnet_IpAddress) (resp bool, err error)

This method is used to modify the access control list for this Storage volume. The SoftLayer_Network_Subnet_IpAddress objects which have been allowed access to this storage will be listed in the allowedIpAddresses property of this storage volume.

func (Network_Storage) AllowAccessFromIpAddressList 

func (r Network_Storage) AllowAccessFromIpAddressList(ipAddressObjectTemplates []datatypes.Network_Subnet_IpAddress) (resp bool, err error)

no documentation yet

func (Network_Storage) AllowAccessFromSubnet 

func (r Network_Storage) AllowAccessFromSubnet(subnetObjectTemplate *datatypes.Network_Subnet) (resp bool, err error)

This method is used to modify the access control list for this Storage volume. The SoftLayer_Network_Subnet objects which have been allowed access to this storage will be listed in the allowedHardware property of this storage volume.

func (Network_Storage) AllowAccessFromSubnetList 

func (r Network_Storage) AllowAccessFromSubnetList(subnetObjectTemplates []datatypes.Network_Subnet) (resp bool, err error)

no documentation yet

func (Network_Storage) AllowAccessFromVirtualGuest 

func (r Network_Storage) AllowAccessFromVirtualGuest(virtualGuestObjectTemplate *datatypes.Virtual_Guest) (resp bool, err error)

This method is used to modify the access control list for this Storage volume. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage will be listed in the allowedVirtualGuests property of this storage volume.

func (Network_Storage) AllowAccessFromVirtualGuestList 

func (r Network_Storage) AllowAccessFromVirtualGuestList(virtualGuestObjectTemplates []datatypes.Virtual_Guest) (resp bool, err error)

This method is used to modify the access control list for this Storage volume. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage will be listed in the allowedVirtualGuests property of this storage volume.

func (Network_Storage) AllowAccessToReplicantFromHardware 

func (r Network_Storage) AllowAccessToReplicantFromHardware(hardwareObjectTemplate *datatypes.Hardware) (resp bool, err error)

This method is used to modify the access control list for this Storage replicant volume. The SoftLayer_Hardware objects which have been allowed access to this storage will be listed in the allowedHardware property of this storage replicant volume.

func (Network_Storage) AllowAccessToReplicantFromHardwareList 

func (r Network_Storage) AllowAccessToReplicantFromHardwareList(hardwareObjectTemplates []datatypes.Hardware) (resp bool, err error)

This method is used to modify the access control list for this Storage volume's replica. The SoftLayer_Hardware objects which have been allowed access to this storage volume's replica will be listed in the allowedReplicationHardware property of this storage volume.

func (Network_Storage) AllowAccessToReplicantFromIpAddress 

func (r Network_Storage) AllowAccessToReplicantFromIpAddress(ipAddressObjectTemplate *datatypes.Network_Subnet_IpAddress) (resp bool, err error)

no documentation yet

func (Network_Storage) AllowAccessToReplicantFromIpAddressList 

func (r Network_Storage) AllowAccessToReplicantFromIpAddressList(ipAddressObjectTemplates []datatypes.Network_Subnet_IpAddress) (resp bool, err error)

This method is used to modify the access control list for this Storage volume's replica. The SoftLayer_Network_Subnet_IpAddress objects which have been allowed access to this storage volume's replica will be listed in the allowedReplicationIpAddresses property of this storage volume.

func (Network_Storage) AllowAccessToReplicantFromSubnet 

func (r Network_Storage) AllowAccessToReplicantFromSubnet(subnetObjectTemplate *datatypes.Network_Subnet) (resp bool, err error)

This method is used to modify the access control list for this Storage replicant volume. The SoftLayer_Network_Subnet objects which have been allowed access to this storage will be listed in the allowedHardware property of this storage replicant volume.

func (Network_Storage) AllowAccessToReplicantFromSubnetList 

func (r Network_Storage) AllowAccessToReplicantFromSubnetList(subnetObjectTemplates []datatypes.Network_Subnet) (resp bool, err error)

This method is used to modify the access control list for this Storage volume's replica. The SoftLayer_Network_Subnet objects which have been allowed access to this storage volume's replica will be listed in the allowedReplicationSubnets property of this storage volume.

func (Network_Storage) AllowAccessToReplicantFromVirtualGuest 

func (r Network_Storage) AllowAccessToReplicantFromVirtualGuest(virtualGuestObjectTemplate *datatypes.Virtual_Guest) (resp bool, err error)

This method is used to modify the access control list for this Storage replicant volume. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage will be listed in the allowedVirtualGuests property of this storage replicant volume.

func (Network_Storage) AllowAccessToReplicantFromVirtualGuestList 

func (r Network_Storage) AllowAccessToReplicantFromVirtualGuestList(virtualGuestObjectTemplates []datatypes.Virtual_Guest) (resp bool, err error)

This method is used to modify the access control list for this Storage volume's replica. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage volume's replica will be listed in the allowedReplicationVirtualGuests property of this storage volume.

func (Network_Storage) AssignCredential 

func (r Network_Storage) AssignCredential(username *string) (resp bool, err error)

This method will assign an existing credential to the current volume. The credential must have been created using the 'addNewCredential' method. The volume type must support an additional credential.

func (Network_Storage) AssignNewCredential 

func (r Network_Storage) AssignNewCredential(typ *string) (resp datatypes.Network_Storage_Credential, err error)

This method will set up a new credential for the remote storage volume. The storage volume must support an additional credential. Once created, the credential will be automatically assigned to the current volume. If there are no volumes assigned to the credential it will be automatically deleted.

func (Network_Storage) ChangePassword 

func (r Network_Storage) ChangePassword(username *string, currentPassword *string, newPassword *string) (resp bool, err error)

The method will change the password for the given Storage/Virtual Server Storage account.

func (Network_Storage) CollectBandwidth 

func (r Network_Storage) CollectBandwidth(typ *string, startDate *datatypes.Time, endDate *datatypes.Time) (resp uint, err error)

{{CloudLayerOnlyMethod}}

collectBandwidth() Retrieve the bandwidth usage for the current billing cycle.

func (Network_Storage) CollectBytesUsed 

func (r Network_Storage) CollectBytesUsed() (resp uint, err error)

{{CloudLayerOnlyMethod}}

collectBytesUsed() retrieves the number of bytes capacity currently in use on a Storage account.

func (Network_Storage) ConvertCloneDependentToIndependent added in v1.0.1 

func (r Network_Storage) ConvertCloneDependentToIndependent() (resp bool, err error)

no documentation yet

func (Network_Storage) CreateFolder 

func (r Network_Storage) CreateFolder(folder *string) (resp bool, err error)

no documentation yet

func (Network_Storage) CreateOrUpdateLunId 

func (r Network_Storage) CreateOrUpdateLunId(lunId *int) (resp datatypes.Network_Storage_Property, err error)

The LUN ID only takes effect during the Host Authorization process. It is required to de-authorize all hosts before using this method.

func (Network_Storage) CreateSnapshot 

func (r Network_Storage) CreateSnapshot(notes *string) (resp datatypes.Network_Storage, err error)

no documentation yet

func (Network_Storage) DeleteAllFiles 

func (r Network_Storage) DeleteAllFiles() (resp bool, err error)

{{CloudLayerOnlyMethod}} Delete all files within a Storage account. Depending on the type of Storage account, Deleting either deletes files permanently or sends files to your account's recycle bin.

Currently, Virtual Server storage is the only type of Storage account that sends files to a recycle bin when deleted. When called against a Virtual Server storage account , this method also determines if the files are in the account's recycle bin. If the files exist in the recycle bin, then they are permanently deleted.

Please note, files can not be restored once they are permanently deleted.

func (Network_Storage) DeleteFile 

func (r Network_Storage) DeleteFile(fileId *string) (resp bool, err error)

{{CloudLayerOnlyMethod}} Delete an individual file within a Storage account. Depending on the type of Storage account, Deleting a file either deletes the file permanently or sends the file to your account's recycle bin.

Currently, Virtual Server storage is the only type of Storage account that sends files to a recycle bin when deleted. When called against a Virtual Server storage account , this method also determines if the file is in the account's recycle bin. If the file exist in the recycle bin, then it is permanently deleted.

Please note, a file can not be restored once it is permanently deleted.

func (Network_Storage) DeleteFiles 

func (r Network_Storage) DeleteFiles(fileIds []string) (resp bool, err error)

{{CloudLayerOnlyMethod}} Delete multiple files within a Storage account. Depending on the type of Storage account, Deleting either deletes files permanently or sends files to your account's recycle bin.

Currently, Virtual Server storage is the only type of Storage account that sends files to a recycle bin when deleted. When called against a Virtual Server storage account , this method also determines if the files are in the account's recycle bin. If the files exist in the recycle bin, then they are permanently deleted.

Please note, files can not be restored once they are permanently deleted.

func (Network_Storage) DeleteFolder 

func (r Network_Storage) DeleteFolder(folder *string) (resp bool, err error)

no documentation yet

func (Network_Storage) DeleteObject 

func (r Network_Storage) DeleteObject() (resp bool, err error)

Delete a network storage volume. ”'This cannot be undone.”' At this time only network storage snapshots may be deleted with this method.

”deleteObject” returns Boolean ”true” on successful deletion or ”false” if it was unable to remove a volume;

func (Network_Storage) DisableSnapshots 

func (r Network_Storage) DisableSnapshots(scheduleType *string) (resp bool, err error)

This method is not valid for Legacy iSCSI Storage Volumes.

Disable scheduled snapshots of this storage volume. Scheduling options include 'INTERVAL', HOURLY, DAILY and WEEKLY schedules.

func (Network_Storage) DisasterRecoveryFailoverToReplicant added in v1.0.3 

func (r Network_Storage) DisasterRecoveryFailoverToReplicant(replicantId *int) (resp bool, err error)

If a volume (with replication) becomes inaccessible due to a disaster event, this method can be used to immediately failover to an available replica in another location. This method does not allow for fail back via the API. To fail back to the original volume after using this method, open a support ticket. To test failover, use [[SoftLayer_Network_Storage::failoverToReplicant]] instead.

func (Network_Storage) DownloadFile 

func (r Network_Storage) DownloadFile(fileId *string) (resp datatypes.Container_Utility_File_Entity, err error)

{{CloudLayerOnlyMethod}} Download a file from a Storage account. This method returns a file's details including the file's raw content.

func (Network_Storage) EditCredential 

func (r Network_Storage) EditCredential(username *string, newPassword *string) (resp bool, err error)

This method will change the password of a credential created using the 'addNewCredential' method. If the credential exists on multiple storage volumes it will change for those volumes as well.

func (Network_Storage) EditObject 

func (r Network_Storage) EditObject(templateObject *datatypes.Network_Storage) (resp bool, err error)

The password and/or notes may be modified for the Storage service except evault passwords and notes.

func (Network_Storage) EnableSnapshots 

func (r Network_Storage) EnableSnapshots(scheduleType *string, retentionCount *int, minute *int, hour *int, dayOfWeek *string) (resp bool, err error)

This method is not valid for Legacy iSCSI Storage Volumes.

Enable scheduled snapshots of this storage volume. Scheduling options include HOURLY, DAILY and WEEKLY schedules. For HOURLY schedules, provide relevant data for $scheduleType, $retentionCount and $minute. For DAILY schedules, provide relevant data for $scheduleType, $retentionCount, $minute, and $hour. For WEEKLY schedules, provide relevant data for all parameters of this method.

func (Network_Storage) FailbackFromReplicant 

func (r Network_Storage) FailbackFromReplicant() (resp bool, err error)

Failback from a volume replicant. In order to failback the volume must have already been failed over to a replicant.

func (Network_Storage) FailoverToReplicant 

func (r Network_Storage) FailoverToReplicant(replicantId *int) (resp bool, err error)

Failover to a volume replicant. During the time which the replicant is in use the local nas volume will not be available.

func (Network_Storage) Filter 

func (r Network_Storage) Filter(filter string) Network_Storage

func (Network_Storage) GetAccount 

func (r Network_Storage) GetAccount() (resp datatypes.Account, err error)

Retrieve The account that a Storage services belongs to.

func (Network_Storage) GetAccountPassword 

func (r Network_Storage) GetAccountPassword() (resp datatypes.Account_Password, err error)

Retrieve Other usernames and passwords associated with a Storage volume.

func (Network_Storage) GetActiveTransactions 

func (r Network_Storage) GetActiveTransactions() (resp []datatypes.Provisioning_Version1_Transaction, err error)

Retrieve The currently active transactions on a network storage volume.

func (Network_Storage) GetAllFiles 

func (r Network_Storage) GetAllFiles() (resp []datatypes.Container_Utility_File_Entity, err error)

{{CloudLayerOnlyMethod}} Retrieve details such as id, name, size, create date for all files in a Storage account's root directory. This does not download file content.

func (Network_Storage) GetAllFilesByFilter 

func (r Network_Storage) GetAllFilesByFilter(filter *datatypes.Container_Utility_File_Entity) (resp []datatypes.Container_Utility_File_Entity, err error)

{{CloudLayerOnlyMethod}} Retrieve details such as id, name, size, create date for all files matching the filter's criteria in a Storage account's root directory. This does not download file content.

func (Network_Storage) GetAllowDisasterRecoveryFailback added in v1.0.4 

func (r Network_Storage) GetAllowDisasterRecoveryFailback() (resp string, err error)

Retrieve

func (Network_Storage) GetAllowDisasterRecoveryFailover added in v1.0.4 

func (r Network_Storage) GetAllowDisasterRecoveryFailover() (resp string, err error)

Retrieve

func (Network_Storage) GetAllowableHardware 

func (r Network_Storage) GetAllowableHardware(filterHostname *string) (resp []datatypes.Hardware, err error)

This method retrieves a list of SoftLayer_Hardware that can be authorized to this SoftLayer_Network_Storage.

func (Network_Storage) GetAllowableIpAddresses 

func (r Network_Storage) GetAllowableIpAddresses(subnetId *int, filterIpAddress *string) (resp []datatypes.Network_Subnet_IpAddress, err error)

This method retrieves a list of SoftLayer_Network_Subnet_IpAddress that can be authorized to this SoftLayer_Network_Storage.

func (Network_Storage) GetAllowableSubnets 

func (r Network_Storage) GetAllowableSubnets(filterNetworkIdentifier *string) (resp []datatypes.Network_Subnet, err error)

This method retrieves a list of SoftLayer_Network_Subnet that can be authorized to this SoftLayer_Network_Storage.

func (Network_Storage) GetAllowableVirtualGuests 

func (r Network_Storage) GetAllowableVirtualGuests(filterHostname *string) (resp []datatypes.Virtual_Guest, err error)

This method retrieves a list of SoftLayer_Virtual_Guest that can be authorized to this SoftLayer_Network_Storage.

func (Network_Storage) GetAllowedHardware 

func (r Network_Storage) GetAllowedHardware() (resp []datatypes.Hardware, err error)

Retrieve The SoftLayer_Hardware objects which are allowed access to this storage volume.

func (Network_Storage) GetAllowedHostsLimit 

func (r Network_Storage) GetAllowedHostsLimit() (resp int, err error)

Retrieves the total number of allowed hosts limit per volume.

func (Network_Storage) GetAllowedIpAddresses 

func (r Network_Storage) GetAllowedIpAddresses() (resp []datatypes.Network_Subnet_IpAddress, err error)

Retrieve The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume.

func (Network_Storage) GetAllowedReplicationHardware 

func (r Network_Storage) GetAllowedReplicationHardware() (resp []datatypes.Hardware, err error)

Retrieve The SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant.

func (Network_Storage) GetAllowedReplicationIpAddresses 

func (r Network_Storage) GetAllowedReplicationIpAddresses() (resp []datatypes.Network_Subnet_IpAddress, err error)

Retrieve The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume's Replicant.

func (Network_Storage) GetAllowedReplicationSubnets 

func (r Network_Storage) GetAllowedReplicationSubnets() (resp []datatypes.Network_Subnet, err error)

Retrieve The SoftLayer_Network_Subnet objects which are allowed access to this storage volume's Replicant.

func (Network_Storage) GetAllowedReplicationVirtualGuests 

func (r Network_Storage) GetAllowedReplicationVirtualGuests() (resp []datatypes.Virtual_Guest, err error)

Retrieve The SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant.

func (Network_Storage) GetAllowedSubnets 

func (r Network_Storage) GetAllowedSubnets() (resp []datatypes.Network_Subnet, err error)

Retrieve The SoftLayer_Network_Subnet objects which are allowed access to this storage volume.

func (Network_Storage) GetAllowedVirtualGuests 

func (r Network_Storage) GetAllowedVirtualGuests() (resp []datatypes.Virtual_Guest, err error)

Retrieve The SoftLayer_Virtual_Guest objects which are allowed access to this storage volume.

func (Network_Storage) GetBillingItem 

func (r Network_Storage) GetBillingItem() (resp datatypes.Billing_Item, err error)

Retrieve The current billing item for a Storage volume.

func (Network_Storage) GetBillingItemCategory 

func (r Network_Storage) GetBillingItemCategory() (resp datatypes.Product_Item_Category, err error)

Retrieve

func (Network_Storage) GetByUsername 

func (r Network_Storage) GetByUsername(username *string, typ *string) (resp []datatypes.Network_Storage, err error)

Retrieve network storage accounts by username and storage account type. Use this method if you wish to retrieve a storage record by username rather than by id. The ”type” parameter must correspond to one of the available ”nasType” values in the SoftLayer_Network_Storage data type.

func (Network_Storage) GetBytesUsed 

func (r Network_Storage) GetBytesUsed() (resp string, err error)

Retrieve The amount of space used by the volume, in bytes.

func (Network_Storage) GetCdnUrls 

func (r Network_Storage) GetCdnUrls() (resp []datatypes.Container_Network_Storage_Hub_ObjectStorage_ContentDeliveryUrl, err error)

no documentation yet

func (Network_Storage) GetClusterResource 

func (r Network_Storage) GetClusterResource() (resp datatypes.Network_Service_Resource, err error)

no documentation yet

func (Network_Storage) GetCreationScheduleId 

func (r Network_Storage) GetCreationScheduleId() (resp string, err error)

Retrieve The schedule id which was executed to create a snapshot.

func (Network_Storage) GetCredentials 

func (r Network_Storage) GetCredentials() (resp []datatypes.Network_Storage_Credential, err error)

Retrieve

func (Network_Storage) GetDailySchedule 

func (r Network_Storage) GetDailySchedule() (resp datatypes.Network_Storage_Schedule, err error)

Retrieve The Daily Schedule which is associated with this network storage volume.

func (Network_Storage) GetDependentDuplicate 

func (r Network_Storage) GetDependentDuplicate() (resp string, err error)

Retrieve Whether or not a network storage volume is a dependent duplicate.

func (Network_Storage) GetDependentDuplicates added in v1.0.1 

func (r Network_Storage) GetDependentDuplicates() (resp []datatypes.Network_Storage, err error)

Retrieve The network storage volumes configured to be dependent duplicates of a volume.

func (Network_Storage) GetDuplicateConversionStatus added in v1.0.6 

func (r Network_Storage) GetDuplicateConversionStatus() (resp datatypes.Container_Network_Storage_DuplicateConversionStatusInformation, err error)

This method is used to check, if for the given classic file block storage volume, a transaction performing dependent to independent duplicate conversion is active. If yes, then this returns the current percentage of its progress along with its start time as [SoftLayer_Container_Network_Storage_DuplicateConversionStatusInformation] object with its name, percentage and transaction start timestamp.

func (Network_Storage) GetEvents 

func (r Network_Storage) GetEvents() (resp []datatypes.Network_Storage_Event, err error)

Retrieve The events which have taken place on a network storage volume.

func (Network_Storage) GetFailbackNotAllowed added in v1.0.3 

func (r Network_Storage) GetFailbackNotAllowed() (resp string, err error)

Retrieve Determines whether the volume is allowed to failback

func (Network_Storage) GetFailoverNotAllowed added in v1.0.4 

func (r Network_Storage) GetFailoverNotAllowed() (resp string, err error)

Retrieve Determines whether the volume is allowed to failover

func (Network_Storage) GetFileBlockEncryptedLocations 

func (r Network_Storage) GetFileBlockEncryptedLocations() (resp []datatypes.Location, err error)

func (Network_Storage) GetFileByIdentifier 

func (r Network_Storage) GetFileByIdentifier(identifier *string) (resp datatypes.Container_Utility_File_Entity, err error)

{{CloudLayerOnlyMethod}} Retrieve details such as id, name, size, create date of a file within a Storage account. This does not download file content.

func (Network_Storage) GetFileCount 

func (r Network_Storage) GetFileCount() (resp int, err error)

{{CloudLayerOnlyMethod}} Retrieve the file number of files in a Virtual Server Storage account's root directory. This does not include the files stored in the recycle bin.

func (Network_Storage) GetFileList 

func (r Network_Storage) GetFileList(folder *string, path *string) (resp []datatypes.Container_Utility_File_Entity, err error)

no documentation yet

func (Network_Storage) GetFileNetworkMountAddress 

func (r Network_Storage) GetFileNetworkMountAddress() (resp string, err error)

Retrieve Retrieves the NFS Network Mount Address Name for a given File Storage Volume.

func (Network_Storage) GetFilePendingDeleteCount 

func (r Network_Storage) GetFilePendingDeleteCount() (resp int, err error)

{{CloudLayerOnlyMethod}} Retrieve the number of files pending deletion in a Storage account's recycle bin. Files in an account's recycle bin may either be restored to the account's root directory or permanently deleted.

func (Network_Storage) GetFilesPendingDelete 

func (r Network_Storage) GetFilesPendingDelete() (resp []datatypes.Container_Utility_File_Entity, err error)

{{CloudLayerOnlyMethod}} Retrieve a list of files that are pending deletion in a Storage account's recycle bin. Files in an account's recycle bin may either be restored to the account's root directory or permanently deleted. This method does not download file content.

func (Network_Storage) GetFixReplicationCurrentStatus added in v1.0.5 

func (r Network_Storage) GetFixReplicationCurrentStatus() (resp string, err error)

Retrieve

func (Network_Storage) GetFolderList 

func (r Network_Storage) GetFolderList() (resp []datatypes.Container_Network_Storage_Hub_ObjectStorage_Folder, err error)

no documentation yet

func (Network_Storage) GetHardware 

func (r Network_Storage) GetHardware() (resp datatypes.Hardware, err error)

Retrieve When applicable, the hardware associated with a Storage service.

func (Network_Storage) GetHasEncryptionAtRest 

func (r Network_Storage) GetHasEncryptionAtRest() (resp bool, err error)

Retrieve

func (Network_Storage) GetHourlySchedule 

func (r Network_Storage) GetHourlySchedule() (resp datatypes.Network_Storage_Schedule, err error)

Retrieve The Hourly Schedule which is associated with this network storage volume.

func (Network_Storage) GetIntervalSchedule 

func (r Network_Storage) GetIntervalSchedule() (resp datatypes.Network_Storage_Schedule, err error)

Retrieve The Interval Schedule which is associated with this network storage volume.

func (Network_Storage) GetIops 

func (r Network_Storage) GetIops() (resp string, err error)

Retrieve The maximum number of IOPs selected for this volume.

func (Network_Storage) GetIsConvertToIndependentTransactionInProgress added in v1.0.6 

func (r Network_Storage) GetIsConvertToIndependentTransactionInProgress() (resp bool, err error)

Retrieve Determines whether network storage volume has an active convert dependent clone to Independent transaction.

func (Network_Storage) GetIsDependentDuplicateProvisionCompleted 

func (r Network_Storage) GetIsDependentDuplicateProvisionCompleted() (resp bool, err error)

Retrieve Determines whether dependent volume provision is completed on background.

func (Network_Storage) GetIsInDedicatedServiceResource added in v1.0.2 

func (r Network_Storage) GetIsInDedicatedServiceResource() (resp bool, err error)

Retrieve

func (Network_Storage) GetIsMagneticStorage added in v1.0.4 

func (r Network_Storage) GetIsMagneticStorage() (resp string, err error)

Retrieve

func (Network_Storage) GetIsProvisionInProgress added in v1.0.6 

func (r Network_Storage) GetIsProvisionInProgress() (resp bool, err error)

Retrieve Determines whether network storage volume has an active provision transaction.

func (Network_Storage) GetIsReadyForSnapshot 

func (r Network_Storage) GetIsReadyForSnapshot() (resp bool, err error)

Retrieve Determines whether a volume is ready to order snapshot space, or, if snapshot space is already available, to assign a snapshot schedule, or to take a manual snapshot.

func (Network_Storage) GetIsReadyToMount 

func (r Network_Storage) GetIsReadyToMount() (resp bool, err error)

Retrieve Determines whether a volume is ready to have Hosts authorized to access it. This does not indicate whether another operation may be blocking, please refer to this volume's volumeStatus property for details.

func (Network_Storage) GetIscsiLuns 

func (r Network_Storage) GetIscsiLuns() (resp []datatypes.Network_Storage, err error)

Retrieve Relationship between a container volume and iSCSI LUNs.

func (Network_Storage) GetIscsiReplicatingVolume added in v1.0.5 

func (r Network_Storage) GetIscsiReplicatingVolume() (resp datatypes.Network_Storage, err error)

Retrieve The network storage volumes configured to be replicants of this volume.

func (Network_Storage) GetIscsiTargetIpAddresses 

func (r Network_Storage) GetIscsiTargetIpAddresses() (resp []string, err error)

Retrieve Returns the target IP addresses of an iSCSI volume.

func (Network_Storage) GetLunId 

func (r Network_Storage) GetLunId() (resp string, err error)

Retrieve The ID of the LUN volume.

func (Network_Storage) GetManualSnapshots 

func (r Network_Storage) GetManualSnapshots() (resp []datatypes.Network_Storage, err error)

Retrieve The manually-created snapshots associated with this SoftLayer_Network_Storage volume. Does not support pagination by result limit and offset.

func (Network_Storage) GetMaximumExpansionSize 

func (r Network_Storage) GetMaximumExpansionSize() (resp int, err error)

no documentation yet

func (Network_Storage) GetMetricTrackingObject 

func (r Network_Storage) GetMetricTrackingObject() (resp datatypes.Metric_Tracking_Object, err error)

Retrieve [DEPRECATED] - A network storage volume's metric tracking object. This object records all periodic polled data available to this volume.

func (Network_Storage) GetMountPath added in v1.0.4 

func (r Network_Storage) GetMountPath() (resp string, err error)

Retrieve Retrieves the NFS Network Mount Path for a given File Storage Volume.

func (Network_Storage) GetMountableFlag 

func (r Network_Storage) GetMountableFlag() (resp string, err error)

Retrieve Whether or not a network storage volume may be mounted.

func (Network_Storage) GetMoveAndSplitStatus 

func (r Network_Storage) GetMoveAndSplitStatus() (resp string, err error)

Retrieve The current status of split or move operation as a part of volume duplication.

func (Network_Storage) GetNetworkConnectionDetails 

func (r Network_Storage) GetNetworkConnectionDetails() (resp datatypes.Container_Network_Storage_NetworkConnectionInformation, err error)

no documentation yet

func (Network_Storage) GetNetworkMountAddress 

func (r Network_Storage) GetNetworkMountAddress() (resp string, err error)

no documentation yet

func (Network_Storage) GetNetworkMountPath added in v1.0.4 

func (r Network_Storage) GetNetworkMountPath() (resp string, err error)

no documentation yet

func (Network_Storage) GetNotificationSubscribers 

func (r Network_Storage) GetNotificationSubscribers() (resp []datatypes.Notification_User_Subscriber, err error)

Retrieve The subscribers that will be notified for usage amount warnings and overages.

func (Network_Storage) GetObject 

func (r Network_Storage) GetObject() (resp datatypes.Network_Storage, err error)

getObject retrieves the SoftLayer_Network_Storage object whose ID corresponds to the ID number of the init parameter passed to the SoftLayer_Network_Storage service.

Please use the associated methods in the [[SoftLayer_Network_Storage]] service to retrieve a Storage account's id.

func (Network_Storage) GetObjectStorageConnectionInformation 

func (r Network_Storage) GetObjectStorageConnectionInformation() (resp []datatypes.Container_Network_Service_Resource_ObjectStorage_ConnectionInformation, err error)

no documentation yet

func (Network_Storage) GetObjectsByCredential 

func (r Network_Storage) GetObjectsByCredential(credentialObject *datatypes.Network_Storage_Credential) (resp []datatypes.Network_Storage, err error)

Retrieve network storage accounts by SoftLayer_Network_Storage_Credential object. Use this method if you wish to retrieve a storage record by a credential rather than by id.

func (Network_Storage) GetOriginalSnapshotName 

func (r Network_Storage) GetOriginalSnapshotName() (resp string, err error)

Retrieve The name of the snapshot that this volume was duplicated from.

func (Network_Storage) GetOriginalVolumeId added in v1.1.2 

func (r Network_Storage) GetOriginalVolumeId() (resp int, err error)

Retrieve Volume id of the origin volume from which this volume is been cloned.

func (Network_Storage) GetOriginalVolumeName 

func (r Network_Storage) GetOriginalVolumeName() (resp string, err error)

Retrieve The name of the volume that this volume was duplicated from.

func (Network_Storage) GetOriginalVolumeSize 

func (r Network_Storage) GetOriginalVolumeSize() (resp string, err error)

Retrieve The size (in GB) of the volume or LUN before any size expansion, or of the volume (before any possible size expansion) from which the duplicate volume or LUN was created.

func (Network_Storage) GetOsType 

func (r Network_Storage) GetOsType() (resp datatypes.Network_Storage_Iscsi_OS_Type, err error)

Retrieve A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type.

func (Network_Storage) GetOsTypeId 

func (r Network_Storage) GetOsTypeId() (resp string, err error)

Retrieve A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type ID.

func (Network_Storage) GetParentPartnerships 

func (r Network_Storage) GetParentPartnerships() (resp []datatypes.Network_Storage_Partnership, err error)

Retrieve The volumes or snapshots partnered with a network storage volume in a parental role.

func (Network_Storage) GetParentVolume 

func (r Network_Storage) GetParentVolume() (resp datatypes.Network_Storage, err error)

Retrieve The parent volume of a volume in a complex storage relationship.

func (Network_Storage) GetPartnerships 

func (r Network_Storage) GetPartnerships() (resp []datatypes.Network_Storage_Partnership, err error)

Retrieve The volumes or snapshots partnered with a network storage volume.

func (Network_Storage) GetPermissionsGroups 

func (r Network_Storage) GetPermissionsGroups() (resp []datatypes.Network_Storage_Group, err error)

Retrieve All permissions group(s) this volume is in.

func (Network_Storage) GetProperties 

func (r Network_Storage) GetProperties() (resp []datatypes.Network_Storage_Property, err error)

Retrieve The properties used to provide additional details about a network storage volume.

func (Network_Storage) GetProvisionedIops 

func (r Network_Storage) GetProvisionedIops() (resp string, err error)

Retrieve The number of IOPs provisioned for this volume.

func (Network_Storage) GetRecycleBinFileByIdentifier 

func (r Network_Storage) GetRecycleBinFileByIdentifier(fileId *string) (resp datatypes.Container_Utility_File_Entity, err error)

{{CloudLayerOnlyMethod}} Retrieve the details of a file that is pending deletion in a Storage account's a recycle bin.

func (Network_Storage) GetRemainingAllowedHosts 

func (r Network_Storage) GetRemainingAllowedHosts() (resp int, err error)

Retrieves the remaining number of allowed hosts per volume.

func (Network_Storage) GetRemainingAllowedHostsForReplicant 

func (r Network_Storage) GetRemainingAllowedHostsForReplicant() (resp int, err error)

Retrieves the remaining number of allowed hosts for a volume's replicant.

func (Network_Storage) GetReplicatingLuns 

func (r Network_Storage) GetReplicatingLuns() (resp []datatypes.Network_Storage, err error)

Retrieve The iSCSI LUN volumes being replicated by this network storage volume.

func (Network_Storage) GetReplicatingVolume 

func (r Network_Storage) GetReplicatingVolume() (resp datatypes.Network_Storage, err error)

Retrieve The network storage volume being replicated by a volume.

func (Network_Storage) GetReplicationEvents 

func (r Network_Storage) GetReplicationEvents() (resp []datatypes.Network_Storage_Event, err error)

Retrieve The volume replication events.

func (Network_Storage) GetReplicationPartners 

func (r Network_Storage) GetReplicationPartners() (resp []datatypes.Network_Storage, err error)

Retrieve The network storage volumes configured to be replicants of a volume.

func (Network_Storage) GetReplicationSchedule 

func (r Network_Storage) GetReplicationSchedule() (resp datatypes.Network_Storage_Schedule, err error)

Retrieve The Replication Schedule associated with a network storage volume.

func (Network_Storage) GetReplicationStatus 

func (r Network_Storage) GetReplicationStatus() (resp string, err error)

Retrieve The current replication status of a network storage volume. Indicates Failover or Failback status.

func (Network_Storage) GetReplicationTimestamp added in v1.0.4 

func (r Network_Storage) GetReplicationTimestamp() (resp string, err error)

no documentation yet

func (Network_Storage) GetSchedules 

func (r Network_Storage) GetSchedules() (resp []datatypes.Network_Storage_Schedule, err error)

Retrieve The schedules which are associated with a network storage volume.

func (Network_Storage) GetServiceResource 

func (r Network_Storage) GetServiceResource() (resp datatypes.Network_Service_Resource, err error)

Retrieve The network resource a Storage service is connected to.

func (Network_Storage) GetServiceResourceBackendIpAddress 

func (r Network_Storage) GetServiceResourceBackendIpAddress() (resp string, err error)

Retrieve The IP address of a Storage resource.

func (Network_Storage) GetServiceResourceName 

func (r Network_Storage) GetServiceResourceName() (resp string, err error)

Retrieve The name of a Storage's network resource.

func (Network_Storage) GetSnapshotCapacityGb 

func (r Network_Storage) GetSnapshotCapacityGb() (resp string, err error)

Retrieve A volume's configured snapshot space size.

func (Network_Storage) GetSnapshotCreationTimestamp 

func (r Network_Storage) GetSnapshotCreationTimestamp() (resp string, err error)

Retrieve The creation timestamp of the snapshot on the storage platform.

func (Network_Storage) GetSnapshotDeletionThresholdPercentage 

func (r Network_Storage) GetSnapshotDeletionThresholdPercentage() (resp string, err error)

Retrieve The percentage of used snapshot space after which to delete automated snapshots.

func (Network_Storage) GetSnapshotNotificationStatus added in v1.0.4 

func (r Network_Storage) GetSnapshotNotificationStatus() (resp string, err error)

Retrieve Whether or not a network storage volume may be mounted.

func (Network_Storage) GetSnapshotSizeBytes 

func (r Network_Storage) GetSnapshotSizeBytes() (resp string, err error)

Retrieve The snapshot size in bytes.

func (Network_Storage) GetSnapshotSpaceAvailable 

func (r Network_Storage) GetSnapshotSpaceAvailable() (resp string, err error)

Retrieve A volume's available snapshot reservation space.

func (Network_Storage) GetSnapshots 

func (r Network_Storage) GetSnapshots() (resp []datatypes.Network_Storage, err error)

Retrieve The snapshots associated with this SoftLayer_Network_Storage volume.

func (Network_Storage) GetSnapshotsForVolume 

func (r Network_Storage) GetSnapshotsForVolume() (resp []datatypes.Network_Storage, err error)

Retrieves a list of snapshots for this SoftLayer_Network_Storage volume. This method works with the result limits and offset to support pagination.

func (Network_Storage) GetStaasVersion 

func (r Network_Storage) GetStaasVersion() (resp string, err error)

Retrieve

func (Network_Storage) GetStorageGroups 

func (r Network_Storage) GetStorageGroups() (resp []datatypes.Network_Storage_Group, err error)

Retrieve The network storage groups this volume is attached to.

func (Network_Storage) GetStorageGroupsNetworkConnectionDetails 

func (r Network_Storage) GetStorageGroupsNetworkConnectionDetails() (resp []datatypes.Container_Network_Storage_NetworkConnectionInformation, err error)

no documentation yet

func (Network_Storage) GetStorageTierLevel 

func (r Network_Storage) GetStorageTierLevel() (resp string, err error)

Retrieve

func (Network_Storage) GetStorageType 

func (r Network_Storage) GetStorageType() (resp datatypes.Network_Storage_Type, err error)

Retrieve A description of the Storage object.

func (Network_Storage) GetTargetIpAddresses 

func (r Network_Storage) GetTargetIpAddresses() (resp []string, err error)

no documentation yet

func (Network_Storage) GetTotalBytesUsed 

func (r Network_Storage) GetTotalBytesUsed() (resp string, err error)

Retrieve The amount of space used by the volume.

func (Network_Storage) GetTotalScheduleSnapshotRetentionCount 

func (r Network_Storage) GetTotalScheduleSnapshotRetentionCount() (resp uint, err error)

Retrieve The total snapshot retention count of all schedules on this network storage volume.

func (Network_Storage) GetUsageNotification 

func (r Network_Storage) GetUsageNotification() (resp datatypes.Notification, err error)

Retrieve The usage notification for SL Storage services.

func (Network_Storage) GetValidReplicationTargetDatacenterLocations 

func (r Network_Storage) GetValidReplicationTargetDatacenterLocations() (resp []datatypes.Location, err error)

no documentation yet

func (Network_Storage) GetVendorName 

func (r Network_Storage) GetVendorName() (resp string, err error)

Retrieve The type of network storage service.

func (Network_Storage) GetVirtualGuest 

func (r Network_Storage) GetVirtualGuest() (resp datatypes.Virtual_Guest, err error)

Retrieve When applicable, the virtual guest associated with a Storage service.

func (Network_Storage) GetVolumeCountLimits added in v1.0.1 

func (r Network_Storage) GetVolumeCountLimits() (resp []datatypes.Container_Network_Storage_DataCenterLimits_VolumeCountLimitContainer, err error)

Retrieves an array of volume count limits per location and globally.

func (Network_Storage) GetVolumeDuplicateParameters 

func (r Network_Storage) GetVolumeDuplicateParameters() (resp datatypes.Container_Network_Storage_VolumeDuplicateParameters, err error)

This method returns the parameters for cloning a volume

func (Network_Storage) GetVolumeHistory 

func (r Network_Storage) GetVolumeHistory() (resp []datatypes.Network_Storage_History, err error)

Retrieve The username and password history for a Storage service.

func (Network_Storage) GetVolumeStatus 

func (r Network_Storage) GetVolumeStatus() (resp string, err error)

Retrieve The current status of a network storage volume.

func (Network_Storage) GetWebccAccount 

func (r Network_Storage) GetWebccAccount() (resp datatypes.Account_Password, err error)

Retrieve The account username and password for the EVault webCC interface.

func (Network_Storage) GetWeeklySchedule 

func (r Network_Storage) GetWeeklySchedule() (resp datatypes.Network_Storage_Schedule, err error)

Retrieve The Weekly Schedule which is associated with this network storage volume.

func (Network_Storage) Id 

func (r Network_Storage) Id(id int) Network_Storage

func (Network_Storage) ImmediateFailoverToReplicant 

func (r Network_Storage) ImmediateFailoverToReplicant(replicantId *int) (resp bool, err error)

Immediate Failover to a volume replicant. During the time which the replicant is in use the local nas volume will not be available.

func (Network_Storage) InitiateOriginVolumeReclaim added in v1.0.4 

func (r Network_Storage) InitiateOriginVolumeReclaim() (resp string, err error)

no documentation yet

func (Network_Storage) InitiateVolumeCutover added in v1.0.4 

func (r Network_Storage) InitiateVolumeCutover() (resp string, err error)

no documentation yet

func (Network_Storage) IsBlockingOperationInProgress 

func (r Network_Storage) IsBlockingOperationInProgress(exemptStatusKeyNames []string) (resp bool, err error)

no documentation yet

func (Network_Storage) IsDuplicateReadyForSnapshot 

func (r Network_Storage) IsDuplicateReadyForSnapshot() (resp bool, err error)

This method returns a boolean indicating whether the clone volume is ready for snapshot.

func (Network_Storage) IsDuplicateReadyToMount 

func (r Network_Storage) IsDuplicateReadyToMount() (resp bool, err error)

This method returns a boolean indicating whether the clone volume is ready to mount.

func (Network_Storage) IsVolumeActive 

func (r Network_Storage) IsVolumeActive() (resp bool, err error)

no documentation yet

func (Network_Storage) Limit 

func (r Network_Storage) Limit(limit int) Network_Storage

func (Network_Storage) Mask 

func (r Network_Storage) Mask(mask string) Network_Storage

func (Network_Storage) Offset 

func (r Network_Storage) Offset(offset int) Network_Storage

func (Network_Storage) RefreshDependentDuplicate added in v1.0.1 

func (r Network_Storage) RefreshDependentDuplicate(snapshotId *int) (resp bool, err error)

no documentation yet

func (Network_Storage) RefreshDuplicate added in v1.0.2 

func (r Network_Storage) RefreshDuplicate(snapshotId *int, forceRefresh *bool) (resp bool, err error)

no documentation yet

func (Network_Storage) RemoveAccessFromHardware 

func (r Network_Storage) RemoveAccessFromHardware(hardwareObjectTemplate *datatypes.Hardware) (resp bool, err error)

This method is used to modify the access control list for this Storage volume. The SoftLayer_Hardware objects which have been allowed access to this storage will be listed in the allowedHardware property of this storage volume.

func (Network_Storage) RemoveAccessFromHardwareList 

func (r Network_Storage) RemoveAccessFromHardwareList(hardwareObjectTemplates []datatypes.Hardware) (resp bool, err error)

This method is used to modify the access control list for this Storage volume. The SoftLayer_Hardware objects which have been allowed access to this storage will be listed in the allowedHardware property of this storage volume.

func (Network_Storage) RemoveAccessFromHost 

func (r Network_Storage) RemoveAccessFromHost(typeClassName *string, hostId *int) (resp datatypes.Network_Storage_Allowed_Host, err error)

This method is used to modify the access control list for this Storage volume. The [[SoftLayer_Hardware|SoftLayer_Virtual_Guest|SoftLayer_Network_Subnet|SoftLayer_Network_Subnet_IpAddress]] objects which have been allowed access to this storage will be listed in the [[allowedHardware|allowedVirtualGuests|allowedSubnets|allowedIpAddresses]] property of this storage volume.

func (Network_Storage) RemoveAccessFromHostList 

func (r Network_Storage) RemoveAccessFromHostList(hostObjectTemplates []datatypes.Container_Network_Storage_Host) (resp []datatypes.Network_Storage_Allowed_Host, err error)

This method is used to modify the access control list for this Storage volume. The [[SoftLayer_Hardware|SoftLayer_Virtual_Guest|SoftLayer_Network_Subnet|SoftLayer_Network_Subnet_IpAddress]] objects which have been allowed access to this storage will be listed in the [[allowedHardware|allowedVirtualGuests|allowedSubnets|allowedIpAddresses]] property of this storage volume.

func (Network_Storage) RemoveAccessFromIpAddress 

func (r Network_Storage) RemoveAccessFromIpAddress(ipAddressObjectTemplate *datatypes.Network_Subnet_IpAddress) (resp bool, err error)

This method is used to modify the access control list for this Storage volume. The SoftLayer_Network_Subnet_IpAddress objects which have been allowed access to this storage will be listed in the allowedIpAddresses property of this storage volume.

func (Network_Storage) RemoveAccessFromIpAddressList 

func (r Network_Storage) RemoveAccessFromIpAddressList(ipAddressObjectTemplates []datatypes.Network_Subnet_IpAddress) (resp bool, err error)

no documentation yet

func (Network_Storage) RemoveAccessFromSubnet 

func (r Network_Storage) RemoveAccessFromSubnet(subnetObjectTemplate *datatypes.Network_Subnet) (resp bool, err error)

no documentation yet

func (Network_Storage) RemoveAccessFromSubnetList 

func (r Network_Storage) RemoveAccessFromSubnetList(subnetObjectTemplates []datatypes.Network_Subnet) (resp bool, err error)

no documentation yet

func (Network_Storage) RemoveAccessFromVirtualGuest 

func (r Network_Storage) RemoveAccessFromVirtualGuest(virtualGuestObjectTemplate *datatypes.Virtual_Guest) (resp bool, err error)

This method is used to modify the access control list for this Storage volume. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage will be listed in the allowedVirtualGuests property of this storage volume.

func (Network_Storage) RemoveAccessFromVirtualGuestList 

func (r Network_Storage) RemoveAccessFromVirtualGuestList(virtualGuestObjectTemplates []datatypes.Virtual_Guest) (resp bool, err error)

This method is used to modify the access control list for this Storage volume. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage will be listed in the allowedVirtualGuests property of this storage volume.

func (Network_Storage) RemoveAccessToReplicantFromHardwareList 

func (r Network_Storage) RemoveAccessToReplicantFromHardwareList(hardwareObjectTemplates []datatypes.Hardware) (resp bool, err error)

This method is used to modify the access control list for this Storage volume's replica. The SoftLayer_Hardware objects which have been allowed access to this storage volume's replica will be listed in the allowedReplicationHardware property of this storage volume.

func (Network_Storage) RemoveAccessToReplicantFromIpAddressList 

func (r Network_Storage) RemoveAccessToReplicantFromIpAddressList(ipAddressObjectTemplates []datatypes.Network_Subnet_IpAddress) (resp bool, err error)

This method is used to modify the access control list for this Storage volume's replica. The SoftLayer_Network_Subnet_IpAddress objects which have been allowed access to this storage volume's replica will be listed in the allowedReplicationIpAddresses property of this storage volume.

func (Network_Storage) RemoveAccessToReplicantFromSubnet 

func (r Network_Storage) RemoveAccessToReplicantFromSubnet(subnetObjectTemplate *datatypes.Network_Subnet) (resp bool, err error)

no documentation yet

func (Network_Storage) RemoveAccessToReplicantFromSubnetList 

func (r Network_Storage) RemoveAccessToReplicantFromSubnetList(subnetObjectTemplates []datatypes.Network_Subnet) (resp bool, err error)

This method is used to modify the access control list for this Storage volume's replica. The SoftLayer_Network_Subnet objects which have been allowed access to this storage volume's replica will be listed in the allowedReplicationSubnets property of this storage volume.

func (Network_Storage) RemoveAccessToReplicantFromVirtualGuestList 

func (r Network_Storage) RemoveAccessToReplicantFromVirtualGuestList(virtualGuestObjectTemplates []datatypes.Virtual_Guest) (resp bool, err error)

This method is used to modify the access control list for this Storage volume's replica. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage volume's replica will be listed in the allowedReplicationVirtualGuests property of this storage volume.

func (Network_Storage) RemoveCredential 

func (r Network_Storage) RemoveCredential(username *string) (resp bool, err error)

This method will remove a credential from the current volume. The credential must have been created using the 'addNewCredential' method.

func (Network_Storage) RestoreFile 

func (r Network_Storage) RestoreFile(fileId *string) (resp datatypes.Container_Utility_File_Entity, err error)

{{CloudLayerOnlyMethod}} Restore an individual file so that it may be used as it was before it was deleted.

If a file is deleted from a Virtual Server Storage account, the file is placed into the account's recycle bin and not permanently deleted. Therefore, restoreFile can be used to place the file back into your Virtual Server account's root directory.

func (Network_Storage) RestoreFromSnapshot 

func (r Network_Storage) RestoreFromSnapshot(snapshotId *int) (resp bool, err error)

Restore the volume from a snapshot that was previously taken.

func (Network_Storage) SendPasswordReminderEmail 

func (r Network_Storage) SendPasswordReminderEmail(username *string) (resp bool, err error)

The method will retrieve the password for the StorageLayer or Virtual Server Storage Account and email the password. The Storage Account passwords will be emailed to the master user. For Virtual Server Storage, the password will be sent to the email address used as the username.

func (Network_Storage) SetMountable 

func (r Network_Storage) SetMountable(mountable *bool) (resp bool, err error)

Enable or disable the mounting of a Storage volume. When mounting is enabled the Storage volume will be mountable or available for use.

For Virtual Server volumes, disabling mounting will deny access to the Virtual Server Account, remove published material and deny all file interaction including uploads and downloads.

Enabling or disabling mounting for Storage volumes is not possible if mounting has been disabled by SoftLayer or a parent account.

func (Network_Storage) SetSnapshotAllocation 

func (r Network_Storage) SetSnapshotAllocation(capacityGb *int) (err error)

no documentation yet

func (Network_Storage) SetSnapshotNotification added in v1.0.4 

func (r Network_Storage) SetSnapshotNotification(notificationFlag *bool) (err error)

Function to enable/disable snapshot warning notification.

func (Network_Storage) UpgradeVolumeCapacity 

func (r Network_Storage) UpgradeVolumeCapacity(itemId *int) (resp bool, err error)

Upgrade the Storage volume to one of the upgradable packages (for example from 10 Gigs of EVault storage to 100 Gigs of EVault storage).

func (Network_Storage) UploadFile 

func (r Network_Storage) UploadFile(file *datatypes.Container_Utility_File_Entity) (resp datatypes.Container_Utility_File_Entity, err error)

{{CloudLayerOnlyMethod}} Upload a file to a Storage account's root directory. Once uploaded, this method returns new file entity identifier for the upload file.

The following properties are required in the ”file” parameter. *”'name”': The name of the file you wish to upload *”'content”': The raw contents of the file you wish to upload. *”'contentType”': The MIME-type of content that you wish to upload.

func (Network_Storage) ValidateHostsAccess added in v1.0.5 

func (r Network_Storage) ValidateHostsAccess(hostObjectTemplates []datatypes.Container_Network_Storage_Host) (resp []datatypes.Container_Network_Storage_HostsGatewayInformation, err error)

This method is used to validate if the hosts are behind gateway or not from [SoftLayer_Network_Subnet|SoftLayer_Network_Subnet_IpAddress] objects. This returns [SoftLayer_Container_Network_Storage_HostsGatewayInformation] object containing the host details along with a boolean attribute which indicates if it's behind the gateway or not.

type Network_Storage_Allowed_Host 

type Network_Storage_Allowed_Host struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetNetworkStorageAllowedHostService 

func GetNetworkStorageAllowedHostService(sess session.SLSession) Network_Storage_Allowed_Host

GetNetworkStorageAllowedHostService returns an instance of the Network_Storage_Allowed_Host SoftLayer service

func (Network_Storage_Allowed_Host) AssignSubnetsToAcl 

func (r Network_Storage_Allowed_Host) AssignSubnetsToAcl(subnetIds []int) (resp []int, err error)

no documentation yet

func (Network_Storage_Allowed_Host) EditObject 

func (r Network_Storage_Allowed_Host) EditObject(templateObject *datatypes.Network_Storage_Allowed_Host) (resp bool, err error)

no documentation yet

func (Network_Storage_Allowed_Host) Filter 

func (r Network_Storage_Allowed_Host) Filter(filter string) Network_Storage_Allowed_Host

func (Network_Storage_Allowed_Host) GetAllObjects 

func (r Network_Storage_Allowed_Host) GetAllObjects() (resp []datatypes.Network_Storage_Allowed_Host, err error)

no documentation yet

func (Network_Storage_Allowed_Host) GetAssignedGroups 

func (r Network_Storage_Allowed_Host) GetAssignedGroups() (resp []datatypes.Network_Storage_Group, err error)

Retrieve The SoftLayer_Network_Storage_Group objects this SoftLayer_Network_Storage_Allowed_Host is present in.

func (Network_Storage_Allowed_Host) GetAssignedIscsiVolumes 

func (r Network_Storage_Allowed_Host) GetAssignedIscsiVolumes() (resp []datatypes.Network_Storage, err error)

Retrieve The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access.

func (Network_Storage_Allowed_Host) GetAssignedNfsVolumes 

func (r Network_Storage_Allowed_Host) GetAssignedNfsVolumes() (resp []datatypes.Network_Storage, err error)

Retrieve The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access.

func (Network_Storage_Allowed_Host) GetAssignedReplicationVolumes 

func (r Network_Storage_Allowed_Host) GetAssignedReplicationVolumes() (resp []datatypes.Network_Storage, err error)

Retrieve The SoftLayer_Network_Storage primary volumes whose replicas are allowed access.

func (Network_Storage_Allowed_Host) GetAssignedVolumes 

func (r Network_Storage_Allowed_Host) GetAssignedVolumes() (resp []datatypes.Network_Storage, err error)

Retrieve The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access.

func (Network_Storage_Allowed_Host) GetCredential 

func (r Network_Storage_Allowed_Host) GetCredential() (resp datatypes.Network_Storage_Credential, err error)

Retrieve The SoftLayer_Network_Storage_Credential this allowed host uses.

func (Network_Storage_Allowed_Host) GetObject 

func (r Network_Storage_Allowed_Host) GetObject() (resp datatypes.Network_Storage_Allowed_Host, err error)

no documentation yet

func (Network_Storage_Allowed_Host) GetSourceSubnet 

func (r Network_Storage_Allowed_Host) GetSourceSubnet() (resp string, err error)

Retrieve Connections to a target with a source IP in this subnet prefix are allowed.

func (Network_Storage_Allowed_Host) GetSubnetsInAcl 

func (r Network_Storage_Allowed_Host) GetSubnetsInAcl() (resp []datatypes.Network_Subnet, err error)

Retrieve The SoftLayer_Network_Subnet records assigned to the ACL for this allowed host.

func (Network_Storage_Allowed_Host) Id 

func (r Network_Storage_Allowed_Host) Id(id int) Network_Storage_Allowed_Host

func (Network_Storage_Allowed_Host) Limit 

func (r Network_Storage_Allowed_Host) Limit(limit int) Network_Storage_Allowed_Host

func (Network_Storage_Allowed_Host) Mask 

func (r Network_Storage_Allowed_Host) Mask(mask string) Network_Storage_Allowed_Host

func (Network_Storage_Allowed_Host) Offset 

func (r Network_Storage_Allowed_Host) Offset(offset int) Network_Storage_Allowed_Host

func (Network_Storage_Allowed_Host) RemoveSubnetsFromAcl 

func (r Network_Storage_Allowed_Host) RemoveSubnetsFromAcl(subnetIds []int) (resp []int, err error)

no documentation yet

func (Network_Storage_Allowed_Host) SetCredentialPassword 

func (r Network_Storage_Allowed_Host) SetCredentialPassword(password *string) (resp bool, err error)

Use this method to modify the credential password for a SoftLayer_Network_Storage_Allowed_Host object.

type Network_Storage_Allowed_Host_Hardware 

type Network_Storage_Allowed_Host_Hardware struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetNetworkStorageAllowedHostHardwareService 

func GetNetworkStorageAllowedHostHardwareService(sess session.SLSession) Network_Storage_Allowed_Host_Hardware

GetNetworkStorageAllowedHostHardwareService returns an instance of the Network_Storage_Allowed_Host_Hardware SoftLayer service

func (Network_Storage_Allowed_Host_Hardware) AssignSubnetsToAcl 

func (r Network_Storage_Allowed_Host_Hardware) AssignSubnetsToAcl(subnetIds []int) (resp []int, err error)

no documentation yet

func (Network_Storage_Allowed_Host_Hardware) EditObject 

func (r Network_Storage_Allowed_Host_Hardware) EditObject(templateObject *datatypes.Network_Storage_Allowed_Host) (resp bool, err error)

no documentation yet

func (Network_Storage_Allowed_Host_Hardware) Filter 

func (r Network_Storage_Allowed_Host_Hardware) Filter(filter string) Network_Storage_Allowed_Host_Hardware

func (Network_Storage_Allowed_Host_Hardware) GetAccount 

func (r Network_Storage_Allowed_Host_Hardware) GetAccount() (resp datatypes.Account, err error)

Retrieve The SoftLayer_Account object which this SoftLayer_Network_Storage_Allowed_Host belongs to.

func (Network_Storage_Allowed_Host_Hardware) GetAllObjects 

func (r Network_Storage_Allowed_Host_Hardware) GetAllObjects() (resp []datatypes.Network_Storage_Allowed_Host, err error)

no documentation yet

func (Network_Storage_Allowed_Host_Hardware) GetAssignedGroups 

func (r Network_Storage_Allowed_Host_Hardware) GetAssignedGroups() (resp []datatypes.Network_Storage_Group, err error)

Retrieve The SoftLayer_Network_Storage_Group objects this SoftLayer_Network_Storage_Allowed_Host is present in.

func (Network_Storage_Allowed_Host_Hardware) GetAssignedIscsiVolumes 

func (r Network_Storage_Allowed_Host_Hardware) GetAssignedIscsiVolumes() (resp []datatypes.Network_Storage, err error)

Retrieve The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access.

func (Network_Storage_Allowed_Host_Hardware) GetAssignedNfsVolumes 

func (r Network_Storage_Allowed_Host_Hardware) GetAssignedNfsVolumes() (resp []datatypes.Network_Storage, err error)

Retrieve The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access.

func (Network_Storage_Allowed_Host_Hardware) GetAssignedReplicationVolumes 

func (r Network_Storage_Allowed_Host_Hardware) GetAssignedReplicationVolumes() (resp []datatypes.Network_Storage, err error)

Retrieve The SoftLayer_Network_Storage primary volumes whose replicas are allowed access.

func (Network_Storage_Allowed_Host_Hardware) GetAssignedVolumes 

func (r Network_Storage_Allowed_Host_Hardware) GetAssignedVolumes() (resp []datatypes.Network_Storage, err error)

Retrieve The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access.

func (Network_Storage_Allowed_Host_Hardware) GetCredential 

func (r Network_Storage_Allowed_Host_Hardware) GetCredential() (resp datatypes.Network_Storage_Credential, err error)

Retrieve The SoftLayer_Network_Storage_Credential this allowed host uses.

func (Network_Storage_Allowed_Host_Hardware) GetObject 

func (r Network_Storage_Allowed_Host_Hardware) GetObject() (resp datatypes.Network_Storage_Allowed_Host_Hardware, err error)

no documentation yet

func (Network_Storage_Allowed_Host_Hardware) GetResource 

func (r Network_Storage_Allowed_Host_Hardware) GetResource() (resp datatypes.Hardware, err error)

Retrieve The SoftLayer_Hardware object which this SoftLayer_Network_Storage_Allowed_Host is referencing.

func (Network_Storage_Allowed_Host_Hardware) GetSourceSubnet 

func (r Network_Storage_Allowed_Host_Hardware) GetSourceSubnet() (resp string, err error)

Retrieve Connections to a target with a source IP in this subnet prefix are allowed.

func (Network_Storage_Allowed_Host_Hardware) GetSubnetsInAcl 

func (r Network_Storage_Allowed_Host_Hardware) GetSubnetsInAcl() (resp []datatypes.Network_Subnet, err error)

Retrieve The SoftLayer_Network_Subnet records assigned to the ACL for this allowed host.

func (Network_Storage_Allowed_Host_Hardware) Id 

func (r Network_Storage_Allowed_Host_Hardware) Id(id int) Network_Storage_Allowed_Host_Hardware

func (Network_Storage_Allowed_Host_Hardware) Limit 

func (r Network_Storage_Allowed_Host_Hardware) Limit(limit int) Network_Storage_Allowed_Host_Hardware

func (Network_Storage_Allowed_Host_Hardware) Mask 

func (r Network_Storage_Allowed_Host_Hardware) Mask(mask string) Network_Storage_Allowed_Host_Hardware

func (Network_Storage_Allowed_Host_Hardware) Offset 

func (r Network_Storage_Allowed_Host_Hardware) Offset(offset int) Network_Storage_Allowed_Host_Hardware

func (Network_Storage_Allowed_Host_Hardware) RemoveSubnetsFromAcl 

func (r Network_Storage_Allowed_Host_Hardware) RemoveSubnetsFromAcl(subnetIds []int) (resp []int, err error)

no documentation yet

func (Network_Storage_Allowed_Host_Hardware) SetCredentialPassword 

func (r Network_Storage_Allowed_Host_Hardware) SetCredentialPassword(password *string) (resp bool, err error)

Use this method to modify the credential password for a SoftLayer_Network_Storage_Allowed_Host object.

type Network_Storage_Allowed_Host_IpAddress 

type Network_Storage_Allowed_Host_IpAddress struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetNetworkStorageAllowedHostIpAddressService 

func GetNetworkStorageAllowedHostIpAddressService(sess session.SLSession) Network_Storage_Allowed_Host_IpAddress

GetNetworkStorageAllowedHostIpAddressService returns an instance of the Network_Storage_Allowed_Host_IpAddress SoftLayer service

func (Network_Storage_Allowed_Host_IpAddress) AssignSubnetsToAcl 

func (r Network_Storage_Allowed_Host_IpAddress) AssignSubnetsToAcl(subnetIds []int) (resp []int, err error)

no documentation yet

func (Network_Storage_Allowed_Host_IpAddress) EditObject 

func (r Network_Storage_Allowed_Host_IpAddress) EditObject(templateObject *datatypes.Network_Storage_Allowed_Host) (resp bool, err error)

no documentation yet

func (Network_Storage_Allowed_Host_IpAddress) Filter 

func (r Network_Storage_Allowed_Host_IpAddress) Filter(filter string) Network_Storage_Allowed_Host_IpAddress

func (Network_Storage_Allowed_Host_IpAddress) GetAccount 

func (r Network_Storage_Allowed_Host_IpAddress) GetAccount() (resp datatypes.Account, err error)

Retrieve The SoftLayer_Account object which this SoftLayer_Network_Storage_Allowed_Host belongs to.

func (Network_Storage_Allowed_Host_IpAddress) GetAllObjects 

func (r Network_Storage_Allowed_Host_IpAddress) GetAllObjects() (resp []datatypes.Network_Storage_Allowed_Host, err error)

no documentation yet

func (Network_Storage_Allowed_Host_IpAddress) GetAssignedGroups 

func (r Network_Storage_Allowed_Host_IpAddress) GetAssignedGroups() (resp []datatypes.Network_Storage_Group, err error)

Retrieve The SoftLayer_Network_Storage_Group objects this SoftLayer_Network_Storage_Allowed_Host is present in.

func (Network_Storage_Allowed_Host_IpAddress) GetAssignedIscsiVolumes 

func (r Network_Storage_Allowed_Host_IpAddress) GetAssignedIscsiVolumes() (resp []datatypes.Network_Storage, err error)

Retrieve The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access.

func (Network_Storage_Allowed_Host_IpAddress) GetAssignedNfsVolumes 

func (r Network_Storage_Allowed_Host_IpAddress) GetAssignedNfsVolumes() (resp []datatypes.Network_Storage, err error)

Retrieve The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access.

func (Network_Storage_Allowed_Host_IpAddress) GetAssignedReplicationVolumes 

func (r Network_Storage_Allowed_Host_IpAddress) GetAssignedReplicationVolumes() (resp []datatypes.Network_Storage, err error)

Retrieve The SoftLayer_Network_Storage primary volumes whose replicas are allowed access.

func (Network_Storage_Allowed_Host_IpAddress) GetAssignedVolumes 

func (r Network_Storage_Allowed_Host_IpAddress) GetAssignedVolumes() (resp []datatypes.Network_Storage, err error)

Retrieve The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access.

func (Network_Storage_Allowed_Host_IpAddress) GetCredential 

func (r Network_Storage_Allowed_Host_IpAddress) GetCredential() (resp datatypes.Network_Storage_Credential, err error)

Retrieve The SoftLayer_Network_Storage_Credential this allowed host uses.

func (Network_Storage_Allowed_Host_IpAddress) GetObject 

func (r Network_Storage_Allowed_Host_IpAddress) GetObject() (resp datatypes.Network_Storage_Allowed_Host_IpAddress, err error)

no documentation yet

func (Network_Storage_Allowed_Host_IpAddress) GetResource 

func (r Network_Storage_Allowed_Host_IpAddress) GetResource() (resp datatypes.Network_Subnet_IpAddress, err error)

Retrieve The SoftLayer_Network_Subnet_IpAddress object which this SoftLayer_Network_Storage_Allowed_Host is referencing.

func (Network_Storage_Allowed_Host_IpAddress) GetSourceSubnet 

func (r Network_Storage_Allowed_Host_IpAddress) GetSourceSubnet() (resp string, err error)

Retrieve Connections to a target with a source IP in this subnet prefix are allowed.

func (Network_Storage_Allowed_Host_IpAddress) GetSubnetsInAcl 

func (r Network_Storage_Allowed_Host_IpAddress) GetSubnetsInAcl() (resp []datatypes.Network_Subnet, err error)

Retrieve The SoftLayer_Network_Subnet records assigned to the ACL for this allowed host.

func (Network_Storage_Allowed_Host_IpAddress) Id 

func (r Network_Storage_Allowed_Host_IpAddress) Id(id int) Network_Storage_Allowed_Host_IpAddress

func (Network_Storage_Allowed_Host_IpAddress) Limit 

func (r Network_Storage_Allowed_Host_IpAddress) Limit(limit int) Network_Storage_Allowed_Host_IpAddress

func (Network_Storage_Allowed_Host_IpAddress) Mask 

func (r Network_Storage_Allowed_Host_IpAddress) Mask(mask string) Network_Storage_Allowed_Host_IpAddress

func (Network_Storage_Allowed_Host_IpAddress) Offset 

func (r Network_Storage_Allowed_Host_IpAddress) Offset(offset int) Network_Storage_Allowed_Host_IpAddress

func (Network_Storage_Allowed_Host_IpAddress) RemoveSubnetsFromAcl 

func (r Network_Storage_Allowed_Host_IpAddress) RemoveSubnetsFromAcl(subnetIds []int) (resp []int, err error)

no documentation yet

func (Network_Storage_Allowed_Host_IpAddress) SetCredentialPassword 

func (r Network_Storage_Allowed_Host_IpAddress) SetCredentialPassword(password *string) (resp bool, err error)

Use this method to modify the credential password for a SoftLayer_Network_Storage_Allowed_Host object.

type Network_Storage_Allowed_Host_Subnet 

type Network_Storage_Allowed_Host_Subnet struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetNetworkStorageAllowedHostSubnetService 

func GetNetworkStorageAllowedHostSubnetService(sess session.SLSession) Network_Storage_Allowed_Host_Subnet

GetNetworkStorageAllowedHostSubnetService returns an instance of the Network_Storage_Allowed_Host_Subnet SoftLayer service

func (Network_Storage_Allowed_Host_Subnet) AssignSubnetsToAcl 

func (r Network_Storage_Allowed_Host_Subnet) AssignSubnetsToAcl(subnetIds []int) (resp []int, err error)

no documentation yet

func (Network_Storage_Allowed_Host_Subnet) EditObject 

func (r Network_Storage_Allowed_Host_Subnet) EditObject(templateObject *datatypes.Network_Storage_Allowed_Host) (resp bool, err error)

no documentation yet

func (Network_Storage_Allowed_Host_Subnet) Filter 

func (r Network_Storage_Allowed_Host_Subnet) Filter(filter string) Network_Storage_Allowed_Host_Subnet

func (Network_Storage_Allowed_Host_Subnet) GetAccount 

func (r Network_Storage_Allowed_Host_Subnet) GetAccount() (resp datatypes.Account, err error)

Retrieve The SoftLayer_Account object which this SoftLayer_Network_Storage_Allowed_Host belongs to.

func (Network_Storage_Allowed_Host_Subnet) GetAllObjects 

func (r Network_Storage_Allowed_Host_Subnet) GetAllObjects() (resp []datatypes.Network_Storage_Allowed_Host, err error)

no documentation yet

func (Network_Storage_Allowed_Host_Subnet) GetAssignedGroups 

func (r Network_Storage_Allowed_Host_Subnet) GetAssignedGroups() (resp []datatypes.Network_Storage_Group, err error)

Retrieve The SoftLayer_Network_Storage_Group objects this SoftLayer_Network_Storage_Allowed_Host is present in.

func (Network_Storage_Allowed_Host_Subnet) GetAssignedIscsiVolumes 

func (r Network_Storage_Allowed_Host_Subnet) GetAssignedIscsiVolumes() (resp []datatypes.Network_Storage, err error)

Retrieve The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access.

func (Network_Storage_Allowed_Host_Subnet) GetAssignedNfsVolumes 

func (r Network_Storage_Allowed_Host_Subnet) GetAssignedNfsVolumes() (resp []datatypes.Network_Storage, err error)

Retrieve The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access.

func (Network_Storage_Allowed_Host_Subnet) GetAssignedReplicationVolumes 

func (r Network_Storage_Allowed_Host_Subnet) GetAssignedReplicationVolumes() (resp []datatypes.Network_Storage, err error)

Retrieve The SoftLayer_Network_Storage primary volumes whose replicas are allowed access.

func (Network_Storage_Allowed_Host_Subnet) GetAssignedVolumes 

func (r Network_Storage_Allowed_Host_Subnet) GetAssignedVolumes() (resp []datatypes.Network_Storage, err error)

Retrieve The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access.

func (Network_Storage_Allowed_Host_Subnet) GetCredential 

func (r Network_Storage_Allowed_Host_Subnet) GetCredential() (resp datatypes.Network_Storage_Credential, err error)

Retrieve The SoftLayer_Network_Storage_Credential this allowed host uses.

func (Network_Storage_Allowed_Host_Subnet) GetObject 

func (r Network_Storage_Allowed_Host_Subnet) GetObject() (resp datatypes.Network_Storage_Allowed_Host_Subnet, err error)

no documentation yet

func (Network_Storage_Allowed_Host_Subnet) GetResource 

func (r Network_Storage_Allowed_Host_Subnet) GetResource() (resp datatypes.Network_Subnet, err error)

Retrieve The SoftLayer_Network_Subnet object which this SoftLayer_Network_Storage_Allowed_Host is referencing.

func (Network_Storage_Allowed_Host_Subnet) GetSourceSubnet 

func (r Network_Storage_Allowed_Host_Subnet) GetSourceSubnet() (resp string, err error)

Retrieve Connections to a target with a source IP in this subnet prefix are allowed.

func (Network_Storage_Allowed_Host_Subnet) GetSubnetsInAcl 

func (r Network_Storage_Allowed_Host_Subnet) GetSubnetsInAcl() (resp []datatypes.Network_Subnet, err error)

Retrieve The SoftLayer_Network_Subnet records assigned to the ACL for this allowed host.

func (Network_Storage_Allowed_Host_Subnet) Id 

func (r Network_Storage_Allowed_Host_Subnet) Id(id int) Network_Storage_Allowed_Host_Subnet

func (Network_Storage_Allowed_Host_Subnet) Limit 

func (r Network_Storage_Allowed_Host_Subnet) Limit(limit int) Network_Storage_Allowed_Host_Subnet

func (Network_Storage_Allowed_Host_Subnet) Mask 

func (r Network_Storage_Allowed_Host_Subnet) Mask(mask string) Network_Storage_Allowed_Host_Subnet

func (Network_Storage_Allowed_Host_Subnet) Offset 

func (r Network_Storage_Allowed_Host_Subnet) Offset(offset int) Network_Storage_Allowed_Host_Subnet

func (Network_Storage_Allowed_Host_Subnet) RemoveSubnetsFromAcl 

func (r Network_Storage_Allowed_Host_Subnet) RemoveSubnetsFromAcl(subnetIds []int) (resp []int, err error)

no documentation yet

func (Network_Storage_Allowed_Host_Subnet) SetCredentialPassword 

func (r Network_Storage_Allowed_Host_Subnet) SetCredentialPassword(password *string) (resp bool, err error)

Use this method to modify the credential password for a SoftLayer_Network_Storage_Allowed_Host object.

type Network_Storage_Allowed_Host_VirtualGuest 

type Network_Storage_Allowed_Host_VirtualGuest struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetNetworkStorageAllowedHostVirtualGuestService 

func GetNetworkStorageAllowedHostVirtualGuestService(sess session.SLSession) Network_Storage_Allowed_Host_VirtualGuest

GetNetworkStorageAllowedHostVirtualGuestService returns an instance of the Network_Storage_Allowed_Host_VirtualGuest SoftLayer service

func (Network_Storage_Allowed_Host_VirtualGuest) AssignSubnetsToAcl 

func (r Network_Storage_Allowed_Host_VirtualGuest) AssignSubnetsToAcl(subnetIds []int) (resp []int, err error)

no documentation yet

func (Network_Storage_Allowed_Host_VirtualGuest) EditObject 

func (r Network_Storage_Allowed_Host_VirtualGuest) EditObject(templateObject *datatypes.Network_Storage_Allowed_Host) (resp bool, err error)

no documentation yet

func (Network_Storage_Allowed_Host_VirtualGuest) Filter 

func (r Network_Storage_Allowed_Host_VirtualGuest) Filter(filter string) Network_Storage_Allowed_Host_VirtualGuest

func (Network_Storage_Allowed_Host_VirtualGuest) GetAccount 

func (r Network_Storage_Allowed_Host_VirtualGuest) GetAccount() (resp datatypes.Account, err error)

Retrieve The SoftLayer_Account object which this SoftLayer_Network_Storage_Allowed_Host belongs to.

func (Network_Storage_Allowed_Host_VirtualGuest) GetAllObjects 

func (r Network_Storage_Allowed_Host_VirtualGuest) GetAllObjects() (resp []datatypes.Network_Storage_Allowed_Host, err error)

no documentation yet

func (Network_Storage_Allowed_Host_VirtualGuest) GetAssignedGroups 

func (r Network_Storage_Allowed_Host_VirtualGuest) GetAssignedGroups() (resp []datatypes.Network_Storage_Group, err error)

Retrieve The SoftLayer_Network_Storage_Group objects this SoftLayer_Network_Storage_Allowed_Host is present in.

func (Network_Storage_Allowed_Host_VirtualGuest) GetAssignedIscsiVolumes 

func (r Network_Storage_Allowed_Host_VirtualGuest) GetAssignedIscsiVolumes() (resp []datatypes.Network_Storage, err error)

Retrieve The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access.

func (Network_Storage_Allowed_Host_VirtualGuest) GetAssignedNfsVolumes 

func (r Network_Storage_Allowed_Host_VirtualGuest) GetAssignedNfsVolumes() (resp []datatypes.Network_Storage, err error)

Retrieve The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access.

func (Network_Storage_Allowed_Host_VirtualGuest) GetAssignedReplicationVolumes 

func (r Network_Storage_Allowed_Host_VirtualGuest) GetAssignedReplicationVolumes() (resp []datatypes.Network_Storage, err error)

Retrieve The SoftLayer_Network_Storage primary volumes whose replicas are allowed access.

func (Network_Storage_Allowed_Host_VirtualGuest) GetAssignedVolumes 

func (r Network_Storage_Allowed_Host_VirtualGuest) GetAssignedVolumes() (resp []datatypes.Network_Storage, err error)

Retrieve The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access.

func (Network_Storage_Allowed_Host_VirtualGuest) GetCredential 

func (r Network_Storage_Allowed_Host_VirtualGuest) GetCredential() (resp datatypes.Network_Storage_Credential, err error)

Retrieve The SoftLayer_Network_Storage_Credential this allowed host uses.

func (Network_Storage_Allowed_Host_VirtualGuest) GetObject 

func (r Network_Storage_Allowed_Host_VirtualGuest) GetObject() (resp datatypes.Network_Storage_Allowed_Host_VirtualGuest, err error)

no documentation yet

func (Network_Storage_Allowed_Host_VirtualGuest) GetResource 

func (r Network_Storage_Allowed_Host_VirtualGuest) GetResource() (resp datatypes.Virtual_Guest, err error)

Retrieve The SoftLayer_Virtual_Guest object which this SoftLayer_Network_Storage_Allowed_Host is referencing.

func (Network_Storage_Allowed_Host_VirtualGuest) GetSourceSubnet 

func (r Network_Storage_Allowed_Host_VirtualGuest) GetSourceSubnet() (resp string, err error)

Retrieve Connections to a target with a source IP in this subnet prefix are allowed.

func (Network_Storage_Allowed_Host_VirtualGuest) GetSubnetsInAcl 

func (r Network_Storage_Allowed_Host_VirtualGuest) GetSubnetsInAcl() (resp []datatypes.Network_Subnet, err error)

Retrieve The SoftLayer_Network_Subnet records assigned to the ACL for this allowed host.

func (Network_Storage_Allowed_Host_VirtualGuest) Id 

func (r Network_Storage_Allowed_Host_VirtualGuest) Id(id int) Network_Storage_Allowed_Host_VirtualGuest

func (Network_Storage_Allowed_Host_VirtualGuest) Limit 

func (r Network_Storage_Allowed_Host_VirtualGuest) Limit(limit int) Network_Storage_Allowed_Host_VirtualGuest

func (Network_Storage_Allowed_Host_VirtualGuest) Mask 

func (r Network_Storage_Allowed_Host_VirtualGuest) Mask(mask string) Network_Storage_Allowed_Host_VirtualGuest

func (Network_Storage_Allowed_Host_VirtualGuest) Offset 

func (r Network_Storage_Allowed_Host_VirtualGuest) Offset(offset int) Network_Storage_Allowed_Host_VirtualGuest

func (Network_Storage_Allowed_Host_VirtualGuest) RemoveSubnetsFromAcl 

func (r Network_Storage_Allowed_Host_VirtualGuest) RemoveSubnetsFromAcl(subnetIds []int) (resp []int, err error)

no documentation yet

func (Network_Storage_Allowed_Host_VirtualGuest) SetCredentialPassword 

func (r Network_Storage_Allowed_Host_VirtualGuest) SetCredentialPassword(password *string) (resp bool, err error)

Use this method to modify the credential password for a SoftLayer_Network_Storage_Allowed_Host object.

type Network_Storage_Backup_Evault 

type Network_Storage_Backup_Evault struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetNetworkStorageBackupEvaultService 

func GetNetworkStorageBackupEvaultService(sess session.SLSession) Network_Storage_Backup_Evault

GetNetworkStorageBackupEvaultService returns an instance of the Network_Storage_Backup_Evault SoftLayer service

func (Network_Storage_Backup_Evault) AllowAccessFromHardware 

func (r Network_Storage_Backup_Evault) AllowAccessFromHardware(hardwareObjectTemplate *datatypes.Hardware) (resp bool, err error)

This method is used to modify the access control list for this Storage volume. The SoftLayer_Hardware objects which have been allowed access to this storage will be listed in the allowedHardware property of this storage volume.

func (Network_Storage_Backup_Evault) AllowAccessFromHardwareList 

func (r Network_Storage_Backup_Evault) AllowAccessFromHardwareList(hardwareObjectTemplates []datatypes.Hardware) (resp bool, err error)

no documentation yet

func (Network_Storage_Backup_Evault) AllowAccessFromHost 

func (r Network_Storage_Backup_Evault) AllowAccessFromHost(typeClassName *string, hostId *int) (resp datatypes.Network_Storage_Allowed_Host, err error)

This method is used to modify the access control list for this Storage volume. The [[SoftLayer_Hardware|SoftLayer_Virtual_Guest|SoftLayer_Network_Subnet|SoftLayer_Network_Subnet_IpAddress]] objects which have been allowed access to this storage will be listed in the [[allowedHardware|allowedVirtualGuests|allowedSubnets|allowedIpAddresses]] property of this storage volume.

func (Network_Storage_Backup_Evault) AllowAccessFromHostList 

func (r Network_Storage_Backup_Evault) AllowAccessFromHostList(hostObjectTemplates []datatypes.Container_Network_Storage_Host) (resp []datatypes.Network_Storage_Allowed_Host, err error)

This method is used to modify the access control list for this Storage volume. The [[SoftLayer_Hardware|SoftLayer_Virtual_Guest|SoftLayer_Network_Subnet|SoftLayer_Network_Subnet_IpAddress]] objects which have been allowed access to this storage volume will be listed in the [[allowedHardware|allowedVirtualGuests|allowedSubnets|allowedIpAddresses]] property of this storage volume.

func (Network_Storage_Backup_Evault) AllowAccessFromIpAddress 

func (r Network_Storage_Backup_Evault) AllowAccessFromIpAddress(ipAddressObjectTemplate *datatypes.Network_Subnet_IpAddress) (resp bool, err error)

This method is used to modify the access control list for this Storage volume. The SoftLayer_Network_Subnet_IpAddress objects which have been allowed access to this storage will be listed in the allowedIpAddresses property of this storage volume.

func (Network_Storage_Backup_Evault) AllowAccessFromIpAddressList 

func (r Network_Storage_Backup_Evault) AllowAccessFromIpAddressList(ipAddressObjectTemplates []datatypes.Network_Subnet_IpAddress) (resp bool, err error)

no documentation yet

func (Network_Storage_Backup_Evault) AllowAccessFromSubnet 

func (r Network_Storage_Backup_Evault) AllowAccessFromSubnet(subnetObjectTemplate *datatypes.Network_Subnet) (resp bool, err error)

This method is used to modify the access control list for this Storage volume. The SoftLayer_Network_Subnet objects which have been allowed access to this storage will be listed in the allowedHardware property of this storage volume.

func (Network_Storage_Backup_Evault) AllowAccessFromSubnetList 

func (r Network_Storage_Backup_Evault) AllowAccessFromSubnetList(subnetObjectTemplates []datatypes.Network_Subnet) (resp bool, err error)

no documentation yet

func (Network_Storage_Backup_Evault) AllowAccessFromVirtualGuest 

func (r Network_Storage_Backup_Evault) AllowAccessFromVirtualGuest(virtualGuestObjectTemplate *datatypes.Virtual_Guest) (resp bool, err error)

This method is used to modify the access control list for this Storage volume. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage will be listed in the allowedVirtualGuests property of this storage volume.

func (Network_Storage_Backup_Evault) AllowAccessFromVirtualGuestList 

func (r Network_Storage_Backup_Evault) AllowAccessFromVirtualGuestList(virtualGuestObjectTemplates []datatypes.Virtual_Guest) (resp bool, err error)

This method is used to modify the access control list for this Storage volume. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage will be listed in the allowedVirtualGuests property of this storage volume.

func (Network_Storage_Backup_Evault) AllowAccessToReplicantFromHardware 

func (r Network_Storage_Backup_Evault) AllowAccessToReplicantFromHardware(hardwareObjectTemplate *datatypes.Hardware) (resp bool, err error)

This method is used to modify the access control list for this Storage replicant volume. The SoftLayer_Hardware objects which have been allowed access to this storage will be listed in the allowedHardware property of this storage replicant volume.

func (Network_Storage_Backup_Evault) AllowAccessToReplicantFromHardwareList 

func (r Network_Storage_Backup_Evault) AllowAccessToReplicantFromHardwareList(hardwareObjectTemplates []datatypes.Hardware) (resp bool, err error)

This method is used to modify the access control list for this Storage volume's replica. The SoftLayer_Hardware objects which have been allowed access to this storage volume's replica will be listed in the allowedReplicationHardware property of this storage volume.

func (Network_Storage_Backup_Evault) AllowAccessToReplicantFromIpAddress 

func (r Network_Storage_Backup_Evault) AllowAccessToReplicantFromIpAddress(ipAddressObjectTemplate *datatypes.Network_Subnet_IpAddress) (resp bool, err error)

no documentation yet

func (Network_Storage_Backup_Evault) AllowAccessToReplicantFromIpAddressList 

func (r Network_Storage_Backup_Evault) AllowAccessToReplicantFromIpAddressList(ipAddressObjectTemplates []datatypes.Network_Subnet_IpAddress) (resp bool, err error)

This method is used to modify the access control list for this Storage volume's replica. The SoftLayer_Network_Subnet_IpAddress objects which have been allowed access to this storage volume's replica will be listed in the allowedReplicationIpAddresses property of this storage volume.

func (Network_Storage_Backup_Evault) AllowAccessToReplicantFromSubnet 

func (r Network_Storage_Backup_Evault) AllowAccessToReplicantFromSubnet(subnetObjectTemplate *datatypes.Network_Subnet) (resp bool, err error)

This method is used to modify the access control list for this Storage replicant volume. The SoftLayer_Network_Subnet objects which have been allowed access to this storage will be listed in the allowedHardware property of this storage replicant volume.

func (Network_Storage_Backup_Evault) AllowAccessToReplicantFromSubnetList 

func (r Network_Storage_Backup_Evault) AllowAccessToReplicantFromSubnetList(subnetObjectTemplates []datatypes.Network_Subnet) (resp bool, err error)

This method is used to modify the access control list for this Storage volume's replica. The SoftLayer_Network_Subnet objects which have been allowed access to this storage volume's replica will be listed in the allowedReplicationSubnets property of this storage volume.

func (Network_Storage_Backup_Evault) AllowAccessToReplicantFromVirtualGuest 

func (r Network_Storage_Backup_Evault) AllowAccessToReplicantFromVirtualGuest(virtualGuestObjectTemplate *datatypes.Virtual_Guest) (resp bool, err error)

This method is used to modify the access control list for this Storage replicant volume. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage will be listed in the allowedVirtualGuests property of this storage replicant volume.

func (Network_Storage_Backup_Evault) AllowAccessToReplicantFromVirtualGuestList 

func (r Network_Storage_Backup_Evault) AllowAccessToReplicantFromVirtualGuestList(virtualGuestObjectTemplates []datatypes.Virtual_Guest) (resp bool, err error)

This method is used to modify the access control list for this Storage volume's replica. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage volume's replica will be listed in the allowedReplicationVirtualGuests property of this storage volume.

func (Network_Storage_Backup_Evault) AssignCredential 

func (r Network_Storage_Backup_Evault) AssignCredential(username *string) (resp bool, err error)

This method will assign an existing credential to the current volume. The credential must have been created using the 'addNewCredential' method. The volume type must support an additional credential.

func (Network_Storage_Backup_Evault) AssignNewCredential 

func (r Network_Storage_Backup_Evault) AssignNewCredential(typ *string) (resp datatypes.Network_Storage_Credential, err error)

This method will set up a new credential for the remote storage volume. The storage volume must support an additional credential. Once created, the credential will be automatically assigned to the current volume. If there are no volumes assigned to the credential it will be automatically deleted.

func (Network_Storage_Backup_Evault) ChangePassword 

func (r Network_Storage_Backup_Evault) ChangePassword(username *string, currentPassword *string, newPassword *string) (resp bool, err error)

The method will change the password for the given Storage/Virtual Server Storage account.

func (Network_Storage_Backup_Evault) CollectBandwidth 

func (r Network_Storage_Backup_Evault) CollectBandwidth(typ *string, startDate *datatypes.Time, endDate *datatypes.Time) (resp uint, err error)

{{CloudLayerOnlyMethod}}

collectBandwidth() Retrieve the bandwidth usage for the current billing cycle.

func (Network_Storage_Backup_Evault) CollectBytesUsed 

func (r Network_Storage_Backup_Evault) CollectBytesUsed() (resp uint, err error)

{{CloudLayerOnlyMethod}}

collectBytesUsed() retrieves the number of bytes capacity currently in use on a Storage account.

func (Network_Storage_Backup_Evault) ConvertCloneDependentToIndependent added in v1.0.1 

func (r Network_Storage_Backup_Evault) ConvertCloneDependentToIndependent() (resp bool, err error)

no documentation yet

func (Network_Storage_Backup_Evault) CreateFolder 

func (r Network_Storage_Backup_Evault) CreateFolder(folder *string) (resp bool, err error)

no documentation yet

func (Network_Storage_Backup_Evault) CreateOrUpdateLunId 

func (r Network_Storage_Backup_Evault) CreateOrUpdateLunId(lunId *int) (resp datatypes.Network_Storage_Property, err error)

The LUN ID only takes effect during the Host Authorization process. It is required to de-authorize all hosts before using this method.

func (Network_Storage_Backup_Evault) CreateSnapshot 

func (r Network_Storage_Backup_Evault) CreateSnapshot(notes *string) (resp datatypes.Network_Storage, err error)

no documentation yet

func (Network_Storage_Backup_Evault) DeleteAllFiles 

func (r Network_Storage_Backup_Evault) DeleteAllFiles() (resp bool, err error)

{{CloudLayerOnlyMethod}} Delete all files within a Storage account. Depending on the type of Storage account, Deleting either deletes files permanently or sends files to your account's recycle bin.

Currently, Virtual Server storage is the only type of Storage account that sends files to a recycle bin when deleted. When called against a Virtual Server storage account , this method also determines if the files are in the account's recycle bin. If the files exist in the recycle bin, then they are permanently deleted.

Please note, files can not be restored once they are permanently deleted.

func (Network_Storage_Backup_Evault) DeleteFile 

func (r Network_Storage_Backup_Evault) DeleteFile(fileId *string) (resp bool, err error)

{{CloudLayerOnlyMethod}} Delete an individual file within a Storage account. Depending on the type of Storage account, Deleting a file either deletes the file permanently or sends the file to your account's recycle bin.

Currently, Virtual Server storage is the only type of Storage account that sends files to a recycle bin when deleted. When called against a Virtual Server storage account , this method also determines if the file is in the account's recycle bin. If the file exist in the recycle bin, then it is permanently deleted.

Please note, a file can not be restored once it is permanently deleted.

func (Network_Storage_Backup_Evault) DeleteFiles 

func (r Network_Storage_Backup_Evault) DeleteFiles(fileIds []string) (resp bool, err error)

{{CloudLayerOnlyMethod}} Delete multiple files within a Storage account. Depending on the type of Storage account, Deleting either deletes files permanently or sends files to your account's recycle bin.

Currently, Virtual Server storage is the only type of Storage account that sends files to a recycle bin when deleted. When called against a Virtual Server storage account , this method also determines if the files are in the account's recycle bin. If the files exist in the recycle bin, then they are permanently deleted.

Please note, files can not be restored once they are permanently deleted.

func (Network_Storage_Backup_Evault) DeleteFolder 

func (r Network_Storage_Backup_Evault) DeleteFolder(folder *string) (resp bool, err error)

no documentation yet

func (Network_Storage_Backup_Evault) DeleteObject 

func (r Network_Storage_Backup_Evault) DeleteObject() (resp bool, err error)

Delete a network storage volume. ”'This cannot be undone.”' At this time only network storage snapshots may be deleted with this method.

”deleteObject” returns Boolean ”true” on successful deletion or ”false” if it was unable to remove a volume;

func (Network_Storage_Backup_Evault) DeleteTasks 

func (r Network_Storage_Backup_Evault) DeleteTasks(tasks []int) (resp bool, err error)

This method can be used to help maintain the storage space on a vault. When a job is removed from the Webcc, the task and stored usage still exists on the vault. This method can be used to delete the associated task and its usage.

All that is required for the use of the method is to pass in an integer array of task(s).

func (Network_Storage_Backup_Evault) DisableSnapshots 

func (r Network_Storage_Backup_Evault) DisableSnapshots(scheduleType *string) (resp bool, err error)

This method is not valid for Legacy iSCSI Storage Volumes.

Disable scheduled snapshots of this storage volume. Scheduling options include 'INTERVAL', HOURLY, DAILY and WEEKLY schedules.

func (Network_Storage_Backup_Evault) DisasterRecoveryFailoverToReplicant added in v1.0.3 

func (r Network_Storage_Backup_Evault) DisasterRecoveryFailoverToReplicant(replicantId *int) (resp bool, err error)

If a volume (with replication) becomes inaccessible due to a disaster event, this method can be used to immediately failover to an available replica in another location. This method does not allow for fail back via the API. To fail back to the original volume after using this method, open a support ticket. To test failover, use [[SoftLayer_Network_Storage::failoverToReplicant]] instead.

func (Network_Storage_Backup_Evault) DownloadFile 

func (r Network_Storage_Backup_Evault) DownloadFile(fileId *string) (resp datatypes.Container_Utility_File_Entity, err error)

{{CloudLayerOnlyMethod}} Download a file from a Storage account. This method returns a file's details including the file's raw content.

func (Network_Storage_Backup_Evault) EditCredential 

func (r Network_Storage_Backup_Evault) EditCredential(username *string, newPassword *string) (resp bool, err error)

This method will change the password of a credential created using the 'addNewCredential' method. If the credential exists on multiple storage volumes it will change for those volumes as well.

func (Network_Storage_Backup_Evault) EditObject 

func (r Network_Storage_Backup_Evault) EditObject(templateObject *datatypes.Network_Storage) (resp bool, err error)

The password and/or notes may be modified for the Storage service except evault passwords and notes.

func (Network_Storage_Backup_Evault) EnableSnapshots 

func (r Network_Storage_Backup_Evault) EnableSnapshots(scheduleType *string, retentionCount *int, minute *int, hour *int, dayOfWeek *string) (resp bool, err error)

This method is not valid for Legacy iSCSI Storage Volumes.

Enable scheduled snapshots of this storage volume. Scheduling options include HOURLY, DAILY and WEEKLY schedules. For HOURLY schedules, provide relevant data for $scheduleType, $retentionCount and $minute. For DAILY schedules, provide relevant data for $scheduleType, $retentionCount, $minute, and $hour. For WEEKLY schedules, provide relevant data for all parameters of this method.

func (Network_Storage_Backup_Evault) FailbackFromReplicant 

func (r Network_Storage_Backup_Evault) FailbackFromReplicant() (resp bool, err error)

Failback from a volume replicant. In order to failback the volume must have already been failed over to a replicant.

func (Network_Storage_Backup_Evault) FailoverToReplicant 

func (r Network_Storage_Backup_Evault) FailoverToReplicant(replicantId *int) (resp bool, err error)

Failover to a volume replicant. During the time which the replicant is in use the local nas volume will not be available.

func (Network_Storage_Backup_Evault) Filter 

func (r Network_Storage_Backup_Evault) Filter(filter string) Network_Storage_Backup_Evault

func (Network_Storage_Backup_Evault) GetAccount 

func (r Network_Storage_Backup_Evault) GetAccount() (resp datatypes.Account, err error)

Retrieve The account that a Storage services belongs to.

func (Network_Storage_Backup_Evault) GetAccountPassword 

func (r Network_Storage_Backup_Evault) GetAccountPassword() (resp datatypes.Account_Password, err error)

Retrieve Other usernames and passwords associated with a Storage volume.

func (Network_Storage_Backup_Evault) GetActiveTransactions 

func (r Network_Storage_Backup_Evault) GetActiveTransactions() (resp []datatypes.Provisioning_Version1_Transaction, err error)

Retrieve The currently active transactions on a network storage volume.

func (Network_Storage_Backup_Evault) GetAllFiles 

func (r Network_Storage_Backup_Evault) GetAllFiles() (resp []datatypes.Container_Utility_File_Entity, err error)

{{CloudLayerOnlyMethod}} Retrieve details such as id, name, size, create date for all files in a Storage account's root directory. This does not download file content.

func (Network_Storage_Backup_Evault) GetAllFilesByFilter 

func (r Network_Storage_Backup_Evault) GetAllFilesByFilter(filter *datatypes.Container_Utility_File_Entity) (resp []datatypes.Container_Utility_File_Entity, err error)

{{CloudLayerOnlyMethod}} Retrieve details such as id, name, size, create date for all files matching the filter's criteria in a Storage account's root directory. This does not download file content.

func (Network_Storage_Backup_Evault) GetAllowDisasterRecoveryFailback added in v1.0.4 

func (r Network_Storage_Backup_Evault) GetAllowDisasterRecoveryFailback() (resp string, err error)

Retrieve

func (Network_Storage_Backup_Evault) GetAllowDisasterRecoveryFailover added in v1.0.4 

func (r Network_Storage_Backup_Evault) GetAllowDisasterRecoveryFailover() (resp string, err error)

Retrieve

func (Network_Storage_Backup_Evault) GetAllowableHardware 

func (r Network_Storage_Backup_Evault) GetAllowableHardware(filterHostname *string) (resp []datatypes.Hardware, err error)

This method retrieves a list of SoftLayer_Hardware that can be authorized to this SoftLayer_Network_Storage.

func (Network_Storage_Backup_Evault) GetAllowableIpAddresses 

func (r Network_Storage_Backup_Evault) GetAllowableIpAddresses(subnetId *int, filterIpAddress *string) (resp []datatypes.Network_Subnet_IpAddress, err error)

This method retrieves a list of SoftLayer_Network_Subnet_IpAddress that can be authorized to this SoftLayer_Network_Storage.

func (Network_Storage_Backup_Evault) GetAllowableSubnets 

func (r Network_Storage_Backup_Evault) GetAllowableSubnets(filterNetworkIdentifier *string) (resp []datatypes.Network_Subnet, err error)

This method retrieves a list of SoftLayer_Network_Subnet that can be authorized to this SoftLayer_Network_Storage.

func (Network_Storage_Backup_Evault) GetAllowableVirtualGuests 

func (r Network_Storage_Backup_Evault) GetAllowableVirtualGuests(filterHostname *string) (resp []datatypes.Virtual_Guest, err error)

This method retrieves a list of SoftLayer_Virtual_Guest that can be authorized to this SoftLayer_Network_Storage.

func (Network_Storage_Backup_Evault) GetAllowedHardware 

func (r Network_Storage_Backup_Evault) GetAllowedHardware() (resp []datatypes.Hardware, err error)

Retrieve The SoftLayer_Hardware objects which are allowed access to this storage volume.

func (Network_Storage_Backup_Evault) GetAllowedHostsLimit 

func (r Network_Storage_Backup_Evault) GetAllowedHostsLimit() (resp int, err error)

Retrieves the total number of allowed hosts limit per volume.

func (Network_Storage_Backup_Evault) GetAllowedIpAddresses 

func (r Network_Storage_Backup_Evault) GetAllowedIpAddresses() (resp []datatypes.Network_Subnet_IpAddress, err error)

Retrieve The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume.

func (Network_Storage_Backup_Evault) GetAllowedReplicationHardware 

func (r Network_Storage_Backup_Evault) GetAllowedReplicationHardware() (resp []datatypes.Hardware, err error)

Retrieve The SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant.

func (Network_Storage_Backup_Evault) GetAllowedReplicationIpAddresses 

func (r Network_Storage_Backup_Evault) GetAllowedReplicationIpAddresses() (resp []datatypes.Network_Subnet_IpAddress, err error)

Retrieve The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume's Replicant.

func (Network_Storage_Backup_Evault) GetAllowedReplicationSubnets 

func (r Network_Storage_Backup_Evault) GetAllowedReplicationSubnets() (resp []datatypes.Network_Subnet, err error)

Retrieve The SoftLayer_Network_Subnet objects which are allowed access to this storage volume's Replicant.

func (Network_Storage_Backup_Evault) GetAllowedReplicationVirtualGuests 

func (r Network_Storage_Backup_Evault) GetAllowedReplicationVirtualGuests() (resp []datatypes.Virtual_Guest, err error)

Retrieve The SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant.

func (Network_Storage_Backup_Evault) GetAllowedSubnets 

func (r Network_Storage_Backup_Evault) GetAllowedSubnets() (resp []datatypes.Network_Subnet, err error)

Retrieve The SoftLayer_Network_Subnet objects which are allowed access to this storage volume.

func (Network_Storage_Backup_Evault) GetAllowedVirtualGuests 

func (r Network_Storage_Backup_Evault) GetAllowedVirtualGuests() (resp []datatypes.Virtual_Guest, err error)

Retrieve The SoftLayer_Virtual_Guest objects which are allowed access to this storage volume.

func (Network_Storage_Backup_Evault) GetBillingItem 

func (r Network_Storage_Backup_Evault) GetBillingItem() (resp datatypes.Billing_Item, err error)

Retrieve The current billing item for a Storage volume.

func (Network_Storage_Backup_Evault) GetBillingItemCategory 

func (r Network_Storage_Backup_Evault) GetBillingItemCategory() (resp datatypes.Product_Item_Category, err error)

Retrieve

func (Network_Storage_Backup_Evault) GetByUsername 

func (r Network_Storage_Backup_Evault) GetByUsername(username *string, typ *string) (resp []datatypes.Network_Storage, err error)

Retrieve network storage accounts by username and storage account type. Use this method if you wish to retrieve a storage record by username rather than by id. The ”type” parameter must correspond to one of the available ”nasType” values in the SoftLayer_Network_Storage data type.

func (Network_Storage_Backup_Evault) GetBytesUsed 

func (r Network_Storage_Backup_Evault) GetBytesUsed() (resp string, err error)

Retrieve The amount of space used by the volume, in bytes.

func (Network_Storage_Backup_Evault) GetCdnUrls 

func (r Network_Storage_Backup_Evault) GetCdnUrls() (resp []datatypes.Container_Network_Storage_Hub_ObjectStorage_ContentDeliveryUrl, err error)

no documentation yet

func (Network_Storage_Backup_Evault) GetClusterResource 

func (r Network_Storage_Backup_Evault) GetClusterResource() (resp datatypes.Network_Service_Resource, err error)

no documentation yet

func (Network_Storage_Backup_Evault) GetCreationScheduleId 

func (r Network_Storage_Backup_Evault) GetCreationScheduleId() (resp string, err error)

Retrieve The schedule id which was executed to create a snapshot.

func (Network_Storage_Backup_Evault) GetCredentials 

func (r Network_Storage_Backup_Evault) GetCredentials() (resp []datatypes.Network_Storage_Credential, err error)

Retrieve

func (Network_Storage_Backup_Evault) GetDailySchedule 

func (r Network_Storage_Backup_Evault) GetDailySchedule() (resp datatypes.Network_Storage_Schedule, err error)

Retrieve The Daily Schedule which is associated with this network storage volume.

func (Network_Storage_Backup_Evault) GetDependentDuplicate 

func (r Network_Storage_Backup_Evault) GetDependentDuplicate() (resp string, err error)

Retrieve Whether or not a network storage volume is a dependent duplicate.

func (Network_Storage_Backup_Evault) GetDependentDuplicates added in v1.0.1 

func (r Network_Storage_Backup_Evault) GetDependentDuplicates() (resp []datatypes.Network_Storage, err error)

Retrieve The network storage volumes configured to be dependent duplicates of a volume.

func (Network_Storage_Backup_Evault) GetDuplicateConversionStatus added in v1.0.6 

func (r Network_Storage_Backup_Evault) GetDuplicateConversionStatus() (resp datatypes.Container_Network_Storage_DuplicateConversionStatusInformation, err error)

This method is used to check, if for the given classic file block storage volume, a transaction performing dependent to independent duplicate conversion is active. If yes, then this returns the current percentage of its progress along with its start time as [SoftLayer_Container_Network_Storage_DuplicateConversionStatusInformation] object with its name, percentage and transaction start timestamp.

func (Network_Storage_Backup_Evault) GetEvents 

func (r Network_Storage_Backup_Evault) GetEvents() (resp []datatypes.Network_Storage_Event, err error)

Retrieve The events which have taken place on a network storage volume.

func (Network_Storage_Backup_Evault) GetFailbackNotAllowed added in v1.0.3 

func (r Network_Storage_Backup_Evault) GetFailbackNotAllowed() (resp string, err error)

Retrieve Determines whether the volume is allowed to failback

func (Network_Storage_Backup_Evault) GetFailoverNotAllowed added in v1.0.4 

func (r Network_Storage_Backup_Evault) GetFailoverNotAllowed() (resp string, err error)

Retrieve Determines whether the volume is allowed to failover

func (Network_Storage_Backup_Evault) GetFileBlockEncryptedLocations 

func (r Network_Storage_Backup_Evault) GetFileBlockEncryptedLocations() (resp []datatypes.Location, err error)

func (Network_Storage_Backup_Evault) GetFileByIdentifier 

func (r Network_Storage_Backup_Evault) GetFileByIdentifier(identifier *string) (resp datatypes.Container_Utility_File_Entity, err error)

{{CloudLayerOnlyMethod}} Retrieve details such as id, name, size, create date of a file within a Storage account. This does not download file content.

func (Network_Storage_Backup_Evault) GetFileCount 

func (r Network_Storage_Backup_Evault) GetFileCount() (resp int, err error)

{{CloudLayerOnlyMethod}} Retrieve the file number of files in a Virtual Server Storage account's root directory. This does not include the files stored in the recycle bin.

func (Network_Storage_Backup_Evault) GetFileList 

func (r Network_Storage_Backup_Evault) GetFileList(folder *string, path *string) (resp []datatypes.Container_Utility_File_Entity, err error)

no documentation yet

func (Network_Storage_Backup_Evault) GetFileNetworkMountAddress 

func (r Network_Storage_Backup_Evault) GetFileNetworkMountAddress() (resp string, err error)

Retrieve Retrieves the NFS Network Mount Address Name for a given File Storage Volume.

func (Network_Storage_Backup_Evault) GetFilePendingDeleteCount 

func (r Network_Storage_Backup_Evault) GetFilePendingDeleteCount() (resp int, err error)

{{CloudLayerOnlyMethod}} Retrieve the number of files pending deletion in a Storage account's recycle bin. Files in an account's recycle bin may either be restored to the account's root directory or permanently deleted.

func (Network_Storage_Backup_Evault) GetFilesPendingDelete 

func (r Network_Storage_Backup_Evault) GetFilesPendingDelete() (resp []datatypes.Container_Utility_File_Entity, err error)

{{CloudLayerOnlyMethod}} Retrieve a list of files that are pending deletion in a Storage account's recycle bin. Files in an account's recycle bin may either be restored to the account's root directory or permanently deleted. This method does not download file content.

func (Network_Storage_Backup_Evault) GetFixReplicationCurrentStatus added in v1.0.5 

func (r Network_Storage_Backup_Evault) GetFixReplicationCurrentStatus() (resp string, err error)

Retrieve

func (Network_Storage_Backup_Evault) GetFolderList 

func (r Network_Storage_Backup_Evault) GetFolderList() (resp []datatypes.Container_Network_Storage_Hub_ObjectStorage_Folder, err error)

no documentation yet

func (Network_Storage_Backup_Evault) GetHardware 

func (r Network_Storage_Backup_Evault) GetHardware() (resp datatypes.Hardware, err error)

Retrieve When applicable, the hardware associated with a Storage service.

func (Network_Storage_Backup_Evault) GetHardwareWithEvaultFirst 

func (r Network_Storage_Backup_Evault) GetHardwareWithEvaultFirst(option *string, exactMatch *bool, criteria *string, mode *string) (resp []datatypes.Hardware, err error)

Retrieve a list of hardware associated with a SoftLayer customer account, placing all hardware with associated EVault storage accounts at the beginning of the list. The return type is SoftLayer_Hardware_Server[] contains the results; the number of items returned in the result will be returned in the soap header (totalItems). ”getHardwareWithEvaultFirst” is useful in situations where you wish to search for hardware and provide paginated output.

Results are only returned for hardware belonging to the account of the user making the API call.

This method drives the backup page of the SoftLayer customer portal. It serves a very specific function, but we have exposed it as it may prove useful for API developers too.

func (Network_Storage_Backup_Evault) GetHasEncryptionAtRest 

func (r Network_Storage_Backup_Evault) GetHasEncryptionAtRest() (resp bool, err error)

Retrieve

func (Network_Storage_Backup_Evault) GetHourlySchedule 

func (r Network_Storage_Backup_Evault) GetHourlySchedule() (resp datatypes.Network_Storage_Schedule, err error)

Retrieve The Hourly Schedule which is associated with this network storage volume.

func (Network_Storage_Backup_Evault) GetIntervalSchedule 

func (r Network_Storage_Backup_Evault) GetIntervalSchedule() (resp datatypes.Network_Storage_Schedule, err error)

Retrieve The Interval Schedule which is associated with this network storage volume.

func (Network_Storage_Backup_Evault) GetIops 

func (r Network_Storage_Backup_Evault) GetIops() (resp string, err error)

Retrieve The maximum number of IOPs selected for this volume.

func (Network_Storage_Backup_Evault) GetIsConvertToIndependentTransactionInProgress added in v1.0.6 

func (r Network_Storage_Backup_Evault) GetIsConvertToIndependentTransactionInProgress() (resp bool, err error)

Retrieve Determines whether network storage volume has an active convert dependent clone to Independent transaction.

func (Network_Storage_Backup_Evault) GetIsDependentDuplicateProvisionCompleted 

func (r Network_Storage_Backup_Evault) GetIsDependentDuplicateProvisionCompleted() (resp bool, err error)

Retrieve Determines whether dependent volume provision is completed on background.

func (Network_Storage_Backup_Evault) GetIsInDedicatedServiceResource added in v1.0.2 

func (r Network_Storage_Backup_Evault) GetIsInDedicatedServiceResource() (resp bool, err error)

Retrieve

func (Network_Storage_Backup_Evault) GetIsMagneticStorage added in v1.0.4 

func (r Network_Storage_Backup_Evault) GetIsMagneticStorage() (resp string, err error)

Retrieve

func (Network_Storage_Backup_Evault) GetIsProvisionInProgress added in v1.0.6 

func (r Network_Storage_Backup_Evault) GetIsProvisionInProgress() (resp bool, err error)

Retrieve Determines whether network storage volume has an active provision transaction.

func (Network_Storage_Backup_Evault) GetIsReadyForSnapshot 

func (r Network_Storage_Backup_Evault) GetIsReadyForSnapshot() (resp bool, err error)

Retrieve Determines whether a volume is ready to order snapshot space, or, if snapshot space is already available, to assign a snapshot schedule, or to take a manual snapshot.

func (Network_Storage_Backup_Evault) GetIsReadyToMount 

func (r Network_Storage_Backup_Evault) GetIsReadyToMount() (resp bool, err error)

Retrieve Determines whether a volume is ready to have Hosts authorized to access it. This does not indicate whether another operation may be blocking, please refer to this volume's volumeStatus property for details.

func (Network_Storage_Backup_Evault) GetIscsiLuns 

func (r Network_Storage_Backup_Evault) GetIscsiLuns() (resp []datatypes.Network_Storage, err error)

Retrieve Relationship between a container volume and iSCSI LUNs.

func (Network_Storage_Backup_Evault) GetIscsiReplicatingVolume added in v1.0.5 

func (r Network_Storage_Backup_Evault) GetIscsiReplicatingVolume() (resp datatypes.Network_Storage, err error)

Retrieve The network storage volumes configured to be replicants of this volume.

func (Network_Storage_Backup_Evault) GetIscsiTargetIpAddresses 

func (r Network_Storage_Backup_Evault) GetIscsiTargetIpAddresses() (resp []string, err error)

Retrieve Returns the target IP addresses of an iSCSI volume.

func (Network_Storage_Backup_Evault) GetLunId 

func (r Network_Storage_Backup_Evault) GetLunId() (resp string, err error)

Retrieve The ID of the LUN volume.

func (Network_Storage_Backup_Evault) GetManualSnapshots 

func (r Network_Storage_Backup_Evault) GetManualSnapshots() (resp []datatypes.Network_Storage, err error)

Retrieve The manually-created snapshots associated with this SoftLayer_Network_Storage volume. Does not support pagination by result limit and offset.

func (Network_Storage_Backup_Evault) GetMaximumExpansionSize 

func (r Network_Storage_Backup_Evault) GetMaximumExpansionSize() (resp int, err error)

no documentation yet

func (Network_Storage_Backup_Evault) GetMetricTrackingObject 

func (r Network_Storage_Backup_Evault) GetMetricTrackingObject() (resp datatypes.Metric_Tracking_Object, err error)

Retrieve [DEPRECATED] - A network storage volume's metric tracking object. This object records all periodic polled data available to this volume.

func (Network_Storage_Backup_Evault) GetMountPath added in v1.0.4 

func (r Network_Storage_Backup_Evault) GetMountPath() (resp string, err error)

Retrieve Retrieves the NFS Network Mount Path for a given File Storage Volume.

func (Network_Storage_Backup_Evault) GetMountableFlag 

func (r Network_Storage_Backup_Evault) GetMountableFlag() (resp string, err error)

Retrieve Whether or not a network storage volume may be mounted.

func (Network_Storage_Backup_Evault) GetMoveAndSplitStatus 

func (r Network_Storage_Backup_Evault) GetMoveAndSplitStatus() (resp string, err error)

Retrieve The current status of split or move operation as a part of volume duplication.

func (Network_Storage_Backup_Evault) GetNetworkConnectionDetails 

func (r Network_Storage_Backup_Evault) GetNetworkConnectionDetails() (resp datatypes.Container_Network_Storage_NetworkConnectionInformation, err error)

no documentation yet

func (Network_Storage_Backup_Evault) GetNetworkMountAddress 

func (r Network_Storage_Backup_Evault) GetNetworkMountAddress() (resp string, err error)

no documentation yet

func (Network_Storage_Backup_Evault) GetNetworkMountPath added in v1.0.4 

func (r Network_Storage_Backup_Evault) GetNetworkMountPath() (resp string, err error)

no documentation yet

func (Network_Storage_Backup_Evault) GetNotificationSubscribers 

func (r Network_Storage_Backup_Evault) GetNotificationSubscribers() (resp []datatypes.Notification_User_Subscriber, err error)

Retrieve The subscribers that will be notified for usage amount warnings and overages.

func (Network_Storage_Backup_Evault) GetObject 

func (r Network_Storage_Backup_Evault) GetObject() (resp datatypes.Network_Storage_Backup_Evault, err error)

getObject retrieves the SoftLayer_Network_Storage_Backup_Evault object whose ID corresponds to the ID number of the init parameter passed to the SoftLayer_Network_Storage_Backup_Evault service.

func (Network_Storage_Backup_Evault) GetObjectStorageConnectionInformation 

func (r Network_Storage_Backup_Evault) GetObjectStorageConnectionInformation() (resp []datatypes.Container_Network_Service_Resource_ObjectStorage_ConnectionInformation, err error)

no documentation yet

func (Network_Storage_Backup_Evault) GetObjectsByCredential 

func (r Network_Storage_Backup_Evault) GetObjectsByCredential(credentialObject *datatypes.Network_Storage_Credential) (resp []datatypes.Network_Storage, err error)

Retrieve network storage accounts by SoftLayer_Network_Storage_Credential object. Use this method if you wish to retrieve a storage record by a credential rather than by id.

func (Network_Storage_Backup_Evault) GetOriginalSnapshotName 

func (r Network_Storage_Backup_Evault) GetOriginalSnapshotName() (resp string, err error)

Retrieve The name of the snapshot that this volume was duplicated from.

func (Network_Storage_Backup_Evault) GetOriginalVolumeId added in v1.1.2 

func (r Network_Storage_Backup_Evault) GetOriginalVolumeId() (resp int, err error)

Retrieve Volume id of the origin volume from which this volume is been cloned.

func (Network_Storage_Backup_Evault) GetOriginalVolumeName 

func (r Network_Storage_Backup_Evault) GetOriginalVolumeName() (resp string, err error)

Retrieve The name of the volume that this volume was duplicated from.

func (Network_Storage_Backup_Evault) GetOriginalVolumeSize 

func (r Network_Storage_Backup_Evault) GetOriginalVolumeSize() (resp string, err error)

Retrieve The size (in GB) of the volume or LUN before any size expansion, or of the volume (before any possible size expansion) from which the duplicate volume or LUN was created.

func (Network_Storage_Backup_Evault) GetOsType 

func (r Network_Storage_Backup_Evault) GetOsType() (resp datatypes.Network_Storage_Iscsi_OS_Type, err error)

Retrieve A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type.

func (Network_Storage_Backup_Evault) GetOsTypeId 

func (r Network_Storage_Backup_Evault) GetOsTypeId() (resp string, err error)

Retrieve A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type ID.

func (Network_Storage_Backup_Evault) GetParentPartnerships 

func (r Network_Storage_Backup_Evault) GetParentPartnerships() (resp []datatypes.Network_Storage_Partnership, err error)

Retrieve The volumes or snapshots partnered with a network storage volume in a parental role.

func (Network_Storage_Backup_Evault) GetParentVolume 

func (r Network_Storage_Backup_Evault) GetParentVolume() (resp datatypes.Network_Storage, err error)

Retrieve The parent volume of a volume in a complex storage relationship.

func (Network_Storage_Backup_Evault) GetPartnerships 

func (r Network_Storage_Backup_Evault) GetPartnerships() (resp []datatypes.Network_Storage_Partnership, err error)

Retrieve The volumes or snapshots partnered with a network storage volume.

func (Network_Storage_Backup_Evault) GetPermissionsGroups 

func (r Network_Storage_Backup_Evault) GetPermissionsGroups() (resp []datatypes.Network_Storage_Group, err error)

Retrieve All permissions group(s) this volume is in.

func (Network_Storage_Backup_Evault) GetProperties 

func (r Network_Storage_Backup_Evault) GetProperties() (resp []datatypes.Network_Storage_Property, err error)

Retrieve The properties used to provide additional details about a network storage volume.

func (Network_Storage_Backup_Evault) GetProvisionedIops 

func (r Network_Storage_Backup_Evault) GetProvisionedIops() (resp string, err error)

Retrieve The number of IOPs provisioned for this volume.

func (Network_Storage_Backup_Evault) GetRecycleBinFileByIdentifier 

func (r Network_Storage_Backup_Evault) GetRecycleBinFileByIdentifier(fileId *string) (resp datatypes.Container_Utility_File_Entity, err error)

{{CloudLayerOnlyMethod}} Retrieve the details of a file that is pending deletion in a Storage account's a recycle bin.

func (Network_Storage_Backup_Evault) GetRemainingAllowedHosts 

func (r Network_Storage_Backup_Evault) GetRemainingAllowedHosts() (resp int, err error)

Retrieves the remaining number of allowed hosts per volume.

func (Network_Storage_Backup_Evault) GetRemainingAllowedHostsForReplicant 

func (r Network_Storage_Backup_Evault) GetRemainingAllowedHostsForReplicant() (resp int, err error)

Retrieves the remaining number of allowed hosts for a volume's replicant.

func (Network_Storage_Backup_Evault) GetReplicatingLuns 

func (r Network_Storage_Backup_Evault) GetReplicatingLuns() (resp []datatypes.Network_Storage, err error)

Retrieve The iSCSI LUN volumes being replicated by this network storage volume.

func (Network_Storage_Backup_Evault) GetReplicatingVolume 

func (r Network_Storage_Backup_Evault) GetReplicatingVolume() (resp datatypes.Network_Storage, err error)

Retrieve The network storage volume being replicated by a volume.

func (Network_Storage_Backup_Evault) GetReplicationEvents 

func (r Network_Storage_Backup_Evault) GetReplicationEvents() (resp []datatypes.Network_Storage_Event, err error)

Retrieve The volume replication events.

func (Network_Storage_Backup_Evault) GetReplicationPartners 

func (r Network_Storage_Backup_Evault) GetReplicationPartners() (resp []datatypes.Network_Storage, err error)

Retrieve The network storage volumes configured to be replicants of a volume.

func (Network_Storage_Backup_Evault) GetReplicationSchedule 

func (r Network_Storage_Backup_Evault) GetReplicationSchedule() (resp datatypes.Network_Storage_Schedule, err error)

Retrieve The Replication Schedule associated with a network storage volume.

func (Network_Storage_Backup_Evault) GetReplicationStatus 

func (r Network_Storage_Backup_Evault) GetReplicationStatus() (resp string, err error)

Retrieve The current replication status of a network storage volume. Indicates Failover or Failback status.

func (Network_Storage_Backup_Evault) GetReplicationTimestamp added in v1.0.4 

func (r Network_Storage_Backup_Evault) GetReplicationTimestamp() (resp string, err error)

no documentation yet

func (Network_Storage_Backup_Evault) GetSchedules 

func (r Network_Storage_Backup_Evault) GetSchedules() (resp []datatypes.Network_Storage_Schedule, err error)

Retrieve The schedules which are associated with a network storage volume.

func (Network_Storage_Backup_Evault) GetServiceResource 

func (r Network_Storage_Backup_Evault) GetServiceResource() (resp datatypes.Network_Service_Resource, err error)

Retrieve The network resource a Storage service is connected to.

func (Network_Storage_Backup_Evault) GetServiceResourceBackendIpAddress 

func (r Network_Storage_Backup_Evault) GetServiceResourceBackendIpAddress() (resp string, err error)

Retrieve The IP address of a Storage resource.

func (Network_Storage_Backup_Evault) GetServiceResourceName 

func (r Network_Storage_Backup_Evault) GetServiceResourceName() (resp string, err error)

Retrieve The name of a Storage's network resource.

func (Network_Storage_Backup_Evault) GetSnapshotCapacityGb 

func (r Network_Storage_Backup_Evault) GetSnapshotCapacityGb() (resp string, err error)

Retrieve A volume's configured snapshot space size.

func (Network_Storage_Backup_Evault) GetSnapshotCreationTimestamp 

func (r Network_Storage_Backup_Evault) GetSnapshotCreationTimestamp() (resp string, err error)

Retrieve The creation timestamp of the snapshot on the storage platform.

func (Network_Storage_Backup_Evault) GetSnapshotDeletionThresholdPercentage 

func (r Network_Storage_Backup_Evault) GetSnapshotDeletionThresholdPercentage() (resp string, err error)

Retrieve The percentage of used snapshot space after which to delete automated snapshots.

func (Network_Storage_Backup_Evault) GetSnapshotNotificationStatus added in v1.0.4 

func (r Network_Storage_Backup_Evault) GetSnapshotNotificationStatus() (resp string, err error)

Retrieve Whether or not a network storage volume may be mounted.

func (Network_Storage_Backup_Evault) GetSnapshotSizeBytes 

func (r Network_Storage_Backup_Evault) GetSnapshotSizeBytes() (resp string, err error)

Retrieve The snapshot size in bytes.

func (Network_Storage_Backup_Evault) GetSnapshotSpaceAvailable 

func (r Network_Storage_Backup_Evault) GetSnapshotSpaceAvailable() (resp string, err error)

Retrieve A volume's available snapshot reservation space.

func (Network_Storage_Backup_Evault) GetSnapshots 

func (r Network_Storage_Backup_Evault) GetSnapshots() (resp []datatypes.Network_Storage, err error)

Retrieve The snapshots associated with this SoftLayer_Network_Storage volume.

func (Network_Storage_Backup_Evault) GetSnapshotsForVolume 

func (r Network_Storage_Backup_Evault) GetSnapshotsForVolume() (resp []datatypes.Network_Storage, err error)

Retrieves a list of snapshots for this SoftLayer_Network_Storage volume. This method works with the result limits and offset to support pagination.

func (Network_Storage_Backup_Evault) GetStaasVersion 

func (r Network_Storage_Backup_Evault) GetStaasVersion() (resp string, err error)

Retrieve

func (Network_Storage_Backup_Evault) GetStorageGroups 

func (r Network_Storage_Backup_Evault) GetStorageGroups() (resp []datatypes.Network_Storage_Group, err error)

Retrieve The network storage groups this volume is attached to.

func (Network_Storage_Backup_Evault) GetStorageGroupsNetworkConnectionDetails 

func (r Network_Storage_Backup_Evault) GetStorageGroupsNetworkConnectionDetails() (resp []datatypes.Container_Network_Storage_NetworkConnectionInformation, err error)

no documentation yet

func (Network_Storage_Backup_Evault) GetStorageTierLevel 

func (r Network_Storage_Backup_Evault) GetStorageTierLevel() (resp string, err error)

Retrieve

func (Network_Storage_Backup_Evault) GetStorageType 

func (r Network_Storage_Backup_Evault) GetStorageType() (resp datatypes.Network_Storage_Type, err error)

Retrieve A description of the Storage object.

func (Network_Storage_Backup_Evault) GetTargetIpAddresses 

func (r Network_Storage_Backup_Evault) GetTargetIpAddresses() (resp []string, err error)

no documentation yet

func (Network_Storage_Backup_Evault) GetTotalBytesUsed 

func (r Network_Storage_Backup_Evault) GetTotalBytesUsed() (resp string, err error)

Retrieve The amount of space used by the volume.

func (Network_Storage_Backup_Evault) GetTotalScheduleSnapshotRetentionCount 

func (r Network_Storage_Backup_Evault) GetTotalScheduleSnapshotRetentionCount() (resp uint, err error)

Retrieve The total snapshot retention count of all schedules on this network storage volume.

func (Network_Storage_Backup_Evault) GetUsageNotification 

func (r Network_Storage_Backup_Evault) GetUsageNotification() (resp datatypes.Notification, err error)

Retrieve The usage notification for SL Storage services.

func (Network_Storage_Backup_Evault) GetValidReplicationTargetDatacenterLocations 

func (r Network_Storage_Backup_Evault) GetValidReplicationTargetDatacenterLocations() (resp []datatypes.Location, err error)

no documentation yet

func (Network_Storage_Backup_Evault) GetVendorName 

func (r Network_Storage_Backup_Evault) GetVendorName() (resp string, err error)

Retrieve The type of network storage service.

func (Network_Storage_Backup_Evault) GetVirtualGuest 

func (r Network_Storage_Backup_Evault) GetVirtualGuest() (resp datatypes.Virtual_Guest, err error)

Retrieve When applicable, the virtual guest associated with a Storage service.

func (Network_Storage_Backup_Evault) GetVolumeCountLimits added in v1.0.1 

func (r Network_Storage_Backup_Evault) GetVolumeCountLimits() (resp []datatypes.Container_Network_Storage_DataCenterLimits_VolumeCountLimitContainer, err error)

Retrieves an array of volume count limits per location and globally.

func (Network_Storage_Backup_Evault) GetVolumeDuplicateParameters 

func (r Network_Storage_Backup_Evault) GetVolumeDuplicateParameters() (resp datatypes.Container_Network_Storage_VolumeDuplicateParameters, err error)

This method returns the parameters for cloning a volume

func (Network_Storage_Backup_Evault) GetVolumeHistory 

func (r Network_Storage_Backup_Evault) GetVolumeHistory() (resp []datatypes.Network_Storage_History, err error)

Retrieve The username and password history for a Storage service.

func (Network_Storage_Backup_Evault) GetVolumeStatus 

func (r Network_Storage_Backup_Evault) GetVolumeStatus() (resp string, err error)

Retrieve The current status of a network storage volume.

func (Network_Storage_Backup_Evault) GetWebCCAuthenticationDetails 

func (r Network_Storage_Backup_Evault) GetWebCCAuthenticationDetails() (resp datatypes.Container_Network_Storage_Backup_Evault_WebCc_Authentication_Details, err error)

no documentation yet

func (Network_Storage_Backup_Evault) GetWebccAccount 

func (r Network_Storage_Backup_Evault) GetWebccAccount() (resp datatypes.Account_Password, err error)

Retrieve The account username and password for the EVault webCC interface.

func (Network_Storage_Backup_Evault) GetWeeklySchedule 

func (r Network_Storage_Backup_Evault) GetWeeklySchedule() (resp datatypes.Network_Storage_Schedule, err error)

Retrieve The Weekly Schedule which is associated with this network storage volume.

func (Network_Storage_Backup_Evault) Id 

func (r Network_Storage_Backup_Evault) Id(id int) Network_Storage_Backup_Evault

func (Network_Storage_Backup_Evault) ImmediateFailoverToReplicant 

func (r Network_Storage_Backup_Evault) ImmediateFailoverToReplicant(replicantId *int) (resp bool, err error)

Immediate Failover to a volume replicant. During the time which the replicant is in use the local nas volume will not be available.

func (Network_Storage_Backup_Evault) InitiateBareMetalRestore 

func (r Network_Storage_Backup_Evault) InitiateBareMetalRestore() (resp bool, err error)

Evault Bare Metal Restore is a special version of Rescue Kernel designed specifically for making full system restores made with Evault's BMR backup. This process works very similar to Rescue Kernel, except only the Evault restore program is available. The process takes approximately 10 minutes. Once completed you will be able to access your server to do a restore through VNC or your servers KVM-over-IP. IP information and credentials can be found on the hardware page of the customer portal. The Evault Application will be running automatically upon startup, and will walk you through the restore process.

func (Network_Storage_Backup_Evault) InitiateBareMetalRestoreForServer 

func (r Network_Storage_Backup_Evault) InitiateBareMetalRestoreForServer(hardwareId *int) (resp bool, err error)

This method operates the same as the initiateBareMetalRestore() method. However, using this method, the Bare Metal Restore can be initiated on any Windows server under the account.

func (Network_Storage_Backup_Evault) InitiateOriginVolumeReclaim added in v1.0.4 

func (r Network_Storage_Backup_Evault) InitiateOriginVolumeReclaim() (resp string, err error)

no documentation yet

func (Network_Storage_Backup_Evault) InitiateVolumeCutover added in v1.0.4 

func (r Network_Storage_Backup_Evault) InitiateVolumeCutover() (resp string, err error)

no documentation yet

func (Network_Storage_Backup_Evault) IsBlockingOperationInProgress 

func (r Network_Storage_Backup_Evault) IsBlockingOperationInProgress(exemptStatusKeyNames []string) (resp bool, err error)

no documentation yet

func (Network_Storage_Backup_Evault) IsDuplicateReadyForSnapshot 

func (r Network_Storage_Backup_Evault) IsDuplicateReadyForSnapshot() (resp bool, err error)

This method returns a boolean indicating whether the clone volume is ready for snapshot.

func (Network_Storage_Backup_Evault) IsDuplicateReadyToMount 

func (r Network_Storage_Backup_Evault) IsDuplicateReadyToMount() (resp bool, err error)

This method returns a boolean indicating whether the clone volume is ready to mount.

func (Network_Storage_Backup_Evault) IsVolumeActive 

func (r Network_Storage_Backup_Evault) IsVolumeActive() (resp bool, err error)

no documentation yet

func (Network_Storage_Backup_Evault) Limit 

func (r Network_Storage_Backup_Evault) Limit(limit int) Network_Storage_Backup_Evault

func (Network_Storage_Backup_Evault) Mask 

func (r Network_Storage_Backup_Evault) Mask(mask string) Network_Storage_Backup_Evault

func (Network_Storage_Backup_Evault) Offset 

func (r Network_Storage_Backup_Evault) Offset(offset int) Network_Storage_Backup_Evault

func (Network_Storage_Backup_Evault) RefreshDependentDuplicate added in v1.0.1 

func (r Network_Storage_Backup_Evault) RefreshDependentDuplicate(snapshotId *int) (resp bool, err error)

no documentation yet

func (Network_Storage_Backup_Evault) RefreshDuplicate added in v1.0.2 

func (r Network_Storage_Backup_Evault) RefreshDuplicate(snapshotId *int, forceRefresh *bool) (resp bool, err error)

no documentation yet

func (Network_Storage_Backup_Evault) RemoveAccessFromHardware 

func (r Network_Storage_Backup_Evault) RemoveAccessFromHardware(hardwareObjectTemplate *datatypes.Hardware) (resp bool, err error)

This method is used to modify the access control list for this Storage volume. The SoftLayer_Hardware objects which have been allowed access to this storage will be listed in the allowedHardware property of this storage volume.

func (Network_Storage_Backup_Evault) RemoveAccessFromHardwareList 

func (r Network_Storage_Backup_Evault) RemoveAccessFromHardwareList(hardwareObjectTemplates []datatypes.Hardware) (resp bool, err error)

This method is used to modify the access control list for this Storage volume. The SoftLayer_Hardware objects which have been allowed access to this storage will be listed in the allowedHardware property of this storage volume.

func (Network_Storage_Backup_Evault) RemoveAccessFromHost 

func (r Network_Storage_Backup_Evault) RemoveAccessFromHost(typeClassName *string, hostId *int) (resp datatypes.Network_Storage_Allowed_Host, err error)

This method is used to modify the access control list for this Storage volume. The [[SoftLayer_Hardware|SoftLayer_Virtual_Guest|SoftLayer_Network_Subnet|SoftLayer_Network_Subnet_IpAddress]] objects which have been allowed access to this storage will be listed in the [[allowedHardware|allowedVirtualGuests|allowedSubnets|allowedIpAddresses]] property of this storage volume.

func (Network_Storage_Backup_Evault) RemoveAccessFromHostList 

func (r Network_Storage_Backup_Evault) RemoveAccessFromHostList(hostObjectTemplates []datatypes.Container_Network_Storage_Host) (resp []datatypes.Network_Storage_Allowed_Host, err error)

This method is used to modify the access control list for this Storage volume. The [[SoftLayer_Hardware|SoftLayer_Virtual_Guest|SoftLayer_Network_Subnet|SoftLayer_Network_Subnet_IpAddress]] objects which have been allowed access to this storage will be listed in the [[allowedHardware|allowedVirtualGuests|allowedSubnets|allowedIpAddresses]] property of this storage volume.

func (Network_Storage_Backup_Evault) RemoveAccessFromIpAddress 

func (r Network_Storage_Backup_Evault) RemoveAccessFromIpAddress(ipAddressObjectTemplate *datatypes.Network_Subnet_IpAddress) (resp bool, err error)

This method is used to modify the access control list for this Storage volume. The SoftLayer_Network_Subnet_IpAddress objects which have been allowed access to this storage will be listed in the allowedIpAddresses property of this storage volume.

func (Network_Storage_Backup_Evault) RemoveAccessFromIpAddressList 

func (r Network_Storage_Backup_Evault) RemoveAccessFromIpAddressList(ipAddressObjectTemplates []datatypes.Network_Subnet_IpAddress) (resp bool, err error)

no documentation yet

func (Network_Storage_Backup_Evault) RemoveAccessFromSubnet 

func (r Network_Storage_Backup_Evault) RemoveAccessFromSubnet(subnetObjectTemplate *datatypes.Network_Subnet) (resp bool, err error)

no documentation yet

func (Network_Storage_Backup_Evault) RemoveAccessFromSubnetList 

func (r Network_Storage_Backup_Evault) RemoveAccessFromSubnetList(subnetObjectTemplates []datatypes.Network_Subnet) (resp bool, err error)

no documentation yet

func (Network_Storage_Backup_Evault) RemoveAccessFromVirtualGuest 

func (r Network_Storage_Backup_Evault) RemoveAccessFromVirtualGuest(virtualGuestObjectTemplate *datatypes.Virtual_Guest) (resp bool, err error)

This method is used to modify the access control list for this Storage volume. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage will be listed in the allowedVirtualGuests property of this storage volume.

func (Network_Storage_Backup_Evault) RemoveAccessFromVirtualGuestList 

func (r Network_Storage_Backup_Evault) RemoveAccessFromVirtualGuestList(virtualGuestObjectTemplates []datatypes.Virtual_Guest) (resp bool, err error)

This method is used to modify the access control list for this Storage volume. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage will be listed in the allowedVirtualGuests property of this storage volume.

func (Network_Storage_Backup_Evault) RemoveAccessToReplicantFromHardwareList 

func (r Network_Storage_Backup_Evault) RemoveAccessToReplicantFromHardwareList(hardwareObjectTemplates []datatypes.Hardware) (resp bool, err error)

This method is used to modify the access control list for this Storage volume's replica. The SoftLayer_Hardware objects which have been allowed access to this storage volume's replica will be listed in the allowedReplicationHardware property of this storage volume.

func (Network_Storage_Backup_Evault) RemoveAccessToReplicantFromIpAddressList 

func (r Network_Storage_Backup_Evault) RemoveAccessToReplicantFromIpAddressList(ipAddressObjectTemplates []datatypes.Network_Subnet_IpAddress) (resp bool, err error)

This method is used to modify the access control list for this Storage volume's replica. The SoftLayer_Network_Subnet_IpAddress objects which have been allowed access to this storage volume's replica will be listed in the allowedReplicationIpAddresses property of this storage volume.

func (Network_Storage_Backup_Evault) RemoveAccessToReplicantFromSubnet 

func (r Network_Storage_Backup_Evault) RemoveAccessToReplicantFromSubnet(subnetObjectTemplate *datatypes.Network_Subnet) (resp bool, err error)

no documentation yet

func (Network_Storage_Backup_Evault) RemoveAccessToReplicantFromSubnetList 

func (r Network_Storage_Backup_Evault) RemoveAccessToReplicantFromSubnetList(subnetObjectTemplates []datatypes.Network_Subnet) (resp bool, err error)

This method is used to modify the access control list for this Storage volume's replica. The SoftLayer_Network_Subnet objects which have been allowed access to this storage volume's replica will be listed in the allowedReplicationSubnets property of this storage volume.

func (Network_Storage_Backup_Evault) RemoveAccessToReplicantFromVirtualGuestList 

func (r Network_Storage_Backup_Evault) RemoveAccessToReplicantFromVirtualGuestList(virtualGuestObjectTemplates []datatypes.Virtual_Guest) (resp bool, err error)

This method is used to modify the access control list for this Storage volume's replica. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage volume's replica will be listed in the allowedReplicationVirtualGuests property of this storage volume.

func (Network_Storage_Backup_Evault) RemoveCredential 

func (r Network_Storage_Backup_Evault) RemoveCredential(username *string) (resp bool, err error)

This method will remove a credential from the current volume. The credential must have been created using the 'addNewCredential' method.

func (Network_Storage_Backup_Evault) RestoreFile 

func (r Network_Storage_Backup_Evault) RestoreFile(fileId *string) (resp datatypes.Container_Utility_File_Entity, err error)

{{CloudLayerOnlyMethod}} Restore an individual file so that it may be used as it was before it was deleted.

If a file is deleted from a Virtual Server Storage account, the file is placed into the account's recycle bin and not permanently deleted. Therefore, restoreFile can be used to place the file back into your Virtual Server account's root directory.

func (Network_Storage_Backup_Evault) RestoreFromSnapshot 

func (r Network_Storage_Backup_Evault) RestoreFromSnapshot(snapshotId *int) (resp bool, err error)

Restore the volume from a snapshot that was previously taken.

func (Network_Storage_Backup_Evault) SendPasswordReminderEmail 

func (r Network_Storage_Backup_Evault) SendPasswordReminderEmail(username *string) (resp bool, err error)

The method will retrieve the password for the StorageLayer or Virtual Server Storage Account and email the password. The Storage Account passwords will be emailed to the master user. For Virtual Server Storage, the password will be sent to the email address used as the username.

func (Network_Storage_Backup_Evault) SetMountable 

func (r Network_Storage_Backup_Evault) SetMountable(mountable *bool) (resp bool, err error)

Enable or disable the mounting of a Storage volume. When mounting is enabled the Storage volume will be mountable or available for use.

For Virtual Server volumes, disabling mounting will deny access to the Virtual Server Account, remove published material and deny all file interaction including uploads and downloads.

Enabling or disabling mounting for Storage volumes is not possible if mounting has been disabled by SoftLayer or a parent account.

func (Network_Storage_Backup_Evault) SetSnapshotAllocation 

func (r Network_Storage_Backup_Evault) SetSnapshotAllocation(capacityGb *int) (err error)

no documentation yet

func (Network_Storage_Backup_Evault) SetSnapshotNotification added in v1.0.4 

func (r Network_Storage_Backup_Evault) SetSnapshotNotification(notificationFlag *bool) (err error)

Function to enable/disable snapshot warning notification.

func (Network_Storage_Backup_Evault) UpgradeVolumeCapacity 

func (r Network_Storage_Backup_Evault) UpgradeVolumeCapacity(itemId *int) (resp bool, err error)

Upgrade the Storage volume to one of the upgradable packages (for example from 10 Gigs of EVault storage to 100 Gigs of EVault storage).

func (Network_Storage_Backup_Evault) UploadFile 

func (r Network_Storage_Backup_Evault) UploadFile(file *datatypes.Container_Utility_File_Entity) (resp datatypes.Container_Utility_File_Entity, err error)

{{CloudLayerOnlyMethod}} Upload a file to a Storage account's root directory. Once uploaded, this method returns new file entity identifier for the upload file.

The following properties are required in the ”file” parameter. *”'name”': The name of the file you wish to upload *”'content”': The raw contents of the file you wish to upload. *”'contentType”': The MIME-type of content that you wish to upload.

func (Network_Storage_Backup_Evault) ValidateHostsAccess added in v1.0.5 

func (r Network_Storage_Backup_Evault) ValidateHostsAccess(hostObjectTemplates []datatypes.Container_Network_Storage_Host) (resp []datatypes.Container_Network_Storage_HostsGatewayInformation, err error)

This method is used to validate if the hosts are behind gateway or not from [SoftLayer_Network_Subnet|SoftLayer_Network_Subnet_IpAddress] objects. This returns [SoftLayer_Container_Network_Storage_HostsGatewayInformation] object containing the host details along with a boolean attribute which indicates if it's behind the gateway or not.

type Network_Storage_DedicatedCluster added in v1.0.3 

type Network_Storage_DedicatedCluster struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetNetworkStorageDedicatedClusterService added in v1.0.3 

func GetNetworkStorageDedicatedClusterService(sess session.SLSession) Network_Storage_DedicatedCluster

GetNetworkStorageDedicatedClusterService returns an instance of the Network_Storage_DedicatedCluster SoftLayer service

func (Network_Storage_DedicatedCluster) Filter added in v1.0.3 

func (r Network_Storage_DedicatedCluster) Filter(filter string) Network_Storage_DedicatedCluster

func (Network_Storage_DedicatedCluster) GetAccount added in v1.0.3 

func (r Network_Storage_DedicatedCluster) GetAccount() (resp datatypes.Account, err error)

Retrieve

func (Network_Storage_DedicatedCluster) GetDedicatedClusterList added in v1.0.3 

func (r Network_Storage_DedicatedCluster) GetDedicatedClusterList() (resp []int, err error)

no documentation yet

func (Network_Storage_DedicatedCluster) GetObject added in v1.0.3 

func (r Network_Storage_DedicatedCluster) GetObject() (resp datatypes.Network_Storage_DedicatedCluster, err error)

no documentation yet

func (Network_Storage_DedicatedCluster) GetServiceResource added in v1.0.3 

func (r Network_Storage_DedicatedCluster) GetServiceResource() (resp datatypes.Network_Service_Resource, err error)

Retrieve

func (Network_Storage_DedicatedCluster) Id added in v1.0.3 

func (r Network_Storage_DedicatedCluster) Id(id int) Network_Storage_DedicatedCluster

func (Network_Storage_DedicatedCluster) Limit added in v1.0.3 

func (r Network_Storage_DedicatedCluster) Limit(limit int) Network_Storage_DedicatedCluster

func (Network_Storage_DedicatedCluster) Mask added in v1.0.3 

func (r Network_Storage_DedicatedCluster) Mask(mask string) Network_Storage_DedicatedCluster

func (Network_Storage_DedicatedCluster) Offset added in v1.0.3 

func (r Network_Storage_DedicatedCluster) Offset(offset int) Network_Storage_DedicatedCluster

type Network_Storage_Group 

type Network_Storage_Group struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetNetworkStorageGroupService 

func GetNetworkStorageGroupService(sess session.SLSession) Network_Storage_Group

GetNetworkStorageGroupService returns an instance of the Network_Storage_Group SoftLayer service

func (Network_Storage_Group) AddAllowedHost 

func (r Network_Storage_Group) AddAllowedHost(allowedHost *datatypes.Network_Storage_Allowed_Host) (resp bool, err error)

Use this method to attach a SoftLayer_Network_Storage_Allowed_Host object to this group. This will automatically enable access from this host to any SoftLayer_Network_Storage volumes currently attached to this group.

func (Network_Storage_Group) AttachToVolume 

func (r Network_Storage_Group) AttachToVolume(volume *datatypes.Network_Storage) (resp bool, err error)

Use this method to attach a SoftLayer_Network_Storage volume to this group. This will automatically enable access to this volume for any SoftLayer_Network_Storage_Allowed_Host objects currently attached to this group.

func (Network_Storage_Group) CreateObject 

func (r Network_Storage_Group) CreateObject(templateObject *datatypes.Network_Storage_Group) (resp bool, err error)

no documentation yet

func (Network_Storage_Group) DeleteObject 

func (r Network_Storage_Group) DeleteObject() (resp bool, err error)

no documentation yet

func (Network_Storage_Group) EditObject 

func (r Network_Storage_Group) EditObject(templateObject *datatypes.Network_Storage_Group) (resp bool, err error)

no documentation yet

func (Network_Storage_Group) Filter 

func (r Network_Storage_Group) Filter(filter string) Network_Storage_Group

func (Network_Storage_Group) GetAccount 

func (r Network_Storage_Group) GetAccount() (resp datatypes.Account, err error)

Retrieve The SoftLayer_Account which owns this group.

func (Network_Storage_Group) GetAllObjects 

func (r Network_Storage_Group) GetAllObjects() (resp []datatypes.Network_Storage_Group, err error)

Use this method to retrieve all network storage groups.

func (Network_Storage_Group) GetAllowedHosts 

func (r Network_Storage_Group) GetAllowedHosts() (resp []datatypes.Network_Storage_Allowed_Host, err error)

Retrieve The allowed hosts list for this group.

func (Network_Storage_Group) GetAttachedVolumes 

func (r Network_Storage_Group) GetAttachedVolumes() (resp []datatypes.Network_Storage, err error)

Retrieve The network storage volumes this group is attached to.

func (Network_Storage_Group) GetGroupType 

func (r Network_Storage_Group) GetGroupType() (resp datatypes.Network_Storage_Group_Type, err error)

Retrieve The type which defines this group.

func (Network_Storage_Group) GetNetworkConnectionDetails 

func (r Network_Storage_Group) GetNetworkConnectionDetails() (resp datatypes.Container_Network_Storage_NetworkConnectionInformation, err error)

Use this method to retrieve network connection information for SoftLayer_Network_Storage_Allowed_Host objects within this group.

func (Network_Storage_Group) GetObject 

func (r Network_Storage_Group) GetObject() (resp datatypes.Network_Storage_Group, err error)

no documentation yet

func (Network_Storage_Group) GetOsType 

func (r Network_Storage_Group) GetOsType() (resp datatypes.Network_Storage_Iscsi_OS_Type, err error)

Retrieve The OS Type this group is configured for.

func (Network_Storage_Group) GetServiceResource 

func (r Network_Storage_Group) GetServiceResource() (resp datatypes.Network_Service_Resource, err error)

Retrieve The network resource this group is created on.

func (Network_Storage_Group) Id 

func (r Network_Storage_Group) Id(id int) Network_Storage_Group

func (Network_Storage_Group) Limit 

func (r Network_Storage_Group) Limit(limit int) Network_Storage_Group

func (Network_Storage_Group) Mask 

func (r Network_Storage_Group) Mask(mask string) Network_Storage_Group

func (Network_Storage_Group) Offset 

func (r Network_Storage_Group) Offset(offset int) Network_Storage_Group

func (Network_Storage_Group) RemoveAllowedHost 

func (r Network_Storage_Group) RemoveAllowedHost(allowedHost *datatypes.Network_Storage_Allowed_Host) (resp bool, err error)

Use this method to remove a SoftLayer_Network_Storage_Allowed_Host object from this group. This will automatically disable access from this host to any SoftLayer_Network_Storage volumes currently attached to this group.

func (Network_Storage_Group) RemoveFromVolume 

func (r Network_Storage_Group) RemoveFromVolume(volume *datatypes.Network_Storage) (resp bool, err error)

Use this method to remove a SoftLayer_Network_Storage volume from this group. This will automatically disable access to this volume for any SoftLayer_Network_Storage_Allowed_Host objects currently attached to this group.

type Network_Storage_Group_Iscsi 

type Network_Storage_Group_Iscsi struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetNetworkStorageGroupIscsiService 

func GetNetworkStorageGroupIscsiService(sess session.SLSession) Network_Storage_Group_Iscsi

GetNetworkStorageGroupIscsiService returns an instance of the Network_Storage_Group_Iscsi SoftLayer service

func (Network_Storage_Group_Iscsi) AddAllowedHost 

func (r Network_Storage_Group_Iscsi) AddAllowedHost(allowedHost *datatypes.Network_Storage_Allowed_Host) (resp bool, err error)

Use this method to attach a SoftLayer_Network_Storage_Allowed_Host object to this group. This will automatically enable access from this host to any SoftLayer_Network_Storage volumes currently attached to this group.

func (Network_Storage_Group_Iscsi) AttachToVolume 

func (r Network_Storage_Group_Iscsi) AttachToVolume(volume *datatypes.Network_Storage) (resp bool, err error)

Use this method to attach a SoftLayer_Network_Storage volume to this group. This will automatically enable access to this volume for any SoftLayer_Network_Storage_Allowed_Host objects currently attached to this group.

func (Network_Storage_Group_Iscsi) CreateObject 

func (r Network_Storage_Group_Iscsi) CreateObject(templateObject *datatypes.Network_Storage_Group) (resp bool, err error)

no documentation yet

func (Network_Storage_Group_Iscsi) DeleteObject 

func (r Network_Storage_Group_Iscsi) DeleteObject() (resp bool, err error)

no documentation yet

func (Network_Storage_Group_Iscsi) EditObject 

func (r Network_Storage_Group_Iscsi) EditObject(templateObject *datatypes.Network_Storage_Group) (resp bool, err error)

no documentation yet

func (Network_Storage_Group_Iscsi) Filter 

func (r Network_Storage_Group_Iscsi) Filter(filter string) Network_Storage_Group_Iscsi

func (Network_Storage_Group_Iscsi) GetAccount 

func (r Network_Storage_Group_Iscsi) GetAccount() (resp datatypes.Account, err error)

Retrieve The SoftLayer_Account which owns this group.

func (Network_Storage_Group_Iscsi) GetAllObjects 

func (r Network_Storage_Group_Iscsi) GetAllObjects() (resp []datatypes.Network_Storage_Group, err error)

Use this method to retrieve all network storage groups.

func (Network_Storage_Group_Iscsi) GetAllowedHosts 

func (r Network_Storage_Group_Iscsi) GetAllowedHosts() (resp []datatypes.Network_Storage_Allowed_Host, err error)

Retrieve The allowed hosts list for this group.

func (Network_Storage_Group_Iscsi) GetAttachedVolumes 

func (r Network_Storage_Group_Iscsi) GetAttachedVolumes() (resp []datatypes.Network_Storage, err error)

Retrieve The network storage volumes this group is attached to.

func (Network_Storage_Group_Iscsi) GetGroupType 

func (r Network_Storage_Group_Iscsi) GetGroupType() (resp datatypes.Network_Storage_Group_Type, err error)

Retrieve The type which defines this group.

func (Network_Storage_Group_Iscsi) GetNetworkConnectionDetails 

func (r Network_Storage_Group_Iscsi) GetNetworkConnectionDetails() (resp datatypes.Container_Network_Storage_NetworkConnectionInformation, err error)

Use this method to retrieve network connection information for SoftLayer_Network_Storage_Allowed_Host objects within this group.

func (Network_Storage_Group_Iscsi) GetObject 

func (r Network_Storage_Group_Iscsi) GetObject() (resp datatypes.Network_Storage_Group_Iscsi, err error)

no documentation yet

func (Network_Storage_Group_Iscsi) GetOsType 

func (r Network_Storage_Group_Iscsi) GetOsType() (resp datatypes.Network_Storage_Iscsi_OS_Type, err error)

Retrieve The OS Type this group is configured for.

func (Network_Storage_Group_Iscsi) GetServiceResource 

func (r Network_Storage_Group_Iscsi) GetServiceResource() (resp datatypes.Network_Service_Resource, err error)

Retrieve The network resource this group is created on.

func (Network_Storage_Group_Iscsi) Id 

func (r Network_Storage_Group_Iscsi) Id(id int) Network_Storage_Group_Iscsi

func (Network_Storage_Group_Iscsi) Limit 

func (r Network_Storage_Group_Iscsi) Limit(limit int) Network_Storage_Group_Iscsi

func (Network_Storage_Group_Iscsi) Mask 

func (r Network_Storage_Group_Iscsi) Mask(mask string) Network_Storage_Group_Iscsi

func (Network_Storage_Group_Iscsi) Offset 

func (r Network_Storage_Group_Iscsi) Offset(offset int) Network_Storage_Group_Iscsi

func (Network_Storage_Group_Iscsi) RemoveAllowedHost 

func (r Network_Storage_Group_Iscsi) RemoveAllowedHost(allowedHost *datatypes.Network_Storage_Allowed_Host) (resp bool, err error)

Use this method to remove a SoftLayer_Network_Storage_Allowed_Host object from this group. This will automatically disable access from this host to any SoftLayer_Network_Storage volumes currently attached to this group.

func (Network_Storage_Group_Iscsi) RemoveFromVolume 

func (r Network_Storage_Group_Iscsi) RemoveFromVolume(volume *datatypes.Network_Storage) (resp bool, err error)

Use this method to remove a SoftLayer_Network_Storage volume from this group. This will automatically disable access to this volume for any SoftLayer_Network_Storage_Allowed_Host objects currently attached to this group.

type Network_Storage_Group_Nfs 

type Network_Storage_Group_Nfs struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetNetworkStorageGroupNfsService 

func GetNetworkStorageGroupNfsService(sess session.SLSession) Network_Storage_Group_Nfs

GetNetworkStorageGroupNfsService returns an instance of the Network_Storage_Group_Nfs SoftLayer service

func (Network_Storage_Group_Nfs) AddAllowedHost 

func (r Network_Storage_Group_Nfs) AddAllowedHost(allowedHost *datatypes.Network_Storage_Allowed_Host) (resp bool, err error)

Use this method to attach a SoftLayer_Network_Storage_Allowed_Host object to this group. This will automatically enable access from this host to any SoftLayer_Network_Storage volumes currently attached to this group.

func (Network_Storage_Group_Nfs) AttachToVolume 

func (r Network_Storage_Group_Nfs) AttachToVolume(volume *datatypes.Network_Storage) (resp bool, err error)

Use this method to attach a SoftLayer_Network_Storage volume to this group. This will automatically enable access to this volume for any SoftLayer_Network_Storage_Allowed_Host objects currently attached to this group.

func (Network_Storage_Group_Nfs) CreateObject 

func (r Network_Storage_Group_Nfs) CreateObject(templateObject *datatypes.Network_Storage_Group) (resp bool, err error)

no documentation yet

func (Network_Storage_Group_Nfs) DeleteObject 

func (r Network_Storage_Group_Nfs) DeleteObject() (resp bool, err error)

no documentation yet

func (Network_Storage_Group_Nfs) EditObject 

func (r Network_Storage_Group_Nfs) EditObject(templateObject *datatypes.Network_Storage_Group) (resp bool, err error)

no documentation yet

func (Network_Storage_Group_Nfs) Filter 

func (r Network_Storage_Group_Nfs) Filter(filter string) Network_Storage_Group_Nfs

func (Network_Storage_Group_Nfs) GetAccount 

func (r Network_Storage_Group_Nfs) GetAccount() (resp datatypes.Account, err error)

Retrieve The SoftLayer_Account which owns this group.

func (Network_Storage_Group_Nfs) GetAllObjects 

func (r Network_Storage_Group_Nfs) GetAllObjects() (resp []datatypes.Network_Storage_Group, err error)

Use this method to retrieve all network storage groups.

func (Network_Storage_Group_Nfs) GetAllowedHosts 

func (r Network_Storage_Group_Nfs) GetAllowedHosts() (resp []datatypes.Network_Storage_Allowed_Host, err error)

Retrieve The allowed hosts list for this group.

func (Network_Storage_Group_Nfs) GetAttachedVolumes 

func (r Network_Storage_Group_Nfs) GetAttachedVolumes() (resp []datatypes.Network_Storage, err error)

Retrieve The network storage volumes this group is attached to.

func (Network_Storage_Group_Nfs) GetGroupType 

func (r Network_Storage_Group_Nfs) GetGroupType() (resp datatypes.Network_Storage_Group_Type, err error)

Retrieve The type which defines this group.

func (Network_Storage_Group_Nfs) GetNetworkConnectionDetails 

func (r Network_Storage_Group_Nfs) GetNetworkConnectionDetails() (resp datatypes.Container_Network_Storage_NetworkConnectionInformation, err error)

Use this method to retrieve network connection information for SoftLayer_Network_Storage_Allowed_Host objects within this group.

func (Network_Storage_Group_Nfs) GetObject 

func (r Network_Storage_Group_Nfs) GetObject() (resp datatypes.Network_Storage_Group_Nfs, err error)

no documentation yet

func (Network_Storage_Group_Nfs) GetOsType 

func (r Network_Storage_Group_Nfs) GetOsType() (resp datatypes.Network_Storage_Iscsi_OS_Type, err error)

Retrieve The OS Type this group is configured for.

func (Network_Storage_Group_Nfs) GetServiceResource 

func (r Network_Storage_Group_Nfs) GetServiceResource() (resp datatypes.Network_Service_Resource, err error)

Retrieve The network resource this group is created on.

func (Network_Storage_Group_Nfs) Id 

func (r Network_Storage_Group_Nfs) Id(id int) Network_Storage_Group_Nfs

func (Network_Storage_Group_Nfs) Limit 

func (r Network_Storage_Group_Nfs) Limit(limit int) Network_Storage_Group_Nfs

func (Network_Storage_Group_Nfs) Mask 

func (r Network_Storage_Group_Nfs) Mask(mask string) Network_Storage_Group_Nfs

func (Network_Storage_Group_Nfs) Offset 

func (r Network_Storage_Group_Nfs) Offset(offset int) Network_Storage_Group_Nfs

func (Network_Storage_Group_Nfs) RemoveAllowedHost 

func (r Network_Storage_Group_Nfs) RemoveAllowedHost(allowedHost *datatypes.Network_Storage_Allowed_Host) (resp bool, err error)

Use this method to remove a SoftLayer_Network_Storage_Allowed_Host object from this group. This will automatically disable access from this host to any SoftLayer_Network_Storage volumes currently attached to this group.

func (Network_Storage_Group_Nfs) RemoveFromVolume 

func (r Network_Storage_Group_Nfs) RemoveFromVolume(volume *datatypes.Network_Storage) (resp bool, err error)

Use this method to remove a SoftLayer_Network_Storage volume from this group. This will automatically disable access to this volume for any SoftLayer_Network_Storage_Allowed_Host objects currently attached to this group.

type Network_Storage_Group_Type 

type Network_Storage_Group_Type struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetNetworkStorageGroupTypeService 

func GetNetworkStorageGroupTypeService(sess session.SLSession) Network_Storage_Group_Type

GetNetworkStorageGroupTypeService returns an instance of the Network_Storage_Group_Type SoftLayer service

func (Network_Storage_Group_Type) Filter 

func (r Network_Storage_Group_Type) Filter(filter string) Network_Storage_Group_Type

func (Network_Storage_Group_Type) GetAllObjects 

func (r Network_Storage_Group_Type) GetAllObjects() (resp []datatypes.Network_Storage_Group_Type, err error)

Use this method to retrieve all storage group types available.

func (Network_Storage_Group_Type) GetObject 

func (r Network_Storage_Group_Type) GetObject() (resp datatypes.Network_Storage_Group_Type, err error)

no documentation yet

func (Network_Storage_Group_Type) Id 

func (r Network_Storage_Group_Type) Id(id int) Network_Storage_Group_Type

func (Network_Storage_Group_Type) Limit 

func (r Network_Storage_Group_Type) Limit(limit int) Network_Storage_Group_Type

func (Network_Storage_Group_Type) Mask 

func (r Network_Storage_Group_Type) Mask(mask string) Network_Storage_Group_Type

func (Network_Storage_Group_Type) Offset 

func (r Network_Storage_Group_Type) Offset(offset int) Network_Storage_Group_Type

type Network_Storage_Hub_Cleversafe_Account 

type Network_Storage_Hub_Cleversafe_Account struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetNetworkStorageHubCleversafeAccountService 

func GetNetworkStorageHubCleversafeAccountService(sess session.SLSession) Network_Storage_Hub_Cleversafe_Account

GetNetworkStorageHubCleversafeAccountService returns an instance of the Network_Storage_Hub_Cleversafe_Account SoftLayer service

func (Network_Storage_Hub_Cleversafe_Account) CredentialCreate 

func (r Network_Storage_Hub_Cleversafe_Account) CredentialCreate() (resp []datatypes.Network_Storage_Credential, err error)

Create credentials for an IBM Cloud Object Storage Account

func (Network_Storage_Hub_Cleversafe_Account) CredentialDelete 

func (r Network_Storage_Hub_Cleversafe_Account) CredentialDelete(credential *datatypes.Network_Storage_Credential) (resp bool, err error)

Delete a credential

func (Network_Storage_Hub_Cleversafe_Account) Filter 

func (r Network_Storage_Hub_Cleversafe_Account) Filter(filter string) Network_Storage_Hub_Cleversafe_Account

func (Network_Storage_Hub_Cleversafe_Account) GetAccount 

func (r Network_Storage_Hub_Cleversafe_Account) GetAccount() (resp datatypes.Account, err error)

Retrieve SoftLayer account to which an IBM Cloud Object Storage account belongs to.

func (Network_Storage_Hub_Cleversafe_Account) GetAllObjects 

func (r Network_Storage_Hub_Cleversafe_Account) GetAllObjects() (resp []datatypes.Network_Storage_Hub_Cleversafe_Account, err error)

no documentation yet

func (Network_Storage_Hub_Cleversafe_Account) GetBillingItem 

func (r Network_Storage_Hub_Cleversafe_Account) GetBillingItem() (resp datatypes.Billing_Item, err error)

Retrieve An associated parent billing item which is active. Includes billing items which are scheduled to be cancelled in the future.

func (Network_Storage_Hub_Cleversafe_Account) GetBuckets 

func (r Network_Storage_Hub_Cleversafe_Account) GetBuckets() (resp []datatypes.Container_Network_Storage_Hub_ObjectStorage_Bucket, err error)

Get buckets

func (Network_Storage_Hub_Cleversafe_Account) GetCancelledBillingItem 

func (r Network_Storage_Hub_Cleversafe_Account) GetCancelledBillingItem() (resp datatypes.Billing_Item, err error)

Retrieve An associated parent billing item which has been cancelled.

func (Network_Storage_Hub_Cleversafe_Account) GetCapacityUsage 

func (r Network_Storage_Hub_Cleversafe_Account) GetCapacityUsage() (resp int, err error)

Returns the capacity usage for an IBM Cloud Object Storage account.

func (Network_Storage_Hub_Cleversafe_Account) GetCloudObjectStorageMetrics 

func (r Network_Storage_Hub_Cleversafe_Account) GetCloudObjectStorageMetrics(start *string, end *string, storageLocation *string, storageClass *string, metrics *string) (resp []string, err error)

Makes a request to Cloud Object Storage metricsAPI service and when successful, returns an associative array with two elements:

if 200:

[ <response Status Code String>, <JSON from metricsAPI as outlined below as String> ]

if not 200:

[ <response Status Code String>, <response body as String> ]

{ "start": "<timeInMilliseconds>", "errors": [], "end": "<timeInMilliseconds>", "resource_type": "account", "warnings": [], "resources": [{"metrics" : [{"name": "retrieval", "value": "<number>"}]}] }

Notes: 1) When no data is found for a particular triplet (resource_id, storage_location, storage_class) a JSON element is inserted to the warnings Array. 2) If all queried triplets find data, only the resources Array will be populated, errors and warnings will remain empty.

func (Network_Storage_Hub_Cleversafe_Account) GetCredentialLimit 

func (r Network_Storage_Hub_Cleversafe_Account) GetCredentialLimit() (resp int, err error)

Returns credential limits for this IBM Cloud Object Storage account.

func (Network_Storage_Hub_Cleversafe_Account) GetCredentials 

func (r Network_Storage_Hub_Cleversafe_Account) GetCredentials() (resp []datatypes.Network_Storage_Credential, err error)

Retrieve Credentials used for generating an AWS signature. Max of 2.

func (Network_Storage_Hub_Cleversafe_Account) GetEndpoints 

func (r Network_Storage_Hub_Cleversafe_Account) GetEndpoints(accountId *int) (resp []datatypes.Container_Network_Storage_Hub_ObjectStorage_Endpoint, err error)

Returns a collection of endpoint URLs available to this IBM Cloud Object Storage account.

func (Network_Storage_Hub_Cleversafe_Account) GetEndpointsWithRefetch 

func (r Network_Storage_Hub_Cleversafe_Account) GetEndpointsWithRefetch(accountId *int, refetch *bool) (resp []datatypes.Container_Network_Storage_Hub_ObjectStorage_Endpoint, err error)

Returns a collection of endpoint URLs available to this IBM Cloud Object Storage account.

func (Network_Storage_Hub_Cleversafe_Account) GetMetricTrackingObject 

func (r Network_Storage_Hub_Cleversafe_Account) GetMetricTrackingObject() (resp datatypes.Metric_Tracking_Object, err error)

Retrieve [DEPRECATED] - Provides an interface to various metrics relating to the usage of an IBM Cloud Object Storage account.

func (Network_Storage_Hub_Cleversafe_Account) GetObject 

func (r Network_Storage_Hub_Cleversafe_Account) GetObject() (resp datatypes.Network_Storage_Hub_Cleversafe_Account, err error)

no documentation yet

func (Network_Storage_Hub_Cleversafe_Account) GetUuid 

func (r Network_Storage_Hub_Cleversafe_Account) GetUuid() (resp string, err error)

Retrieve Unique identifier for an IBM Cloud Object Storage account.

func (Network_Storage_Hub_Cleversafe_Account) Id 

func (r Network_Storage_Hub_Cleversafe_Account) Id(id int) Network_Storage_Hub_Cleversafe_Account

func (Network_Storage_Hub_Cleversafe_Account) Limit 

func (r Network_Storage_Hub_Cleversafe_Account) Limit(limit int) Network_Storage_Hub_Cleversafe_Account

func (Network_Storage_Hub_Cleversafe_Account) Mask 

func (r Network_Storage_Hub_Cleversafe_Account) Mask(mask string) Network_Storage_Hub_Cleversafe_Account

func (Network_Storage_Hub_Cleversafe_Account) Offset 

func (r Network_Storage_Hub_Cleversafe_Account) Offset(offset int) Network_Storage_Hub_Cleversafe_Account

type Network_Storage_Hub_Swift_Metrics 

type Network_Storage_Hub_Swift_Metrics struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetNetworkStorageHubSwiftMetricsService 

func GetNetworkStorageHubSwiftMetricsService(sess session.SLSession) Network_Storage_Hub_Swift_Metrics

GetNetworkStorageHubSwiftMetricsService returns an instance of the Network_Storage_Hub_Swift_Metrics SoftLayer service

func (Network_Storage_Hub_Swift_Metrics) Filter 

func (r Network_Storage_Hub_Swift_Metrics) Filter(filter string) Network_Storage_Hub_Swift_Metrics

func (Network_Storage_Hub_Swift_Metrics) GetMetricData 

func (r Network_Storage_Hub_Swift_Metrics) GetMetricData(startDateTime *datatypes.Time, endDateTime *datatypes.Time, metricKey *string, location *string) (resp []datatypes.Metric_Tracking_Object_Data, err error)

no documentation yet

func (Network_Storage_Hub_Swift_Metrics) GetSummaryData 

func (r Network_Storage_Hub_Swift_Metrics) GetSummaryData(startDateTime *datatypes.Time, endDateTime *datatypes.Time, validTypes []datatypes.Container_Metric_Data_Type, summaryPeriod *int) (resp []datatypes.Metric_Tracking_Object_Data, err error)

no documentation yet

func (Network_Storage_Hub_Swift_Metrics) Id 

func (r Network_Storage_Hub_Swift_Metrics) Id(id int) Network_Storage_Hub_Swift_Metrics

func (Network_Storage_Hub_Swift_Metrics) Limit 

func (r Network_Storage_Hub_Swift_Metrics) Limit(limit int) Network_Storage_Hub_Swift_Metrics

func (Network_Storage_Hub_Swift_Metrics) Mask 

func (r Network_Storage_Hub_Swift_Metrics) Mask(mask string) Network_Storage_Hub_Swift_Metrics

func (Network_Storage_Hub_Swift_Metrics) Offset 

func (r Network_Storage_Hub_Swift_Metrics) Offset(offset int) Network_Storage_Hub_Swift_Metrics

type Network_Storage_Hub_Swift_Share 

type Network_Storage_Hub_Swift_Share struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetNetworkStorageHubSwiftShareService 

func GetNetworkStorageHubSwiftShareService(sess session.SLSession) Network_Storage_Hub_Swift_Share

GetNetworkStorageHubSwiftShareService returns an instance of the Network_Storage_Hub_Swift_Share SoftLayer service

func (Network_Storage_Hub_Swift_Share) Filter 

func (r Network_Storage_Hub_Swift_Share) Filter(filter string) Network_Storage_Hub_Swift_Share

func (Network_Storage_Hub_Swift_Share) GetContainerList 

func (r Network_Storage_Hub_Swift_Share) GetContainerList() (resp []datatypes.Container_Network_Storage_Hub_ObjectStorage_Folder, err error)

This method returns a collection of container objects.

func (Network_Storage_Hub_Swift_Share) GetFile 

func (r Network_Storage_Hub_Swift_Share) GetFile(fileName *string, container *string) (resp datatypes.Container_Network_Storage_Hub_ObjectStorage_File, err error)

This method returns a file object given the file's full name.

func (Network_Storage_Hub_Swift_Share) GetFileList 

func (r Network_Storage_Hub_Swift_Share) GetFileList(container *string, path *string) (resp []datatypes.Container_Utility_File_Entity, err error)

This method returns a collection of the file objects within a container and the given path.

func (Network_Storage_Hub_Swift_Share) Id 

func (r Network_Storage_Hub_Swift_Share) Id(id int) Network_Storage_Hub_Swift_Share

func (Network_Storage_Hub_Swift_Share) Limit 

func (r Network_Storage_Hub_Swift_Share) Limit(limit int) Network_Storage_Hub_Swift_Share

func (Network_Storage_Hub_Swift_Share) Mask 

func (r Network_Storage_Hub_Swift_Share) Mask(mask string) Network_Storage_Hub_Swift_Share

func (Network_Storage_Hub_Swift_Share) Offset 

func (r Network_Storage_Hub_Swift_Share) Offset(offset int) Network_Storage_Hub_Swift_Share

type Network_Storage_Iscsi 

type Network_Storage_Iscsi struct {
	Session session.SLSession
	Options sl.Options
}

The iscsi data type provides access to additional information about an iscsi volume such as the snapshot capacity limit and replication partners.

func GetNetworkStorageIscsiService 

func GetNetworkStorageIscsiService(sess session.SLSession) Network_Storage_Iscsi

GetNetworkStorageIscsiService returns an instance of the Network_Storage_Iscsi SoftLayer service

func (Network_Storage_Iscsi) AllowAccessFromHardware 

func (r Network_Storage_Iscsi) AllowAccessFromHardware(hardwareObjectTemplate *datatypes.Hardware) (resp bool, err error)

This method is used to modify the access control list for this Storage volume. The SoftLayer_Hardware objects which have been allowed access to this storage will be listed in the allowedHardware property of this storage volume.

func (Network_Storage_Iscsi) AllowAccessFromHardwareList 

func (r Network_Storage_Iscsi) AllowAccessFromHardwareList(hardwareObjectTemplates []datatypes.Hardware) (resp bool, err error)

no documentation yet

func (Network_Storage_Iscsi) AllowAccessFromHost 

func (r Network_Storage_Iscsi) AllowAccessFromHost(typeClassName *string, hostId *int) (resp datatypes.Network_Storage_Allowed_Host, err error)

This method is used to modify the access control list for this Storage volume. The [[SoftLayer_Hardware|SoftLayer_Virtual_Guest|SoftLayer_Network_Subnet|SoftLayer_Network_Subnet_IpAddress]] objects which have been allowed access to this storage will be listed in the [[allowedHardware|allowedVirtualGuests|allowedSubnets|allowedIpAddresses]] property of this storage volume.

func (Network_Storage_Iscsi) AllowAccessFromHostList 

func (r Network_Storage_Iscsi) AllowAccessFromHostList(hostObjectTemplates []datatypes.Container_Network_Storage_Host) (resp []datatypes.Network_Storage_Allowed_Host, err error)

This method is used to modify the access control list for this Storage volume. The [[SoftLayer_Hardware|SoftLayer_Virtual_Guest|SoftLayer_Network_Subnet|SoftLayer_Network_Subnet_IpAddress]] objects which have been allowed access to this storage volume will be listed in the [[allowedHardware|allowedVirtualGuests|allowedSubnets|allowedIpAddresses]] property of this storage volume.

func (Network_Storage_Iscsi) AllowAccessFromIpAddress 

func (r Network_Storage_Iscsi) AllowAccessFromIpAddress(ipAddressObjectTemplate *datatypes.Network_Subnet_IpAddress) (resp bool, err error)

no documentation yet

func (Network_Storage_Iscsi) AllowAccessFromIpAddressList 

func (r Network_Storage_Iscsi) AllowAccessFromIpAddressList(ipAddressObjectTemplates []datatypes.Network_Subnet_IpAddress) (resp bool, err error)

no documentation yet

func (Network_Storage_Iscsi) AllowAccessFromSubnet 

func (r Network_Storage_Iscsi) AllowAccessFromSubnet(subnetObjectTemplate *datatypes.Network_Subnet) (resp bool, err error)

This method is used to modify the access control list for this Storage volume. The SoftLayer_Network_Subnet objects which have been allowed access to this storage will be listed in the allowedHardware property of this storage volume.

func (Network_Storage_Iscsi) AllowAccessFromSubnetList 

func (r Network_Storage_Iscsi) AllowAccessFromSubnetList(subnetObjectTemplates []datatypes.Network_Subnet) (resp bool, err error)

no documentation yet

func (Network_Storage_Iscsi) AllowAccessFromVirtualGuest 

func (r Network_Storage_Iscsi) AllowAccessFromVirtualGuest(virtualGuestObjectTemplate *datatypes.Virtual_Guest) (resp bool, err error)

This method is used to modify the access control list for this Storage volume. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage will be listed in the allowedVirtualGuests property of this storage volume.

func (Network_Storage_Iscsi) AllowAccessFromVirtualGuestList 

func (r Network_Storage_Iscsi) AllowAccessFromVirtualGuestList(virtualGuestObjectTemplates []datatypes.Virtual_Guest) (resp bool, err error)

This method is used to modify the access control list for this Storage volume. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage will be listed in the allowedVirtualGuests property of this storage volume.

func (Network_Storage_Iscsi) AllowAccessToReplicantFromHardware 

func (r Network_Storage_Iscsi) AllowAccessToReplicantFromHardware(hardwareObjectTemplate *datatypes.Hardware) (resp bool, err error)

This method is used to modify the access control list for this Storage replicant volume. The SoftLayer_Hardware objects which have been allowed access to this storage will be listed in the allowedHardware property of this storage replicant volume.

func (Network_Storage_Iscsi) AllowAccessToReplicantFromHardwareList 

func (r Network_Storage_Iscsi) AllowAccessToReplicantFromHardwareList(hardwareObjectTemplates []datatypes.Hardware) (resp bool, err error)

This method is used to modify the access control list for this Storage replica volume. The SoftLayer_Hardware objects which have been allowed access to this storage will be listed in the allowedHardware property of this storage replica volume.

func (Network_Storage_Iscsi) AllowAccessToReplicantFromIpAddress 

func (r Network_Storage_Iscsi) AllowAccessToReplicantFromIpAddress(ipAddressObjectTemplate *datatypes.Network_Subnet_IpAddress) (resp bool, err error)

no documentation yet

func (Network_Storage_Iscsi) AllowAccessToReplicantFromIpAddressList 

func (r Network_Storage_Iscsi) AllowAccessToReplicantFromIpAddressList(ipAddressObjectTemplates []datatypes.Network_Subnet_IpAddress) (resp bool, err error)

This method is used to modify the access control list for this Storage volume. The SoftLayer_Network_Subnet_IpAddress objects which have been allowed access to this storage will be listed in the allowedVirtualGuests property of this storage volume.

func (Network_Storage_Iscsi) AllowAccessToReplicantFromSubnet 

func (r Network_Storage_Iscsi) AllowAccessToReplicantFromSubnet(subnetObjectTemplate *datatypes.Network_Subnet) (resp bool, err error)

This method is used to modify the access control list for this Storage replicant volume. The SoftLayer_Network_Subnet objects which have been allowed access to this storage will be listed in the allowedHardware property of this storage replicant volume.

func (Network_Storage_Iscsi) AllowAccessToReplicantFromSubnetList 

func (r Network_Storage_Iscsi) AllowAccessToReplicantFromSubnetList(subnetObjectTemplates []datatypes.Network_Subnet) (resp bool, err error)

This method is used to modify the access control list for this Storage volume's replica. The SoftLayer_Network_Subnet objects which have been allowed access to this storage volume's replica will be listed in the allowedReplicationSubnets property of this storage volume.

func (Network_Storage_Iscsi) AllowAccessToReplicantFromVirtualGuest 

func (r Network_Storage_Iscsi) AllowAccessToReplicantFromVirtualGuest(virtualGuestObjectTemplate *datatypes.Virtual_Guest) (resp bool, err error)

This method is used to modify the access control list for this Storage replicant volume. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage will be listed in the allowedVirtualGuests property of this storage replicant volume.

func (Network_Storage_Iscsi) AllowAccessToReplicantFromVirtualGuestList 

func (r Network_Storage_Iscsi) AllowAccessToReplicantFromVirtualGuestList(virtualGuestObjectTemplates []datatypes.Virtual_Guest) (resp bool, err error)

This method is used to modify the access control list for this Storage volume. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage will be listed in the allowedVirtualGuests property of this storage volume.

func (Network_Storage_Iscsi) AssignCredential 

func (r Network_Storage_Iscsi) AssignCredential(username *string) (resp bool, err error)

This method will assign an existing credential to the current volume. The credential must have been created using the 'addNewCredential' method. The volume type must support an additional credential.

func (Network_Storage_Iscsi) AssignNewCredential 

func (r Network_Storage_Iscsi) AssignNewCredential(typ *string) (resp datatypes.Network_Storage_Credential, err error)

This method will set up a new credential for the remote storage volume. The storage volume must support an additional credential. Once created, the credential will be automatically assigned to the current volume. If there are no volumes assigned to the credential it will be automatically deleted.

func (Network_Storage_Iscsi) ChangePassword 

func (r Network_Storage_Iscsi) ChangePassword(username *string, currentPassword *string, newPassword *string) (resp bool, err error)

The method will change the password for the given Storage/Virtual Server Storage account.

func (Network_Storage_Iscsi) CollectBandwidth 

func (r Network_Storage_Iscsi) CollectBandwidth(typ *string, startDate *datatypes.Time, endDate *datatypes.Time) (resp uint, err error)

{{CloudLayerOnlyMethod}}

collectBandwidth() Retrieve the bandwidth usage for the current billing cycle.

func (Network_Storage_Iscsi) CollectBytesUsed 

func (r Network_Storage_Iscsi) CollectBytesUsed() (resp uint, err error)

{{CloudLayerOnlyMethod}}

collectBytesUsed() retrieves the number of bytes capacity currently in use on a Storage account.

func (Network_Storage_Iscsi) ConvertCloneDependentToIndependent added in v1.0.1 

func (r Network_Storage_Iscsi) ConvertCloneDependentToIndependent() (resp bool, err error)

no documentation yet

func (Network_Storage_Iscsi) CreateFolder 

func (r Network_Storage_Iscsi) CreateFolder(folder *string) (resp bool, err error)

no documentation yet

func (Network_Storage_Iscsi) CreateOrUpdateLunId 

func (r Network_Storage_Iscsi) CreateOrUpdateLunId(lunId *int) (resp datatypes.Network_Storage_Property, err error)

The LUN ID only takes effect during the Host Authorization process. It is required to de-authorize all hosts before using this method.

func (Network_Storage_Iscsi) CreateSnapshot 

func (r Network_Storage_Iscsi) CreateSnapshot(notes *string) (resp datatypes.Network_Storage, err error)

no documentation yet

func (Network_Storage_Iscsi) DeleteAllFiles 

func (r Network_Storage_Iscsi) DeleteAllFiles() (resp bool, err error)

{{CloudLayerOnlyMethod}} Delete all files within a Storage account. Depending on the type of Storage account, Deleting either deletes files permanently or sends files to your account's recycle bin.

Currently, Virtual Server storage is the only type of Storage account that sends files to a recycle bin when deleted. When called against a Virtual Server storage account , this method also determines if the files are in the account's recycle bin. If the files exist in the recycle bin, then they are permanently deleted.

Please note, files can not be restored once they are permanently deleted.

func (Network_Storage_Iscsi) DeleteFile 

func (r Network_Storage_Iscsi) DeleteFile(fileId *string) (resp bool, err error)

{{CloudLayerOnlyMethod}} Delete an individual file within a Storage account. Depending on the type of Storage account, Deleting a file either deletes the file permanently or sends the file to your account's recycle bin.

Currently, Virtual Server storage is the only type of Storage account that sends files to a recycle bin when deleted. When called against a Virtual Server storage account , this method also determines if the file is in the account's recycle bin. If the file exist in the recycle bin, then it is permanently deleted.

Please note, a file can not be restored once it is permanently deleted.

func (Network_Storage_Iscsi) DeleteFiles 

func (r Network_Storage_Iscsi) DeleteFiles(fileIds []string) (resp bool, err error)

{{CloudLayerOnlyMethod}} Delete multiple files within a Storage account. Depending on the type of Storage account, Deleting either deletes files permanently or sends files to your account's recycle bin.

Currently, Virtual Server storage is the only type of Storage account that sends files to a recycle bin when deleted. When called against a Virtual Server storage account , this method also determines if the files are in the account's recycle bin. If the files exist in the recycle bin, then they are permanently deleted.

Please note, files can not be restored once they are permanently deleted.

func (Network_Storage_Iscsi) DeleteFolder 

func (r Network_Storage_Iscsi) DeleteFolder(folder *string) (resp bool, err error)

no documentation yet

func (Network_Storage_Iscsi) DeleteObject 

func (r Network_Storage_Iscsi) DeleteObject() (resp bool, err error)

Delete a network storage volume. ”'This cannot be undone.”' At this time only network storage snapshots may be deleted with this method.

”deleteObject” returns Boolean ”true” on successful deletion or ”false” if it was unable to remove a volume;

func (Network_Storage_Iscsi) DisableSnapshots 

func (r Network_Storage_Iscsi) DisableSnapshots(scheduleType *string) (resp bool, err error)

This method is not valid for Legacy iSCSI Storage Volumes.

Disable scheduled snapshots of this storage volume. Scheduling options include 'INTERVAL', HOURLY, DAILY and WEEKLY schedules.

func (Network_Storage_Iscsi) DisasterRecoveryFailoverToReplicant added in v1.0.3 

func (r Network_Storage_Iscsi) DisasterRecoveryFailoverToReplicant(replicantId *int) (resp bool, err error)

If a volume (with replication) becomes inaccessible due to a disaster event, this method can be used to immediately failover to an available replica in another location. This method does not allow for fail back via the API. To fail back to the original volume after using this method, open a support ticket. To test failover, use [[SoftLayer_Network_Storage::failoverToReplicant]] instead.

func (Network_Storage_Iscsi) DownloadFile 

func (r Network_Storage_Iscsi) DownloadFile(fileId *string) (resp datatypes.Container_Utility_File_Entity, err error)

{{CloudLayerOnlyMethod}} Download a file from a Storage account. This method returns a file's details including the file's raw content.

func (Network_Storage_Iscsi) EditCredential 

func (r Network_Storage_Iscsi) EditCredential(username *string, newPassword *string) (resp bool, err error)

This method will change the password of a credential created using the 'addNewCredential' method. If the credential exists on multiple storage volumes it will change for those volumes as well.

func (Network_Storage_Iscsi) EditObject 

func (r Network_Storage_Iscsi) EditObject(templateObject *datatypes.Network_Storage) (resp bool, err error)

The password and/or notes may be modified for the Storage service except evault passwords and notes.

func (Network_Storage_Iscsi) EnableSnapshots 

func (r Network_Storage_Iscsi) EnableSnapshots(scheduleType *string, retentionCount *int, minute *int, hour *int, dayOfWeek *string) (resp bool, err error)

This method is not valid for Legacy iSCSI Storage Volumes.

Enable scheduled snapshots of this storage volume. Scheduling options include HOURLY, DAILY and WEEKLY schedules. For HOURLY schedules, provide relevant data for $scheduleType, $retentionCount and $minute. For DAILY schedules, provide relevant data for $scheduleType, $retentionCount, $minute, and $hour. For WEEKLY schedules, provide relevant data for all parameters of this method.

func (Network_Storage_Iscsi) FailbackFromReplicant 

func (r Network_Storage_Iscsi) FailbackFromReplicant() (resp bool, err error)

Failback from a volume replicant. In order to failback the volume must have already been failed over to a replicant.

func (Network_Storage_Iscsi) FailoverToReplicant 

func (r Network_Storage_Iscsi) FailoverToReplicant(replicantId *int) (resp bool, err error)

Failover to a volume replicant. During the time which the replicant is in use the local nas volume will not be available.

func (Network_Storage_Iscsi) Filter 

func (r Network_Storage_Iscsi) Filter(filter string) Network_Storage_Iscsi

func (Network_Storage_Iscsi) GetAccount 

func (r Network_Storage_Iscsi) GetAccount() (resp datatypes.Account, err error)

Retrieve The account that a Storage services belongs to.

func (Network_Storage_Iscsi) GetAccountPassword 

func (r Network_Storage_Iscsi) GetAccountPassword() (resp datatypes.Account_Password, err error)

Retrieve Other usernames and passwords associated with a Storage volume.

func (Network_Storage_Iscsi) GetActiveTransactions 

func (r Network_Storage_Iscsi) GetActiveTransactions() (resp []datatypes.Provisioning_Version1_Transaction, err error)

Retrieve The currently active transactions on a network storage volume.

func (Network_Storage_Iscsi) GetAllFiles 

func (r Network_Storage_Iscsi) GetAllFiles() (resp []datatypes.Container_Utility_File_Entity, err error)

{{CloudLayerOnlyMethod}} Retrieve details such as id, name, size, create date for all files in a Storage account's root directory. This does not download file content.

func (Network_Storage_Iscsi) GetAllFilesByFilter 

func (r Network_Storage_Iscsi) GetAllFilesByFilter(filter *datatypes.Container_Utility_File_Entity) (resp []datatypes.Container_Utility_File_Entity, err error)

{{CloudLayerOnlyMethod}} Retrieve details such as id, name, size, create date for all files matching the filter's criteria in a Storage account's root directory. This does not download file content.

func (Network_Storage_Iscsi) GetAllowDisasterRecoveryFailback added in v1.0.4 

func (r Network_Storage_Iscsi) GetAllowDisasterRecoveryFailback() (resp string, err error)

Retrieve

func (Network_Storage_Iscsi) GetAllowDisasterRecoveryFailover added in v1.0.4 

func (r Network_Storage_Iscsi) GetAllowDisasterRecoveryFailover() (resp string, err error)

Retrieve

func (Network_Storage_Iscsi) GetAllowableHardware 

func (r Network_Storage_Iscsi) GetAllowableHardware(filterHostname *string) (resp []datatypes.Hardware, err error)

This method retrieves a list of SoftLayer_Hardware that can be authorized to this SoftLayer_Network_Storage.

func (Network_Storage_Iscsi) GetAllowableIpAddresses 

func (r Network_Storage_Iscsi) GetAllowableIpAddresses(subnetId *int, filterIpAddress *string) (resp []datatypes.Network_Subnet_IpAddress, err error)

This method retrieves a list of SoftLayer_Network_Subnet_IpAddress that can be authorized to this SoftLayer_Network_Storage.

func (Network_Storage_Iscsi) GetAllowableSubnets 

func (r Network_Storage_Iscsi) GetAllowableSubnets(filterNetworkIdentifier *string) (resp []datatypes.Network_Subnet, err error)

This method retrieves a list of SoftLayer_Network_Subnet that can be authorized to this SoftLayer_Network_Storage.

func (Network_Storage_Iscsi) GetAllowableVirtualGuests 

func (r Network_Storage_Iscsi) GetAllowableVirtualGuests(filterHostname *string) (resp []datatypes.Virtual_Guest, err error)

This method retrieves a list of SoftLayer_Virtual_Guest that can be authorized to this SoftLayer_Network_Storage.

func (Network_Storage_Iscsi) GetAllowedHardware 

func (r Network_Storage_Iscsi) GetAllowedHardware() (resp []datatypes.Hardware, err error)

Retrieve The SoftLayer_Hardware objects which are allowed access to this storage volume.

func (Network_Storage_Iscsi) GetAllowedHostsLimit 

func (r Network_Storage_Iscsi) GetAllowedHostsLimit() (resp int, err error)

Retrieves the total number of allowed hosts limit per volume.

func (Network_Storage_Iscsi) GetAllowedIpAddresses 

func (r Network_Storage_Iscsi) GetAllowedIpAddresses() (resp []datatypes.Network_Subnet_IpAddress, err error)

Retrieve The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume.

func (Network_Storage_Iscsi) GetAllowedReplicationHardware 

func (r Network_Storage_Iscsi) GetAllowedReplicationHardware() (resp []datatypes.Hardware, err error)

Retrieve The SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant.

func (Network_Storage_Iscsi) GetAllowedReplicationIpAddresses 

func (r Network_Storage_Iscsi) GetAllowedReplicationIpAddresses() (resp []datatypes.Network_Subnet_IpAddress, err error)

Retrieve The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume's Replicant.

func (Network_Storage_Iscsi) GetAllowedReplicationSubnets 

func (r Network_Storage_Iscsi) GetAllowedReplicationSubnets() (resp []datatypes.Network_Subnet, err error)

Retrieve The SoftLayer_Network_Subnet objects which are allowed access to this storage volume's Replicant.

func (Network_Storage_Iscsi) GetAllowedReplicationVirtualGuests 

func (r Network_Storage_Iscsi) GetAllowedReplicationVirtualGuests() (resp []datatypes.Virtual_Guest, err error)

Retrieve The SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant.

func (Network_Storage_Iscsi) GetAllowedSubnets 

func (r Network_Storage_Iscsi) GetAllowedSubnets() (resp []datatypes.Network_Subnet, err error)

Retrieve The SoftLayer_Network_Subnet objects which are allowed access to this storage volume.

func (Network_Storage_Iscsi) GetAllowedVirtualGuests 

func (r Network_Storage_Iscsi) GetAllowedVirtualGuests() (resp []datatypes.Virtual_Guest, err error)

Retrieve The SoftLayer_Virtual_Guest objects which are allowed access to this storage volume.

func (Network_Storage_Iscsi) GetBillingItem 

func (r Network_Storage_Iscsi) GetBillingItem() (resp datatypes.Billing_Item, err error)

Retrieve The current billing item for a Storage volume.

func (Network_Storage_Iscsi) GetBillingItemCategory 

func (r Network_Storage_Iscsi) GetBillingItemCategory() (resp datatypes.Product_Item_Category, err error)

Retrieve

func (Network_Storage_Iscsi) GetByUsername 

func (r Network_Storage_Iscsi) GetByUsername(username *string, typ *string) (resp []datatypes.Network_Storage, err error)

Retrieve network storage accounts by username and storage account type. Use this method if you wish to retrieve a storage record by username rather than by id. The ”type” parameter must correspond to one of the available ”nasType” values in the SoftLayer_Network_Storage data type.

func (Network_Storage_Iscsi) GetBytesUsed 

func (r Network_Storage_Iscsi) GetBytesUsed() (resp string, err error)

Retrieve The amount of space used by the volume, in bytes.

func (Network_Storage_Iscsi) GetCdnUrls 

func (r Network_Storage_Iscsi) GetCdnUrls() (resp []datatypes.Container_Network_Storage_Hub_ObjectStorage_ContentDeliveryUrl, err error)

no documentation yet

func (Network_Storage_Iscsi) GetClusterResource 

func (r Network_Storage_Iscsi) GetClusterResource() (resp datatypes.Network_Service_Resource, err error)

no documentation yet

func (Network_Storage_Iscsi) GetCreationScheduleId 

func (r Network_Storage_Iscsi) GetCreationScheduleId() (resp string, err error)

Retrieve The schedule id which was executed to create a snapshot.

func (Network_Storage_Iscsi) GetCredentials 

func (r Network_Storage_Iscsi) GetCredentials() (resp []datatypes.Network_Storage_Credential, err error)

Retrieve

func (Network_Storage_Iscsi) GetDailySchedule 

func (r Network_Storage_Iscsi) GetDailySchedule() (resp datatypes.Network_Storage_Schedule, err error)

Retrieve The Daily Schedule which is associated with this network storage volume.

func (Network_Storage_Iscsi) GetDependentDuplicate 

func (r Network_Storage_Iscsi) GetDependentDuplicate() (resp string, err error)

Retrieve Whether or not a network storage volume is a dependent duplicate.

func (Network_Storage_Iscsi) GetDependentDuplicates added in v1.0.1 

func (r Network_Storage_Iscsi) GetDependentDuplicates() (resp []datatypes.Network_Storage, err error)

Retrieve The network storage volumes configured to be dependent duplicates of a volume.

func (Network_Storage_Iscsi) GetDuplicateConversionStatus added in v1.0.6 

func (r Network_Storage_Iscsi) GetDuplicateConversionStatus() (resp datatypes.Container_Network_Storage_DuplicateConversionStatusInformation, err error)

This method is used to check, if for the given classic file block storage volume, a transaction performing dependent to independent duplicate conversion is active. If yes, then this returns the current percentage of its progress along with its start time as [SoftLayer_Container_Network_Storage_DuplicateConversionStatusInformation] object with its name, percentage and transaction start timestamp.

func (Network_Storage_Iscsi) GetEvents 

func (r Network_Storage_Iscsi) GetEvents() (resp []datatypes.Network_Storage_Event, err error)

Retrieve The events which have taken place on a network storage volume.

func (Network_Storage_Iscsi) GetFailbackNotAllowed added in v1.0.3 

func (r Network_Storage_Iscsi) GetFailbackNotAllowed() (resp string, err error)

Retrieve Determines whether the volume is allowed to failback

func (Network_Storage_Iscsi) GetFailoverNotAllowed added in v1.0.4 

func (r Network_Storage_Iscsi) GetFailoverNotAllowed() (resp string, err error)

Retrieve Determines whether the volume is allowed to failover

func (Network_Storage_Iscsi) GetFileBlockEncryptedLocations 

func (r Network_Storage_Iscsi) GetFileBlockEncryptedLocations() (resp []datatypes.Location, err error)

func (Network_Storage_Iscsi) GetFileByIdentifier 

func (r Network_Storage_Iscsi) GetFileByIdentifier(identifier *string) (resp datatypes.Container_Utility_File_Entity, err error)

{{CloudLayerOnlyMethod}} Retrieve details such as id, name, size, create date of a file within a Storage account. This does not download file content.

func (Network_Storage_Iscsi) GetFileCount 

func (r Network_Storage_Iscsi) GetFileCount() (resp int, err error)

{{CloudLayerOnlyMethod}} Retrieve the file number of files in a Virtual Server Storage account's root directory. This does not include the files stored in the recycle bin.

func (Network_Storage_Iscsi) GetFileList 

func (r Network_Storage_Iscsi) GetFileList(folder *string, path *string) (resp []datatypes.Container_Utility_File_Entity, err error)

no documentation yet

func (Network_Storage_Iscsi) GetFileNetworkMountAddress 

func (r Network_Storage_Iscsi) GetFileNetworkMountAddress() (resp string, err error)

Retrieve Retrieves the NFS Network Mount Address Name for a given File Storage Volume.

func (Network_Storage_Iscsi) GetFilePendingDeleteCount 

func (r Network_Storage_Iscsi) GetFilePendingDeleteCount() (resp int, err error)

{{CloudLayerOnlyMethod}} Retrieve the number of files pending deletion in a Storage account's recycle bin. Files in an account's recycle bin may either be restored to the account's root directory or permanently deleted.

func (Network_Storage_Iscsi) GetFilesPendingDelete 

func (r Network_Storage_Iscsi) GetFilesPendingDelete() (resp []datatypes.Container_Utility_File_Entity, err error)

{{CloudLayerOnlyMethod}} Retrieve a list of files that are pending deletion in a Storage account's recycle bin. Files in an account's recycle bin may either be restored to the account's root directory or permanently deleted. This method does not download file content.

func (Network_Storage_Iscsi) GetFixReplicationCurrentStatus added in v1.0.5 

func (r Network_Storage_Iscsi) GetFixReplicationCurrentStatus() (resp string, err error)

Retrieve

func (Network_Storage_Iscsi) GetFolderList 

func (r Network_Storage_Iscsi) GetFolderList() (resp []datatypes.Container_Network_Storage_Hub_ObjectStorage_Folder, err error)

no documentation yet

func (Network_Storage_Iscsi) GetHardware 

func (r Network_Storage_Iscsi) GetHardware() (resp datatypes.Hardware, err error)

Retrieve When applicable, the hardware associated with a Storage service.

func (Network_Storage_Iscsi) GetHasEncryptionAtRest 

func (r Network_Storage_Iscsi) GetHasEncryptionAtRest() (resp bool, err error)

Retrieve

func (Network_Storage_Iscsi) GetHourlySchedule 

func (r Network_Storage_Iscsi) GetHourlySchedule() (resp datatypes.Network_Storage_Schedule, err error)

Retrieve The Hourly Schedule which is associated with this network storage volume.

func (Network_Storage_Iscsi) GetIntervalSchedule 

func (r Network_Storage_Iscsi) GetIntervalSchedule() (resp datatypes.Network_Storage_Schedule, err error)

Retrieve The Interval Schedule which is associated with this network storage volume.

func (Network_Storage_Iscsi) GetIops 

func (r Network_Storage_Iscsi) GetIops() (resp string, err error)

Retrieve The maximum number of IOPs selected for this volume.

func (Network_Storage_Iscsi) GetIsConvertToIndependentTransactionInProgress added in v1.0.6 

func (r Network_Storage_Iscsi) GetIsConvertToIndependentTransactionInProgress() (resp bool, err error)

Retrieve Determines whether network storage volume has an active convert dependent clone to Independent transaction.

func (Network_Storage_Iscsi) GetIsDependentDuplicateProvisionCompleted 

func (r Network_Storage_Iscsi) GetIsDependentDuplicateProvisionCompleted() (resp bool, err error)

Retrieve Determines whether dependent volume provision is completed on background.

func (Network_Storage_Iscsi) GetIsInDedicatedServiceResource added in v1.0.2 

func (r Network_Storage_Iscsi) GetIsInDedicatedServiceResource() (resp bool, err error)

Retrieve

func (Network_Storage_Iscsi) GetIsMagneticStorage added in v1.0.4 

func (r Network_Storage_Iscsi) GetIsMagneticStorage() (resp string, err error)

Retrieve

func (Network_Storage_Iscsi) GetIsProvisionInProgress added in v1.0.6 

func (r Network_Storage_Iscsi) GetIsProvisionInProgress() (resp bool, err error)

Retrieve Determines whether network storage volume has an active provision transaction.

func (Network_Storage_Iscsi) GetIsReadyForSnapshot 

func (r Network_Storage_Iscsi) GetIsReadyForSnapshot() (resp bool, err error)

Retrieve Determines whether a volume is ready to order snapshot space, or, if snapshot space is already available, to assign a snapshot schedule, or to take a manual snapshot.

func (Network_Storage_Iscsi) GetIsReadyToMount 

func (r Network_Storage_Iscsi) GetIsReadyToMount() (resp bool, err error)

Retrieve Determines whether a volume is ready to have Hosts authorized to access it. This does not indicate whether another operation may be blocking, please refer to this volume's volumeStatus property for details.

func (Network_Storage_Iscsi) GetIscsiLuns 

func (r Network_Storage_Iscsi) GetIscsiLuns() (resp []datatypes.Network_Storage, err error)

Retrieve Relationship between a container volume and iSCSI LUNs.

func (Network_Storage_Iscsi) GetIscsiReplicatingVolume added in v1.0.5 

func (r Network_Storage_Iscsi) GetIscsiReplicatingVolume() (resp datatypes.Network_Storage, err error)

Retrieve The network storage volumes configured to be replicants of this volume.

func (Network_Storage_Iscsi) GetIscsiTargetIpAddresses 

func (r Network_Storage_Iscsi) GetIscsiTargetIpAddresses() (resp []string, err error)

Retrieve Returns the target IP addresses of an iSCSI volume.

func (Network_Storage_Iscsi) GetLunId 

func (r Network_Storage_Iscsi) GetLunId() (resp string, err error)

Retrieve The ID of the LUN volume.

func (Network_Storage_Iscsi) GetManualSnapshots 

func (r Network_Storage_Iscsi) GetManualSnapshots() (resp []datatypes.Network_Storage, err error)

Retrieve The manually-created snapshots associated with this SoftLayer_Network_Storage volume. Does not support pagination by result limit and offset.

func (Network_Storage_Iscsi) GetMaximumExpansionSize 

func (r Network_Storage_Iscsi) GetMaximumExpansionSize() (resp int, err error)

no documentation yet

func (Network_Storage_Iscsi) GetMetricTrackingObject 

func (r Network_Storage_Iscsi) GetMetricTrackingObject() (resp datatypes.Metric_Tracking_Object, err error)

Retrieve [DEPRECATED] - A network storage volume's metric tracking object. This object records all periodic polled data available to this volume.

func (Network_Storage_Iscsi) GetMountPath added in v1.0.4 

func (r Network_Storage_Iscsi) GetMountPath() (resp string, err error)

Retrieve Retrieves the NFS Network Mount Path for a given File Storage Volume.

func (Network_Storage_Iscsi) GetMountableFlag 

func (r Network_Storage_Iscsi) GetMountableFlag() (resp string, err error)

Retrieve Whether or not a network storage volume may be mounted.

func (Network_Storage_Iscsi) GetMoveAndSplitStatus 

func (r Network_Storage_Iscsi) GetMoveAndSplitStatus() (resp string, err error)

Retrieve The current status of split or move operation as a part of volume duplication.

func (Network_Storage_Iscsi) GetNetworkConnectionDetails 

func (r Network_Storage_Iscsi) GetNetworkConnectionDetails() (resp datatypes.Container_Network_Storage_NetworkConnectionInformation, err error)

no documentation yet

func (Network_Storage_Iscsi) GetNetworkMountAddress 

func (r Network_Storage_Iscsi) GetNetworkMountAddress() (resp string, err error)

no documentation yet

func (Network_Storage_Iscsi) GetNetworkMountPath added in v1.0.4 

func (r Network_Storage_Iscsi) GetNetworkMountPath() (resp string, err error)

no documentation yet

func (Network_Storage_Iscsi) GetNotificationSubscribers 

func (r Network_Storage_Iscsi) GetNotificationSubscribers() (resp []datatypes.Notification_User_Subscriber, err error)

Retrieve The subscribers that will be notified for usage amount warnings and overages.

func (Network_Storage_Iscsi) GetObject 

func (r Network_Storage_Iscsi) GetObject() (resp datatypes.Network_Storage_Iscsi, err error)

no documentation yet

func (Network_Storage_Iscsi) GetObjectStorageConnectionInformation 

func (r Network_Storage_Iscsi) GetObjectStorageConnectionInformation() (resp []datatypes.Container_Network_Service_Resource_ObjectStorage_ConnectionInformation, err error)

no documentation yet

func (Network_Storage_Iscsi) GetObjectsByCredential 

func (r Network_Storage_Iscsi) GetObjectsByCredential(credentialObject *datatypes.Network_Storage_Credential) (resp []datatypes.Network_Storage, err error)

Retrieve network storage accounts by SoftLayer_Network_Storage_Credential object. Use this method if you wish to retrieve a storage record by a credential rather than by id.

func (Network_Storage_Iscsi) GetOriginalSnapshotName 

func (r Network_Storage_Iscsi) GetOriginalSnapshotName() (resp string, err error)

Retrieve The name of the snapshot that this volume was duplicated from.

func (Network_Storage_Iscsi) GetOriginalVolumeId added in v1.1.2 

func (r Network_Storage_Iscsi) GetOriginalVolumeId() (resp int, err error)

Retrieve Volume id of the origin volume from which this volume is been cloned.

func (Network_Storage_Iscsi) GetOriginalVolumeName 

func (r Network_Storage_Iscsi) GetOriginalVolumeName() (resp string, err error)

Retrieve The name of the volume that this volume was duplicated from.

func (Network_Storage_Iscsi) GetOriginalVolumeSize 

func (r Network_Storage_Iscsi) GetOriginalVolumeSize() (resp string, err error)

Retrieve The size (in GB) of the volume or LUN before any size expansion, or of the volume (before any possible size expansion) from which the duplicate volume or LUN was created.

func (Network_Storage_Iscsi) GetOsType 

func (r Network_Storage_Iscsi) GetOsType() (resp datatypes.Network_Storage_Iscsi_OS_Type, err error)

Retrieve A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type.

func (Network_Storage_Iscsi) GetOsTypeId 

func (r Network_Storage_Iscsi) GetOsTypeId() (resp string, err error)

Retrieve A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type ID.

func (Network_Storage_Iscsi) GetParentPartnerships 

func (r Network_Storage_Iscsi) GetParentPartnerships() (resp []datatypes.Network_Storage_Partnership, err error)

Retrieve The volumes or snapshots partnered with a network storage volume in a parental role.

func (Network_Storage_Iscsi) GetParentVolume 

func (r Network_Storage_Iscsi) GetParentVolume() (resp datatypes.Network_Storage, err error)

Retrieve The parent volume of a volume in a complex storage relationship.

func (Network_Storage_Iscsi) GetPartnerships 

func (r Network_Storage_Iscsi) GetPartnerships() (resp []datatypes.Network_Storage_Partnership, err error)

Retrieve The volumes or snapshots partnered with a network storage volume.

func (Network_Storage_Iscsi) GetPermissionsGroups 

func (r Network_Storage_Iscsi) GetPermissionsGroups() (resp []datatypes.Network_Storage_Group, err error)

Retrieve All permissions group(s) this volume is in.

func (Network_Storage_Iscsi) GetProperties 

func (r Network_Storage_Iscsi) GetProperties() (resp []datatypes.Network_Storage_Property, err error)

Retrieve The properties used to provide additional details about a network storage volume.

func (Network_Storage_Iscsi) GetProvisionedIops 

func (r Network_Storage_Iscsi) GetProvisionedIops() (resp string, err error)

Retrieve The number of IOPs provisioned for this volume.

func (Network_Storage_Iscsi) GetRecycleBinFileByIdentifier 

func (r Network_Storage_Iscsi) GetRecycleBinFileByIdentifier(fileId *string) (resp datatypes.Container_Utility_File_Entity, err error)

{{CloudLayerOnlyMethod}} Retrieve the details of a file that is pending deletion in a Storage account's a recycle bin.

func (Network_Storage_Iscsi) GetRemainingAllowedHosts 

func (r Network_Storage_Iscsi) GetRemainingAllowedHosts() (resp int, err error)

Retrieves the remaining number of allowed hosts per volume.

func (Network_Storage_Iscsi) GetRemainingAllowedHostsForReplicant 

func (r Network_Storage_Iscsi) GetRemainingAllowedHostsForReplicant() (resp int, err error)

Retrieves the remaining number of allowed hosts for a volume's replicant.

func (Network_Storage_Iscsi) GetReplicatingLuns 

func (r Network_Storage_Iscsi) GetReplicatingLuns() (resp []datatypes.Network_Storage, err error)

Retrieve The iSCSI LUN volumes being replicated by this network storage volume.

func (Network_Storage_Iscsi) GetReplicatingVolume 

func (r Network_Storage_Iscsi) GetReplicatingVolume() (resp datatypes.Network_Storage, err error)

Retrieve The network storage volume being replicated by a volume.

func (Network_Storage_Iscsi) GetReplicationEvents 

func (r Network_Storage_Iscsi) GetReplicationEvents() (resp []datatypes.Network_Storage_Event, err error)

Retrieve The volume replication events.

func (Network_Storage_Iscsi) GetReplicationPartners 

func (r Network_Storage_Iscsi) GetReplicationPartners() (resp []datatypes.Network_Storage, err error)

Retrieve The network storage volumes configured to be replicants of a volume.

func (Network_Storage_Iscsi) GetReplicationSchedule 

func (r Network_Storage_Iscsi) GetReplicationSchedule() (resp datatypes.Network_Storage_Schedule, err error)

Retrieve The Replication Schedule associated with a network storage volume.

func (Network_Storage_Iscsi) GetReplicationStatus 

func (r Network_Storage_Iscsi) GetReplicationStatus() (resp string, err error)

Retrieve The current replication status of a network storage volume. Indicates Failover or Failback status.

func (Network_Storage_Iscsi) GetReplicationTimestamp added in v1.0.4 

func (r Network_Storage_Iscsi) GetReplicationTimestamp() (resp string, err error)

no documentation yet

func (Network_Storage_Iscsi) GetSchedules 

func (r Network_Storage_Iscsi) GetSchedules() (resp []datatypes.Network_Storage_Schedule, err error)

Retrieve The schedules which are associated with a network storage volume.

func (Network_Storage_Iscsi) GetServiceResource 

func (r Network_Storage_Iscsi) GetServiceResource() (resp datatypes.Network_Service_Resource, err error)

Retrieve The network resource a Storage service is connected to.

func (Network_Storage_Iscsi) GetServiceResourceBackendIpAddress 

func (r Network_Storage_Iscsi) GetServiceResourceBackendIpAddress() (resp string, err error)

Retrieve The IP address of a Storage resource.

func (Network_Storage_Iscsi) GetServiceResourceName 

func (r Network_Storage_Iscsi) GetServiceResourceName() (resp string, err error)

Retrieve The name of a Storage's network resource.

func (Network_Storage_Iscsi) GetSnapshotCapacityGb 

func (r Network_Storage_Iscsi) GetSnapshotCapacityGb() (resp string, err error)

Retrieve A volume's configured snapshot space size.

func (Network_Storage_Iscsi) GetSnapshotCreationTimestamp 

func (r Network_Storage_Iscsi) GetSnapshotCreationTimestamp() (resp string, err error)

Retrieve The creation timestamp of the snapshot on the storage platform.

func (Network_Storage_Iscsi) GetSnapshotDeletionThresholdPercentage 

func (r Network_Storage_Iscsi) GetSnapshotDeletionThresholdPercentage() (resp string, err error)

Retrieve The percentage of used snapshot space after which to delete automated snapshots.

func (Network_Storage_Iscsi) GetSnapshotNotificationStatus added in v1.0.4 

func (r Network_Storage_Iscsi) GetSnapshotNotificationStatus() (resp string, err error)

Retrieve Whether or not a network storage volume may be mounted.

func (Network_Storage_Iscsi) GetSnapshotSizeBytes 

func (r Network_Storage_Iscsi) GetSnapshotSizeBytes() (resp string, err error)

Retrieve The snapshot size in bytes.

func (Network_Storage_Iscsi) GetSnapshotSpaceAvailable 

func (r Network_Storage_Iscsi) GetSnapshotSpaceAvailable() (resp string, err error)

Retrieve A volume's available snapshot reservation space.

func (Network_Storage_Iscsi) GetSnapshots 

func (r Network_Storage_Iscsi) GetSnapshots() (resp []datatypes.Network_Storage, err error)

Retrieve The snapshots associated with this SoftLayer_Network_Storage volume.

func (Network_Storage_Iscsi) GetSnapshotsForVolume 

func (r Network_Storage_Iscsi) GetSnapshotsForVolume() (resp []datatypes.Network_Storage, err error)

Retrieves a list of snapshots for this SoftLayer_Network_Storage volume. This method works with the result limits and offset to support pagination.

func (Network_Storage_Iscsi) GetStaasVersion 

func (r Network_Storage_Iscsi) GetStaasVersion() (resp string, err error)

Retrieve

func (Network_Storage_Iscsi) GetStorageGroups 

func (r Network_Storage_Iscsi) GetStorageGroups() (resp []datatypes.Network_Storage_Group, err error)

Retrieve The network storage groups this volume is attached to.

func (Network_Storage_Iscsi) GetStorageGroupsNetworkConnectionDetails 

func (r Network_Storage_Iscsi) GetStorageGroupsNetworkConnectionDetails() (resp []datatypes.Container_Network_Storage_NetworkConnectionInformation, err error)

no documentation yet

func (Network_Storage_Iscsi) GetStorageTierLevel 

func (r Network_Storage_Iscsi) GetStorageTierLevel() (resp string, err error)

Retrieve

func (Network_Storage_Iscsi) GetStorageType 

func (r Network_Storage_Iscsi) GetStorageType() (resp datatypes.Network_Storage_Type, err error)

Retrieve A description of the Storage object.

func (Network_Storage_Iscsi) GetTargetIpAddresses 

func (r Network_Storage_Iscsi) GetTargetIpAddresses() (resp []string, err error)

no documentation yet

func (Network_Storage_Iscsi) GetTotalBytesUsed 

func (r Network_Storage_Iscsi) GetTotalBytesUsed() (resp string, err error)

Retrieve The amount of space used by the volume.

func (Network_Storage_Iscsi) GetTotalScheduleSnapshotRetentionCount 

func (r Network_Storage_Iscsi) GetTotalScheduleSnapshotRetentionCount() (resp uint, err error)

Retrieve The total snapshot retention count of all schedules on this network storage volume.

func (Network_Storage_Iscsi) GetUsageNotification 

func (r Network_Storage_Iscsi) GetUsageNotification() (resp datatypes.Notification, err error)

Retrieve The usage notification for SL Storage services.

func (Network_Storage_Iscsi) GetValidReplicationTargetDatacenterLocations 

func (r Network_Storage_Iscsi) GetValidReplicationTargetDatacenterLocations() (resp []datatypes.Location, err error)

no documentation yet

func (Network_Storage_Iscsi) GetVendorName 

func (r Network_Storage_Iscsi) GetVendorName() (resp string, err error)

Retrieve The type of network storage service.

func (Network_Storage_Iscsi) GetVirtualGuest 

func (r Network_Storage_Iscsi) GetVirtualGuest() (resp datatypes.Virtual_Guest, err error)

Retrieve When applicable, the virtual guest associated with a Storage service.

func (Network_Storage_Iscsi) GetVolumeCountLimits added in v1.0.1 

func (r Network_Storage_Iscsi) GetVolumeCountLimits() (resp []datatypes.Container_Network_Storage_DataCenterLimits_VolumeCountLimitContainer, err error)

Retrieves an array of volume count limits per location and globally.

func (Network_Storage_Iscsi) GetVolumeDuplicateParameters 

func (r Network_Storage_Iscsi) GetVolumeDuplicateParameters() (resp datatypes.Container_Network_Storage_VolumeDuplicateParameters, err error)

This method returns the parameters for cloning a volume

func (Network_Storage_Iscsi) GetVolumeHistory 

func (r Network_Storage_Iscsi) GetVolumeHistory() (resp []datatypes.Network_Storage_History, err error)

Retrieve The username and password history for a Storage service.

func (Network_Storage_Iscsi) GetVolumeStatus 

func (r Network_Storage_Iscsi) GetVolumeStatus() (resp string, err error)

Retrieve The current status of a network storage volume.

func (Network_Storage_Iscsi) GetWebccAccount 

func (r Network_Storage_Iscsi) GetWebccAccount() (resp datatypes.Account_Password, err error)

Retrieve The account username and password for the EVault webCC interface.

func (Network_Storage_Iscsi) GetWeeklySchedule 

func (r Network_Storage_Iscsi) GetWeeklySchedule() (resp datatypes.Network_Storage_Schedule, err error)

Retrieve The Weekly Schedule which is associated with this network storage volume.

func (Network_Storage_Iscsi) Id 

func (r Network_Storage_Iscsi) Id(id int) Network_Storage_Iscsi

func (Network_Storage_Iscsi) ImmediateFailoverToReplicant 

func (r Network_Storage_Iscsi) ImmediateFailoverToReplicant(replicantId *int) (resp bool, err error)

Immediate Failover to a volume replicant. During the time which the replicant is in use the local nas volume will not be available.

func (Network_Storage_Iscsi) InitiateOriginVolumeReclaim added in v1.0.4 

func (r Network_Storage_Iscsi) InitiateOriginVolumeReclaim() (resp string, err error)

no documentation yet

func (Network_Storage_Iscsi) InitiateVolumeCutover added in v1.0.4 

func (r Network_Storage_Iscsi) InitiateVolumeCutover() (resp string, err error)

no documentation yet

func (Network_Storage_Iscsi) IsBlockingOperationInProgress 

func (r Network_Storage_Iscsi) IsBlockingOperationInProgress(exemptStatusKeyNames []string) (resp bool, err error)

no documentation yet

func (Network_Storage_Iscsi) IsDuplicateReadyForSnapshot 

func (r Network_Storage_Iscsi) IsDuplicateReadyForSnapshot() (resp bool, err error)

This method returns a boolean indicating whether the clone volume is ready for snapshot.

func (Network_Storage_Iscsi) IsDuplicateReadyToMount 

func (r Network_Storage_Iscsi) IsDuplicateReadyToMount() (resp bool, err error)

This method returns a boolean indicating whether the clone volume is ready to mount.

func (Network_Storage_Iscsi) IsVolumeActive 

func (r Network_Storage_Iscsi) IsVolumeActive() (resp bool, err error)

no documentation yet

func (Network_Storage_Iscsi) Limit 

func (r Network_Storage_Iscsi) Limit(limit int) Network_Storage_Iscsi

func (Network_Storage_Iscsi) Mask 

func (r Network_Storage_Iscsi) Mask(mask string) Network_Storage_Iscsi

func (Network_Storage_Iscsi) Offset 

func (r Network_Storage_Iscsi) Offset(offset int) Network_Storage_Iscsi

func (Network_Storage_Iscsi) RefreshDependentDuplicate added in v1.0.1 

func (r Network_Storage_Iscsi) RefreshDependentDuplicate(snapshotId *int) (resp bool, err error)

no documentation yet

func (Network_Storage_Iscsi) RefreshDuplicate added in v1.0.2 

func (r Network_Storage_Iscsi) RefreshDuplicate(snapshotId *int, forceRefresh *bool) (resp bool, err error)

no documentation yet

func (Network_Storage_Iscsi) RemoveAccessFromHardware 

func (r Network_Storage_Iscsi) RemoveAccessFromHardware(hardwareObjectTemplate *datatypes.Hardware) (resp bool, err error)

This method is used to modify the access control list for this Storage volume. The SoftLayer_Hardware objects which have been allowed access to this storage will be listed in the allowedHardware property of this storage volume.

func (Network_Storage_Iscsi) RemoveAccessFromHardwareList 

func (r Network_Storage_Iscsi) RemoveAccessFromHardwareList(hardwareObjectTemplates []datatypes.Hardware) (resp bool, err error)

This method is used to modify the access control list for this Storage volume. The SoftLayer_Hardware objects which have been allowed access to this storage will be listed in the allowedHardware property of this storage volume.

func (Network_Storage_Iscsi) RemoveAccessFromHost 

func (r Network_Storage_Iscsi) RemoveAccessFromHost(typeClassName *string, hostId *int) (resp datatypes.Network_Storage_Allowed_Host, err error)

This method is used to modify the access control list for this Storage volume. The [[SoftLayer_Hardware|SoftLayer_Virtual_Guest|SoftLayer_Network_Subnet|SoftLayer_Network_Subnet_IpAddress]] objects which have been allowed access to this storage will be listed in the [[allowedHardware|allowedVirtualGuests|allowedSubnets|allowedIpAddresses]] property of this storage volume.

func (Network_Storage_Iscsi) RemoveAccessFromHostList 

func (r Network_Storage_Iscsi) RemoveAccessFromHostList(hostObjectTemplates []datatypes.Container_Network_Storage_Host) (resp []datatypes.Network_Storage_Allowed_Host, err error)

This method is used to modify the access control list for this Storage volume. The [[SoftLayer_Hardware|SoftLayer_Virtual_Guest|SoftLayer_Network_Subnet|SoftLayer_Network_Subnet_IpAddress]] objects which have been allowed access to this storage will be listed in the [[allowedHardware|allowedVirtualGuests|allowedSubnets|allowedIpAddresses]] property of this storage volume.

func (Network_Storage_Iscsi) RemoveAccessFromIpAddress 

func (r Network_Storage_Iscsi) RemoveAccessFromIpAddress(ipAddressObjectTemplate *datatypes.Network_Subnet_IpAddress) (resp bool, err error)

no documentation yet

func (Network_Storage_Iscsi) RemoveAccessFromIpAddressList 

func (r Network_Storage_Iscsi) RemoveAccessFromIpAddressList(ipAddressObjectTemplates []datatypes.Network_Subnet_IpAddress) (resp bool, err error)

no documentation yet

func (Network_Storage_Iscsi) RemoveAccessFromSubnet 

func (r Network_Storage_Iscsi) RemoveAccessFromSubnet(subnetObjectTemplate *datatypes.Network_Subnet) (resp bool, err error)

no documentation yet

func (Network_Storage_Iscsi) RemoveAccessFromSubnetList 

func (r Network_Storage_Iscsi) RemoveAccessFromSubnetList(subnetObjectTemplates []datatypes.Network_Subnet) (resp bool, err error)

no documentation yet

func (Network_Storage_Iscsi) RemoveAccessFromVirtualGuest 

func (r Network_Storage_Iscsi) RemoveAccessFromVirtualGuest(virtualGuestObjectTemplate *datatypes.Virtual_Guest) (resp bool, err error)

This method is used to modify the access control list for this Storage volume. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage will be listed in the allowedVirtualGuests property of this storage volume.

func (Network_Storage_Iscsi) RemoveAccessFromVirtualGuestList 

func (r Network_Storage_Iscsi) RemoveAccessFromVirtualGuestList(virtualGuestObjectTemplates []datatypes.Virtual_Guest) (resp bool, err error)

This method is used to modify the access control list for this Storage volume. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage will be listed in the allowedVirtualGuests property of this storage volume.

func (Network_Storage_Iscsi) RemoveAccessToReplicantFromHardwareList 

func (r Network_Storage_Iscsi) RemoveAccessToReplicantFromHardwareList(hardwareObjectTemplates []datatypes.Hardware) (resp bool, err error)

This method is used to modify the access control list for this Storage replica volume. The SoftLayer_Hardware objects which have been allowed access to this storage will be listed in the allowedHardware property of this storage replica volume.

func (Network_Storage_Iscsi) RemoveAccessToReplicantFromIpAddressList 

func (r Network_Storage_Iscsi) RemoveAccessToReplicantFromIpAddressList(ipAddressObjectTemplates []datatypes.Network_Subnet_IpAddress) (resp bool, err error)

This method is used to modify the access control list for this Storage replica volume. The SoftLayer_Network_Subnet_IpAddress objects which have been allowed access to this storage will be listed in the allowedIpAddresses property of this storage replica volume.

func (Network_Storage_Iscsi) RemoveAccessToReplicantFromSubnet 

func (r Network_Storage_Iscsi) RemoveAccessToReplicantFromSubnet(subnetObjectTemplate *datatypes.Network_Subnet) (resp bool, err error)

no documentation yet

func (Network_Storage_Iscsi) RemoveAccessToReplicantFromSubnetList 

func (r Network_Storage_Iscsi) RemoveAccessToReplicantFromSubnetList(subnetObjectTemplates []datatypes.Network_Subnet) (resp bool, err error)

This method is used to modify the access control list for this Storage volume's replica. The SoftLayer_Network_Subnet objects which have been allowed access to this storage volume's replica will be listed in the allowedReplicationSubnets property of this storage volume.

func (Network_Storage_Iscsi) RemoveAccessToReplicantFromVirtualGuestList 

func (r Network_Storage_Iscsi) RemoveAccessToReplicantFromVirtualGuestList(virtualGuestObjectTemplates []datatypes.Virtual_Guest) (resp bool, err error)

This method is used to modify the access control list for this Storage replica volume. The SoftLayer_Virtual_Guest objects which have been allowed access to this storage will be listed in the allowedVirtualGuests property of this storage replica volume.

func (Network_Storage_Iscsi) RemoveCredential 

func (r Network_Storage_Iscsi) RemoveCredential(username *string) (resp bool, err error)

This method will remove a credential from the current volume. The credential must have been created using the 'addNewCredential' method.

func (Network_Storage_Iscsi) RestoreFile 

func (r Network_Storage_Iscsi) RestoreFile(fileId *string) (resp datatypes.Container_Utility_File_Entity, err error)

{{CloudLayerOnlyMethod}} Restore an individual file so that it may be used as it was before it was deleted.

If a file is deleted from a Virtual Server Storage account, the file is placed into the account's recycle bin and not permanently deleted. Therefore, restoreFile can be used to place the file back into your Virtual Server account's root directory.

func (Network_Storage_Iscsi) RestoreFromSnapshot 

func (r Network_Storage_Iscsi) RestoreFromSnapshot(snapshotId *int) (resp bool, err error)

Restore the volume from a snapshot that was previously taken.

func (Network_Storage_Iscsi) SendPasswordReminderEmail 

func (r Network_Storage_Iscsi) SendPasswordReminderEmail(username *string) (resp bool, err error)

The method will retrieve the password for the StorageLayer or Virtual Server Storage Account and email the password. The Storage Account passwords will be emailed to the master user. For Virtual Server Storage, the password will be sent to the email address used as the username.

func (Network_Storage_Iscsi) SetMountable 

func (r Network_Storage_Iscsi) SetMountable(mountable *bool) (resp bool, err error)

Enable or disable the mounting of a Storage volume. When mounting is enabled the Storage volume will be mountable or available for use.

For Virtual Server volumes, disabling mounting will deny access to the Virtual Server Account, remove published material and deny all file interaction including uploads and downloads.

Enabling or disabling mounting for Storage volumes is not possible if mounting has been disabled by SoftLayer or a parent account.

func (Network_Storage_Iscsi) SetSnapshotAllocation 

func (r Network_Storage_Iscsi) SetSnapshotAllocation(capacityGb *int) (err error)

no documentation yet

func (Network_Storage_Iscsi) SetSnapshotNotification added in v1.0.4 

func (r Network_Storage_Iscsi) SetSnapshotNotification(notificationFlag *bool) (err error)

Function to enable/disable snapshot warning notification.

func (Network_Storage_Iscsi) UpgradeVolumeCapacity 

func (r Network_Storage_Iscsi) UpgradeVolumeCapacity(itemId *int) (resp bool, err error)

Upgrade the Storage volume to one of the upgradable packages (for example from 10 Gigs of EVault storage to 100 Gigs of EVault storage).

func (Network_Storage_Iscsi) UploadFile 

func (r Network_Storage_Iscsi) UploadFile(file *datatypes.Container_Utility_File_Entity) (resp datatypes.Container_Utility_File_Entity, err error)

{{CloudLayerOnlyMethod}} Upload a file to a Storage account's root directory. Once uploaded, this method returns new file entity identifier for the upload file.

The following properties are required in the ”file” parameter. *”'name”': The name of the file you wish to upload *”'content”': The raw contents of the file you wish to upload. *”'contentType”': The MIME-type of content that you wish to upload.

func (Network_Storage_Iscsi) ValidateHostsAccess added in v1.0.5 

func (r Network_Storage_Iscsi) ValidateHostsAccess(hostObjectTemplates []datatypes.Container_Network_Storage_Host) (resp []datatypes.Container_Network_Storage_HostsGatewayInformation, err error)

This method is used to validate if the hosts are behind gateway or not from [SoftLayer_Network_Subnet|SoftLayer_Network_Subnet_IpAddress] objects. This returns [SoftLayer_Container_Network_Storage_HostsGatewayInformation] object containing the host details along with a boolean attribute which indicates if it's behind the gateway or not.

type Network_Storage_Iscsi_OS_Type 

type Network_Storage_Iscsi_OS_Type struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetNetworkStorageIscsiOSTypeService 

func GetNetworkStorageIscsiOSTypeService(sess session.SLSession) Network_Storage_Iscsi_OS_Type

GetNetworkStorageIscsiOSTypeService returns an instance of the Network_Storage_Iscsi_OS_Type SoftLayer service

func (Network_Storage_Iscsi_OS_Type) Filter 

func (r Network_Storage_Iscsi_OS_Type) Filter(filter string) Network_Storage_Iscsi_OS_Type

func (Network_Storage_Iscsi_OS_Type) GetAllObjects 

func (r Network_Storage_Iscsi_OS_Type) GetAllObjects() (resp []datatypes.Network_Storage_Iscsi_OS_Type, err error)

Use this method to retrieve all iSCSI OS Types.

func (Network_Storage_Iscsi_OS_Type) GetObject 

func (r Network_Storage_Iscsi_OS_Type) GetObject() (resp datatypes.Network_Storage_Iscsi_OS_Type, err error)

no documentation yet

func (Network_Storage_Iscsi_OS_Type) Id 

func (r Network_Storage_Iscsi_OS_Type) Id(id int) Network_Storage_Iscsi_OS_Type

func (Network_Storage_Iscsi_OS_Type) Limit 

func (r Network_Storage_Iscsi_OS_Type) Limit(limit int) Network_Storage_Iscsi_OS_Type

func (Network_Storage_Iscsi_OS_Type) Mask 

func (r Network_Storage_Iscsi_OS_Type) Mask(mask string) Network_Storage_Iscsi_OS_Type

func (Network_Storage_Iscsi_OS_Type) Offset 

func (r Network_Storage_Iscsi_OS_Type) Offset(offset int) Network_Storage_Iscsi_OS_Type

type Network_Storage_MassDataMigration_CrossRegion_Country_Xref 

type Network_Storage_MassDataMigration_CrossRegion_Country_Xref struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet Deprecated: This function has been marked as deprecated.

func GetNetworkStorageMassDataMigrationCrossRegionCountryXrefService 

func GetNetworkStorageMassDataMigrationCrossRegionCountryXrefService(sess session.SLSession) Network_Storage_MassDataMigration_CrossRegion_Country_Xref

GetNetworkStorageMassDataMigrationCrossRegionCountryXrefService returns an instance of the Network_Storage_MassDataMigration_CrossRegion_Country_Xref SoftLayer service

func (Network_Storage_MassDataMigration_CrossRegion_Country_Xref) Filter 

func (r Network_Storage_MassDataMigration_CrossRegion_Country_Xref) Filter(filter string) Network_Storage_MassDataMigration_CrossRegion_Country_Xref

func (Network_Storage_MassDataMigration_CrossRegion_Country_Xref) GetAllObjects 

func (r Network_Storage_MassDataMigration_CrossRegion_Country_Xref) GetAllObjects() (resp []datatypes.Network_Storage_MassDataMigration_CrossRegion_Country_Xref, err error)

no documentation yet Deprecated: This function has been marked as deprecated.

func (Network_Storage_MassDataMigration_CrossRegion_Country_Xref) GetCountry 

func (r Network_Storage_MassDataMigration_CrossRegion_Country_Xref) GetCountry() (resp datatypes.Locale_Country, err error)

Retrieve SoftLayer_Locale_Country Id.

func (Network_Storage_MassDataMigration_CrossRegion_Country_Xref) GetLocationGroup 

func (r Network_Storage_MassDataMigration_CrossRegion_Country_Xref) GetLocationGroup() (resp datatypes.Location_Group, err error)

Retrieve Location Group ID of CleverSafe cross region.

func (Network_Storage_MassDataMigration_CrossRegion_Country_Xref) GetObject 

func (r Network_Storage_MassDataMigration_CrossRegion_Country_Xref) GetObject() (resp datatypes.Network_Storage_MassDataMigration_CrossRegion_Country_Xref, err error)

no documentation yet

func (Network_Storage_MassDataMigration_CrossRegion_Country_Xref) GetValidCountriesForRegion 

func (r Network_Storage_MassDataMigration_CrossRegion_Country_Xref) GetValidCountriesForRegion(locationGroupName *string) (resp []datatypes.Network_Storage_MassDataMigration_CrossRegion_Country_Xref, err error)

DEPRECATED Deprecated: This function has been marked as deprecated.

func (Network_Storage_MassDataMigration_CrossRegion_Country_Xref) Id 

func (r Network_Storage_MassDataMigration_CrossRegion_Country_Xref) Id(id int) Network_Storage_MassDataMigration_CrossRegion_Country_Xref

func (Network_Storage_MassDataMigration_CrossRegion_Country_Xref) Limit 

func (r Network_Storage_MassDataMigration_CrossRegion_Country_Xref) Limit(limit int) Network_Storage_MassDataMigration_CrossRegion_Country_Xref

func (Network_Storage_MassDataMigration_CrossRegion_Country_Xref) Mask 

func (r Network_Storage_MassDataMigration_CrossRegion_Country_Xref) Mask(mask string) Network_Storage_MassDataMigration_CrossRegion_Country_Xref

func (Network_Storage_MassDataMigration_CrossRegion_Country_Xref) Offset 

func (r Network_Storage_MassDataMigration_CrossRegion_Country_Xref) Offset(offset int) Network_Storage_MassDataMigration_CrossRegion_Country_Xref

type Network_Storage_MassDataMigration_Request 

type Network_Storage_MassDataMigration_Request struct {
	Session session.SLSession
	Options sl.Options
}

DEPRECATED Deprecated: This function has been marked as deprecated.

func GetNetworkStorageMassDataMigrationRequestService 

func GetNetworkStorageMassDataMigrationRequestService(sess session.SLSession) Network_Storage_MassDataMigration_Request

GetNetworkStorageMassDataMigrationRequestService returns an instance of the Network_Storage_MassDataMigration_Request SoftLayer service

func (Network_Storage_MassDataMigration_Request) Filter 

func (r Network_Storage_MassDataMigration_Request) Filter(filter string) Network_Storage_MassDataMigration_Request

func (Network_Storage_MassDataMigration_Request) GetAccount 

func (r Network_Storage_MassDataMigration_Request) GetAccount() (resp datatypes.Account, err error)

Retrieve The account to which the request belongs.

func (Network_Storage_MassDataMigration_Request) GetActiveTickets 

func (r Network_Storage_MassDataMigration_Request) GetActiveTickets() (resp []datatypes.Ticket, err error)

Retrieve The active tickets that are attached to the MDMS request.

func (Network_Storage_MassDataMigration_Request) GetAddress 

func (r Network_Storage_MassDataMigration_Request) GetAddress() (resp datatypes.Account_Address, err error)

Retrieve The customer address where the device is shipped to.

func (Network_Storage_MassDataMigration_Request) GetAllObjects 

func (r Network_Storage_MassDataMigration_Request) GetAllObjects() (resp []datatypes.Network_Storage_MassDataMigration_Request, err error)

no documentation yet Deprecated: This function has been marked as deprecated.

func (Network_Storage_MassDataMigration_Request) GetAllRequestStatuses 

func (r Network_Storage_MassDataMigration_Request) GetAllRequestStatuses() (resp []datatypes.Network_Storage_MassDataMigration_Request_Status, err error)

DEPRECATED Deprecated: This function has been marked as deprecated.

func (Network_Storage_MassDataMigration_Request) GetBillingItem 

func (r Network_Storage_MassDataMigration_Request) GetBillingItem() (resp datatypes.Billing_Item, err error)

Retrieve An associated parent billing item which is active. Includes billing items which are scheduled to be cancelled in the future.

func (Network_Storage_MassDataMigration_Request) GetCreateEmployee 

func (r Network_Storage_MassDataMigration_Request) GetCreateEmployee() (resp datatypes.User_Employee, err error)

Retrieve The employee user who created the request.

func (Network_Storage_MassDataMigration_Request) GetCreateUser 

func (r Network_Storage_MassDataMigration_Request) GetCreateUser() (resp datatypes.User_Customer, err error)

Retrieve The customer user who created the request.

func (Network_Storage_MassDataMigration_Request) GetDeviceConfiguration 

func (r Network_Storage_MassDataMigration_Request) GetDeviceConfiguration() (resp datatypes.Network_Storage_MassDataMigration_Request_DeviceConfiguration, err error)

Retrieve The device configurations.

func (Network_Storage_MassDataMigration_Request) GetDeviceModel 

func (r Network_Storage_MassDataMigration_Request) GetDeviceModel() (resp string, err error)

Retrieve The model of device assigned to this request.

func (Network_Storage_MassDataMigration_Request) GetKeyContacts 

func (r Network_Storage_MassDataMigration_Request) GetKeyContacts() (resp []datatypes.Network_Storage_MassDataMigration_Request_KeyContact, err error)

Retrieve The key contacts for this requests.

func (Network_Storage_MassDataMigration_Request) GetModifyEmployee 

func (r Network_Storage_MassDataMigration_Request) GetModifyEmployee() (resp datatypes.User_Employee, err error)

Retrieve The employee who last modified the request.

func (Network_Storage_MassDataMigration_Request) GetModifyUser 

func (r Network_Storage_MassDataMigration_Request) GetModifyUser() (resp datatypes.User_Customer, err error)

Retrieve The customer user who last modified the request.

func (Network_Storage_MassDataMigration_Request) GetObject 

func (r Network_Storage_MassDataMigration_Request) GetObject() (resp datatypes.Network_Storage_MassDataMigration_Request, err error)

no documentation yet

func (Network_Storage_MassDataMigration_Request) GetPendingRequests 

func (r Network_Storage_MassDataMigration_Request) GetPendingRequests() (resp []datatypes.Network_Storage_MassDataMigration_Request, err error)

DEPRECATED Deprecated: This function has been marked as deprecated.

func (Network_Storage_MassDataMigration_Request) GetShipments 

func (r Network_Storage_MassDataMigration_Request) GetShipments() (resp []datatypes.Account_Shipment, err error)

Retrieve The shipments of the request.

func (Network_Storage_MassDataMigration_Request) GetStatus 

func (r Network_Storage_MassDataMigration_Request) GetStatus() (resp datatypes.Network_Storage_MassDataMigration_Request_Status, err error)

Retrieve The status of the request.

func (Network_Storage_MassDataMigration_Request) GetTicket 

func (r Network_Storage_MassDataMigration_Request) GetTicket() (resp datatypes.Ticket, err error)

Retrieve Ticket that is attached to this mass data migration request.

func (Network_Storage_MassDataMigration_Request) GetTickets 

func (r Network_Storage_MassDataMigration_Request) GetTickets() (resp []datatypes.Ticket, err error)

Retrieve All tickets that are attached to the mass data migration request.

func (Network_Storage_MassDataMigration_Request) Id 

func (r Network_Storage_MassDataMigration_Request) Id(id int) Network_Storage_MassDataMigration_Request

func (Network_Storage_MassDataMigration_Request) Limit 

func (r Network_Storage_MassDataMigration_Request) Limit(limit int) Network_Storage_MassDataMigration_Request

func (Network_Storage_MassDataMigration_Request) Mask 

func (r Network_Storage_MassDataMigration_Request) Mask(mask string) Network_Storage_MassDataMigration_Request

func (Network_Storage_MassDataMigration_Request) Offset 

func (r Network_Storage_MassDataMigration_Request) Offset(offset int) Network_Storage_MassDataMigration_Request

type Network_Storage_MassDataMigration_Request_KeyContact 

type Network_Storage_MassDataMigration_Request_KeyContact struct {
	Session session.SLSession
	Options sl.Options
}

DEPRECATED Deprecated: This function has been marked as deprecated.

func GetNetworkStorageMassDataMigrationRequestKeyContactService 

func GetNetworkStorageMassDataMigrationRequestKeyContactService(sess session.SLSession) Network_Storage_MassDataMigration_Request_KeyContact

GetNetworkStorageMassDataMigrationRequestKeyContactService returns an instance of the Network_Storage_MassDataMigration_Request_KeyContact SoftLayer service

func (Network_Storage_MassDataMigration_Request_KeyContact) Filter 

func (r Network_Storage_MassDataMigration_Request_KeyContact) Filter(filter string) Network_Storage_MassDataMigration_Request_KeyContact

func (Network_Storage_MassDataMigration_Request_KeyContact) GetAccount 

func (r Network_Storage_MassDataMigration_Request_KeyContact) GetAccount() (resp datatypes.Account, err error)

Retrieve The request this key contact belongs to.

func (Network_Storage_MassDataMigration_Request_KeyContact) GetObject 

func (r Network_Storage_MassDataMigration_Request_KeyContact) GetObject() (resp datatypes.Network_Storage_MassDataMigration_Request_KeyContact, err error)

no documentation yet

func (Network_Storage_MassDataMigration_Request_KeyContact) GetRequest 

func (r Network_Storage_MassDataMigration_Request_KeyContact) GetRequest() (resp datatypes.Network_Storage_MassDataMigration_Request, err error)

Retrieve The request this key contact belongs to.

func (Network_Storage_MassDataMigration_Request_KeyContact) Id 

func (r Network_Storage_MassDataMigration_Request_KeyContact) Id(id int) Network_Storage_MassDataMigration_Request_KeyContact

func (Network_Storage_MassDataMigration_Request_KeyContact) Limit 

func (r Network_Storage_MassDataMigration_Request_KeyContact) Limit(limit int) Network_Storage_MassDataMigration_Request_KeyContact

func (Network_Storage_MassDataMigration_Request_KeyContact) Mask 

func (r Network_Storage_MassDataMigration_Request_KeyContact) Mask(mask string) Network_Storage_MassDataMigration_Request_KeyContact

func (Network_Storage_MassDataMigration_Request_KeyContact) Offset 

func (r Network_Storage_MassDataMigration_Request_KeyContact) Offset(offset int) Network_Storage_MassDataMigration_Request_KeyContact

type Network_Storage_MassDataMigration_Request_Status 

type Network_Storage_MassDataMigration_Request_Status struct {
	Session session.SLSession
	Options sl.Options
}

DEPRECATED Deprecated: This function has been marked as deprecated.

func GetNetworkStorageMassDataMigrationRequestStatusService 

func GetNetworkStorageMassDataMigrationRequestStatusService(sess session.SLSession) Network_Storage_MassDataMigration_Request_Status

GetNetworkStorageMassDataMigrationRequestStatusService returns an instance of the Network_Storage_MassDataMigration_Request_Status SoftLayer service

func (Network_Storage_MassDataMigration_Request_Status) Filter 

func (r Network_Storage_MassDataMigration_Request_Status) Filter(filter string) Network_Storage_MassDataMigration_Request_Status

func (Network_Storage_MassDataMigration_Request_Status) GetObject 

func (r Network_Storage_MassDataMigration_Request_Status) GetObject() (resp datatypes.Network_Storage_MassDataMigration_Request_Status, err error)

no documentation yet

func (Network_Storage_MassDataMigration_Request_Status) Id 

func (r Network_Storage_MassDataMigration_Request_Status) Id(id int) Network_Storage_MassDataMigration_Request_Status

func (Network_Storage_MassDataMigration_Request_Status) Limit 

func (r Network_Storage_MassDataMigration_Request_Status) Limit(limit int) Network_Storage_MassDataMigration_Request_Status

func (Network_Storage_MassDataMigration_Request_Status) Mask 

func (r Network_Storage_MassDataMigration_Request_Status) Mask(mask string) Network_Storage_MassDataMigration_Request_Status

func (Network_Storage_MassDataMigration_Request_Status) Offset 

func (r Network_Storage_MassDataMigration_Request_Status) Offset(offset int) Network_Storage_MassDataMigration_Request_Status

type Network_Storage_Schedule 

type Network_Storage_Schedule struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetNetworkStorageScheduleService 

func GetNetworkStorageScheduleService(sess session.SLSession) Network_Storage_Schedule

GetNetworkStorageScheduleService returns an instance of the Network_Storage_Schedule SoftLayer service

func (Network_Storage_Schedule) CreateObject 

func (r Network_Storage_Schedule) CreateObject(templateObject *datatypes.Network_Storage_Schedule) (resp datatypes.Network_Storage_Schedule, err error)

Create a nas volume schedule

func (Network_Storage_Schedule) DeleteObject 

func (r Network_Storage_Schedule) DeleteObject() (resp bool, err error)

Delete a network storage schedule. ”'This cannot be undone.”' ”deleteObject” returns Boolean ”true” on successful deletion or ”false” if it was unable to remove a schedule;

func (Network_Storage_Schedule) EditObject 

func (r Network_Storage_Schedule) EditObject(templateObject *datatypes.Network_Storage_Schedule) (resp bool, err error)

Edit a nas volume schedule

func (Network_Storage_Schedule) Filter 

func (r Network_Storage_Schedule) Filter(filter string) Network_Storage_Schedule

func (Network_Storage_Schedule) GetDay 

func (r Network_Storage_Schedule) GetDay() (resp string, err error)

Retrieve The hour parameter of this schedule.

func (Network_Storage_Schedule) GetDayOfMonth 

func (r Network_Storage_Schedule) GetDayOfMonth() (resp string, err error)

Retrieve The day of the month parameter of this schedule.

func (Network_Storage_Schedule) GetDayOfWeek 

func (r Network_Storage_Schedule) GetDayOfWeek() (resp string, err error)

Retrieve The day of the week parameter of this schedule.

func (Network_Storage_Schedule) GetEvents 

func (r Network_Storage_Schedule) GetEvents() (resp []datatypes.Network_Storage_Event, err error)

Retrieve Events which have been created as the result of a schedule execution.

func (Network_Storage_Schedule) GetHour 

func (r Network_Storage_Schedule) GetHour() (resp string, err error)

Retrieve The hour parameter of this schedule.

func (Network_Storage_Schedule) GetMinute 

func (r Network_Storage_Schedule) GetMinute() (resp string, err error)

Retrieve The minute parameter of this schedule.

func (Network_Storage_Schedule) GetMonthOfYear 

func (r Network_Storage_Schedule) GetMonthOfYear() (resp string, err error)

Retrieve The month of the year parameter of this schedule.

func (Network_Storage_Schedule) GetObject 

func (r Network_Storage_Schedule) GetObject() (resp datatypes.Network_Storage_Schedule, err error)

no documentation yet

func (Network_Storage_Schedule) GetPartnership 

func (r Network_Storage_Schedule) GetPartnership() (resp datatypes.Network_Storage_Partnership, err error)

Retrieve The associated partnership for a schedule.

func (Network_Storage_Schedule) GetProperties 

func (r Network_Storage_Schedule) GetProperties() (resp []datatypes.Network_Storage_Schedule_Property, err error)

Retrieve Properties used for configuration of a schedule.

func (Network_Storage_Schedule) GetReplicaSnapshots 

func (r Network_Storage_Schedule) GetReplicaSnapshots() (resp []datatypes.Network_Storage, err error)

Retrieve Replica snapshots which have been created as the result of this schedule's execution.

func (Network_Storage_Schedule) GetRetentionCount 

func (r Network_Storage_Schedule) GetRetentionCount() (resp string, err error)

Retrieve The number of snapshots this schedule is configured to retain.

func (Network_Storage_Schedule) GetSecond 

func (r Network_Storage_Schedule) GetSecond() (resp string, err error)

Retrieve The minute parameter of this schedule.

func (Network_Storage_Schedule) GetSnapshots 

func (r Network_Storage_Schedule) GetSnapshots() (resp []datatypes.Network_Storage, err error)

Retrieve Snapshots which have been created as the result of this schedule's execution.

func (Network_Storage_Schedule) GetType 

func (r Network_Storage_Schedule) GetType() (resp datatypes.Network_Storage_Schedule_Type, err error)

Retrieve The type provides a standardized definition for a schedule.

func (Network_Storage_Schedule) GetVolume 

func (r Network_Storage_Schedule) GetVolume() (resp datatypes.Network_Storage, err error)

Retrieve The associated volume for a schedule.

func (Network_Storage_Schedule) Id 

func (r Network_Storage_Schedule) Id(id int) Network_Storage_Schedule

func (Network_Storage_Schedule) Limit 

func (r Network_Storage_Schedule) Limit(limit int) Network_Storage_Schedule

func (Network_Storage_Schedule) Mask 

func (r Network_Storage_Schedule) Mask(mask string) Network_Storage_Schedule

func (Network_Storage_Schedule) Offset 

func (r Network_Storage_Schedule) Offset(offset int) Network_Storage_Schedule

type Network_Storage_Schedule_Property_Type 

type Network_Storage_Schedule_Property_Type struct {
	Session session.SLSession
	Options sl.Options
}

A schedule property type is used to allow for a standardized method of defining network storage schedules.

func GetNetworkStorageSchedulePropertyTypeService 

func GetNetworkStorageSchedulePropertyTypeService(sess session.SLSession) Network_Storage_Schedule_Property_Type

GetNetworkStorageSchedulePropertyTypeService returns an instance of the Network_Storage_Schedule_Property_Type SoftLayer service

func (Network_Storage_Schedule_Property_Type) Filter 

func (r Network_Storage_Schedule_Property_Type) Filter(filter string) Network_Storage_Schedule_Property_Type

func (Network_Storage_Schedule_Property_Type) GetAllObjects 

func (r Network_Storage_Schedule_Property_Type) GetAllObjects() (resp []datatypes.Network_Storage_Schedule_Property_Type, err error)

Use this method to retrieve all network storage schedule property types.

func (Network_Storage_Schedule_Property_Type) GetObject 

func (r Network_Storage_Schedule_Property_Type) GetObject() (resp datatypes.Network_Storage_Schedule_Property_Type, err error)

no documentation yet

func (Network_Storage_Schedule_Property_Type) Id 

func (r Network_Storage_Schedule_Property_Type) Id(id int) Network_Storage_Schedule_Property_Type

func (Network_Storage_Schedule_Property_Type) Limit 

func (r Network_Storage_Schedule_Property_Type) Limit(limit int) Network_Storage_Schedule_Property_Type

func (Network_Storage_Schedule_Property_Type) Mask 

func (r Network_Storage_Schedule_Property_Type) Mask(mask string) Network_Storage_Schedule_Property_Type

func (Network_Storage_Schedule_Property_Type) Offset 

func (r Network_Storage_Schedule_Property_Type) Offset(offset int) Network_Storage_Schedule_Property_Type

type Network_Subnet 

type Network_Subnet struct {
	Session session.SLSession
	Options sl.Options
}

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)

func GetNetworkSubnetService 

func GetNetworkSubnetService(sess session.SLSession) Network_Subnet

GetNetworkSubnetService returns an instance of the Network_Subnet SoftLayer service

func (Network_Subnet) AllowAccessToNetworkStorage 

func (r Network_Subnet) AllowAccessToNetworkStorage(networkStorageTemplateObject *datatypes.Network_Storage) (resp bool, err error)

This method is used to allow access to a SoftLayer_Network_Storage volume that supports host- or network-level access control.

func (Network_Subnet) AllowAccessToNetworkStorageList 

func (r Network_Subnet) AllowAccessToNetworkStorageList(networkStorageTemplateObjects []datatypes.Network_Storage) (resp bool, err error)

This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support host- or network-level access control.

func (Network_Subnet) ClearRoute added in v1.0.2 

func (r Network_Subnet) ClearRoute() (resp bool, err error)

This interface allows you to remove the route of your secondary subnets. The result will be a subnet that is no longer routed on the network. Remove the route of subnets you are not actively using, as it will make it easier to identify available subnets later.

”'Important:”' When removing the route of ”Portable” subnets, know that any subnet depending on an IP address provided by the Portable subnet will also have their routes removed!

To review what subnets are routed to IP addresses provided by a ”Portable” subnet, you can utilize the following object mask: 'mask[ipAddresses[endpointSubnets]]'. Any subnet present in conjunction with ”endpointSubnets” is a subnet which depends on the respective IP address.

The behavior of this interface is such that either true or false is returned. A result of false can be interpreted as the clear route request having already been completed. In contrast, a result of true means the subnet is currently routed and will be transitioned. This route change is asynchronous to the request. A response of true does not mean the subnet's route has changed, but simply that it will change. In order to monitor for the completion of the change, you may either attempt a clear route again until the result is false, or monitor one or more SoftLayer_Network_Subnet properties: subnetType, networkVlanId, and or endPointIpAddress to determine if routing of the subnet has been removed.

func (Network_Subnet) CreateReverseDomainRecords 

func (r Network_Subnet) CreateReverseDomainRecords() (resp datatypes.Dns_Domain_Reverse, err error)

Create the default PTR records for this subnet

func (Network_Subnet) CreateSubnetRouteUpdateTransaction 

func (r Network_Subnet) CreateSubnetRouteUpdateTransaction(newEndPointIpAddress *string) (resp bool, err error)

***DEPRECATED*** This endpoint is deprecated in favor of the more expressive and capable SoftLayer_Network_Subnet::route, to which this endpoint now proxies. Refer to it for more information.

Similarly, unroute requests are proxied to SoftLayer_Network_Subnet::clearRoute. Deprecated: This function has been marked as deprecated.

func (Network_Subnet) EditNote 

func (r Network_Subnet) EditNote(note *string) (resp bool, err error)

Edit the note for this subnet.

func (Network_Subnet) Filter 

func (r Network_Subnet) Filter(filter string) Network_Subnet

func (Network_Subnet) GetAccount 

func (r Network_Subnet) GetAccount() (resp datatypes.Account, err error)

Retrieve

func (Network_Subnet) GetActiveTransaction 

func (r Network_Subnet) GetActiveTransaction() (resp datatypes.Provisioning_Version1_Transaction, err error)

Retrieve DEPRECATED

func (Network_Subnet) GetAddressSpace 

func (r Network_Subnet) GetAddressSpace() (resp string, err error)

Retrieve 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.

func (Network_Subnet) GetAllowedHost 

func (r Network_Subnet) GetAllowedHost() (resp datatypes.Network_Storage_Allowed_Host, err error)

Retrieve The link from this subnet to network storage devices supporting access control lists.

func (Network_Subnet) GetAllowedNetworkStorage 

func (r Network_Subnet) GetAllowedNetworkStorage() (resp []datatypes.Network_Storage, err error)

Retrieve The network storage devices this subnet has been granted access to.

func (Network_Subnet) GetAllowedNetworkStorageReplicas 

func (r Network_Subnet) GetAllowedNetworkStorageReplicas() (resp []datatypes.Network_Storage, err error)

Retrieve The network storage device replicas this subnet has been granted access to.

func (Network_Subnet) GetAttachedNetworkStorages 

func (r Network_Subnet) GetAttachedNetworkStorages(nasType *string) (resp []datatypes.Network_Storage, err error)

Retrieves the combination of network storage devices and replicas this subnet has been granted access to. Allows for filtering based on storage device type.

func (Network_Subnet) GetAvailableNetworkStorages 

func (r Network_Subnet) GetAvailableNetworkStorages(nasType *string) (resp []datatypes.Network_Storage, err error)

Retrieves the combination of network storage devices and replicas this subnet has NOT been granted access to. Allows for filtering based on storage device type.

func (Network_Subnet) GetBillingItem 

func (r Network_Subnet) GetBillingItem() (resp datatypes.Billing_Item, err error)

Retrieve The active billing item for this subnet.

func (Network_Subnet) GetBoundDescendants 

func (r Network_Subnet) GetBoundDescendants() (resp []datatypes.Network_Subnet, err error)

Retrieve

func (Network_Subnet) GetBoundRouterFlag 

func (r Network_Subnet) GetBoundRouterFlag() (resp bool, err error)

Retrieve Indicates whether this subnet is associated to a network router and is routable on the network.

func (Network_Subnet) GetChildren 

func (r Network_Subnet) GetChildren() (resp []datatypes.Network_Subnet, err error)

Retrieve The immediate descendants of this subnet.

func (Network_Subnet) GetDatacenter 

func (r Network_Subnet) GetDatacenter() (resp datatypes.Location_Datacenter, err error)

Retrieve The datacenter this subnet is primarily associated with.

func (Network_Subnet) GetDescendants 

func (r Network_Subnet) GetDescendants() (resp []datatypes.Network_Subnet, err error)

Retrieve The descendants of this subnet, including all parents and children.

func (Network_Subnet) GetDisplayLabel 

func (r Network_Subnet) GetDisplayLabel() (resp string, err error)

Retrieve [DEPRECATED] The description of this subnet.

func (Network_Subnet) GetEndPointIpAddress 

func (r Network_Subnet) GetEndPointIpAddress() (resp datatypes.Network_Subnet_IpAddress, err error)

Retrieve The IP address target of this statically routed subnet.

func (Network_Subnet) GetGlobalIpRecord 

func (r Network_Subnet) GetGlobalIpRecord() (resp datatypes.Network_Subnet_IpAddress_Global, err error)

Retrieve

func (Network_Subnet) GetHardware 

func (r Network_Subnet) GetHardware() (resp []datatypes.Hardware, err error)

Retrieve The Bare Metal devices which have been assigned a primary IP address from this subnet.

func (Network_Subnet) GetIpAddressUsage added in v1.1.3 

func (r Network_Subnet) GetIpAddressUsage() (resp []datatypes.Network_Subnet_IpAddress_UsageDetail, err error)

Returns a list of IP address assignment details. Only assigned IP addresses are reported on. IP address assignments are presently only recorded and available for Primary Subnets.

Details on the resource assigned to each IP address will only be provided to users with access to the underlying resource. If the user cannot access the resource, a detail record will still be returned for the assignment but without any accompanying resource data.

func (Network_Subnet) GetIpAddresses 

func (r Network_Subnet) GetIpAddresses() (resp []datatypes.Network_Subnet_IpAddress, err error)

Retrieve The IP address records belonging to this subnet.

func (Network_Subnet) GetNetworkComponentFirewall 

func (r Network_Subnet) GetNetworkComponentFirewall() (resp datatypes.Network_Component_Firewall, err error)

Retrieve The hardware firewall associated to this subnet via access control list.

func (Network_Subnet) GetNetworkProtectionAddresses 

func (r Network_Subnet) GetNetworkProtectionAddresses() (resp []datatypes.Network_Protection_Address, err error)

Retrieve

func (Network_Subnet) GetNetworkTunnelContexts 

func (r Network_Subnet) GetNetworkTunnelContexts() (resp []datatypes.Network_Tunnel_Module_Context, err error)

Retrieve The IPSec VPN tunnels associated to this subnet.

func (Network_Subnet) GetNetworkVlan 

func (r Network_Subnet) GetNetworkVlan() (resp datatypes.Network_Vlan, err error)

Retrieve The VLAN this subnet is associated with.

func (Network_Subnet) GetObject 

func (r Network_Subnet) GetObject() (resp datatypes.Network_Subnet, err error)

Retrieves a subnet by its id value. Only subnets assigned to your account are accessible.

func (Network_Subnet) GetPodName 

func (r Network_Subnet) GetPodName() (resp string, err error)

Retrieve The pod in which this subnet is currently routed.

func (Network_Subnet) GetProtectedIpAddresses 

func (r Network_Subnet) GetProtectedIpAddresses() (resp []datatypes.Network_Subnet_IpAddress, err error)

Retrieve

func (Network_Subnet) GetRegionalInternetRegistry 

func (r Network_Subnet) GetRegionalInternetRegistry() (resp datatypes.Network_Regional_Internet_Registry, err error)

Retrieve The RIR which is authoritative over the network in which this subnet resides.

func (Network_Subnet) GetReverseDomain 

func (r Network_Subnet) GetReverseDomain() (resp datatypes.Dns_Domain, err error)

Retrieve The reverse DNS domain associated with this subnet.

func (Network_Subnet) GetReverseDomainRecords 

func (r Network_Subnet) GetReverseDomainRecords() (resp []datatypes.Dns_Domain, err error)

Retrieve all reverse DNS records associated with a subnet.

func (Network_Subnet) GetRoleKeyName 

func (r Network_Subnet) GetRoleKeyName() (resp string, err error)

Retrieve The role identifier that this subnet is participating in. Roles dictate how a subnet may be used.

func (Network_Subnet) GetRoleName 

func (r Network_Subnet) GetRoleName() (resp string, err error)

Retrieve The name of the role the subnet is within. Roles dictate how a subnet may be used.

func (Network_Subnet) GetRoutableEndpointIpAddresses 

func (r Network_Subnet) GetRoutableEndpointIpAddresses() (resp []datatypes.Network_Subnet_IpAddress, err error)

Returns IP addresses which may be used as routing endpoints for a given subnet. IP address which are currently the network, gateway, or broadcast address of a Secondary Portable subnet, are an address in a Secondary Static subnet, or if the address is not assigned to a resource when part of a Primary Subnet will not be available as a routing endpoint.

func (Network_Subnet) GetRoutingTypeKeyName 

func (r Network_Subnet) GetRoutingTypeKeyName() (resp string, err error)

Retrieve The product and route classifier for this routed subnet, with the following values: PRIMARY, SECONDARY, STATIC_TO_IP, GLOBAL_IP

func (Network_Subnet) GetRoutingTypeName 

func (r Network_Subnet) GetRoutingTypeName() (resp string, err error)

Retrieve The description of the product and route classifier for this routed subnet, with the following values: Primary, Portable, Static, Global.

func (Network_Subnet) GetSubnetForIpAddress 

func (r Network_Subnet) GetSubnetForIpAddress(ipAddress *string) (resp datatypes.Network_Subnet, err error)

Retrieve the subnet associated with an IP address. You may only retrieve subnets assigned to your SoftLayer customer account.

func (Network_Subnet) GetTagReferences added in v1.0.2 

func (r Network_Subnet) GetTagReferences() (resp []datatypes.Tag_Reference, err error)

Retrieve The tags associated to this subnet.

func (Network_Subnet) GetUnboundDescendants 

func (r Network_Subnet) GetUnboundDescendants() (resp []datatypes.Network_Subnet, err error)

Retrieve

func (Network_Subnet) GetUtilizedIpAddressCount 

func (r Network_Subnet) GetUtilizedIpAddressCount() (resp uint, err error)

Retrieve 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.

func (Network_Subnet) GetVirtualGuests 

func (r Network_Subnet) GetVirtualGuests() (resp []datatypes.Virtual_Guest, err error)

Retrieve The Virtual Server devices which have been assigned a primary IP address from this subnet.

func (Network_Subnet) Id 

func (r Network_Subnet) Id(id int) Network_Subnet

func (Network_Subnet) Limit 

func (r Network_Subnet) Limit(limit int) Network_Subnet

func (Network_Subnet) Mask 

func (r Network_Subnet) Mask(mask string) Network_Subnet

func (Network_Subnet) Offset 

func (r Network_Subnet) Offset(offset int) Network_Subnet

func (Network_Subnet) RemoveAccessToNetworkStorageList 

func (r Network_Subnet) RemoveAccessToNetworkStorageList(networkStorageTemplateObjects []datatypes.Network_Storage) (resp bool, err error)

no documentation yet

func (Network_Subnet) Route added in v1.0.2 

func (r Network_Subnet) Route(typ *string, identifier *string) (resp bool, err error)

This interface allows you to change the route of your secondary subnets. It accommodates a number of ways to identify your desired routing destination through the use of a 'type' and 'identifier'. Subnets may be routed as either Static or Portable, and that designation is dictated by the routing destination specified.

Static subnets have an ultimate routing destination of a single IP address but may not be routed to an existing subnet's IP address whose subnet is routed as a Static. Portable subnets have an ultimate routing destination of a VLAN.

A subnet can be routed to any resource within the same "routing region" as the subnet itself. A subnet's routing region can be diverse but is usually limited to a single data center.

The following identifier 'type' values will result in Static routing: <ul> <li>SoftLayer_Network_Subnet_IpAddress</li> <li>SoftLayer_Hardware_Server</li> <li>SoftLayer_Virtual_Guest</li> </ul>

The following identifier 'type' values will result in Portable routing: <ul> <li>SoftLayer_Network_Vlan</li> </ul>

For each identifier type, one or more 'identifier' formats are possible.

”SoftLayer_Network_Subnet_IpAddress” will accept the following identifier formats: <ul> <li>An entirely numeric value will be treated as a SoftLayer_Network_Subnet_IpAddress.id value of the desired IP address object.</li> <li>A dotted-quad IPv4 address.</li> <li>A full or compressed IPv6 address.</li> </ul>

”SoftLayer_Network_Vlan” will accept the following identifier formats: <ul> <li>An entirely numeric value will be treated as a SoftLayer_Network_Vlan.id value of the desired VLAN object.</li> <li>A semantic VLAN identifier of the form &lt;data center short name&gt;.&lt;router&gt;.&lt;vlan number&gt;, where &lt; and &gt; are literal, eg. dal13.fcr01.1234 - the router name may optionally contain the 'a' or 'b' redundancy qualifier (which has no meaning in this context).</li> </ul>

”SoftLayer_Hardware_Server” will accept the following identifier formats: <ul> <li>An entirely numeric value will be treated as a SoftLayer_Hardware_Server.id value of the desired server.</li> <li>A UUID corresponding to a server's SoftLayer_Hardware_Server.globalIdentifier.</li> <li>A value corresponding to a unique SoftLayer_Hardware_Server.hostname.</li> <li>A value corresponding to a unique fully-qualified domain name in the format 'hostname&lt;domain&gt;' where &lt; and &gt; are literal, e.g. myhost&lt;mydomain.com&gt;, hostname refers to SoftLayer_Hardware_Server.hostname and domain to SoftLayer_Hardware_Server.domain, respectively.</li> </ul>

”SoftLayer_Virtual_Guest” will accept the following identifier formats: <ul> <li>An entirely numeric value will be treated as a SoftLayer_Virtual_Guest.id value of the desired server.</li> <li>A UUID corresponding to a server's SoftLayer_Virtual_Guest.globalIdentifier.</li> <li>A value corresponding to a unique SoftLayer_Virtual_Guest.hostname.</li> <li>A value corresponding to a unique fully-qualified domain name in the format 'hostname&lt;domain&gt;' where &lt; and &gt; are literal, e.g. myhost&lt;mydomain.com&gt;, hostname refers to SoftLayer_Virtual_Guest.hostname and domain to SoftLayer_Virtual_Guest.domain, respectively.</li> </ul>

The routing destination result of specifying a SoftLayer_Hardware_Server or SoftLayer_Virtual_Guest type will be the primary IP address of the server for the same network segment the subnet is on. Thus, a public subnet will be routed to the server's public, primary IP address. Additionally, this IP address resolution will match the subnet's IP version; routing a IPv6 subnet to a server will result in selection of the primary IPv6 address of the respective network segment, if available.

Subnets may only be routed to the IP version they themselves represent. That means an IPv4 subnet can only be routed to IPv4 addresses. Any type/identifier combination that resolves to an IP address must be able to locate an IP address of the same version as the subnet being routed.

When routing to an IP address on a Primary subnet, only those addresses actively assigned to resources may be targeted. Additionally, the network, gateway, or broadcast address of any Portable subnet may not be a routing destination. For some VLANs utilizing the HSRP redundancy strategy, there are additional addresses which cannot be a route destination.

When routing a subnet that is already routed, note that the subnet first has its route removed; this procedure is the same as what will occur when using SoftLayer_Network_Subnet::clearRoute. Special consideration should be made for subnets routed as Portable. Please refer to the documentation for SoftLayer_Network_Subnet::clearRoute for details.

The behavior of this interface is such that either true or false is returned. A response of false indicates the route request would not result in the route of the subnet changing; attempts to route the subnet to the same destination, even if identified by differing means, will result in no changes. A result of false can be interpreted as the route request having already been completed. In contrast, a result of true means the requested destination is different from the current destination and the subnet's routing will be transitioned. This route change is asynchronous to the request. A response of true does not mean the subnet's route has changed, but simply that it will change. In order to monitor for the completion of the change, you may either attempt a route change again until the result is false, or monitor one or more SoftLayer_Network_Subnet properties: subnetType, networkVlanId, and or endPointIpAddress to determine if routing of the subnet has become the desired route destination.

Use of this operation is limited to a single active request per subnet. If a previous route request is not yet complete, a "not ready" message will be returned upon subsequent requests.

func (Network_Subnet) SetTags added in v1.0.2 

func (r Network_Subnet) SetTags(tags *string) (resp bool, err error)

Tag a subnet by passing in one or more tags separated by a comma. Any existing tags you wish to keep should be included in the set of tags, as any missing tags will be removed. To remove all tags from the subnet, send an empty string.

type Network_Subnet_IpAddress 

type Network_Subnet_IpAddress struct {
	Session session.SLSession
	Options sl.Options
}

The SoftLayer_Network_Subnet_IpAddress data type contains general information relating to a single SoftLayer IPv4 address.

func GetNetworkSubnetIpAddressService 

func GetNetworkSubnetIpAddressService(sess session.SLSession) Network_Subnet_IpAddress

GetNetworkSubnetIpAddressService returns an instance of the Network_Subnet_IpAddress SoftLayer service

func (Network_Subnet_IpAddress) AllowAccessToNetworkStorage 

func (r Network_Subnet_IpAddress) AllowAccessToNetworkStorage(networkStorageTemplateObject *datatypes.Network_Storage) (resp bool, err error)

This method is used to allow access to a SoftLayer_Network_Storage volume that supports host- or network-level access control.

func (Network_Subnet_IpAddress) AllowAccessToNetworkStorageList 

func (r Network_Subnet_IpAddress) AllowAccessToNetworkStorageList(networkStorageTemplateObjects []datatypes.Network_Storage) (resp bool, err error)

This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support host- or network-level access control.

func (Network_Subnet_IpAddress) EditObject 

func (r Network_Subnet_IpAddress) EditObject(templateObject *datatypes.Network_Subnet_IpAddress) (resp bool, err error)

Edit a subnet IP address.

func (Network_Subnet_IpAddress) EditObjects 

func (r Network_Subnet_IpAddress) EditObjects(templateObjects []datatypes.Network_Subnet_IpAddress) (resp bool, err error)

This function is used to edit multiple objects at the same time.

func (Network_Subnet_IpAddress) Filter 

func (r Network_Subnet_IpAddress) Filter(filter string) Network_Subnet_IpAddress

func (Network_Subnet_IpAddress) FindByIpv4Address 

func (r Network_Subnet_IpAddress) FindByIpv4Address(ipAddress *string) (resp datatypes.Network_Subnet_IpAddress, err error)

Search for an IP address record by IPv4 address.

func (Network_Subnet_IpAddress) FindUsage added in v1.1.3 

func (r Network_Subnet_IpAddress) FindUsage() (resp []datatypes.Network_Subnet_IpAddress_UsageDetail, err error)

Returns a list of IP address assignment details. Only assigned IP addresses are reported on. IP address assignments are presently only recorded and available for Primary Subnets and their IP addresses.

Details on the resource assigned to each IP address will only be provided to users with access to the underlying resource. If the user cannot access the resource, a detail record will still be returned for the assignment but without any accompanying resource data.

Callers may provide a SoftLayer_Network_Subnet_IpAddress object filter as search criteria. A result limit and offset may also be provided. A maximum of 1024 results can be retrieved at a time.

func (Network_Subnet_IpAddress) GetAllowedHost 

func (r Network_Subnet_IpAddress) GetAllowedHost() (resp datatypes.Network_Storage_Allowed_Host, err error)

Retrieve The SoftLayer_Network_Storage_Allowed_Host information to connect this IP Address to Network Storage supporting access control lists.

func (Network_Subnet_IpAddress) GetAllowedNetworkStorage 

func (r Network_Subnet_IpAddress) GetAllowedNetworkStorage() (resp []datatypes.Network_Storage, err error)

Retrieve The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to.

func (Network_Subnet_IpAddress) GetAllowedNetworkStorageReplicas 

func (r Network_Subnet_IpAddress) GetAllowedNetworkStorageReplicas() (resp []datatypes.Network_Storage, err error)

Retrieve The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to.

func (Network_Subnet_IpAddress) GetApplicationDeliveryController 

func (r Network_Subnet_IpAddress) GetApplicationDeliveryController() (resp datatypes.Network_Application_Delivery_Controller, err error)

Retrieve The application delivery controller using this address.

func (Network_Subnet_IpAddress) GetAttachedNetworkStorages 

func (r Network_Subnet_IpAddress) GetAttachedNetworkStorages(nasType *string) (resp []datatypes.Network_Storage, err error)

This method is retrieve a list of SoftLayer_Network_Storage volumes that are authorized access to this SoftLayer_Network_Subnet_IpAddress.

func (Network_Subnet_IpAddress) GetAvailableNetworkStorages 

func (r Network_Subnet_IpAddress) GetAvailableNetworkStorages(nasType *string) (resp []datatypes.Network_Storage, err error)

This method retrieves a list of SoftLayer_Network_Storage volumes that can be authorized to this SoftLayer_Network_Subnet_IpAddress.

func (Network_Subnet_IpAddress) GetByIpAddress 

func (r Network_Subnet_IpAddress) GetByIpAddress(ipAddress *string) (resp datatypes.Network_Subnet_IpAddress, err error)

Search for an IP address record by IP address.

func (Network_Subnet_IpAddress) GetContextTunnelTranslations 

func (r Network_Subnet_IpAddress) GetContextTunnelTranslations() (resp []datatypes.Network_Tunnel_Module_Context_Address_Translation, err error)

Retrieve An IPSec network tunnel's address translations. These translations use a SoftLayer ip address from an assigned static NAT subnet to deliver the packets to the remote (customer) destination.

func (Network_Subnet_IpAddress) GetEndpointSubnets 

func (r Network_Subnet_IpAddress) GetEndpointSubnets() (resp []datatypes.Network_Subnet, err error)

Retrieve All the subnets routed to an IP address.

func (Network_Subnet_IpAddress) GetGuestNetworkComponent 

func (r Network_Subnet_IpAddress) GetGuestNetworkComponent() (resp datatypes.Virtual_Guest_Network_Component, err error)

Retrieve A network component that is statically routed to an IP address.

func (Network_Subnet_IpAddress) GetGuestNetworkComponentBinding 

func (r Network_Subnet_IpAddress) GetGuestNetworkComponentBinding() (resp datatypes.Virtual_Guest_Network_Component_IpAddress, err error)

Retrieve A network component that is statically routed to an IP address.

func (Network_Subnet_IpAddress) GetHardware 

func (r Network_Subnet_IpAddress) GetHardware() (resp datatypes.Hardware, err error)

Retrieve A server that this IP address is routed to.

func (Network_Subnet_IpAddress) GetNetworkComponent 

func (r Network_Subnet_IpAddress) GetNetworkComponent() (resp datatypes.Network_Component, err error)

Retrieve A network component that is statically routed to an IP address.

func (Network_Subnet_IpAddress) GetObject 

func (r Network_Subnet_IpAddress) GetObject() (resp datatypes.Network_Subnet_IpAddress, err error)

getObject retrieves the SoftLayer_Network_Subnet_IpAddress object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Network_Subnet_IpAddress service. You can only retrieve the IP address whose subnet is associated with a VLAN that is associated with the account that your portal user is assigned to.

func (Network_Subnet_IpAddress) GetPrivateNetworkGateway 

func (r Network_Subnet_IpAddress) GetPrivateNetworkGateway() (resp datatypes.Network_Gateway, err error)

Retrieve The network gateway appliance using this address as the private IP address.

func (Network_Subnet_IpAddress) GetProtectionAddress 

func (r Network_Subnet_IpAddress) GetProtectionAddress() (resp []datatypes.Network_Protection_Address, err error)

Retrieve

func (Network_Subnet_IpAddress) GetPublicNetworkGateway 

func (r Network_Subnet_IpAddress) GetPublicNetworkGateway() (resp datatypes.Network_Gateway, err error)

Retrieve The network gateway appliance using this address as the public IP address.

func (Network_Subnet_IpAddress) GetRemoteManagementNetworkComponent 

func (r Network_Subnet_IpAddress) GetRemoteManagementNetworkComponent() (resp datatypes.Network_Component, err error)

Retrieve An IPMI-based management network component of the IP address.

func (Network_Subnet_IpAddress) GetSubnet 

func (r Network_Subnet_IpAddress) GetSubnet() (resp datatypes.Network_Subnet, err error)

Retrieve An IP address' associated subnet.

func (Network_Subnet_IpAddress) GetSyslogEventsOneDay 

func (r Network_Subnet_IpAddress) GetSyslogEventsOneDay() (resp []datatypes.Network_Logging_Syslog, err error)

Retrieve All events for this IP address stored in the datacenter syslogs from the last 24 hours

func (Network_Subnet_IpAddress) GetSyslogEventsSevenDays 

func (r Network_Subnet_IpAddress) GetSyslogEventsSevenDays() (resp []datatypes.Network_Logging_Syslog, err error)

Retrieve All events for this IP address stored in the datacenter syslogs from the last 7 days

func (Network_Subnet_IpAddress) GetTopTenSyslogEventsByDestinationPortOneDay 

func (r Network_Subnet_IpAddress) GetTopTenSyslogEventsByDestinationPortOneDay() (resp []datatypes.Network_Logging_Syslog, err error)

Retrieve Top Ten network datacenter syslog events, grouped by destination port, for the last 24 hours

func (Network_Subnet_IpAddress) GetTopTenSyslogEventsByDestinationPortSevenDays 

func (r Network_Subnet_IpAddress) GetTopTenSyslogEventsByDestinationPortSevenDays() (resp []datatypes.Network_Logging_Syslog, err error)

Retrieve Top Ten network datacenter syslog events, grouped by destination port, for the last 7 days

func (Network_Subnet_IpAddress) GetTopTenSyslogEventsByProtocolsOneDay 

func (r Network_Subnet_IpAddress) GetTopTenSyslogEventsByProtocolsOneDay() (resp []datatypes.Network_Logging_Syslog, err error)

Retrieve Top Ten network datacenter syslog events, grouped by source port, for the last 24 hours

func (Network_Subnet_IpAddress) GetTopTenSyslogEventsByProtocolsSevenDays 

func (r Network_Subnet_IpAddress) GetTopTenSyslogEventsByProtocolsSevenDays() (resp []datatypes.Network_Logging_Syslog, err error)

Retrieve Top Ten network datacenter syslog events, grouped by source port, for the last 7 days

func (Network_Subnet_IpAddress) GetTopTenSyslogEventsBySourceIpOneDay 

func (r Network_Subnet_IpAddress) GetTopTenSyslogEventsBySourceIpOneDay() (resp []datatypes.Network_Logging_Syslog, err error)

Retrieve Top Ten network datacenter syslog events, grouped by source ip address, for the last 24 hours

func (Network_Subnet_IpAddress) GetTopTenSyslogEventsBySourceIpSevenDays 

func (r Network_Subnet_IpAddress) GetTopTenSyslogEventsBySourceIpSevenDays() (resp []datatypes.Network_Logging_Syslog, err error)

Retrieve Top Ten network datacenter syslog events, grouped by source ip address, for the last 7 days

func (Network_Subnet_IpAddress) GetTopTenSyslogEventsBySourcePortOneDay 

func (r Network_Subnet_IpAddress) GetTopTenSyslogEventsBySourcePortOneDay() (resp []datatypes.Network_Logging_Syslog, err error)

Retrieve Top Ten network datacenter syslog events, grouped by source port, for the last 24 hours

func (Network_Subnet_IpAddress) GetTopTenSyslogEventsBySourcePortSevenDays 

func (r Network_Subnet_IpAddress) GetTopTenSyslogEventsBySourcePortSevenDays() (resp []datatypes.Network_Logging_Syslog, err error)

Retrieve Top Ten network datacenter syslog events, grouped by source port, for the last 7 days

func (Network_Subnet_IpAddress) GetVirtualGuest 

func (r Network_Subnet_IpAddress) GetVirtualGuest() (resp datatypes.Virtual_Guest, err error)

Retrieve A virtual guest that this IP address is routed to.

func (Network_Subnet_IpAddress) GetVirtualLicenses 

func (r Network_Subnet_IpAddress) GetVirtualLicenses() (resp []datatypes.Software_VirtualLicense, err error)

Retrieve Virtual licenses allocated for an IP Address.

func (Network_Subnet_IpAddress) Id 

func (r Network_Subnet_IpAddress) Id(id int) Network_Subnet_IpAddress

func (Network_Subnet_IpAddress) Limit 

func (r Network_Subnet_IpAddress) Limit(limit int) Network_Subnet_IpAddress

func (Network_Subnet_IpAddress) Mask 

func (r Network_Subnet_IpAddress) Mask(mask string) Network_Subnet_IpAddress

func (Network_Subnet_IpAddress) Offset 

func (r Network_Subnet_IpAddress) Offset(offset int) Network_Subnet_IpAddress

func (Network_Subnet_IpAddress) RemoveAccessToNetworkStorageList 

func (r Network_Subnet_IpAddress) RemoveAccessToNetworkStorageList(networkStorageTemplateObjects []datatypes.Network_Storage) (resp bool, err error)

This method is used to remove access to multiple SoftLayer_Network_Storage volumes

type Network_Subnet_IpAddress_Global 

type Network_Subnet_IpAddress_Global struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetNetworkSubnetIpAddressGlobalService 

func GetNetworkSubnetIpAddressGlobalService(sess session.SLSession) Network_Subnet_IpAddress_Global

GetNetworkSubnetIpAddressGlobalService returns an instance of the Network_Subnet_IpAddress_Global SoftLayer service

func (Network_Subnet_IpAddress_Global) Filter 

func (r Network_Subnet_IpAddress_Global) Filter(filter string) Network_Subnet_IpAddress_Global

func (Network_Subnet_IpAddress_Global) GetAccount 

func (r Network_Subnet_IpAddress_Global) GetAccount() (resp datatypes.Account, err error)

Retrieve

func (Network_Subnet_IpAddress_Global) GetActiveTransaction 

func (r Network_Subnet_IpAddress_Global) GetActiveTransaction() (resp datatypes.Provisioning_Version1_Transaction, err error)

Retrieve DEPRECATED

func (Network_Subnet_IpAddress_Global) GetBillingItem 

func (r Network_Subnet_IpAddress_Global) GetBillingItem() (resp datatypes.Billing_Item_Network_Subnet_IpAddress_Global, err error)

Retrieve The billing item for this Global IP.

func (Network_Subnet_IpAddress_Global) GetDestinationIpAddress 

func (r Network_Subnet_IpAddress_Global) GetDestinationIpAddress() (resp datatypes.Network_Subnet_IpAddress, err error)

Retrieve

func (Network_Subnet_IpAddress_Global) GetIpAddress 

func (r Network_Subnet_IpAddress_Global) GetIpAddress() (resp datatypes.Network_Subnet_IpAddress, err error)

Retrieve

func (Network_Subnet_IpAddress_Global) GetObject 

func (r Network_Subnet_IpAddress_Global) GetObject() (resp datatypes.Network_Subnet_IpAddress_Global, err error)

no documentation yet

func (Network_Subnet_IpAddress_Global) Id 

func (r Network_Subnet_IpAddress_Global) Id(id int) Network_Subnet_IpAddress_Global

func (Network_Subnet_IpAddress_Global) Limit 

func (r Network_Subnet_IpAddress_Global) Limit(limit int) Network_Subnet_IpAddress_Global

func (Network_Subnet_IpAddress_Global) Mask 

func (r Network_Subnet_IpAddress_Global) Mask(mask string) Network_Subnet_IpAddress_Global

func (Network_Subnet_IpAddress_Global) Offset 

func (r Network_Subnet_IpAddress_Global) Offset(offset int) Network_Subnet_IpAddress_Global

func (Network_Subnet_IpAddress_Global) Route 

func (r Network_Subnet_IpAddress_Global) Route(newEndPointIpAddress *string) (resp bool, err error)

***DEPRECATED*** This endpoint is deprecated in favor of the more expressive and capable SoftLayer_Network_Subnet::route, to which this endpoint now proxies. Refer to it for more information.

Similarly, unroute requests are proxied to SoftLayer_Network_Subnet::clearRoute. Deprecated: This function has been marked as deprecated.

func (Network_Subnet_IpAddress_Global) Unroute 

func (r Network_Subnet_IpAddress_Global) Unroute() (resp bool, err error)

***DEPRECATED*** This endpoint is deprecated in favor of SoftLayer_Network_Subnet::clearRoute, to which this endpoint now proxies. Refer to it for more information. Deprecated: This function has been marked as deprecated.

type Network_Tunnel_Module_Context 

type Network_Tunnel_Module_Context struct {
	Session session.SLSession
	Options sl.Options
}

DEPRECATED Deprecated: This function has been marked as deprecated.

func GetNetworkTunnelModuleContextService 

func GetNetworkTunnelModuleContextService(sess session.SLSession) Network_Tunnel_Module_Context

GetNetworkTunnelModuleContextService returns an instance of the Network_Tunnel_Module_Context SoftLayer service

func (Network_Tunnel_Module_Context) AddCustomerSubnetToNetworkTunnel 

func (r Network_Tunnel_Module_Context) AddCustomerSubnetToNetworkTunnel(subnetId *int) (resp bool, err error)

Deprecated

func (Network_Tunnel_Module_Context) AddPrivateSubnetToNetworkTunnel 

func (r Network_Tunnel_Module_Context) AddPrivateSubnetToNetworkTunnel(subnetId *int) (resp bool, err error)

Deprecated Deprecated: This function has been marked as deprecated.

func (Network_Tunnel_Module_Context) AddServiceSubnetToNetworkTunnel 

func (r Network_Tunnel_Module_Context) AddServiceSubnetToNetworkTunnel(subnetId *int) (resp bool, err error)

Deprecated

func (Network_Tunnel_Module_Context) ApplyConfigurationsToDevice 

func (r Network_Tunnel_Module_Context) ApplyConfigurationsToDevice() (resp bool, err error)

Deprecated

func (Network_Tunnel_Module_Context) CreateAddressTranslation 

func (r Network_Tunnel_Module_Context) CreateAddressTranslation(translation *datatypes.Network_Tunnel_Module_Context_Address_Translation) (resp datatypes.Network_Tunnel_Module_Context_Address_Translation, err error)

Deprecated

func (Network_Tunnel_Module_Context) CreateAddressTranslations 

func (r Network_Tunnel_Module_Context) CreateAddressTranslations(translations []datatypes.Network_Tunnel_Module_Context_Address_Translation) (resp []datatypes.Network_Tunnel_Module_Context_Address_Translation, err error)

Deprecated

func (Network_Tunnel_Module_Context) DeleteAddressTranslation 

func (r Network_Tunnel_Module_Context) DeleteAddressTranslation(translationId *int) (resp bool, err error)

Deprecated

func (Network_Tunnel_Module_Context) DownloadAddressTranslationConfigurations 

func (r Network_Tunnel_Module_Context) DownloadAddressTranslationConfigurations() (resp datatypes.Container_Utility_File_Entity, err error)

Deprecated

func (Network_Tunnel_Module_Context) DownloadParameterConfigurations 

func (r Network_Tunnel_Module_Context) DownloadParameterConfigurations() (resp datatypes.Container_Utility_File_Entity, err error)

Deprecated

func (Network_Tunnel_Module_Context) EditAddressTranslation 

func (r Network_Tunnel_Module_Context) EditAddressTranslation(translation *datatypes.Network_Tunnel_Module_Context_Address_Translation) (resp datatypes.Network_Tunnel_Module_Context_Address_Translation, err error)

Deprecated

func (Network_Tunnel_Module_Context) EditAddressTranslations 

func (r Network_Tunnel_Module_Context) EditAddressTranslations(translations []datatypes.Network_Tunnel_Module_Context_Address_Translation) (resp []datatypes.Network_Tunnel_Module_Context_Address_Translation, err error)

Deprecated

func (Network_Tunnel_Module_Context) EditObject 

func (r Network_Tunnel_Module_Context) EditObject(templateObject *datatypes.Network_Tunnel_Module_Context) (resp bool, err error)

Deprecated

func (Network_Tunnel_Module_Context) Filter 

func (r Network_Tunnel_Module_Context) Filter(filter string) Network_Tunnel_Module_Context

func (Network_Tunnel_Module_Context) GetAccount 

func (r Network_Tunnel_Module_Context) GetAccount() (resp datatypes.Account, err error)

Retrieve The account that a network tunnel belongs to.

func (Network_Tunnel_Module_Context) GetActiveTransaction 

func (r Network_Tunnel_Module_Context) GetActiveTransaction() (resp datatypes.Provisioning_Version1_Transaction, err error)

Retrieve DEPRECATED

func (Network_Tunnel_Module_Context) GetAddressTranslationConfigurations 

func (r Network_Tunnel_Module_Context) GetAddressTranslationConfigurations() (resp string, err error)

Deprecated

func (Network_Tunnel_Module_Context) GetAddressTranslations 

func (r Network_Tunnel_Module_Context) GetAddressTranslations() (resp []datatypes.Network_Tunnel_Module_Context_Address_Translation, err error)

Retrieve A network tunnel's address translations.

func (Network_Tunnel_Module_Context) GetAllAvailableServiceSubnets 

func (r Network_Tunnel_Module_Context) GetAllAvailableServiceSubnets() (resp []datatypes.Network_Subnet, err error)

Retrieve Subnets that provide access to SoftLayer services such as the management portal and the SoftLayer API.

func (Network_Tunnel_Module_Context) GetAuthenticationDefault 

func (r Network_Tunnel_Module_Context) GetAuthenticationDefault() (resp string, err error)

Deprecated

func (Network_Tunnel_Module_Context) GetAuthenticationOptions 

func (r Network_Tunnel_Module_Context) GetAuthenticationOptions() (resp []string, err error)

Deprecated

func (Network_Tunnel_Module_Context) GetBillingItem 

func (r Network_Tunnel_Module_Context) GetBillingItem() (resp datatypes.Billing_Item, err error)

Retrieve The current billing item for network tunnel.

func (Network_Tunnel_Module_Context) GetCustomerSubnets 

func (r Network_Tunnel_Module_Context) GetCustomerSubnets() (resp []datatypes.Network_Customer_Subnet, err error)

Retrieve Remote subnets that are allowed access through a network tunnel.

func (Network_Tunnel_Module_Context) GetDatacenter 

func (r Network_Tunnel_Module_Context) GetDatacenter() (resp datatypes.Location, err error)

Retrieve The datacenter location for one end of the network tunnel that allows access to account's private subnets.

func (Network_Tunnel_Module_Context) GetDiffieHellmanGroupDefault 

func (r Network_Tunnel_Module_Context) GetDiffieHellmanGroupDefault() (resp int, err error)

Deprecated

func (Network_Tunnel_Module_Context) GetDiffieHellmanGroupOptions 

func (r Network_Tunnel_Module_Context) GetDiffieHellmanGroupOptions() (resp []int, err error)

Deprecated

func (Network_Tunnel_Module_Context) GetEncryptionDefault 

func (r Network_Tunnel_Module_Context) GetEncryptionDefault() (resp string, err error)

Deprecated

func (Network_Tunnel_Module_Context) GetEncryptionOptions 

func (r Network_Tunnel_Module_Context) GetEncryptionOptions() (resp []string, err error)

Deprecated

func (Network_Tunnel_Module_Context) GetInternalSubnets 

func (r Network_Tunnel_Module_Context) GetInternalSubnets() (resp []datatypes.Network_Subnet, err error)

Retrieve Private subnets that can be accessed through the network tunnel.

func (Network_Tunnel_Module_Context) GetKeylifeLimits 

func (r Network_Tunnel_Module_Context) GetKeylifeLimits() (resp []int, err error)

Deprecated

func (Network_Tunnel_Module_Context) GetObject 

func (r Network_Tunnel_Module_Context) GetObject() (resp datatypes.Network_Tunnel_Module_Context, err error)

DEPRECATED

func (Network_Tunnel_Module_Context) GetParameterConfigurationsForCustomerView 

func (r Network_Tunnel_Module_Context) GetParameterConfigurationsForCustomerView() (resp string, err error)

Deprecated

func (Network_Tunnel_Module_Context) GetPhaseOneKeylifeDefault 

func (r Network_Tunnel_Module_Context) GetPhaseOneKeylifeDefault() (resp string, err error)

Deprecated

func (Network_Tunnel_Module_Context) GetPhaseTwoKeylifeDefault 

func (r Network_Tunnel_Module_Context) GetPhaseTwoKeylifeDefault() (resp string, err error)

Deprecated

func (Network_Tunnel_Module_Context) GetServiceSubnets 

func (r Network_Tunnel_Module_Context) GetServiceSubnets() (resp []datatypes.Network_Subnet, err error)

Retrieve Service subnets that can be access through the network tunnel.

func (Network_Tunnel_Module_Context) GetStaticRouteSubnets 

func (r Network_Tunnel_Module_Context) GetStaticRouteSubnets() (resp []datatypes.Network_Subnet, err error)

Retrieve Subnets used for a network tunnel's address translations.

func (Network_Tunnel_Module_Context) GetTransactionHistory 

func (r Network_Tunnel_Module_Context) GetTransactionHistory() (resp []datatypes.Provisioning_Version1_Transaction, err error)

Retrieve DEPRECATED

func (Network_Tunnel_Module_Context) Id 

func (r Network_Tunnel_Module_Context) Id(id int) Network_Tunnel_Module_Context

func (Network_Tunnel_Module_Context) Limit 

func (r Network_Tunnel_Module_Context) Limit(limit int) Network_Tunnel_Module_Context

func (Network_Tunnel_Module_Context) Mask 

func (r Network_Tunnel_Module_Context) Mask(mask string) Network_Tunnel_Module_Context

func (Network_Tunnel_Module_Context) Offset 

func (r Network_Tunnel_Module_Context) Offset(offset int) Network_Tunnel_Module_Context

func (Network_Tunnel_Module_Context) RemoveCustomerSubnetFromNetworkTunnel 

func (r Network_Tunnel_Module_Context) RemoveCustomerSubnetFromNetworkTunnel(subnetId *int) (resp bool, err error)

Deprecated

func (Network_Tunnel_Module_Context) RemovePrivateSubnetFromNetworkTunnel 

func (r Network_Tunnel_Module_Context) RemovePrivateSubnetFromNetworkTunnel(subnetId *int) (resp bool, err error)

Deprecated

func (Network_Tunnel_Module_Context) RemoveServiceSubnetFromNetworkTunnel 

func (r Network_Tunnel_Module_Context) RemoveServiceSubnetFromNetworkTunnel(subnetId *int) (resp bool, err error)

Deprecated

type Network_Vlan 

type Network_Vlan struct {
	Session session.SLSession
	Options sl.Options
}

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)

func GetNetworkVlanService 

func GetNetworkVlanService(sess session.SLSession) Network_Vlan

GetNetworkVlanService returns an instance of the Network_Vlan SoftLayer service

func (Network_Vlan) EditObject 

func (r Network_Vlan) EditObject(templateObject *datatypes.Network_Vlan) (resp bool, err error)

Updates this VLAN using the provided VLAN template.

The following properties may be modified.

- "name" - A description no more than 20 characters in length.

func (Network_Vlan) Filter 

func (r Network_Vlan) Filter(filter string) Network_Vlan

func (Network_Vlan) GetAccount 

func (r Network_Vlan) GetAccount() (resp datatypes.Account, err error)

Retrieve The account this VLAN is associated with.

func (Network_Vlan) GetAdditionalPrimarySubnets 

func (r Network_Vlan) GetAdditionalPrimarySubnets() (resp []datatypes.Network_Subnet, err error)

Retrieve The primary IPv4 subnets routed on this VLAN, excluding the primarySubnet.

func (Network_Vlan) GetAttachedNetworkGateway 

func (r Network_Vlan) GetAttachedNetworkGateway() (resp datatypes.Network_Gateway, err error)

Retrieve The gateway device this VLAN is associated with for routing purposes.

func (Network_Vlan) GetAttachedNetworkGatewayFlag 

func (r Network_Vlan) GetAttachedNetworkGatewayFlag() (resp bool, err error)

Retrieve A value of '1' indicates this VLAN is associated with a gateway device for routing purposes.

func (Network_Vlan) GetAttachedNetworkGatewayVlan 

func (r Network_Vlan) GetAttachedNetworkGatewayVlan() (resp datatypes.Network_Gateway_Vlan, err error)

Retrieve The gateway device VLAN context this VLAN is associated with for routing purposes.

func (Network_Vlan) GetBillingItem 

func (r Network_Vlan) GetBillingItem() (resp datatypes.Billing_Item, err error)

Retrieve The billing item for this VLAN.

func (Network_Vlan) GetCancelFailureReasons 

func (r Network_Vlan) GetCancelFailureReasons() (resp []string, err error)

Evaluates this VLAN for cancellation and returns a list of descriptions why this VLAN may not be cancelled. If the result is empty, this VLAN may be cancelled.

func (Network_Vlan) GetDatacenter added in v1.1.2 

func (r Network_Vlan) GetDatacenter() (resp datatypes.Location, err error)

Retrieve The datacenter this VLAN is associated with.

func (Network_Vlan) GetDedicatedFirewallFlag 

func (r Network_Vlan) GetDedicatedFirewallFlag() (resp int, err error)

Retrieve A value of '1' indicates this VLAN is associated with a firewall device. This does not include Hardware Firewalls.

func (Network_Vlan) GetExtensionRouter 

func (r Network_Vlan) GetExtensionRouter() (resp datatypes.Hardware_Router, err error)

Retrieve [DEPRECATED] The extension router that this VLAN is associated with.

func (Network_Vlan) GetFirewallGuestNetworkComponents 

func (r Network_Vlan) GetFirewallGuestNetworkComponents() (resp []datatypes.Network_Component_Firewall, err error)

Retrieve The VSI network interfaces connected to this VLAN and associated with a Hardware Firewall.

func (Network_Vlan) GetFirewallInterfaces 

func (r Network_Vlan) GetFirewallInterfaces() (resp []datatypes.Network_Firewall_Module_Context_Interface, err error)

Retrieve The context for the firewall device associated with this VLAN.

func (Network_Vlan) GetFirewallNetworkComponents 

func (r Network_Vlan) GetFirewallNetworkComponents() (resp []datatypes.Network_Component_Firewall, err error)

Retrieve The uplinks of the hardware network interfaces connected natively to this VLAN and associated with a Hardware Firewall.

func (Network_Vlan) GetFirewallProtectableIpAddresses 

func (r Network_Vlan) GetFirewallProtectableIpAddresses() (resp []datatypes.Network_Subnet_IpAddress, err error)

*** DEPRECATED *** Retrieves the IP addresses routed on this VLAN that are protectable by a Hardware Firewall. Deprecated: This function has been marked as deprecated.

func (Network_Vlan) GetFirewallProtectableSubnets 

func (r Network_Vlan) GetFirewallProtectableSubnets() (resp []datatypes.Network_Subnet, err error)

*** DEPRECATED *** Retrieves the subnets routed on this VLAN that are protectable by a Hardware Firewall. Deprecated: This function has been marked as deprecated.

func (Network_Vlan) GetFirewallRules 

func (r Network_Vlan) GetFirewallRules() (resp []datatypes.Network_Vlan_Firewall_Rule, err error)

Retrieve The access rules for the firewall device associated with this VLAN.

func (Network_Vlan) GetGuestNetworkComponents 

func (r Network_Vlan) GetGuestNetworkComponents() (resp []datatypes.Virtual_Guest_Network_Component, err error)

Retrieve The VSI network interfaces connected to this VLAN.

func (Network_Vlan) GetHardware 

func (r Network_Vlan) GetHardware() (resp []datatypes.Hardware, err error)

Retrieve The hardware with network interfaces connected natively to this VLAN.

func (Network_Vlan) GetHighAvailabilityFirewallFlag 

func (r Network_Vlan) GetHighAvailabilityFirewallFlag() (resp bool, err error)

Retrieve A value of '1' indicates this VLAN is associated with a firewall device in a high availability configuration.

func (Network_Vlan) GetIpAddressUsage added in v1.1.3 

func (r Network_Vlan) GetIpAddressUsage() (resp []datatypes.Network_Subnet_IpAddress_UsageDetail, err error)

Returns a list of IP address assignment details. Only assigned IP addresses are reported on. IP address assignments are presently only recorded and available for Primary Subnets.

Details on the resource assigned to each IP address will only be provided to users with access to the underlying resource. If the user cannot access the resource, a detail record will still be returned for the assignment but without any accompanying resource data.

func (Network_Vlan) GetLocalDiskStorageCapabilityFlag 

func (r Network_Vlan) GetLocalDiskStorageCapabilityFlag() (resp bool, err error)

Retrieve A value of '1' indicates this VLAN's pod has VSI local disk storage capability.

func (Network_Vlan) GetNetworkComponentTrunks 

func (r Network_Vlan) GetNetworkComponentTrunks() (resp []datatypes.Network_Component_Network_Vlan_Trunk, err error)

Retrieve The hardware network interfaces connected via trunk to this VLAN.

func (Network_Vlan) GetNetworkComponents 

func (r Network_Vlan) GetNetworkComponents() (resp []datatypes.Network_Component, err error)

Retrieve The hardware network interfaces connected natively to this VLAN.

func (Network_Vlan) GetNetworkComponentsTrunkable added in v1.0.4 

func (r Network_Vlan) GetNetworkComponentsTrunkable() (resp []datatypes.Network_Component, err error)

Retrieve 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.

func (Network_Vlan) GetNetworkVlanFirewall 

func (r Network_Vlan) GetNetworkVlanFirewall() (resp datatypes.Network_Vlan_Firewall, err error)

Retrieve The firewall device associated with this VLAN.

func (Network_Vlan) GetObject 

func (r Network_Vlan) GetObject() (resp datatypes.Network_Vlan, err error)

Retrieves a VLAN by its id value. Only VLANs assigned to your account are accessible.

func (Network_Vlan) GetPodName added in v1.1.3 

func (r Network_Vlan) GetPodName() (resp string, err error)

Retrieve The pod this VLAN is associated with.

func (Network_Vlan) GetPrimaryRouter 

func (r Network_Vlan) GetPrimaryRouter() (resp datatypes.Hardware_Router, err error)

Retrieve The router device that this VLAN is associated with.

func (Network_Vlan) GetPrimarySubnet 

func (r Network_Vlan) GetPrimarySubnet() (resp datatypes.Network_Subnet, err error)

Retrieve A primary IPv4 subnet routed on this VLAN, if accessible.

func (Network_Vlan) GetPrimarySubnetVersion6 

func (r Network_Vlan) GetPrimarySubnetVersion6() (resp datatypes.Network_Subnet, err error)

Retrieve The primary IPv6 subnet routed on this VLAN, if IPv6 is enabled.

func (Network_Vlan) GetPrimarySubnets 

func (r Network_Vlan) GetPrimarySubnets() (resp []datatypes.Network_Subnet, err error)

Retrieve All primary subnets routed on this VLAN.

func (Network_Vlan) GetPrivateNetworkGateways 

func (r Network_Vlan) GetPrivateNetworkGateways() (resp []datatypes.Network_Gateway, err error)

Retrieve The gateway devices with connectivity supported by this private VLAN.

func (Network_Vlan) GetPrivateVlan 

func (r Network_Vlan) GetPrivateVlan() (resp datatypes.Network_Vlan, err error)

*** DEPRECATED *** Retrieves a private VLAN associated to one or more hosts also associated to this public VLAN. Deprecated: This function has been marked as deprecated.

func (Network_Vlan) GetPrivateVlanByIpAddress 

func (r Network_Vlan) GetPrivateVlanByIpAddress(ipAddress *string) (resp datatypes.Network_Vlan, err error)

*** DEPRECATED *** Retrieve the private network VLAN associated with an IP address. Deprecated: This function has been marked as deprecated.

func (Network_Vlan) GetProtectedIpAddresses 

func (r Network_Vlan) GetProtectedIpAddresses() (resp []datatypes.Network_Subnet_IpAddress, err error)

Retrieve IP addresses routed on this VLAN which are actively associated with network protections.

func (Network_Vlan) GetPublicNetworkGateways 

func (r Network_Vlan) GetPublicNetworkGateways() (resp []datatypes.Network_Gateway, err error)

Retrieve The gateway devices with connectivity supported by this public VLAN.

func (Network_Vlan) GetPublicVlanByFqdn 

func (r Network_Vlan) GetPublicVlanByFqdn(fqdn *string) (resp datatypes.Network_Vlan, err error)

*** DEPRECATED *** Retrieves a public VLAN associated to the host matched by the given fully-qualified domain name. Deprecated: This function has been marked as deprecated.

func (Network_Vlan) GetReverseDomainRecords 

func (r Network_Vlan) GetReverseDomainRecords() (resp []datatypes.Dns_Domain, err error)

*** DEPRECATED *** Retrieves DNS PTR records associated with IP addresses routed on this VLAN. Results will be grouped by DNS domain with the "resourceRecords" property populated. Deprecated: This function has been marked as deprecated.

func (Network_Vlan) GetSanStorageCapabilityFlag 

func (r Network_Vlan) GetSanStorageCapabilityFlag() (resp bool, err error)

Retrieve A value of '1' indicates this VLAN's pod has VSI SAN disk storage capability.

func (Network_Vlan) GetSecondaryRouter 

func (r Network_Vlan) GetSecondaryRouter() (resp datatypes.Hardware, err error)

Retrieve [DEPRECATED] The secondary router device that this VLAN is associated with.

func (Network_Vlan) GetSecondarySubnets 

func (r Network_Vlan) GetSecondarySubnets() (resp []datatypes.Network_Subnet, err error)

Retrieve All non-primary subnets routed on this VLAN.

func (Network_Vlan) GetSubnets 

func (r Network_Vlan) GetSubnets() (resp []datatypes.Network_Subnet, err error)

Retrieve All subnets routed on this VLAN.

func (Network_Vlan) GetTagReferences 

func (r Network_Vlan) GetTagReferences() (resp []datatypes.Tag_Reference, err error)

Retrieve The tags associated to this VLAN.

func (Network_Vlan) GetTotalPrimaryIpAddressCount 

func (r Network_Vlan) GetTotalPrimaryIpAddressCount() (resp uint, err error)

Retrieve The number of primary IPv4 addresses routed on this VLAN.

func (Network_Vlan) GetType 

func (r Network_Vlan) GetType() (resp datatypes.Network_Vlan_Type, err error)

Retrieve The type for this VLAN, with the following values: STANDARD, GATEWAY, INTERCONNECT

func (Network_Vlan) GetVirtualGuests 

func (r Network_Vlan) GetVirtualGuests() (resp []datatypes.Virtual_Guest, err error)

Retrieve The VSIs with network interfaces connected to this VLAN.

func (Network_Vlan) GetVlanForIpAddress 

func (r Network_Vlan) GetVlanForIpAddress(ipAddress *string) (resp datatypes.Network_Vlan, err error)

Retrieves the VLAN on which the given IP address is routed.

func (Network_Vlan) Id 

func (r Network_Vlan) Id(id int) Network_Vlan

func (Network_Vlan) Limit 

func (r Network_Vlan) Limit(limit int) Network_Vlan

func (Network_Vlan) Mask 

func (r Network_Vlan) Mask(mask string) Network_Vlan

func (Network_Vlan) Offset 

func (r Network_Vlan) Offset(offset int) Network_Vlan

func (Network_Vlan) SetTags 

func (r Network_Vlan) SetTags(tags *string) (resp bool, err error)

Tag a VLAN by passing in one or more tags separated by a comma. Tag references are cleared out every time this method is called. If your VLAN is already tagged you will need to pass the current tags along with any new ones. To remove all tag references pass an empty string. To remove one or more tags omit them from the tag list.

func (Network_Vlan) UpdateFirewallIntraVlanCommunication 

func (r Network_Vlan) UpdateFirewallIntraVlanCommunication(enabled *bool) (err error)

*** DEPRECATED *** Updates the firewall associated to this VLAN to allow or disallow intra-VLAN communication. Deprecated: This function has been marked as deprecated.

func (Network_Vlan) Upgrade 

func (r Network_Vlan) Upgrade() (resp datatypes.Container_Product_Order_Network_Vlan, err error)

Converts this VLAN to a paid resource. This can be done for any Automatic VLAN. This operation can only be executed on an Automatic VLAN, and will transition it to being a Premium VLAN. The VLAN will then provide the benefits of a Premium VLAN. A Premium VLAN will remain on the account until cancelled. This operation cannot be undone! Once a VLAN becomes Premium, it can only be removed through cancellation, which will result in it being reclaimed.

This operation is a convenience for utilizing the SoftLayer_Product_Order.placeOrder operation. It will place an order to upgrade the VLAN it is executed against. It will take a few moments for the order to be processed and the upgrade to complete. Note that the order is placed in such a way that any account state which prevents automatic order approval will prevent the order from being placed. Thus, if no error is received, the order was placed and approved, and the VLAN will be upgraded shortly.

type Network_Vlan_Firewall 

type Network_Vlan_Firewall struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetNetworkVlanFirewallService 

func GetNetworkVlanFirewallService(sess session.SLSession) Network_Vlan_Firewall

GetNetworkVlanFirewallService returns an instance of the Network_Vlan_Firewall SoftLayer service

func (Network_Vlan_Firewall) ApproveBypassRequest 

func (r Network_Vlan_Firewall) ApproveBypassRequest() (err error)

Approve a request from technical support to bypass the firewall. Once approved, support will be able to route and unroute the VLAN on the firewall.

func (Network_Vlan_Firewall) Filter 

func (r Network_Vlan_Firewall) Filter(filter string) Network_Vlan_Firewall

func (Network_Vlan_Firewall) GetAccountId 

func (r Network_Vlan_Firewall) GetAccountId() (resp int, err error)

Retrieve

func (Network_Vlan_Firewall) GetBandwidthAllocation 

func (r Network_Vlan_Firewall) GetBandwidthAllocation() (resp datatypes.Float64, err error)

Retrieve A firewall's allotted bandwidth (measured in GB).

func (Network_Vlan_Firewall) GetBillingCycleBandwidthUsage 

func (r Network_Vlan_Firewall) GetBillingCycleBandwidthUsage() (resp []datatypes.Network_Bandwidth_Usage, err error)

Retrieve The raw bandwidth usage data for the current billing cycle. One object will be returned for each network this firewall is attached to.

func (Network_Vlan_Firewall) GetBillingCyclePrivateBandwidthUsage 

func (r Network_Vlan_Firewall) GetBillingCyclePrivateBandwidthUsage() (resp datatypes.Network_Bandwidth_Usage, err error)

Retrieve The raw private bandwidth usage data for the current billing cycle.

func (Network_Vlan_Firewall) GetBillingCyclePublicBandwidthUsage 

func (r Network_Vlan_Firewall) GetBillingCyclePublicBandwidthUsage() (resp datatypes.Network_Bandwidth_Usage, err error)

Retrieve The raw public bandwidth usage data for the current billing cycle.

func (Network_Vlan_Firewall) GetBillingItem 

func (r Network_Vlan_Firewall) GetBillingItem() (resp datatypes.Billing_Item, err error)

Retrieve The billing item for a Hardware Firewall (Dedicated).

func (Network_Vlan_Firewall) GetBypassRequestStatus 

func (r Network_Vlan_Firewall) GetBypassRequestStatus() (resp string, err error)

Retrieve Administrative bypass request status.

func (Network_Vlan_Firewall) GetDatacenter 

func (r Network_Vlan_Firewall) GetDatacenter() (resp datatypes.Location, err error)

Retrieve The datacenter that the firewall resides in.

func (Network_Vlan_Firewall) GetFirewallFirmwareVersion added in v1.0.4 

func (r Network_Vlan_Firewall) GetFirewallFirmwareVersion() (resp string, err error)

Retrieve the firewall device firmware version from database.

func (Network_Vlan_Firewall) GetFirewallType 

func (r Network_Vlan_Firewall) GetFirewallType() (resp string, err error)

Retrieve The firewall device type.

func (Network_Vlan_Firewall) GetFullyQualifiedDomainName 

func (r Network_Vlan_Firewall) GetFullyQualifiedDomainName() (resp string, err error)

Retrieve A name reflecting the hostname and domain of the firewall. This is created from the combined values of the firewall's logical name and vlan number automatically, and thus can not be edited directly.

func (Network_Vlan_Firewall) GetManagementCredentials 

func (r Network_Vlan_Firewall) GetManagementCredentials() (resp datatypes.Software_Component_Password, err error)

Retrieve The credentials to log in to a firewall device. This is only present for dedicated appliances.

func (Network_Vlan_Firewall) GetMetricTrackingObject 

func (r Network_Vlan_Firewall) GetMetricTrackingObject() (resp datatypes.Metric_Tracking_Object, err error)

Retrieve A firewall's metric tracking object.

func (Network_Vlan_Firewall) GetMetricTrackingObjectId 

func (r Network_Vlan_Firewall) GetMetricTrackingObjectId() (resp int, err error)

Retrieve The metric tracking object ID for this firewall.

func (Network_Vlan_Firewall) GetNetworkFirewallUpdateRequests 

func (r Network_Vlan_Firewall) GetNetworkFirewallUpdateRequests() (resp []datatypes.Network_Firewall_Update_Request, err error)

Retrieve The update requests made for this firewall.

func (Network_Vlan_Firewall) GetNetworkGateway 

func (r Network_Vlan_Firewall) GetNetworkGateway() (resp datatypes.Network_Gateway, err error)

Retrieve The gateway associated with this firewall, if any.

func (Network_Vlan_Firewall) GetNetworkVlan 

func (r Network_Vlan_Firewall) GetNetworkVlan() (resp datatypes.Network_Vlan, err error)

Retrieve The VLAN object that a firewall is associated with and protecting.

func (Network_Vlan_Firewall) GetNetworkVlans 

func (r Network_Vlan_Firewall) GetNetworkVlans() (resp []datatypes.Network_Vlan, err error)

Retrieve The VLAN objects that a firewall is associated with and protecting.

func (Network_Vlan_Firewall) GetObject 

func (r Network_Vlan_Firewall) GetObject() (resp datatypes.Network_Vlan_Firewall, err error)

getObject returns a SoftLayer_Network_Vlan_Firewall object. You can only get objects for vlans attached to your account that have a network firewall enabled.

func (Network_Vlan_Firewall) GetRules 

func (r Network_Vlan_Firewall) GetRules() (resp []datatypes.Network_Vlan_Firewall_Rule, err error)

Retrieve The currently running rule set of this network component firewall.

func (Network_Vlan_Firewall) GetTagReferences 

func (r Network_Vlan_Firewall) GetTagReferences() (resp []datatypes.Tag_Reference, err error)

Retrieve

func (Network_Vlan_Firewall) GetUpgradeRequest 

func (r Network_Vlan_Firewall) GetUpgradeRequest() (resp datatypes.Product_Upgrade_Request, err error)

Retrieve A firewall's associated upgrade request object, if any.

func (Network_Vlan_Firewall) HasActiveTransactions added in v1.0.4 

func (r Network_Vlan_Firewall) HasActiveTransactions() (resp bool, err error)

Check for active transactions for the Firewall.

func (Network_Vlan_Firewall) Id 

func (r Network_Vlan_Firewall) Id(id int) Network_Vlan_Firewall

func (Network_Vlan_Firewall) IsAccountAllowed added in v1.0.4 

func (r Network_Vlan_Firewall) IsAccountAllowed() (resp bool, err error)

Checks if the account is allowed to use some features of FSA1G and Hardware firewall (Dedicated)

func (Network_Vlan_Firewall) IsHighAvailabilityUpgradeAvailable 

func (r Network_Vlan_Firewall) IsHighAvailabilityUpgradeAvailable() (resp bool, err error)

Whether this firewall qualifies for High Availability upgrade.

func (Network_Vlan_Firewall) Limit 

func (r Network_Vlan_Firewall) Limit(limit int) Network_Vlan_Firewall

func (Network_Vlan_Firewall) Mask 

func (r Network_Vlan_Firewall) Mask(mask string) Network_Vlan_Firewall

func (Network_Vlan_Firewall) Offset 

func (r Network_Vlan_Firewall) Offset(offset int) Network_Vlan_Firewall

func (Network_Vlan_Firewall) RejectBypassRequest 

func (r Network_Vlan_Firewall) RejectBypassRequest() (err error)

Reject a request from technical support to bypass the firewall. Once rejected, IBM support will not be able to route and unroute the VLAN on the firewall.

func (Network_Vlan_Firewall) RestoreDefaults 

func (r Network_Vlan_Firewall) RestoreDefaults() (resp datatypes.Provisioning_Version1_Transaction, err error)

This will completely reset the firewall to factory settings. If the firewall is not a FSA 10G appliance an error will occur. Note, this process is performed asynchronously. During the process all traffic will not be routed through the firewall.

func (Network_Vlan_Firewall) SetTags 

func (r Network_Vlan_Firewall) SetTags(tags *string) (resp bool, err error)

This method will associate a comma separated list of tags with this object.

func (Network_Vlan_Firewall) UpdateRouteBypass 

func (r Network_Vlan_Firewall) UpdateRouteBypass(bypass *bool) (resp datatypes.Provisioning_Version1_Transaction, err error)

Enable or disable route bypass for this context. If enabled, this will bypass the firewall entirely and all traffic will be routed directly to the host(s) behind it. If disabled, traffic will flow through the firewall normally. This feature is only available for Hardware Firewall (Dedicated) and dedicated appliances.

type Network_Vlan_Type 

type Network_Vlan_Type struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetNetworkVlanTypeService 

func GetNetworkVlanTypeService(sess session.SLSession) Network_Vlan_Type

GetNetworkVlanTypeService returns an instance of the Network_Vlan_Type SoftLayer service

func (Network_Vlan_Type) Filter 

func (r Network_Vlan_Type) Filter(filter string) Network_Vlan_Type

func (Network_Vlan_Type) GetObject 

func (r Network_Vlan_Type) GetObject() (resp datatypes.Network_Vlan_Type, err error)

no documentation yet

func (Network_Vlan_Type) Id 

func (r Network_Vlan_Type) Id(id int) Network_Vlan_Type

func (Network_Vlan_Type) Limit 

func (r Network_Vlan_Type) Limit(limit int) Network_Vlan_Type

func (Network_Vlan_Type) Mask 

func (r Network_Vlan_Type) Mask(mask string) Network_Vlan_Type

func (Network_Vlan_Type) Offset 

func (r Network_Vlan_Type) Offset(offset int) Network_Vlan_Type

type Notification 

type Notification struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetNotificationService 

func GetNotificationService(sess session.SLSession) Notification

GetNotificationService returns an instance of the Notification SoftLayer service

func (Notification) Filter 

func (r Notification) Filter(filter string) Notification

func (Notification) GetAllObjects 

func (r Notification) GetAllObjects() (resp []datatypes.Notification, err error)

Use this method to retrieve all active notifications that can be subscribed to.

func (Notification) GetObject 

func (r Notification) GetObject() (resp datatypes.Notification, err error)

no documentation yet

func (Notification) GetPreferences 

func (r Notification) GetPreferences() (resp []datatypes.Notification_Preference, err error)

Retrieve The preferences related to the notification. These are preferences are configurable and optional for subscribers to use.

func (Notification) GetRequiredPreferences 

func (r Notification) GetRequiredPreferences() (resp []datatypes.Notification_Preference, err error)

Retrieve The required preferences related to the notification. While configurable, the subscriber does not have the option whether to use the preference.

func (Notification) Id 

func (r Notification) Id(id int) Notification

func (Notification) Limit 

func (r Notification) Limit(limit int) Notification

func (Notification) Mask 

func (r Notification) Mask(mask string) Notification

func (Notification) Offset 

func (r Notification) Offset(offset int) Notification

type Notification_Mobile 

type Notification_Mobile struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetNotificationMobileService 

func GetNotificationMobileService(sess session.SLSession) Notification_Mobile

GetNotificationMobileService returns an instance of the Notification_Mobile SoftLayer service

func (Notification_Mobile) CreateSubscriberForMobileDevice 

func (r Notification_Mobile) CreateSubscriberForMobileDevice(keyName *string, resourceTableId *int, userRecordId *int) (resp bool, err error)

Create a new subscriber for a given resource.

func (Notification_Mobile) Filter 

func (r Notification_Mobile) Filter(filter string) Notification_Mobile

func (Notification_Mobile) GetAllObjects 

func (r Notification_Mobile) GetAllObjects() (resp []datatypes.Notification, err error)

Use this method to retrieve all active notifications that can be subscribed to.

func (Notification_Mobile) GetObject 

func (r Notification_Mobile) GetObject() (resp datatypes.Notification_Mobile, err error)

no documentation yet

func (Notification_Mobile) GetPreferences 

func (r Notification_Mobile) GetPreferences() (resp []datatypes.Notification_Preference, err error)

Retrieve The preferences related to the notification. These are preferences are configurable and optional for subscribers to use.

func (Notification_Mobile) GetRequiredPreferences 

func (r Notification_Mobile) GetRequiredPreferences() (resp []datatypes.Notification_Preference, err error)

Retrieve The required preferences related to the notification. While configurable, the subscriber does not have the option whether to use the preference.

func (Notification_Mobile) Id 

func (r Notification_Mobile) Id(id int) Notification_Mobile

func (Notification_Mobile) Limit 

func (r Notification_Mobile) Limit(limit int) Notification_Mobile

func (Notification_Mobile) Mask 

func (r Notification_Mobile) Mask(mask string) Notification_Mobile

func (Notification_Mobile) Offset 

func (r Notification_Mobile) Offset(offset int) Notification_Mobile

type Notification_Occurrence_Event 

type Notification_Occurrence_Event struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetNotificationOccurrenceEventService 

func GetNotificationOccurrenceEventService(sess session.SLSession) Notification_Occurrence_Event

GetNotificationOccurrenceEventService returns an instance of the Notification_Occurrence_Event SoftLayer service

func (Notification_Occurrence_Event) AcknowledgeNotification 

func (r Notification_Occurrence_Event) AcknowledgeNotification() (resp bool, err error)

<<<< EOT

func (Notification_Occurrence_Event) Filter 

func (r Notification_Occurrence_Event) Filter(filter string) Notification_Occurrence_Event

func (Notification_Occurrence_Event) GetAcknowledgedFlag 

func (r Notification_Occurrence_Event) GetAcknowledgedFlag() (resp bool, err error)

Retrieve Indicates whether or not this event has been acknowledged by the user.

func (Notification_Occurrence_Event) GetAllObjects 

func (r Notification_Occurrence_Event) GetAllObjects() (resp []datatypes.Notification_Occurrence_Event, err error)

no documentation yet

func (Notification_Occurrence_Event) GetAttachedFile 

func (r Notification_Occurrence_Event) GetAttachedFile(attachmentId *int) (resp []byte, err error)

Retrieve the contents of the file attached to a SoftLayer event by it's given identifier.

func (Notification_Occurrence_Event) GetAttachments 

func (r Notification_Occurrence_Event) GetAttachments() (resp []datatypes.Notification_Occurrence_Event_Attachment, err error)

Retrieve A collection of attachments for this event which provide supplementary information to impacted users some examples are RFO (Reason For Outage) and root cause analysis documents.

func (Notification_Occurrence_Event) GetFirstUpdate 

func (r Notification_Occurrence_Event) GetFirstUpdate() (resp datatypes.Notification_Occurrence_Update, err error)

Retrieve The first update for this event.

func (Notification_Occurrence_Event) GetImpactedAccountCount 

func (r Notification_Occurrence_Event) GetImpactedAccountCount() (resp int, err error)

This method will return the number of impacted owned accounts associated with this event for the current user.

func (Notification_Occurrence_Event) GetImpactedAccounts 

func (r Notification_Occurrence_Event) GetImpactedAccounts() (resp []datatypes.Notification_Occurrence_Account, err error)

Retrieve A collection of accounts impacted by this event. Each impacted account record relates directly to a [[SoftLayer_Account]].

func (Notification_Occurrence_Event) GetImpactedDeviceCount 

func (r Notification_Occurrence_Event) GetImpactedDeviceCount() (resp int, err error)

This method will return the number of impacted devices associated with this event for the current user.

func (Notification_Occurrence_Event) GetImpactedDevices 

func (r Notification_Occurrence_Event) GetImpactedDevices() (resp []datatypes.Notification_Occurrence_Resource, err error)

This method will return a collection of SoftLayer_Notification_Occurrence_Resource objects which is a listing of the current users' impacted devices that are associated with this event.

func (Notification_Occurrence_Event) GetImpactedResources 

func (r Notification_Occurrence_Event) GetImpactedResources() (resp []datatypes.Notification_Occurrence_Resource, err error)

Retrieve A collection of resources impacted by this event. Each record will relate to some physical resource that the user has access to such as [[SoftLayer_Hardware]] or [[SoftLayer_Virtual_Guest]].

func (Notification_Occurrence_Event) GetImpactedUsers 

func (r Notification_Occurrence_Event) GetImpactedUsers() (resp []datatypes.Notification_Occurrence_User, err error)

Retrieve A collection of users impacted by this event. Each impacted user record relates directly to a [[SoftLayer_User_Customer]].

func (Notification_Occurrence_Event) GetLastUpdate 

func (r Notification_Occurrence_Event) GetLastUpdate() (resp datatypes.Notification_Occurrence_Update, err error)

Retrieve The last update for this event.

func (Notification_Occurrence_Event) GetNotificationOccurrenceEventType 

func (r Notification_Occurrence_Event) GetNotificationOccurrenceEventType() (resp datatypes.Notification_Occurrence_Event_Type, err error)

Retrieve The type of event such as planned or unplanned maintenance.

func (Notification_Occurrence_Event) GetObject 

func (r Notification_Occurrence_Event) GetObject() (resp datatypes.Notification_Occurrence_Event, err error)

no documentation yet

func (Notification_Occurrence_Event) GetStatusCode 

func (r Notification_Occurrence_Event) GetStatusCode() (resp datatypes.Notification_Occurrence_Status_Code, err error)

Retrieve

func (Notification_Occurrence_Event) GetUpdates 

func (r Notification_Occurrence_Event) GetUpdates() (resp []datatypes.Notification_Occurrence_Update, err error)

Retrieve All updates for this event.

func (Notification_Occurrence_Event) Id 

func (r Notification_Occurrence_Event) Id(id int) Notification_Occurrence_Event

func (Notification_Occurrence_Event) Limit 

func (r Notification_Occurrence_Event) Limit(limit int) Notification_Occurrence_Event

func (Notification_Occurrence_Event) Mask 

func (r Notification_Occurrence_Event) Mask(mask string) Notification_Occurrence_Event

func (Notification_Occurrence_Event) Offset 

func (r Notification_Occurrence_Event) Offset(offset int) Notification_Occurrence_Event

type Notification_Occurrence_User 

type Notification_Occurrence_User struct {
	Session session.SLSession
	Options sl.Options
}

This type contains general information relating to a user that may be impacted by a [[SoftLayer_Notification_Occurrence_Event]].

func GetNotificationOccurrenceUserService 

func GetNotificationOccurrenceUserService(sess session.SLSession) Notification_Occurrence_User

GetNotificationOccurrenceUserService returns an instance of the Notification_Occurrence_User SoftLayer service

func (Notification_Occurrence_User) Acknowledge 

func (r Notification_Occurrence_User) Acknowledge() (resp bool, err error)

no documentation yet

func (Notification_Occurrence_User) Filter 

func (r Notification_Occurrence_User) Filter(filter string) Notification_Occurrence_User

func (Notification_Occurrence_User) GetAllObjects 

func (r Notification_Occurrence_User) GetAllObjects() (resp []datatypes.Notification_Occurrence_User, err error)

no documentation yet

func (Notification_Occurrence_User) GetImpactedDeviceCount 

func (r Notification_Occurrence_User) GetImpactedDeviceCount() (resp int, err error)

no documentation yet

func (Notification_Occurrence_User) GetImpactedResources 

func (r Notification_Occurrence_User) GetImpactedResources() (resp []datatypes.Notification_Occurrence_Resource, err error)

Retrieve A collection of resources impacted by the associated event.

func (Notification_Occurrence_User) GetNotificationOccurrenceEvent 

func (r Notification_Occurrence_User) GetNotificationOccurrenceEvent() (resp datatypes.Notification_Occurrence_Event, err error)

Retrieve The associated event.

func (Notification_Occurrence_User) GetObject 

func (r Notification_Occurrence_User) GetObject() (resp datatypes.Notification_Occurrence_User, err error)

no documentation yet

func (Notification_Occurrence_User) GetUser 

func (r Notification_Occurrence_User) GetUser() (resp datatypes.User_Customer, err error)

Retrieve The impacted user.

func (Notification_Occurrence_User) Id 

func (r Notification_Occurrence_User) Id(id int) Notification_Occurrence_User

func (Notification_Occurrence_User) Limit 

func (r Notification_Occurrence_User) Limit(limit int) Notification_Occurrence_User

func (Notification_Occurrence_User) Mask 

func (r Notification_Occurrence_User) Mask(mask string) Notification_Occurrence_User

func (Notification_Occurrence_User) Offset 

func (r Notification_Occurrence_User) Offset(offset int) Notification_Occurrence_User

type Notification_User_Subscriber 

type Notification_User_Subscriber struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetNotificationUserSubscriberService 

func GetNotificationUserSubscriberService(sess session.SLSession) Notification_User_Subscriber

GetNotificationUserSubscriberService returns an instance of the Notification_User_Subscriber SoftLayer service

func (Notification_User_Subscriber) CreateObject 

func (r Notification_User_Subscriber) CreateObject(templateObject *datatypes.Notification_User_Subscriber) (resp bool, err error)

Use the method to create a new subscription for a notification. This method is the entry method to the notification system. Certain properties are required to create a subscription while others are optional.

The required property is the resourceRecord property which is type SoftLayer_Notification_User_Subscriber_Resource. For the resourceRecord property, the only property that needs to be populated is the resourceTableId. The resourceTableId is the unique identifier of a SoftLayer service to create the subscription for. For example, the unique identifier of the Storage Evault service to create the subscription on.

Optional properties that can be set is the preferences property. The preference property is an array SoftLayer_Notification_User_Subscriber_Preference. By default, the system will populate the preferences with the default values if no preferences are passed in. The preferences passed in must be the preferences related to the notification subscribing to. The notification preferences and preference details (such as minimum and maximum values) can be retrieved using the SoftLayer_Notification service. The properties that need to be populated for preferences are the notificationPreferenceId and value.

For example to create a subscriber for a Storage EVault service to be notified 15 times during a billing cycle and to be notified when the vault usage reaches 85% of its allowed capacity use the following structure:

*userRecordId = 1111 *notificationId = 3 *resourceRecord **resourceTableId = 1234 *preferences[1] **notificationPreferenceId = 2 **value = 85 *preference[2] **notificationPreferenceId = 3 **value = 15

func (Notification_User_Subscriber) EditObject 

func (r Notification_User_Subscriber) EditObject(templateObject *datatypes.Notification_User_Subscriber) (resp bool, err error)

The subscriber's subscription status can be "turned off" or "turned on" if the subscription is not required.

Subscriber preferences may also be edited. To edit the preferences, you must pass in the id off the preferences to edit. Here is an example of structure to pass in. In this example, the structure will set the subscriber status to active and the threshold preference to 90 and the limit preference to 20

*id = 1111 *active = 1 *preferences[1] **id = 11 **value = 90 *preference[2] **id = 12 **value = 20

func (Notification_User_Subscriber) Filter 

func (r Notification_User_Subscriber) Filter(filter string) Notification_User_Subscriber

func (Notification_User_Subscriber) GetDeliveryMethods 

func (r Notification_User_Subscriber) GetDeliveryMethods() (resp []datatypes.Notification_Delivery_Method, err error)

Retrieve The delivery methods used to send the subscribed notification.

func (Notification_User_Subscriber) GetNotification 

func (r Notification_User_Subscriber) GetNotification() (resp datatypes.Notification, err error)

Retrieve Notification subscribed to.

func (Notification_User_Subscriber) GetObject 

func (r Notification_User_Subscriber) GetObject() (resp datatypes.Notification_User_Subscriber, err error)

no documentation yet

func (Notification_User_Subscriber) GetPreferences 

func (r Notification_User_Subscriber) GetPreferences() (resp []datatypes.Notification_User_Subscriber_Preference, err error)

Retrieve Associated subscriber preferences used for the notification subscription. For example, preferences include number of deliveries (limit) and threshold.

func (Notification_User_Subscriber) GetPreferencesDetails 

func (r Notification_User_Subscriber) GetPreferencesDetails() (resp []datatypes.Notification_Preference, err error)

Retrieve Preference details such as description, minimum and maximum limits, default value and unit of measure.

func (Notification_User_Subscriber) GetResourceRecord 

func (r Notification_User_Subscriber) GetResourceRecord() (resp datatypes.Notification_User_Subscriber_Resource, err error)

Retrieve The subscriber id to resource id mapping.

func (Notification_User_Subscriber) GetUserRecord 

func (r Notification_User_Subscriber) GetUserRecord() (resp datatypes.User_Customer, err error)

Retrieve User record for the subscription.

func (Notification_User_Subscriber) Id 

func (r Notification_User_Subscriber) Id(id int) Notification_User_Subscriber

func (Notification_User_Subscriber) Limit 

func (r Notification_User_Subscriber) Limit(limit int) Notification_User_Subscriber

func (Notification_User_Subscriber) Mask 

func (r Notification_User_Subscriber) Mask(mask string) Notification_User_Subscriber

func (Notification_User_Subscriber) Offset 

func (r Notification_User_Subscriber) Offset(offset int) Notification_User_Subscriber

type Notification_User_Subscriber_Billing 

type Notification_User_Subscriber_Billing struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetNotificationUserSubscriberBillingService 

func GetNotificationUserSubscriberBillingService(sess session.SLSession) Notification_User_Subscriber_Billing

GetNotificationUserSubscriberBillingService returns an instance of the Notification_User_Subscriber_Billing SoftLayer service

func (Notification_User_Subscriber_Billing) CreateObject 

func (r Notification_User_Subscriber_Billing) CreateObject(templateObject *datatypes.Notification_User_Subscriber) (resp bool, err error)

Use the method to create a new subscription for a notification. This method is the entry method to the notification system. Certain properties are required to create a subscription while others are optional.

The required property is the resourceRecord property which is type SoftLayer_Notification_User_Subscriber_Resource. For the resourceRecord property, the only property that needs to be populated is the resourceTableId. The resourceTableId is the unique identifier of a SoftLayer service to create the subscription for. For example, the unique identifier of the Storage Evault service to create the subscription on.

Optional properties that can be set is the preferences property. The preference property is an array SoftLayer_Notification_User_Subscriber_Preference. By default, the system will populate the preferences with the default values if no preferences are passed in. The preferences passed in must be the preferences related to the notification subscribing to. The notification preferences and preference details (such as minimum and maximum values) can be retrieved using the SoftLayer_Notification service. The properties that need to be populated for preferences are the notificationPreferenceId and value.

For example to create a subscriber for a Storage EVault service to be notified 15 times during a billing cycle and to be notified when the vault usage reaches 85% of its allowed capacity use the following structure:

*userRecordId = 1111 *notificationId = 3 *resourceRecord **resourceTableId = 1234 *preferences[1] **notificationPreferenceId = 2 **value = 85 *preference[2] **notificationPreferenceId = 3 **value = 15

func (Notification_User_Subscriber_Billing) EditObject 

func (r Notification_User_Subscriber_Billing) EditObject(templateObject *datatypes.Notification_User_Subscriber) (resp bool, err error)

The subscriber's subscription status can be "turned off" or "turned on" if the subscription is not required.

Subscriber preferences may also be edited. To edit the preferences, you must pass in the id off the preferences to edit. Here is an example of structure to pass in. In this example, the structure will set the subscriber status to active and the threshold preference to 90 and the limit preference to 20

*id = 1111 *active = 1 *preferences[1] **id = 11 **value = 90 *preference[2] **id = 12 **value = 20

func (Notification_User_Subscriber_Billing) Filter 

func (r Notification_User_Subscriber_Billing) Filter(filter string) Notification_User_Subscriber_Billing

func (Notification_User_Subscriber_Billing) GetDeliveryMethods 

func (r Notification_User_Subscriber_Billing) GetDeliveryMethods() (resp []datatypes.Notification_Delivery_Method, err error)

Retrieve The delivery methods used to send the subscribed notification.

func (Notification_User_Subscriber_Billing) GetNotification 

func (r Notification_User_Subscriber_Billing) GetNotification() (resp datatypes.Notification, err error)

Retrieve Notification subscribed to.

func (Notification_User_Subscriber_Billing) GetObject 

func (r Notification_User_Subscriber_Billing) GetObject() (resp datatypes.Notification_User_Subscriber_Billing, err error)

no documentation yet

func (Notification_User_Subscriber_Billing) GetPreferences 

func (r Notification_User_Subscriber_Billing) GetPreferences() (resp []datatypes.Notification_User_Subscriber_Preference, err error)

Retrieve Associated subscriber preferences used for the notification subscription. For example, preferences include number of deliveries (limit) and threshold.

func (Notification_User_Subscriber_Billing) GetPreferencesDetails 

func (r Notification_User_Subscriber_Billing) GetPreferencesDetails() (resp []datatypes.Notification_Preference, err error)

Retrieve Preference details such as description, minimum and maximum limits, default value and unit of measure.

func (Notification_User_Subscriber_Billing) GetResourceRecord 

func (r Notification_User_Subscriber_Billing) GetResourceRecord() (resp datatypes.Notification_User_Subscriber_Resource, err error)

Retrieve The subscriber id to resource id mapping.

func (Notification_User_Subscriber_Billing) GetUserRecord 

func (r Notification_User_Subscriber_Billing) GetUserRecord() (resp datatypes.User_Customer, err error)

Retrieve User record for the subscription.

func (Notification_User_Subscriber_Billing) Id 

func (r Notification_User_Subscriber_Billing) Id(id int) Notification_User_Subscriber_Billing

func (Notification_User_Subscriber_Billing) Limit 

func (r Notification_User_Subscriber_Billing) Limit(limit int) Notification_User_Subscriber_Billing

func (Notification_User_Subscriber_Billing) Mask 

func (r Notification_User_Subscriber_Billing) Mask(mask string) Notification_User_Subscriber_Billing

func (Notification_User_Subscriber_Billing) Offset 

func (r Notification_User_Subscriber_Billing) Offset(offset int) Notification_User_Subscriber_Billing

type Notification_User_Subscriber_Mobile 

type Notification_User_Subscriber_Mobile struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetNotificationUserSubscriberMobileService 

func GetNotificationUserSubscriberMobileService(sess session.SLSession) Notification_User_Subscriber_Mobile

GetNotificationUserSubscriberMobileService returns an instance of the Notification_User_Subscriber_Mobile SoftLayer service

func (Notification_User_Subscriber_Mobile) ClearSnoozeTimer 

func (r Notification_User_Subscriber_Mobile) ClearSnoozeTimer() (resp bool, err error)

no documentation yet

func (Notification_User_Subscriber_Mobile) CreateObject 

func (r Notification_User_Subscriber_Mobile) CreateObject(templateObject *datatypes.Notification_User_Subscriber) (resp bool, err error)

Use the method to create a new subscription for a notification. This method is the entry method to the notification system. Certain properties are required to create a subscription while others are optional.

The required property is the resourceRecord property which is type SoftLayer_Notification_User_Subscriber_Resource. For the resourceRecord property, the only property that needs to be populated is the resourceTableId. The resourceTableId is the unique identifier of a SoftLayer service to create the subscription for. For example, the unique identifier of the Storage Evault service to create the subscription on.

Optional properties that can be set is the preferences property. The preference property is an array SoftLayer_Notification_User_Subscriber_Preference. By default, the system will populate the preferences with the default values if no preferences are passed in. The preferences passed in must be the preferences related to the notification subscribing to. The notification preferences and preference details (such as minimum and maximum values) can be retrieved using the SoftLayer_Notification service. The properties that need to be populated for preferences are the notificationPreferenceId and value.

For example to create a subscriber for a Storage EVault service to be notified 15 times during a billing cycle and to be notified when the vault usage reaches 85% of its allowed capacity use the following structure:

*userRecordId = 1111 *notificationId = 3 *resourceRecord **resourceTableId = 1234 *preferences[1] **notificationPreferenceId = 2 **value = 85 *preference[2] **notificationPreferenceId = 3 **value = 15

func (Notification_User_Subscriber_Mobile) EditObject 

func (r Notification_User_Subscriber_Mobile) EditObject(templateObject *datatypes.Notification_User_Subscriber) (resp bool, err error)

The subscriber's subscription status can be "turned off" or "turned on" if the subscription is not required.

Subscriber preferences may also be edited. To edit the preferences, you must pass in the id off the preferences to edit. Here is an example of structure to pass in. In this example, the structure will set the subscriber status to active and the threshold preference to 90 and the limit preference to 20

*id = 1111 *active = 1 *preferences[1] **id = 11 **value = 90 *preference[2] **id = 12 **value = 20

func (Notification_User_Subscriber_Mobile) Filter 

func (r Notification_User_Subscriber_Mobile) Filter(filter string) Notification_User_Subscriber_Mobile

func (Notification_User_Subscriber_Mobile) GetDeliveryMethods 

func (r Notification_User_Subscriber_Mobile) GetDeliveryMethods() (resp []datatypes.Notification_Delivery_Method, err error)

Retrieve The delivery methods used to send the subscribed notification.

func (Notification_User_Subscriber_Mobile) GetNotification 

func (r Notification_User_Subscriber_Mobile) GetNotification() (resp datatypes.Notification, err error)

Retrieve Notification subscribed to.

func (Notification_User_Subscriber_Mobile) GetObject 

func (r Notification_User_Subscriber_Mobile) GetObject() (resp datatypes.Notification_User_Subscriber_Mobile, err error)

no documentation yet

func (Notification_User_Subscriber_Mobile) GetPreferences 

func (r Notification_User_Subscriber_Mobile) GetPreferences() (resp []datatypes.Notification_User_Subscriber_Preference, err error)

Retrieve Associated subscriber preferences used for the notification subscription. For example, preferences include number of deliveries (limit) and threshold.

func (Notification_User_Subscriber_Mobile) GetPreferencesDetails 

func (r Notification_User_Subscriber_Mobile) GetPreferencesDetails() (resp []datatypes.Notification_Preference, err error)

Retrieve Preference details such as description, minimum and maximum limits, default value and unit of measure.

func (Notification_User_Subscriber_Mobile) GetResourceRecord 

func (r Notification_User_Subscriber_Mobile) GetResourceRecord() (resp datatypes.Notification_User_Subscriber_Resource, err error)

Retrieve The subscriber id to resource id mapping.

func (Notification_User_Subscriber_Mobile) GetUserRecord 

func (r Notification_User_Subscriber_Mobile) GetUserRecord() (resp datatypes.User_Customer, err error)

Retrieve User record for the subscription.

func (Notification_User_Subscriber_Mobile) Id 

func (r Notification_User_Subscriber_Mobile) Id(id int) Notification_User_Subscriber_Mobile

func (Notification_User_Subscriber_Mobile) Limit 

func (r Notification_User_Subscriber_Mobile) Limit(limit int) Notification_User_Subscriber_Mobile

func (Notification_User_Subscriber_Mobile) Mask 

func (r Notification_User_Subscriber_Mobile) Mask(mask string) Notification_User_Subscriber_Mobile

func (Notification_User_Subscriber_Mobile) Offset 

func (r Notification_User_Subscriber_Mobile) Offset(offset int) Notification_User_Subscriber_Mobile

func (Notification_User_Subscriber_Mobile) SetSnoozeTimer 

func (r Notification_User_Subscriber_Mobile) SetSnoozeTimer(start *int, end *int) (resp bool, err error)

no documentation yet

type Notification_User_Subscriber_Preference 

type Notification_User_Subscriber_Preference struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetNotificationUserSubscriberPreferenceService 

func GetNotificationUserSubscriberPreferenceService(sess session.SLSession) Notification_User_Subscriber_Preference

GetNotificationUserSubscriberPreferenceService returns an instance of the Notification_User_Subscriber_Preference SoftLayer service

func (Notification_User_Subscriber_Preference) CreateObject 

func (r Notification_User_Subscriber_Preference) CreateObject(templateObject *datatypes.Notification_User_Subscriber_Preference) (resp bool, err error)

Use the method to create a new notification preference for a subscriber

func (Notification_User_Subscriber_Preference) EditObjects 

func (r Notification_User_Subscriber_Preference) EditObjects(templateObjects []datatypes.Notification_User_Subscriber_Preference) (resp bool, err error)

no documentation yet

func (Notification_User_Subscriber_Preference) Filter 

func (r Notification_User_Subscriber_Preference) Filter(filter string) Notification_User_Subscriber_Preference

func (Notification_User_Subscriber_Preference) GetDefaultPreference 

func (r Notification_User_Subscriber_Preference) GetDefaultPreference() (resp datatypes.Notification_Preference, err error)

Retrieve Details such name, keyname, minimum and maximum values for the preference.

func (Notification_User_Subscriber_Preference) GetNotificationUserSubscriber 

func (r Notification_User_Subscriber_Preference) GetNotificationUserSubscriber() (resp datatypes.Notification_User_Subscriber, err error)

Retrieve Details of the subscriber tied to the preference.

func (Notification_User_Subscriber_Preference) GetObject 

func (r Notification_User_Subscriber_Preference) GetObject() (resp datatypes.Notification_User_Subscriber_Preference, err error)

no documentation yet

func (Notification_User_Subscriber_Preference) Id 

func (r Notification_User_Subscriber_Preference) Id(id int) Notification_User_Subscriber_Preference

func (Notification_User_Subscriber_Preference) Limit 

func (r Notification_User_Subscriber_Preference) Limit(limit int) Notification_User_Subscriber_Preference

func (Notification_User_Subscriber_Preference) Mask 

func (r Notification_User_Subscriber_Preference) Mask(mask string) Notification_User_Subscriber_Preference

func (Notification_User_Subscriber_Preference) Offset 

func (r Notification_User_Subscriber_Preference) Offset(offset int) Notification_User_Subscriber_Preference

type Product_Item added in v1.1.3 

type Product_Item struct {
	Session session.SLSession
	Options sl.Options
}

The SoftLayer_Product_Item data type contains general information relating to a single SoftLayer product.

func GetProductItemService added in v1.1.3 

func GetProductItemService(sess session.SLSession) Product_Item

GetProductItemService returns an instance of the Product_Item SoftLayer service

func (Product_Item) Filter added in v1.1.3 

func (r Product_Item) Filter(filter string) Product_Item

func (Product_Item) GetActivePresaleEvents added in v1.1.3 

func (r Product_Item) GetActivePresaleEvents() (resp []datatypes.Sales_Presale_Event, err error)

Retrieve

func (Product_Item) GetActiveUsagePrices added in v1.1.3 

func (r Product_Item) GetActiveUsagePrices() (resp []datatypes.Product_Item_Price, err error)

Retrieve Active usage based prices.

func (Product_Item) GetAttributes added in v1.1.3 

func (r Product_Item) GetAttributes() (resp []datatypes.Product_Item_Attribute, err error)

Retrieve The attribute values for a product item. These are additional properties that give extra information about the product being sold.

func (Product_Item) GetAvailabilityAttributes added in v1.1.3 

func (r Product_Item) GetAvailabilityAttributes() (resp []datatypes.Product_Item_Attribute, err error)

Retrieve Attributes that govern when an item may no longer be available.

func (Product_Item) GetBillingType added in v1.1.3 

func (r Product_Item) GetBillingType() (resp string, err error)

Retrieve An item's special billing type, if applicable.

func (Product_Item) GetBundle added in v1.1.3 

func (r Product_Item) GetBundle() (resp []datatypes.Product_Item_Bundles, err error)

Retrieve 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.

func (Product_Item) GetBundleItems added in v1.1.3 

func (r Product_Item) GetBundleItems() (resp []datatypes.Product_Item, err error)

Retrieve 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.

func (Product_Item) GetCapacityMaximum added in v1.1.3 

func (r Product_Item) GetCapacityMaximum() (resp string, err error)

Retrieve When the product capacity is best described as a range, this holds the ceiling of the range.

func (Product_Item) GetCapacityMinimum added in v1.1.3 

func (r Product_Item) GetCapacityMinimum() (resp string, err error)

Retrieve When the product capacity is best described as a range, this holds the floor of the range.

func (Product_Item) GetCapacityRestrictedProductFlag added in v1.1.3 

func (r Product_Item) GetCapacityRestrictedProductFlag() (resp bool, err error)

Retrieve This flag indicates that this product is restricted by a capacity on a related product.

func (Product_Item) GetCategories added in v1.1.3 

func (r Product_Item) GetCategories() (resp []datatypes.Product_Item_Category, err error)

Retrieve An item's associated item categories.

func (Product_Item) GetConfigurationTemplates added in v1.1.3 

func (r Product_Item) GetConfigurationTemplates() (resp []datatypes.Configuration_Template, err error)

Retrieve Some product items have configuration templates which can be used to during provisioning of that product.

func (Product_Item) GetConflicts added in v1.1.3 

func (r Product_Item) GetConflicts() (resp []datatypes.Product_Item_Resource_Conflict, err error)

Retrieve 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.

func (Product_Item) GetCoreRestrictedItemFlag added in v1.1.3 

func (r Product_Item) GetCoreRestrictedItemFlag() (resp bool, err error)

Retrieve 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]]

func (Product_Item) GetDowngradeItem added in v1.1.3 

func (r Product_Item) GetDowngradeItem() (resp datatypes.Product_Item, err error)

Retrieve Some product items have a downgrade path. This is the first product item in the downgrade path.

func (Product_Item) GetDowngradeItems added in v1.1.3 

func (r Product_Item) GetDowngradeItems() (resp []datatypes.Product_Item, err error)

Retrieve Some product items have a downgrade path. These are those product items.

func (Product_Item) GetGlobalCategoryConflicts added in v1.1.3 

func (r Product_Item) GetGlobalCategoryConflicts() (resp []datatypes.Product_Item_Resource_Conflict, err error)

Retrieve 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.

func (Product_Item) GetHardwareGenericComponentModel added in v1.1.3 

func (r Product_Item) GetHardwareGenericComponentModel() (resp datatypes.Hardware_Component_Model_Generic, err error)

Retrieve The generic hardware component that this item represents.

func (Product_Item) GetHideFromPortalFlag added in v1.1.3 

func (r Product_Item) GetHideFromPortalFlag() (resp bool, err error)

Retrieve

func (Product_Item) GetIneligibleForAccountDiscountFlag added in v1.1.3 

func (r Product_Item) GetIneligibleForAccountDiscountFlag() (resp bool, err error)

Retrieve

func (Product_Item) GetInventory added in v1.1.3 

func (r Product_Item) GetInventory() (resp []datatypes.Product_Package_Inventory, err error)

Retrieve DEPRECATED. An item's inventory status per datacenter.

func (Product_Item) GetIsEngineeredServerProduct added in v1.1.3 

func (r Product_Item) GetIsEngineeredServerProduct() (resp bool, err error)

Retrieve Flag to indicate the server product is engineered for a multi-server solution. (Deprecated)

func (Product_Item) GetItemCategory added in v1.1.3 

func (r Product_Item) GetItemCategory() (resp datatypes.Product_Item_Category, err error)

Retrieve An item's primary item category.

func (Product_Item) GetLocalDiskFlag added in v1.1.3 

func (r Product_Item) GetLocalDiskFlag() (resp bool, err error)

Retrieve

func (Product_Item) GetLocationConflicts added in v1.1.3 

func (r Product_Item) GetLocationConflicts() (resp []datatypes.Product_Item_Resource_Conflict, err error)

Retrieve An item's location conflicts. For example, Dual Path network functionality cannot be ordered in WDC and as such is a conflict.

func (Product_Item) GetM2ControllerFlag added in v1.1.3 

func (r Product_Item) GetM2ControllerFlag() (resp bool, err error)

Retrieve Indicates whether an item is a M.2 disk controller.

func (Product_Item) GetM2DriveFlag added in v1.1.3 

func (r Product_Item) GetM2DriveFlag() (resp bool, err error)

Retrieve Indicates whether an item is a M.2 drive.

func (Product_Item) GetMinimumNvmeBays added in v1.1.3 

func (r Product_Item) GetMinimumNvmeBays() (resp int, err error)

Retrieve The minimum number of bays that support NVMe SSDs.

func (Product_Item) GetNvmeDiskFlag added in v1.1.3 

func (r Product_Item) GetNvmeDiskFlag() (resp bool, err error)

Retrieve Indicates whether an item is a NVMe SSD.

func (Product_Item) GetObject added in v1.1.3 

func (r Product_Item) GetObject() (resp datatypes.Product_Item, err error)

Product Items are the products SoftLayer sells. Items have many properties that help describe what each is for. Each product items holds within it a description, tax rate information, status, and upgrade downgrade path information.

func (Product_Item) GetObjectStorageClusterGeolocationType added in v1.1.3 

func (r Product_Item) GetObjectStorageClusterGeolocationType() (resp string, err error)

Retrieve

func (Product_Item) GetObjectStorageItemFlag added in v1.1.3 

func (r Product_Item) GetObjectStorageItemFlag() (resp bool, err error)

Retrieve

func (Product_Item) GetObjectStorageServiceClass added in v1.1.3 

func (r Product_Item) GetObjectStorageServiceClass() (resp string, err error)

Retrieve

func (Product_Item) GetPackages added in v1.1.3 

func (r Product_Item) GetPackages() (resp []datatypes.Product_Package, err error)

Retrieve A collection of all the SoftLayer_Product_Package(s) in which this item exists.

func (Product_Item) GetPcieDriveFlag added in v1.1.3 

func (r Product_Item) GetPcieDriveFlag() (resp bool, err error)

Retrieve Indicates whether an item is a PCIe drive.

func (Product_Item) GetPhysicalCoreCapacity added in v1.1.3 

func (r Product_Item) GetPhysicalCoreCapacity() (resp string, err error)

Retrieve The number of cores that a processor has.

func (Product_Item) GetPresaleEvents added in v1.1.3 

func (r Product_Item) GetPresaleEvents() (resp []datatypes.Sales_Presale_Event, err error)

Retrieve

func (Product_Item) GetPrices added in v1.1.3 

func (r Product_Item) GetPrices() (resp []datatypes.Product_Item_Price, err error)

Retrieve A product item's prices.

func (Product_Item) GetPrivateInterfaceCount added in v1.1.7 

func (r Product_Item) GetPrivateInterfaceCount() (resp uint, err error)

Retrieve The number of private network interfaces provided by a port_speed product.

func (Product_Item) GetPublicInterfaceCount added in v1.1.7 

func (r Product_Item) GetPublicInterfaceCount() (resp uint, err error)

Retrieve The number of public network interfaces provided by a port_speed product.

func (Product_Item) GetRequirements added in v1.1.3 

func (r Product_Item) GetRequirements() (resp []datatypes.Product_Item_Requirement, err error)

Retrieve If an item must be ordered with another item, it will have a requirement item here.

func (Product_Item) GetRules added in v1.1.3 

func (r Product_Item) GetRules() (resp []datatypes.Product_Item_Rule, err error)

Retrieve An item's rules. This includes the requirements and conflicts to resources that an item has.

func (Product_Item) GetSoftwareDescription added in v1.1.3 

func (r Product_Item) GetSoftwareDescription() (resp datatypes.Software_Description, err error)

Retrieve The SoftLayer_Software_Description tied to this item. This will only be populated for software items.

func (Product_Item) GetSpeedSelectServerCoreCount added in v1.1.3 

func (r Product_Item) GetSpeedSelectServerCoreCount() (resp string, err error)

Retrieve The total number of cores for a speed select server product.

func (Product_Item) GetSpeedSelectServerFlag added in v1.1.3 

func (r Product_Item) GetSpeedSelectServerFlag() (resp bool, err error)

Retrieve Indicates a speed select server item.

func (Product_Item) GetSupportedBiosSettingsProfiles added in v1.2.1 

func (r Product_Item) GetSupportedBiosSettingsProfiles() (resp []string, err error)

Retrieve The supported settings profiles for a server product.

func (Product_Item) GetTaxCategory added in v1.1.3 

func (r Product_Item) GetTaxCategory() (resp datatypes.Product_Item_Tax_Category, err error)

Retrieve An item's tax category, if applicable.

func (Product_Item) GetThirdPartyPolicyAssignments added in v1.1.3 

func (r Product_Item) GetThirdPartyPolicyAssignments() (resp []datatypes.Product_Item_Policy_Assignment, err error)

Retrieve Third-party policy assignments for this product.

func (Product_Item) GetThirdPartySupportVendor added in v1.1.3 

func (r Product_Item) GetThirdPartySupportVendor() (resp string, err error)

Retrieve The 3rd party vendor for a support subscription item. (Deprecated)

func (Product_Item) GetTotalPhysicalCoreCapacity added in v1.1.3 

func (r Product_Item) GetTotalPhysicalCoreCapacity() (resp int, err error)

Retrieve The total number of physical processing cores (excluding virtual cores / hyperthreads) for this server.

func (Product_Item) GetTotalPhysicalCoreCount added in v1.1.3 

func (r Product_Item) GetTotalPhysicalCoreCount() (resp int, err error)

Retrieve 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

func (Product_Item) GetTotalProcessorCapacity added in v1.1.3 

func (r Product_Item) GetTotalProcessorCapacity() (resp int, err error)

Retrieve The total number of processors for this server.

func (Product_Item) GetUpgradeItem added in v1.1.3 

func (r Product_Item) GetUpgradeItem() (resp datatypes.Product_Item, err error)

Retrieve Some product items have an upgrade path. This is the next product item in the upgrade path.

func (Product_Item) GetUpgradeItems added in v1.1.3 

func (r Product_Item) GetUpgradeItems() (resp []datatypes.Product_Item, err error)

Retrieve Some product items have an upgrade path. These are those upgrade product items.

func (Product_Item) Id added in v1.1.3 

func (r Product_Item) Id(id int) Product_Item

func (Product_Item) Limit added in v1.1.3 

func (r Product_Item) Limit(limit int) Product_Item

func (Product_Item) Mask added in v1.1.3 

func (r Product_Item) Mask(mask string) Product_Item

func (Product_Item) Offset added in v1.1.3 

func (r Product_Item) Offset(offset int) Product_Item

type Product_Item_Category 

type Product_Item_Category struct {
	Session session.SLSession
	Options sl.Options
}

The SoftLayer_Product_Item_Category data type contains general category information for prices.

func GetProductItemCategoryService 

func GetProductItemCategoryService(sess session.SLSession) Product_Item_Category

GetProductItemCategoryService returns an instance of the Product_Item_Category SoftLayer service

func (Product_Item_Category) Filter 

func (r Product_Item_Category) Filter(filter string) Product_Item_Category

func (Product_Item_Category) GetAdditionalProductsForCategory 

func (r Product_Item_Category) GetAdditionalProductsForCategory() (resp []datatypes.Product_Item, err error)

Returns a list of of active Items in the "Additional Services" package with their active prices for a given product item category and sorts them by price.

func (Product_Item_Category) GetBandwidthCategories 

func (r Product_Item_Category) GetBandwidthCategories() (resp []datatypes.Product_Item_Category, err error)

no documentation yet

func (Product_Item_Category) GetBillingItems 

func (r Product_Item_Category) GetBillingItems() (resp []datatypes.Billing_Item, err error)

Retrieve The billing items associated with an account that share a category code with an item category's category code.

func (Product_Item_Category) GetComputingCategories 

func (r Product_Item_Category) GetComputingCategories(resetCache *bool) (resp []datatypes.Product_Item_Category, err error)

This method returns a collection of computing categories. These categories are also top level items in a service offering.

func (Product_Item_Category) GetCustomUsageRatesCategories 

func (r Product_Item_Category) GetCustomUsageRatesCategories(resetCache *bool) (resp []datatypes.Product_Item_Category, err error)

no documentation yet

func (Product_Item_Category) GetExternalResourceCategories 

func (r Product_Item_Category) GetExternalResourceCategories() (resp []datatypes.Product_Item_Category, err error)

no documentation yet

func (Product_Item_Category) GetGroup 

func (r Product_Item_Category) GetGroup() (resp datatypes.Product_Item_Category_Group, err error)

Retrieve This invoice item's "item category group".

func (Product_Item_Category) GetGroups 

func (r Product_Item_Category) GetGroups() (resp []datatypes.Product_Package_Item_Category_Group, err error)

Retrieve A collection of service offering category groups. Each group contains a collection of items associated with this category.

func (Product_Item_Category) GetObject 

func (r Product_Item_Category) GetObject() (resp datatypes.Product_Item_Category, err error)

Each product item price must be tied to a category for it to be sold. These categories describe how a particular product item is sold. For example, the 250GB hard drive can be sold as disk0, disk1, ... disk11. There are different prices for this product item depending on which category it is. This keeps down the number of products in total.

func (Product_Item_Category) GetObjectStorageCategories 

func (r Product_Item_Category) GetObjectStorageCategories(resetCache *bool) (resp []datatypes.Product_Item_Category, err error)

no documentation yet

func (Product_Item_Category) GetOrderOptions 

func (r Product_Item_Category) GetOrderOptions() (resp []datatypes.Product_Item_Category_Order_Option_Type, err error)

Retrieve Any unique options associated with an item category.

func (Product_Item_Category) GetPackageConfigurations 

func (r Product_Item_Category) GetPackageConfigurations() (resp []datatypes.Product_Package_Order_Configuration, err error)

Retrieve A list of configuration available in this category.'

func (Product_Item_Category) GetPresetConfigurations 

func (r Product_Item_Category) GetPresetConfigurations() (resp []datatypes.Product_Package_Preset_Configuration, err error)

Retrieve A list of preset configurations this category is used in.'

func (Product_Item_Category) GetQuestionReferences 

func (r Product_Item_Category) GetQuestionReferences() (resp []datatypes.Product_Item_Category_Question_Xref, err error)

Retrieve The question references that are associated with an item category.

func (Product_Item_Category) GetQuestions 

func (r Product_Item_Category) GetQuestions() (resp []datatypes.Product_Item_Category_Question, err error)

Retrieve The questions that are associated with an item category.

func (Product_Item_Category) GetSoftwareCategories 

func (r Product_Item_Category) GetSoftwareCategories() (resp []datatypes.Product_Item_Category, err error)

no documentation yet

func (Product_Item_Category) GetSubnetCategories 

func (r Product_Item_Category) GetSubnetCategories() (resp []datatypes.Product_Item_Category, err error)

This method returns a list of subnet categories.

func (Product_Item_Category) GetTopLevelCategories 

func (r Product_Item_Category) GetTopLevelCategories(resetCache *bool) (resp []datatypes.Product_Item_Category, err error)

This method returns a collection of computing categories. These categories are also top level items in a service offering.

func (Product_Item_Category) GetValidCancelableServiceItemCategories 

func (r Product_Item_Category) GetValidCancelableServiceItemCategories() (resp []datatypes.Product_Item_Category, err error)

This method returns service product categories that can be canceled via API. You can use these categories to find the billing items you wish to cancel.

func (Product_Item_Category) GetVlanCategories 

func (r Product_Item_Category) GetVlanCategories() (resp []datatypes.Product_Item_Category, err error)

no documentation yet

func (Product_Item_Category) Id 

func (r Product_Item_Category) Id(id int) Product_Item_Category

func (Product_Item_Category) Limit 

func (r Product_Item_Category) Limit(limit int) Product_Item_Category

func (Product_Item_Category) Mask 

func (r Product_Item_Category) Mask(mask string) Product_Item_Category

func (Product_Item_Category) Offset 

func (r Product_Item_Category) Offset(offset int) Product_Item_Category

type Product_Item_Category_Group 

type Product_Item_Category_Group struct {
	Session session.SLSession
	Options sl.Options
}

The SoftLayer_Product_Item_Category_Group data type contains general category group information.

func GetProductItemCategoryGroupService 

func GetProductItemCategoryGroupService(sess session.SLSession) Product_Item_Category_Group

GetProductItemCategoryGroupService returns an instance of the Product_Item_Category_Group SoftLayer service

func (Product_Item_Category_Group) Filter 

func (r Product_Item_Category_Group) Filter(filter string) Product_Item_Category_Group

func (Product_Item_Category_Group) GetObject 

func (r Product_Item_Category_Group) GetObject() (resp datatypes.Product_Item_Category_Group, err error)

Each product item category must be tied to a category group. These category groups describe how a particular product item category is categorized. For example, the disk0, disk1, ... disk11 can be categorized as Server and Attached Services. There are different groups for each of this product item category depending on the function of the item product in the subject category.

func (Product_Item_Category_Group) Id 

func (r Product_Item_Category_Group) Id(id int) Product_Item_Category_Group

func (Product_Item_Category_Group) Limit 

func (r Product_Item_Category_Group) Limit(limit int) Product_Item_Category_Group

func (Product_Item_Category_Group) Mask 

func (r Product_Item_Category_Group) Mask(mask string) Product_Item_Category_Group

func (Product_Item_Category_Group) Offset 

func (r Product_Item_Category_Group) Offset(offset int) Product_Item_Category_Group

type Product_Item_Policy_Assignment 

type Product_Item_Policy_Assignment struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetProductItemPolicyAssignmentService 

func GetProductItemPolicyAssignmentService(sess session.SLSession) Product_Item_Policy_Assignment

GetProductItemPolicyAssignmentService returns an instance of the Product_Item_Policy_Assignment SoftLayer service

func (Product_Item_Policy_Assignment) AcceptFromTicket 

func (r Product_Item_Policy_Assignment) AcceptFromTicket(ticketId *int) (resp bool, err error)

Register the acceptance of the associated policy to product assignment, and link the created record to a Ticket.

func (Product_Item_Policy_Assignment) Filter 

func (r Product_Item_Policy_Assignment) Filter(filter string) Product_Item_Policy_Assignment

func (Product_Item_Policy_Assignment) GetObject 

func (r Product_Item_Policy_Assignment) GetObject() (resp datatypes.Product_Item_Policy_Assignment, err error)

no documentation yet

func (Product_Item_Policy_Assignment) GetPolicyDocumentContents 

func (r Product_Item_Policy_Assignment) GetPolicyDocumentContents() (resp []byte, err error)

Retrieve the binary contents of the associated PDF policy document.

func (Product_Item_Policy_Assignment) GetPolicyName 

func (r Product_Item_Policy_Assignment) GetPolicyName() (resp string, err error)

Retrieve The name of the assigned policy.

func (Product_Item_Policy_Assignment) GetProduct 

func (r Product_Item_Policy_Assignment) GetProduct() (resp datatypes.Product_Item, err error)

Retrieve The [[SoftLayer_Product_Item]] for this policy assignment.

func (Product_Item_Policy_Assignment) Id 

func (r Product_Item_Policy_Assignment) Id(id int) Product_Item_Policy_Assignment

func (Product_Item_Policy_Assignment) Limit 

func (r Product_Item_Policy_Assignment) Limit(limit int) Product_Item_Policy_Assignment

func (Product_Item_Policy_Assignment) Mask 

func (r Product_Item_Policy_Assignment) Mask(mask string) Product_Item_Policy_Assignment

func (Product_Item_Policy_Assignment) Offset 

func (r Product_Item_Policy_Assignment) Offset(offset int) Product_Item_Policy_Assignment

type Product_Item_Price 

type Product_Item_Price struct {
	Session session.SLSession
	Options sl.Options
}

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).

func GetProductItemPriceService 

func GetProductItemPriceService(sess session.SLSession) Product_Item_Price

GetProductItemPriceService returns an instance of the Product_Item_Price SoftLayer service

func (Product_Item_Price) Filter 

func (r Product_Item_Price) Filter(filter string) Product_Item_Price

func (Product_Item_Price) GetAccountRestrictions 

func (r Product_Item_Price) GetAccountRestrictions() (resp []datatypes.Product_Item_Price_Account_Restriction, err error)

Retrieve The account that the item price is restricted to.

func (Product_Item_Price) GetAttributes 

func (r Product_Item_Price) GetAttributes() (resp []datatypes.Product_Item_Price_Attribute, err error)

Retrieve

func (Product_Item_Price) GetBareMetalReservedCapacityFlag 

func (r Product_Item_Price) GetBareMetalReservedCapacityFlag() (resp bool, err error)

Retrieve Signifies pricing that is only available on a bare metal reserved capacity order.

func (Product_Item_Price) GetBigDataOsJournalDiskFlag 

func (r Product_Item_Price) GetBigDataOsJournalDiskFlag() (resp bool, err error)

Retrieve Whether the price is for Big Data OS/Journal disks only. (Deprecated)

func (Product_Item_Price) GetBundleReferences 

func (r Product_Item_Price) GetBundleReferences() (resp []datatypes.Product_Item_Bundles, err error)

Retrieve cross reference for bundles

func (Product_Item_Price) GetCapacityRestrictionMaximum 

func (r Product_Item_Price) GetCapacityRestrictionMaximum() (resp string, err error)

Retrieve The maximum capacity value for which this price is suitable.

func (Product_Item_Price) GetCapacityRestrictionMinimum 

func (r Product_Item_Price) GetCapacityRestrictionMinimum() (resp string, err error)

Retrieve The minimum capacity value for which this price is suitable.

func (Product_Item_Price) GetCapacityRestrictionType 

func (r Product_Item_Price) GetCapacityRestrictionType() (resp string, err error)

Retrieve The type of capacity restriction by which this price must abide.

func (Product_Item_Price) GetCategories 

func (r Product_Item_Price) GetCategories() (resp []datatypes.Product_Item_Category, err error)

Retrieve All categories which this item is a member.

func (Product_Item_Price) GetDedicatedHostInstanceFlag 

func (r Product_Item_Price) GetDedicatedHostInstanceFlag() (resp bool, err error)

Retrieve Signifies pricing that is only available on a dedicated host virtual server order.

func (Product_Item_Price) GetDefinedSoftwareLicenseFlag 

func (r Product_Item_Price) GetDefinedSoftwareLicenseFlag() (resp bool, err error)

Retrieve Whether this price defines a software license for its product item.

func (Product_Item_Price) GetEligibilityStrategy 

func (r Product_Item_Price) GetEligibilityStrategy() (resp string, err error)

Retrieve Eligibility strategy to assess if a customer can order using this price.

func (Product_Item_Price) GetItem 

func (r Product_Item_Price) GetItem() (resp datatypes.Product_Item, err error)

Retrieve The product item a price is tied to.

func (Product_Item_Price) GetObject 

func (r Product_Item_Price) GetObject() (resp datatypes.Product_Item_Price, err error)

no documentation yet

func (Product_Item_Price) GetOrderPremiums 

func (r Product_Item_Price) GetOrderPremiums() (resp []datatypes.Product_Item_Price_Premium, err error)

Retrieve

func (Product_Item_Price) GetPackageReferences 

func (r Product_Item_Price) GetPackageReferences() (resp []datatypes.Product_Package_Item_Prices, err error)

Retrieve cross reference for packages

func (Product_Item_Price) GetPackages 

func (r Product_Item_Price) GetPackages() (resp []datatypes.Product_Package, err error)

Retrieve A price's packages under which this item is sold.

func (Product_Item_Price) GetPresetConfigurations 

func (r Product_Item_Price) GetPresetConfigurations() (resp []datatypes.Product_Package_Preset_Configuration, err error)

Retrieve A list of preset configurations this price is used in.'

func (Product_Item_Price) GetPriceType 

func (r Product_Item_Price) GetPriceType() (resp string, err error)

Retrieve The type keyname of this price which can be STANDARD, TIERED, or TERM.

func (Product_Item_Price) GetPricingLocationGroup 

func (r Product_Item_Price) GetPricingLocationGroup() (resp datatypes.Location_Group_Pricing, err error)

Retrieve The pricing location group that this price is applicable for. Prices that have a pricing location group will only be available for ordering with the locations specified on the location group.

func (Product_Item_Price) GetRequiredCoreCount 

func (r Product_Item_Price) GetRequiredCoreCount() (resp int, err error)

Retrieve 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]]

func (Product_Item_Price) GetReservedCapacityInstanceFlag 

func (r Product_Item_Price) GetReservedCapacityInstanceFlag() (resp bool, err error)

Retrieve Signifies pricing that is only available on a reserved capacity virtual server order.

func (Product_Item_Price) GetUsageRatePrices 

func (r Product_Item_Price) GetUsageRatePrices(location *datatypes.Location, items []datatypes.Product_Item) (resp []datatypes.Product_Item_Price, err error)

Returns a collection of rate-based [[SoftLayer_Product_Item_Price]] objects associated with the [[SoftLayer_Product_Item]] objects and the [[SoftLayer_Location]] specified. The location is required to get the appropriate rate-based prices because the usage rates may vary from datacenter to datacenter.

func (Product_Item_Price) Id 

func (r Product_Item_Price) Id(id int) Product_Item_Price

func (Product_Item_Price) Limit 

func (r Product_Item_Price) Limit(limit int) Product_Item_Price

func (Product_Item_Price) Mask 

func (r Product_Item_Price) Mask(mask string) Product_Item_Price

func (Product_Item_Price) Offset 

func (r Product_Item_Price) Offset(offset int) Product_Item_Price

type Product_Item_Price_Premium 

type Product_Item_Price_Premium struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetProductItemPricePremiumService 

func GetProductItemPricePremiumService(sess session.SLSession) Product_Item_Price_Premium

GetProductItemPricePremiumService returns an instance of the Product_Item_Price_Premium SoftLayer service

func (Product_Item_Price_Premium) Filter 

func (r Product_Item_Price_Premium) Filter(filter string) Product_Item_Price_Premium

func (Product_Item_Price_Premium) GetItemPrice 

func (r Product_Item_Price_Premium) GetItemPrice() (resp datatypes.Product_Item_Price, err error)

Retrieve

func (Product_Item_Price_Premium) GetLocation 

func (r Product_Item_Price_Premium) GetLocation() (resp datatypes.Location, err error)

Retrieve

func (Product_Item_Price_Premium) GetObject 

func (r Product_Item_Price_Premium) GetObject() (resp datatypes.Product_Item_Price_Premium, err error)

no documentation yet

func (Product_Item_Price_Premium) GetPackage 

func (r Product_Item_Price_Premium) GetPackage() (resp datatypes.Product_Package, err error)

Retrieve

func (Product_Item_Price_Premium) Id 

func (r Product_Item_Price_Premium) Id(id int) Product_Item_Price_Premium

func (Product_Item_Price_Premium) Limit 

func (r Product_Item_Price_Premium) Limit(limit int) Product_Item_Price_Premium

func (Product_Item_Price_Premium) Mask 

func (r Product_Item_Price_Premium) Mask(mask string) Product_Item_Price_Premium

func (Product_Item_Price_Premium) Offset 

func (r Product_Item_Price_Premium) Offset(offset int) Product_Item_Price_Premium

type Product_Order 

type Product_Order struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetProductOrderService 

func GetProductOrderService(sess session.SLSession) Product_Order

GetProductOrderService returns an instance of the Product_Order SoftLayer service

func (Product_Order) CheckItemAvailability 

func (r Product_Order) CheckItemAvailability(itemPrices []datatypes.Product_Item_Price, accountId *int, availabilityTypeKeyNames []string) (resp bool, err error)

no documentation yet

func (Product_Order) CheckItemAvailabilityForImageTemplate 

func (r Product_Order) CheckItemAvailabilityForImageTemplate(imageTemplateId *int, accountId *int, packageId *int, availabilityTypeKeyNames []string) (resp bool, err error)

no documentation yet

func (Product_Order) CheckItemConflicts 

func (r Product_Order) CheckItemConflicts(itemPrices []datatypes.Product_Item_Price) (resp bool, err error)

Check order items for conflicts

func (Product_Order) Filter 

func (r Product_Order) Filter(filter string) Product_Order

func (Product_Order) GetExternalPaymentAuthorizationReceipt 

func (r Product_Order) GetExternalPaymentAuthorizationReceipt(token *string, payerId *string) (resp datatypes.Container_Product_Order_Receipt, err error)

no documentation yet Deprecated: This function has been marked as deprecated.

func (Product_Order) GetNetworks 

func (r Product_Order) GetNetworks(locationId *int, packageId *int, accountId *int) (resp []datatypes.Container_Product_Order_Network, err error)

This method is deprecated and always returns nothing. Deprecated: This function has been marked as deprecated.

func (Product_Order) GetResellerOrder 

func (r Product_Order) GetResellerOrder(orderContainer *datatypes.Container_Product_Order) (resp datatypes.Container_Product_Order, err error)

When the account is on an external reseller brand, this service will provide a SoftLayer_Product_Order with the the pricing adjusted by the external reseller.

func (Product_Order) GetTaxCalculationResult 

func (r Product_Order) GetTaxCalculationResult(orderHash *string) (resp datatypes.Container_Tax_Cache, err error)

Sometimes taxes cannot be calculated immediately, so we start the calculations and let them run in the background. This method will return the current progress and information related to a specific tax calculation, which allows real-time progress updates on tax calculations.

func (Product_Order) GetVlans 

func (r Product_Order) GetVlans(locationId *int, packageId *int, selectedItems *string, vlanIds []int, subnetIds []int, accountId *int, orderContainer *datatypes.Container_Product_Order, hardwareFirewallOrderedFlag *bool) (resp datatypes.Container_Product_Order_Network_Vlans, err error)

Return collections of public and private VLANs that are available during ordering. If a location ID is provided, the resulting VLANs will be limited to that location. If the Virtual Server package id (46) is provided, the VLANs will be narrowed down to those locations that contain routers with the VIRTUAL_IMAGE_STORE data attribute.

For the selectedItems parameter, this is a comma-separated string of category codes and item values. For example:

- `port_speed=10,guest_disk0=LOCAL_DISK`

- `port_speed=100,disk0=SAN_DISK`

- `port_speed=100,private_network_only=1,guest_disk0=LOCAL_DISK`

This parameter is used to narrow the available results down even further. It's not necessary when selecting a VLAN, but it will help avoid errors when attempting to place an order. The only acceptable category codes are:

- `port_speed`

- A disk category, such as `guest_disk0` or `disk0`, with values of either `LOCAL_DISK` or `SAN_DISK`

- `private_network_only`

- `dual_path_network`

For most customers, it's sufficient to only provide the first 2 parameters.

func (Product_Order) Id 

func (r Product_Order) Id(id int) Product_Order

func (Product_Order) Limit 

func (r Product_Order) Limit(limit int) Product_Order

func (Product_Order) Mask 

func (r Product_Order) Mask(mask string) Product_Order

func (Product_Order) Offset 

func (r Product_Order) Offset(offset int) Product_Order

func (Product_Order) PlaceOrder 

func (r Product_Order) PlaceOrder(orderData interface{}, saveAsQuote *bool) (resp datatypes.Container_Product_Order_Receipt, err error)

Use this method to place bare metal server, virtual server and additional service orders with SoftLayer. Upon success, your credit card or PayPal account will incur charges for the monthly order total (or prorated value if ordered mid billing cycle). If all products on the order are only billed hourly, you will be charged on your billing anniversary date, which occurs monthly on the day you ordered your first service with SoftLayer. For new customers, you are required to provide billing information when you place an order. For existing customers, the credit card on file will be charged. If you're a PayPal customer, a URL will be returned from the call to [SoftLayer_Product_Order/placeOrder] which is to be used to finish the authorization process. This authorization tells PayPal that you indeed want to place an order with SoftLayer. From PayPal's web site, you will be redirected back to SoftLayer for your order receipt.

When an order is placed, your order will be in a "pending approval" state. When all internal checks pass, your order will be automatically approved. For orders that may need extra attention, a Sales representative will review the order and contact you if necessary. Once the order is approved, your server or service will be provisioned and available to you shortly thereafter. Depending on the type of server or service ordered, provisioning times will vary.

## Order Containers

When placing API orders, it's important to order your server and services on the appropriate [[SoftLayer_Container_Product_Order]]. Failing to provide the correct container may delay your server or service from being provisioned in a timely manner. Some common order containers are included below.

**Note:** `SoftLayer_Container_Product_Order_` has been removed from the containers in the table below for readability.

| Product | Order Container | Package Type | | ------- | --------------- | ------------ | | Bare metal server by CPU | [[SoftLayer_Container_Product_Order_Hardware_Server]] | BARE_METAL_CPU | | Bare metal server by core | [[SoftLayer_Container_Product_Order_Hardware_Server]] | BARE_METAL_CORE | | Virtual server | [[SoftLayer_Container_Product_Order_Virtual_Guest]] | VIRTUAL_SERVER_INSTANCE | | Local & dedicated load balancers | [[SoftLayer_Container_Product_Order_Network_LoadBalancer]] | ADDITIONAL_SERVICES_LOAD_BALANCER | | Content delivery network | [[SoftLayer_Container_Product_Order_Network_ContentDelivery_Account]] | ADDITIONAL_SERVICES_CDN | | Content delivery network Addon | [[SoftLayer_Container_Product_Order_Network_ContentDelivery_Account_Addon]] | ADDITIONAL_SERVICES_CDN_ADDON | | Hardware & software firewalls | [[SoftLayer_Container_Product_Order_Network_Protection_Firewall]] | ADDITIONAL_SERVICES_FIREWALL | | Dedicated firewall | [[SoftLayer_Container_Product_Order_Network_Protection_Firewall_Dedicated]] | ADDITIONAL_SERVICES_FIREWALL | | Object storage | [[SoftLayer_Container_Product_Order_Network_Storage_Object]] | ADDITIONAL_SERVICES_OBJECT_STORAGE | | Object storage (hub) | [[SoftLayer_Container_Product_Order_Network_Storage_Hub]] | ADDITIONAL_SERVICES_OBJECT_STORAGE | | Network attached storage | [[SoftLayer_Container_Product_Order_Network_Storage_Nas]] | ADDITIONAL_SERVICES_NETWORK_ATTACHED_STORAGE | | Iscsi storage | [[SoftLayer_Container_Product_Order_Network_Storage_Iscsi]] | ADDITIONAL_SERVICES_ISCSI_STORAGE | | Evault | [[SoftLayer_Container_Product_Order_Network_Storage_Backup_Evault_Vault]] | ADDITIONAL_SERVICES | | Evault Plugin | [[SoftLayer_Container_Product_Order_Network_Storage_Backup_Evault_Plugin]] | ADDITIONAL_SERVICES | | Application delivery appliance | [[SoftLayer_Container_Product_Order_Network_Application_Delivery_Controller]] | ADDITIONAL_SERVICES_APPLICATION_DELIVERY_APPLIANCE | | Network subnet | [[SoftLayer_Container_Product_Order_Network_Subnet]] | ADDITIONAL_SERVICES | | Global IPv4 | [[SoftLayer_Container_Product_Order_Network_Subnet]] | ADDITIONAL_SERVICES_GLOBAL_IP_ADDRESSES | | Global IPv6 | [[SoftLayer_Container_Product_Order_Network_Subnet]] | ADDITIONAL_SERVICES_GLOBAL_IP_ADDRESSES | | Network VLAN | [[SoftLayer_Container_Product_Order_Network_Vlan]] | ADDITIONAL_SERVICES_NETWORK_VLAN | | Portable storage | [[SoftLayer_Container_Product_Order_Virtual_Disk_Image]] | ADDITIONAL_SERVICES_PORTABLE_STORAGE | | SSL certificate | [[SoftLayer_Container_Product_Order_Security_Certificate]] | ADDITIONAL_SERVICES_SSL_CERTIFICATE | | External authentication | [[SoftLayer_Container_Product_Order_User_Customer_External_Binding]] | ADDITIONAL_SERVICES | | Dedicated Host | [[SoftLayer_Container_Product_Order_Virtual_DedicatedHost]] | DEDICATED_HOST |

## Server example

This example includes a single bare metal server being ordered with monthly billing.

**Warning:** the price ids provided below may be outdated or unavailable, so you will need to determine the

available prices from the bare metal server [SoftLayer_Product_Package/getAllObjects], which have a [[SoftLayer_Product_Package_Type]] of `BARE_METAL_CPU` or `BARE_METAL_CORE`. You can get a full list of package types with [SoftLayer_Product_Package_Type/getAllObjects].

### Bare Metal Ordering

```xml <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://api.service.softlayer.com/soap/v3/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> 

<SOAP-ENV:Header>
  <ns1:authenticate>
    <username>your username</username>
    <apiKey>your api key</apiKey>
  </ns1:authenticate>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
  <ns1:placeOrder>
    <orderData xsi:type="ns1:SoftLayer_Container_Product_Order_Hardware_Server">
      <hardware SOAP-ENC:arrayType="ns1:SoftLayer_Hardware[1]" xsi:type="ns1:SoftLayer_HardwareArray">
        <item xsi:type="ns1:SoftLayer_Hardware">
          <domain xsi:type="xsd:string">example.com</domain>
          <hostname xsi:type="xsd:string">server1</hostname>
        </item>
      </hardware>
      <location xsi:type="xsd:string">138124</location>
      <packageId xsi:type="xsd:int">142</packageId>
      <prices SOAP-ENC:arrayType="ns1:SoftLayer_Product_Item_Price[14]" xsi:type="ns1:SoftLayer_Product_Item_PriceArray">
        <item xsi:type="ns1:SoftLayer_Product_Item_Price">
          <id xsi:type="xsd:int">58</id>
        </item>
        <item xsi:type="ns1:SoftLayer_Product_Item_Price">
          <id xsi:type="xsd:int">22337</id>
        </item>
        <item xsi:type="ns1:SoftLayer_Product_Item_Price">
          <id xsi:type="xsd:int">21189</id>
        </item>
        <item xsi:type="ns1:SoftLayer_Product_Item_Price">
          <id xsi:type="xsd:int">876</id>
        </item>
        <item xsi:type="ns1:SoftLayer_Product_Item_Price">
          <id xsi:type="xsd:int">57</id>
        </item>
        <item xsi:type="ns1:SoftLayer_Product_Item_Price">
          <id xsi:type="xsd:int">55</id>
        </item>
        <item xsi:type="ns1:SoftLayer_Product_Item_Price">
          <id xsi:type="xsd:int">21190</id>
        </item>
        <item xsi:type="ns1:SoftLayer_Product_Item_Price">
          <id xsi:type="xsd:int">36381</id>
        </item>
        <item xsi:type="ns1:SoftLayer_Product_Item_Price">
          <id xsi:type="xsd:int">21</id>
        </item>
        <item xsi:type="ns1:SoftLayer_Product_Item_Price">
          <id xsi:type="xsd:int">22013</id>
        </item>
        <item xsi:type="ns1:SoftLayer_Product_Item_Price">
          <id xsi:type="xsd:int">906</id>
        </item>
        <item xsi:type="ns1:SoftLayer_Product_Item_Price">
          <id xsi:type="xsd:int">420</id>
        </item>
        <item xsi:type="ns1:SoftLayer_Product_Item_Price">
          <id xsi:type="xsd:int">418</id>
        </item>
        <item xsi:type="ns1:SoftLayer_Product_Item_Price">
          <id xsi:type="xsd:int">342</id>
        </item>
      </prices>
      <useHourlyPricing xsi:type="xsd:boolean">false</useHourlyPricing>
    </orderData>
    <saveAsQuote xsi:nil="true" />
  </ns1:placeOrder>
</SOAP-ENV:Body>

</SOAP-ENV:Envelope> ```

## Virtual server example

This example includes 2 identical virtual servers (except for hostname) being ordered for hourly billing. It includes an optional image template id and VLAN data specified on the virtualGuest objects - `primaryBackendNetworkComponent` and `primaryNetworkComponent`.

**Warning:** the price ids provided below may be outdated or unavailable, so you will need to determine the

available prices from the virtual server package with [SoftLayer_Product_Package/getAllObjects], which has a [[SoftLayer_Product_Package_Type]] of `VIRTUAL_SERVER_INSTANCE`.

#### Virtual Ordering

```xml <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://api.service.softlayer.com/soap/v3/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> 

<SOAP-ENV:Header>
  <ns1:authenticate>
    <username>your username</username>
    <apiKey>your api key</apiKey>
  </ns1:authenticate>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
  <ns1:placeOrder>
    <orderData xsi:type="ns1:SoftLayer_Container_Product_Order_Virtual_Guest">
      <imageTemplateId xsi:type="xsd:int">13251</imageTemplateId>
      <location xsi:type="xsd:string">37473</location>
      <packageId xsi:type="xsd:int">46</packageId>
      <prices SOAP-ENC:arrayType="ns1:SoftLayer_Product_Item_Price[13]" xsi:type="ns1:SoftLayer_Product_Item_PriceArray">
        <item xsi:type="ns1:SoftLayer_Product_Item_Price">
          <id xsi:type="xsd:int">2159</id>
        </item>
        <item xsi:type="ns1:SoftLayer_Product_Item_Price">
          <id xsi:type="xsd:int">55</id>
        </item>
        <item xsi:type="ns1:SoftLayer_Product_Item_Price">
          <id xsi:type="xsd:int">13754</id>
        </item>
        <item xsi:type="ns1:SoftLayer_Product_Item_Price">
          <id xsi:type="xsd:int">1641</id>
        </item>
        <item xsi:type="ns1:SoftLayer_Product_Item_Price">
          <id xsi:type="xsd:int">905</id>
        </item>
        <item xsi:type="ns1:SoftLayer_Product_Item_Price">
          <id xsi:type="xsd:int">1800</id>
        </item>
        <item xsi:type="ns1:SoftLayer_Product_Item_Price">
          <id xsi:type="xsd:int">58</id>
        </item>
        <item xsi:type="ns1:SoftLayer_Product_Item_Price">
          <id xsi:type="xsd:int">21</id>
        </item>
        <item xsi:type="ns1:SoftLayer_Product_Item_Price">
          <id xsi:type="xsd:int">1645</id>
        </item>
        <item xsi:type="ns1:SoftLayer_Product_Item_Price">
          <id xsi:type="xsd:int">272</id>
        </item>
        <item xsi:type="ns1:SoftLayer_Product_Item_Price">
          <id xsi:type="xsd:int">57</id>
        </item>
        <item xsi:type="ns1:SoftLayer_Product_Item_Price">
          <id xsi:type="xsd:int">418</id>
        </item>
        <item xsi:type="ns1:SoftLayer_Product_Item_Price">
          <id xsi:type="xsd:int">420</id>
        </item>
      </prices>
      <quantity xsi:type="xsd:int">2</quantity>
      <useHourlyPricing xsi:type="xsd:boolean">true</useHourlyPricing>
      <virtualGuests SOAP-ENC:arrayType="ns1:SoftLayer_Virtual_Guest[1]" xsi:type="ns1:SoftLayer_Virtual_GuestArray">
        <item xsi:type="ns1:SoftLayer_Virtual_Guest">
          <domain xsi:type="xsd:string">example.com</domain>
          <hostname xsi:type="xsd:string">server1</hostname>
          <primaryBackendNetworkComponent xsi:type="ns1:SoftLayer_Virtual_Guest_Network_Component">
            <networkVlan xsi:type="ns1:SoftLayer_Network_Vlan">
              <id xsi:type="xsd:int">12345</id>
            </networkVlan>
          </primaryBackendNetworkComponent>
          <primaryNetworkComponent xsi:type="ns1:SoftLayer_Virtual_Guest_Network_Component">
            <networkVlan xsi:type="ns1:SoftLayer_Network_Vlan">
              <id xsi:type="xsd:int">67890</id>
            </networkVlan>
          </primaryNetworkComponent>
        </item>
        <item xsi:type="ns1:SoftLayer_Virtual_Guest">
          <domain xsi:type="xsd:string">example.com</domain>
          <hostname xsi:type="xsd:string">server2</hostname>
          <primaryBackendNetworkComponent xsi:type="ns1:SoftLayer_Virtual_Guest_Network_Component">
            <networkVlan xsi:type="ns1:SoftLayer_Network_Vlan">
              <id xsi:type="xsd:int">12345</id>
            </networkVlan>
          </primaryBackendNetworkComponent>
          <primaryNetworkComponent xsi:type="ns1:SoftLayer_Virtual_Guest_Network_Component">
            <networkVlan xsi:type="ns1:SoftLayer_Network_Vlan">
              <id xsi:type="xsd:int">67890</id>
            </networkVlan>
          </primaryNetworkComponent>
        </item>
      </virtualGuests>
    </orderData>
    <saveAsQuote xsi:nil="true" />
  </ns1:placeOrder>
</SOAP-ENV:Body>

</SOAP-ENV:Envelope> ```

## VLAN example

**Warning:** the price ids provided below may be outdated or unavailable, so you will need to determine the

available prices from the additional services pacakge with [SoftLayer_Product_Package/getAllObjects], which has a [[SoftLayer_Product_Package_Type]] of `ADDITIONAL_SERVICES`. You can get a full list of [[SoftLayer_Product_Package_Type/getAllObjects|]] to find other available additional service packages.<br/><br/>

### VLAN Ordering

```xml <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://api.service.softlayer.com/soap/v3/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> 

<SOAP-ENV:Header>
  <ns1:authenticate>
    <username>your username</username>
    <apiKey>your api key</apiKey>
  </ns1:authenticate>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
  <ns1:placeOrder>
    <orderData xsi:type="ns1:SoftLayer_Container_Product_Order_Network_Vlan">
      <location xsi:type="xsd:string">154820</location>
      <packageId xsi:type="xsd:int">0</packageId>
      <prices SOAP-ENC:arrayType="ns1:SoftLayer_Product_Item_Price[2]" xsi:type="ns1:SoftLayer_Product_Item_PriceArray">
        <item xsi:type="ns1:SoftLayer_Product_Item_Price">
          <id xsi:type="xsd:int">2021</id>
        </item>
        <item xsi:type="ns1:SoftLayer_Product_Item_Price">
          <id xsi:type="xsd:int">2018</id>
        </item>
      </prices>
      <useHourlyPricing xsi:type="xsd:boolean">true</useHourlyPricing>
    </orderData>
    <saveAsQuote xsi:nil="true" />
  </ns1:placeOrder>
</SOAP-ENV:Body>

</SOAP-ENV:Envelope> ```

## Multiple products example

This example includes a combination of the above examples in a single order. Note that all the configuration options for each individual order container are the same as above, except now we encapsulate each one within the `orderContainers` property on the base [[SoftLayer_Container_Product_Order]].

**Warning:** not all products are available to be ordered with other products. For example, since

SSL certificates require validation from a 3rd party, the approval process may take days or even weeks, and this would not be acceptable when you need your hourly virtual server right now. To better accommodate customers, we restrict several products to be ordered individually.

### Bare metal server + virtual server + VLAN

```xml <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://api.service.softlayer.com/soap/v3/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"> 

<SOAP-ENV:Header>
  <ns1:authenticate>
    <username>your username</username>
    <apiKey>your api key</apiKey>
  </ns1:authenticate>
</SOAP-ENV:Header>
<SOAP-ENV:Body>
  <ns1:placeOrder>
    <orderData xsi:type="ns1:SoftLayer_Container_Product_Order">
      <orderContainers SOAP-ENC:arrayType="ns1:SoftLayer_Container_Product_Order[3]" xsi:type="ns1:SoftLayer_Container_Product_OrderArray">
        <item xsi:type="ns1:SoftLayer_Container_Product_Order_Hardware_Server">
          ...
        </item>
        <item xsi:type="ns1:SoftLayer_Container_Product_Order_Virtual_Guest">
          ...
        </item>
        <item xsi:type="ns1:SoftLayer_Container_Product_Order_Network_Vlan">
          ...
        </item>
      </orderContainers>
    </orderData>
    <saveAsQuote xsi:nil="true" />
  </ns1:placeOrder>
</SOAP-ENV:Body>

</SOAP-ENV:Envelope> ```

func (Product_Order) PlaceQuote 

func (r Product_Order) PlaceQuote(orderData interface{}) (resp datatypes.Container_Product_Order_Receipt, err error)

Use this method for placing server quotes and additional services quotes. The same applies for this as with verifyOrder. Send in the SoftLayer_Container_Product_Order_Hardware_Server for server quotes. After placing the quote, you must go to this URL to finish the order process. After going to this URL, it will direct you back to a SoftLayer webpage that tells us you have finished the process. After this, it will go to sales for final approval.

func (Product_Order) ProcessExternalPaymentAuthorization 

func (r Product_Order) ProcessExternalPaymentAuthorization(token *string, payerId *string) (resp datatypes.Container_Product_Order, err error)

no documentation yet Deprecated: This function has been marked as deprecated.

func (Product_Order) RequiredItems 

func (r Product_Order) RequiredItems(itemPrices []datatypes.Product_Item_Price) (resp []datatypes.Product_Item, err error)

Get list of items that are required with the item prices provided

func (Product_Order) VerifyOrder 

func (r Product_Order) VerifyOrder(orderData interface{}) (resp datatypes.Container_Product_Order, err error)

This service is used to verify that an order meets all the necessary requirements to purchase a server, virtual server or service from SoftLayer. It will verify that the products requested do not conflict. For example, you cannot order a Windows firewall with a Linux operating system. It will also check to make sure you have provided all the products that are required for the [[SoftLayer_Product_Package_Order_Configuration]] associated with the [[SoftLayer_Product_Package]] on each of the [[SoftLayer_Container_Product_Order]] specified.<br/><br/>

This service returns the same container that was provided, but with additional information that can be used for debugging or validation. It will also contain pricing information (prorated if applicable) for each of the products on the order. If an exception occurs during verification, a container with the <code>SoftLayer_Exception_Order</code> exception type will be specified in the result.<br/><br/>

<code>verifyOrder</code> accepts the same [[SoftLayer_Container_Product_Order]] as <code>placeOrder</code>, so see [SoftLayer_Product_Order/placeOrder] for more details.

type Product_Package 

type Product_Package struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetProductPackageService 

func GetProductPackageService(sess session.SLSession) Product_Package

GetProductPackageService returns an instance of the Product_Package SoftLayer service

func (Product_Package) Filter 

func (r Product_Package) Filter(filter string) Product_Package

func (Product_Package) GetAccountRestrictedActivePresets 

func (r Product_Package) GetAccountRestrictedActivePresets() (resp []datatypes.Product_Package_Preset, err error)

Retrieve The preset configurations available only for the authenticated account and this package.

func (Product_Package) GetAccountRestrictedCategories 

func (r Product_Package) GetAccountRestrictedCategories() (resp []datatypes.Product_Item_Category, err error)

Retrieve 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.

func (Product_Package) GetAccountRestrictedPricesFlag 

func (r Product_Package) GetAccountRestrictedPricesFlag() (resp bool, err error)

Retrieve The flag to indicate if there are any restricted prices in a package for the currently-active account.

func (Product_Package) GetActiveItems 

func (r Product_Package) GetActiveItems() (resp []datatypes.Product_Item, err error)

Return a list of Items in the package with their active prices.

func (Product_Package) GetActivePackagesByAttribute 

func (r Product_Package) GetActivePackagesByAttribute(attributeKeyName *string) (resp []datatypes.Product_Package, err error)

<strong>This method is deprecated and should not be used in production code.</strong>

This method will return the [[SoftLayer_Product_Package]] objects from which you can order a bare metal server, virtual server, service (such as CDN or Object Storage) or other software filtered by an attribute type associated with the package. Once you have the package you want to order from, you may query one of various endpoints from that package to get specific information about its products and pricing. See [[SoftLayer_Product_Package/getCategories|getCategories]] or [[SoftLayer_Product_Package/getItems|getItems]] for more information. Deprecated: This function has been marked as deprecated.

func (Product_Package) GetActivePresets 

func (r Product_Package) GetActivePresets() (resp []datatypes.Product_Package_Preset, err error)

Retrieve The available preset configurations for this package.

func (Product_Package) GetActivePrivateHostedCloudPackages 

func (r Product_Package) GetActivePrivateHostedCloudPackages() (resp []datatypes.Product_Package, err error)

[DEPRECATED] This method pulls all the active private hosted cloud packages. This will give you a basic description of the packages that are currently active and from which you can order private hosted cloud configurations. Deprecated: This function has been marked as deprecated.

func (Product_Package) GetActiveRamItems 

func (r Product_Package) GetActiveRamItems() (resp []datatypes.Product_Item, err error)

Retrieve A collection of valid RAM items available for purchase in this package.

func (Product_Package) GetActiveServerItems 

func (r Product_Package) GetActiveServerItems() (resp []datatypes.Product_Item, err error)

Retrieve A collection of valid server items available for purchase in this package.

func (Product_Package) GetActiveSoftwareItems 

func (r Product_Package) GetActiveSoftwareItems() (resp []datatypes.Product_Item, err error)

Retrieve A collection of valid software items available for purchase in this package.

func (Product_Package) GetActiveUsagePrices 

func (r Product_Package) GetActiveUsagePrices() (resp []datatypes.Product_Item_Price, err error)

Retrieve A collection of [[SoftLayer_Product_Item_Price]] objects for pay-as-you-go usage.

func (Product_Package) GetActiveUsageRatePrices 

func (r Product_Package) GetActiveUsageRatePrices(locationId *int, categoryCode *string) (resp []datatypes.Product_Item_Price, err error)

This method returns a collection of active usage rate [[SoftLayer_Product_Item_Price]] objects for the current package and specified datacenter. Optionally you can retrieve the active usage rate prices for a particular [[SoftLayer_Product_Item_Category]] by specifying a category code as the first parameter. This information is useful so that you can see "pay as you go" rates (if any) for the current package, location and optionally category.

func (Product_Package) GetAdditionalServiceFlag 

func (r Product_Package) GetAdditionalServiceFlag() (resp bool, err error)

Retrieve This flag indicates that the package is an additional service.

func (Product_Package) GetAllObjects 

func (r Product_Package) GetAllObjects() (resp []datatypes.Product_Package, err error)

This method pulls all the active packages. This will give you a basic description of the packages that are currently active

func (Product_Package) GetAttributes 

func (r Product_Package) GetAttributes() (resp []datatypes.Product_Package_Attribute, err error)

Retrieve

func (Product_Package) GetAvailableLocations 

func (r Product_Package) GetAvailableLocations() (resp []datatypes.Product_Package_Locations, err error)

Retrieve A collection of valid locations for this package. (Deprecated - Use [[SoftLayer_Product_Package/getRegions|getRegions]])

func (Product_Package) GetAvailablePackagesForImageTemplate 

func (r Product_Package) GetAvailablePackagesForImageTemplate(imageTemplate *datatypes.Virtual_Guest_Block_Device_Template_Group) (resp []datatypes.Product_Package, err error)

no documentation yet

func (Product_Package) GetAvailableStorageUnits 

func (r Product_Package) GetAvailableStorageUnits() (resp uint, err error)

Retrieve The maximum number of available disk storage units associated with the servers in a package.

func (Product_Package) GetCategories 

func (r Product_Package) GetCategories() (resp []datatypes.Product_Item_Category, err error)

Retrieve This is a collection of categories ([[SoftLayer_Product_Item_Category]]) associated with a package which can be used for ordering. These categories have several objects prepopulated which are useful when determining the available products for purchase. The categories contain groups ([[SoftLayer_Product_Package_Item_Category_Group]]) that organize the products and prices by similar features. For example, operating systems will be grouped by their manufacturer and virtual server disks will be grouped by their disk type (SAN vs. local). Each group will contain prices ([[SoftLayer_Product_Item_Price]]) which you can use determine the cost of each product. Each price has a product ([[SoftLayer_Product_Item]]) which provides the name and other useful information about the server, service or software you may purchase.

func (Product_Package) GetCdnItems 

func (r Product_Package) GetCdnItems() (resp []datatypes.Product_Item, err error)

no documentation yet

func (Product_Package) GetCloudStorageItems 

func (r Product_Package) GetCloudStorageItems(provider *int) (resp []datatypes.Product_Item, err error)

no documentation yet

func (Product_Package) GetConfiguration 

func (r Product_Package) GetConfiguration() (resp []datatypes.Product_Package_Order_Configuration, err error)

Retrieve The item categories associated with a package, including information detailing which item categories are required as part of a SoftLayer product order.

func (Product_Package) GetDefaultBootCategoryCode added in v1.0.1 

func (r Product_Package) GetDefaultBootCategoryCode() (resp string, err error)

Retrieve The default boot category code for the package.

func (Product_Package) GetDefaultRamItems 

func (r Product_Package) GetDefaultRamItems() (resp []datatypes.Product_Item, err error)

Retrieve A collection of valid RAM items available for purchase in this package.

func (Product_Package) GetDeploymentNodeType 

func (r Product_Package) GetDeploymentNodeType() (resp string, err error)

Retrieve The node type for a package in a solution deployment.

func (Product_Package) GetDeploymentPackages 

func (r Product_Package) GetDeploymentPackages() (resp []datatypes.Product_Package, err error)

Retrieve The packages that are allowed in a multi-server solution. (Deprecated)

func (Product_Package) GetDeploymentType 

func (r Product_Package) GetDeploymentType() (resp string, err error)

Retrieve The solution deployment type.

func (Product_Package) GetDeployments 

func (r Product_Package) GetDeployments() (resp []datatypes.Product_Package, err error)

Retrieve The package that represents a multi-server solution. (Deprecated)

func (Product_Package) GetDisallowCustomDiskPartitions 

func (r Product_Package) GetDisallowCustomDiskPartitions() (resp bool, err error)

Retrieve This flag indicates the package does not allow custom disk partitions.

func (Product_Package) GetFirstOrderStep 

func (r Product_Package) GetFirstOrderStep() (resp datatypes.Product_Package_Order_Step, err error)

Retrieve The Softlayer order step is optionally step-based. This returns the first SoftLayer_Product_Package_Order_Step in the step-based order process.

func (Product_Package) GetGatewayApplianceFlag 

func (r Product_Package) GetGatewayApplianceFlag() (resp bool, err error)

Retrieve Whether the package is a specialized network gateway appliance package.

func (Product_Package) GetGpuFlag 

func (r Product_Package) GetGpuFlag() (resp bool, err error)

Retrieve This flag indicates that the package supports GPUs.

func (Product_Package) GetHourlyBillingAvailableFlag 

func (r Product_Package) GetHourlyBillingAvailableFlag() (resp bool, err error)

Retrieve Determines whether the package contains prices that can be ordered hourly.

func (Product_Package) GetHourlyOnlyOrders 

func (r Product_Package) GetHourlyOnlyOrders() (resp bool, err error)

Retrieve Packages with this flag do not allow monthly orders.

func (Product_Package) GetItemAvailabilityTypes 

func (r Product_Package) GetItemAvailabilityTypes() (resp []datatypes.Product_Item_Attribute_Type, err error)

Returns a collection of SoftLayer_Product_Item_Attribute_Type objects. These item attribute types specifically deal with when an item, SoftLayer_Product_Item, from the product catalog may no longer be available. The keynames for these attribute types start with 'UNAVAILABLE_AFTER_DATE_*', where the '*' may represent any string. For example, 'UNAVAILABLE_AFTER_DATE_NEW_ORDERS', signifies that the item is not available for new orders. There is a catch all attribute type, 'UNAVAILABLE_AFTER_DATE_ALL'. If an item has one of these availability attributes set, the value should be a valid date in MM/DD/YYYY, indicating the date after which the item will no longer be available.

func (Product_Package) GetItemConflicts 

func (r Product_Package) GetItemConflicts() (resp []datatypes.Product_Item_Resource_Conflict, err error)

Retrieve The item-item conflicts associated with a package.

func (Product_Package) GetItemLocationConflicts 

func (r Product_Package) GetItemLocationConflicts() (resp []datatypes.Product_Item_Resource_Conflict, err error)

Retrieve The item-location conflicts associated with a package.

func (Product_Package) GetItemPriceReferences 

func (r Product_Package) GetItemPriceReferences() (resp []datatypes.Product_Package_Item_Prices, err error)

Retrieve cross reference for item prices

func (Product_Package) GetItemPrices 

func (r Product_Package) GetItemPrices() (resp []datatypes.Product_Item_Price, err error)

Retrieve A collection of SoftLayer_Product_Item_Prices that are valid for this package.

func (Product_Package) GetItemPricesFromSoftwareDescriptions 

func (r Product_Package) GetItemPricesFromSoftwareDescriptions(softwareDescriptions []datatypes.Software_Description, includeTranslationsFlag *bool, returnAllPricesFlag *bool) (resp []datatypes.Product_Item_Price, err error)

Return a collection of SoftLayer_Item_Price objects from a collection of SoftLayer_Software_Description

func (Product_Package) GetItems 

func (r Product_Package) GetItems() (resp []datatypes.Product_Item, err error)

Retrieve A collection of valid items available for purchase in this package.

func (Product_Package) GetItemsFromImageTemplate 

func (r Product_Package) GetItemsFromImageTemplate(imageTemplate *datatypes.Virtual_Guest_Block_Device_Template_Group) (resp []datatypes.Product_Item, err error)

Return a collection of [[SoftLayer_Product_Item]] objects from a [[SoftLayer_Virtual_Guest_Block_Device_Template_Group]] object

func (Product_Package) GetLocations 

func (r Product_Package) GetLocations() (resp []datatypes.Location, err error)

Retrieve A collection of valid locations for this package. (Deprecated - Use [[SoftLayer_Product_Package/getRegions|getRegions]])

func (Product_Package) GetLowestServerPrice 

func (r Product_Package) GetLowestServerPrice() (resp datatypes.Product_Item_Price, err error)

Retrieve The lowest server [[SoftLayer_Product_Item_Price]] related to this package.

func (Product_Package) GetMaximumPortSpeed 

func (r Product_Package) GetMaximumPortSpeed() (resp uint, err error)

Retrieve The maximum available network speed associated with the package.

func (Product_Package) GetMessageQueueItems 

func (r Product_Package) GetMessageQueueItems() (resp []datatypes.Product_Item, err error)

no documentation yet

func (Product_Package) GetMinimumPortSpeed 

func (r Product_Package) GetMinimumPortSpeed() (resp uint, err error)

Retrieve The minimum available network speed associated with the package.

func (Product_Package) GetMongoDbEngineeredFlag 

func (r Product_Package) GetMongoDbEngineeredFlag() (resp bool, err error)

Retrieve This flag indicates that this is a MongoDB engineered package. (Deprecated)

func (Product_Package) GetNoUpgradesFlag added in v1.0.2 

func (r Product_Package) GetNoUpgradesFlag() (resp bool, err error)

Retrieve Services ordered from this package cannot have upgrades or downgrades performed.

func (Product_Package) GetNonEuCompliantFlag 

func (r Product_Package) GetNonEuCompliantFlag() (resp bool, err error)

Retrieve Whether the package is not in compliance with EU support.

func (Product_Package) GetObject 

func (r Product_Package) GetObject() (resp datatypes.Product_Package, err error)

no documentation yet

func (Product_Package) GetObjectStorageDatacenters 

func (r Product_Package) GetObjectStorageDatacenters() (resp []datatypes.Container_Product_Order_Network_Storage_Hub_Datacenter, err error)

This method will return a collection of [[SoftLayer_Container_Product_Order_Network_Storage_Hub_Datacenter]] objects which contain a datacenter location and all the associated active usage rate prices where object storage is available. This method is really only applicable to the object storage additional service package which has a [[SoftLayer_Product_Package_Type]] of ”'ADDITIONAL_SERVICES_OBJECT_STORAGE”'. This information is useful so that you can see the "pay as you go" rates per datacenter.

func (Product_Package) GetObjectStorageLocationGroups 

func (r Product_Package) GetObjectStorageLocationGroups() (resp []datatypes.Container_Product_Order_Network_Storage_ObjectStorage_LocationGroup, err error)

This method will return a collection of [[SoftLayer_Container_Product_Order_Network_Storage_ObjectStorage_LocationGroup]] objects which contain a location group and all the associated active usage rate prices where object storage is available. This method is really only applicable to the object storage additional service package which has a [[SoftLayer_Product_Package_Type]] of ”'ADDITIONAL_SERVICES_OBJECT_STORAGE”'. This information is useful so that you can see the "pay as you go" rates per location group.

func (Product_Package) GetOrderPremiums 

func (r Product_Package) GetOrderPremiums() (resp []datatypes.Product_Item_Price_Premium, err error)

Retrieve The premium price modifiers associated with the [[SoftLayer_Product_Item_Price]] and [[SoftLayer_Location]] objects in a package.

func (Product_Package) GetPopLocationAvailabilityFlag 

func (r Product_Package) GetPopLocationAvailabilityFlag() (resp bool, err error)

Retrieve This flag indicates if the package may be available in PoP locations in addition to Datacenters.

func (Product_Package) GetPreconfiguredFlag 

func (r Product_Package) GetPreconfiguredFlag() (resp bool, err error)

Retrieve This flag indicates the package is pre-configured. (Deprecated)

func (Product_Package) GetPresetConfigurationRequiredFlag 

func (r Product_Package) GetPresetConfigurationRequiredFlag() (resp bool, err error)

Retrieve Whether the package requires the user to define a preset configuration.

func (Product_Package) GetPreventVlanSelectionFlag 

func (r Product_Package) GetPreventVlanSelectionFlag() (resp bool, err error)

Retrieve Whether the package prevents the user from specifying a Vlan.

func (Product_Package) GetPrivateHostedCloudPackageFlag 

func (r Product_Package) GetPrivateHostedCloudPackageFlag() (resp bool, err error)

Retrieve This flag indicates the package is for a private hosted cloud deployment. (Deprecated)

func (Product_Package) GetPrivateHostedCloudPackageType 

func (r Product_Package) GetPrivateHostedCloudPackageType() (resp string, err error)

Retrieve The server role of the private hosted cloud deployment. (Deprecated)

func (Product_Package) GetPrivateNetworkOnlyFlag 

func (r Product_Package) GetPrivateNetworkOnlyFlag() (resp bool, err error)

Retrieve Whether the package only has access to the private network.

func (Product_Package) GetQuantaStorPackageFlag 

func (r Product_Package) GetQuantaStorPackageFlag() (resp bool, err error)

Retrieve Whether the package is a specialized mass storage QuantaStor package. (Deprecated)

func (Product_Package) GetRaidDiskRestrictionFlag 

func (r Product_Package) GetRaidDiskRestrictionFlag() (resp bool, err error)

Retrieve This flag indicates the package does not allow different disks with RAID.

func (Product_Package) GetRedundantPowerFlag 

func (r Product_Package) GetRedundantPowerFlag() (resp bool, err error)

Retrieve This flag determines if the package contains a redundant power supply product.

func (Product_Package) GetRegions 

func (r Product_Package) GetRegions() (resp []datatypes.Location_Region, err error)

Retrieve The regional locations that a package is available in.

func (Product_Package) GetStandardCategories 

func (r Product_Package) GetStandardCategories() (resp []datatypes.Product_Item_Category, err error)

This call is similar to [[SoftLayer_Product_Package/getCategories|getCategories]], except that it does not include account-restricted pricing. Not all accounts have restricted pricing.

func (Product_Package) GetTopLevelItemCategoryCode 

func (r Product_Package) GetTopLevelItemCategoryCode() (resp string, err error)

Retrieve The top level category code for this service offering.

func (Product_Package) GetType 

func (r Product_Package) GetType() (resp datatypes.Product_Package_Type, err error)

Retrieve The type of service offering. This property can be used to help filter packages.

func (Product_Package) Id 

func (r Product_Package) Id(id int) Product_Package

func (Product_Package) Limit 

func (r Product_Package) Limit(limit int) Product_Package

func (Product_Package) Mask 

func (r Product_Package) Mask(mask string) Product_Package

func (Product_Package) Offset 

func (r Product_Package) Offset(offset int) Product_Package

type Product_Package_Preset 

type Product_Package_Preset struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetProductPackagePresetService 

func GetProductPackagePresetService(sess session.SLSession) Product_Package_Preset

GetProductPackagePresetService returns an instance of the Product_Package_Preset SoftLayer service

func (Product_Package_Preset) Filter 

func (r Product_Package_Preset) Filter(filter string) Product_Package_Preset

func (Product_Package_Preset) GetAllObjects 

func (r Product_Package_Preset) GetAllObjects() (resp []datatypes.Product_Package_Preset, err error)

This method returns all the active package presets.

func (Product_Package_Preset) GetAvailableStorageUnits 

func (r Product_Package_Preset) GetAvailableStorageUnits() (resp uint, err error)

Retrieve

func (Product_Package_Preset) GetBareMetalReservedFlag 

func (r Product_Package_Preset) GetBareMetalReservedFlag() (resp bool, err error)

Retrieve When true this preset is for ordering a Bare Metal Reserved server.

func (Product_Package_Preset) GetCategories 

func (r Product_Package_Preset) GetCategories() (resp []datatypes.Product_Item_Category, err error)

Retrieve The item categories that are included in this package preset configuration.

func (Product_Package_Preset) GetComputeGroup 

func (r Product_Package_Preset) GetComputeGroup() (resp datatypes.Product_Item_Server_Group, err error)

Retrieve The compute family this configuration belongs to.

func (Product_Package_Preset) GetConfiguration 

func (r Product_Package_Preset) GetConfiguration() (resp []datatypes.Product_Package_Preset_Configuration, err error)

Retrieve The preset configuration (category and price).

func (Product_Package_Preset) GetDisallowedComputeGroupUpgradeFlag 

func (r Product_Package_Preset) GetDisallowedComputeGroupUpgradeFlag() (resp bool, err error)

Retrieve When true this preset is only allowed to upgrade/downgrade to other presets in the same compute family.

func (Product_Package_Preset) GetFixedConfigurationFlag 

func (r Product_Package_Preset) GetFixedConfigurationFlag() (resp bool, err error)

Retrieve A package preset with this flag set will not allow the price's defined in the preset configuration to be overriden during order placement.

func (Product_Package_Preset) GetLocations 

func (r Product_Package_Preset) GetLocations() (resp []datatypes.Location, err error)

Retrieve The locations this preset configuration is available in. If empty the preset is available in all locations the package is available in.

func (Product_Package_Preset) GetLowestPresetServerPrice 

func (r Product_Package_Preset) GetLowestPresetServerPrice() (resp datatypes.Product_Item_Price, err error)

Retrieve The lowest server prices related to this package preset.

func (Product_Package_Preset) GetObject 

func (r Product_Package_Preset) GetObject() (resp datatypes.Product_Package_Preset, err error)

no documentation yet

func (Product_Package_Preset) GetPackage 

func (r Product_Package_Preset) GetPackage() (resp datatypes.Product_Package, err error)

Retrieve The package this preset belongs to.

func (Product_Package_Preset) GetPackageConfiguration 

func (r Product_Package_Preset) GetPackageConfiguration() (resp []datatypes.Product_Package_Order_Configuration, err error)

Retrieve The item categories associated with a package preset, including information detailing which item categories are required as part of a SoftLayer product order.

func (Product_Package_Preset) GetPrices 

func (r Product_Package_Preset) GetPrices() (resp []datatypes.Product_Item_Price, err error)

Retrieve The item prices that are included in this package preset configuration.

func (Product_Package_Preset) GetStorageGroupTemplateArrays 

func (r Product_Package_Preset) GetStorageGroupTemplateArrays() (resp []datatypes.Configuration_Storage_Group_Template_Group, err error)

Retrieve Describes how all disks in this preset will be configured.

func (Product_Package_Preset) GetTotalMinimumHourlyFee 

func (r Product_Package_Preset) GetTotalMinimumHourlyFee() (resp datatypes.Float64, err error)

Retrieve The starting hourly price for this configuration. Additional options not defined in the preset may increase the cost.

func (Product_Package_Preset) GetTotalMinimumRecurringFee 

func (r Product_Package_Preset) GetTotalMinimumRecurringFee() (resp datatypes.Float64, err error)

Retrieve The starting monthly price for this configuration. Additional options not defined in the preset may increase the cost.

func (Product_Package_Preset) Id 

func (r Product_Package_Preset) Id(id int) Product_Package_Preset

func (Product_Package_Preset) Limit 

func (r Product_Package_Preset) Limit(limit int) Product_Package_Preset

func (Product_Package_Preset) Mask 

func (r Product_Package_Preset) Mask(mask string) Product_Package_Preset

func (Product_Package_Preset) Offset 

func (r Product_Package_Preset) Offset(offset int) Product_Package_Preset

type Product_Package_Server 

type Product_Package_Server struct {
	Session session.SLSession
	Options sl.Options
}

The SoftLayer_Product_Package_Server data type contains summarized information for bare metal servers regarding pricing, processor stats, and feature sets.

func GetProductPackageServerService 

func GetProductPackageServerService(sess session.SLSession) Product_Package_Server

GetProductPackageServerService returns an instance of the Product_Package_Server SoftLayer service

func (Product_Package_Server) Filter 

func (r Product_Package_Server) Filter(filter string) Product_Package_Server

func (Product_Package_Server) GetAllObjects 

func (r Product_Package_Server) GetAllObjects() (resp []datatypes.Product_Package_Server, err error)

This method will grab all the package servers.

func (Product_Package_Server) GetCatalog 

func (r Product_Package_Server) GetCatalog() (resp datatypes.Product_Catalog, err error)

Retrieve

func (Product_Package_Server) GetItem 

func (r Product_Package_Server) GetItem() (resp datatypes.Product_Item, err error)

Retrieve

func (Product_Package_Server) GetItemPrice 

func (r Product_Package_Server) GetItemPrice() (resp datatypes.Product_Item_Price, err error)

Retrieve

func (Product_Package_Server) GetObject 

func (r Product_Package_Server) GetObject() (resp datatypes.Product_Package_Server, err error)

no documentation yet

func (Product_Package_Server) GetPackage 

func (r Product_Package_Server) GetPackage() (resp datatypes.Product_Package, err error)

Retrieve

func (Product_Package_Server) GetPreset 

func (r Product_Package_Server) GetPreset() (resp datatypes.Product_Package_Preset, err error)

Retrieve

func (Product_Package_Server) Id 

func (r Product_Package_Server) Id(id int) Product_Package_Server

func (Product_Package_Server) Limit 

func (r Product_Package_Server) Limit(limit int) Product_Package_Server

func (Product_Package_Server) Mask 

func (r Product_Package_Server) Mask(mask string) Product_Package_Server

func (Product_Package_Server) Offset 

func (r Product_Package_Server) Offset(offset int) Product_Package_Server

type Product_Package_Server_Option 

type Product_Package_Server_Option struct {
	Session session.SLSession
	Options sl.Options
}

The [[SoftLayer_Product_Package_Server_Option]] data type contains various data points associated with package servers that can be used in selection criteria.

func GetProductPackageServerOptionService 

func GetProductPackageServerOptionService(sess session.SLSession) Product_Package_Server_Option

GetProductPackageServerOptionService returns an instance of the Product_Package_Server_Option SoftLayer service

func (Product_Package_Server_Option) Filter 

func (r Product_Package_Server_Option) Filter(filter string) Product_Package_Server_Option

func (Product_Package_Server_Option) GetAllOptions 

func (r Product_Package_Server_Option) GetAllOptions() (resp []datatypes.Product_Package_Server_Option, err error)

This method will grab all the package server options.

func (Product_Package_Server_Option) GetObject 

func (r Product_Package_Server_Option) GetObject() (resp datatypes.Product_Package_Server_Option, err error)

no documentation yet

func (Product_Package_Server_Option) GetOptions 

func (r Product_Package_Server_Option) GetOptions(typ *string) (resp []datatypes.Product_Package_Server_Option, err error)

This method will grab all the package server options for the specified type.

func (Product_Package_Server_Option) Id 

func (r Product_Package_Server_Option) Id(id int) Product_Package_Server_Option

func (Product_Package_Server_Option) Limit 

func (r Product_Package_Server_Option) Limit(limit int) Product_Package_Server_Option

func (Product_Package_Server_Option) Mask 

func (r Product_Package_Server_Option) Mask(mask string) Product_Package_Server_Option

func (Product_Package_Server_Option) Offset 

func (r Product_Package_Server_Option) Offset(offset int) Product_Package_Server_Option

type Product_Package_Type 

type Product_Package_Type struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetProductPackageTypeService 

func GetProductPackageTypeService(sess session.SLSession) Product_Package_Type

GetProductPackageTypeService returns an instance of the Product_Package_Type SoftLayer service

func (Product_Package_Type) Filter 

func (r Product_Package_Type) Filter(filter string) Product_Package_Type

func (Product_Package_Type) GetAllObjects 

func (r Product_Package_Type) GetAllObjects() (resp []datatypes.Product_Package_Type, err error)

This method will return all of the available package types.

func (Product_Package_Type) GetObject 

func (r Product_Package_Type) GetObject() (resp datatypes.Product_Package_Type, err error)

no documentation yet

func (Product_Package_Type) GetPackages 

func (r Product_Package_Type) GetPackages() (resp []datatypes.Product_Package, err error)

Retrieve All the packages associated with the given package type.

func (Product_Package_Type) Id 

func (r Product_Package_Type) Id(id int) Product_Package_Type

func (Product_Package_Type) Limit 

func (r Product_Package_Type) Limit(limit int) Product_Package_Type

func (Product_Package_Type) Mask 

func (r Product_Package_Type) Mask(mask string) Product_Package_Type

func (Product_Package_Type) Offset 

func (r Product_Package_Type) Offset(offset int) Product_Package_Type

type Product_Promotion 

type Product_Promotion struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetProductPromotionService 

func GetProductPromotionService(sess session.SLSession) Product_Promotion

GetProductPromotionService returns an instance of the Product_Promotion SoftLayer service

func (Product_Promotion) Filter 

func (r Product_Promotion) Filter(filter string) Product_Promotion

func (Product_Promotion) FindByPromoCode 

func (r Product_Promotion) FindByPromoCode(code *string) (resp datatypes.Container_Product_Promotion, err error)

Retrieves a promotion using its code.

func (Product_Promotion) GetObject 

func (r Product_Promotion) GetObject() (resp datatypes.Product_Promotion, err error)

no documentation yet

func (Product_Promotion) Id 

func (r Product_Promotion) Id(id int) Product_Promotion

func (Product_Promotion) Limit 

func (r Product_Promotion) Limit(limit int) Product_Promotion

func (Product_Promotion) Mask 

func (r Product_Promotion) Mask(mask string) Product_Promotion

func (Product_Promotion) Offset 

func (r Product_Promotion) Offset(offset int) Product_Promotion

type Product_Upgrade_Request 

type Product_Upgrade_Request struct {
	Session session.SLSession
	Options sl.Options
}

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]].

func GetProductUpgradeRequestService 

func GetProductUpgradeRequestService(sess session.SLSession) Product_Upgrade_Request

GetProductUpgradeRequestService returns an instance of the Product_Upgrade_Request SoftLayer service

func (Product_Upgrade_Request) ApproveChanges 

func (r Product_Upgrade_Request) ApproveChanges() (resp bool, err error)

When a change is made to an upgrade by Sales, this method will approve the changes that were made. A customer must acknowledge the change and approve it so that the upgrade request can proceed.

func (Product_Upgrade_Request) Filter 

func (r Product_Upgrade_Request) Filter(filter string) Product_Upgrade_Request

func (Product_Upgrade_Request) GetAccount 

func (r Product_Upgrade_Request) GetAccount() (resp datatypes.Account, err error)

Retrieve The account that an order belongs to

func (Product_Upgrade_Request) GetCompletedFlag 

func (r Product_Upgrade_Request) GetCompletedFlag() (resp bool, err error)

Retrieve Indicates that the upgrade request has completed or has been cancelled.

func (Product_Upgrade_Request) GetInvoice 

func (r Product_Upgrade_Request) GetInvoice() (resp datatypes.Billing_Invoice, err error)

Retrieve This is the invoice associated with the upgrade request. For hourly servers or services, an invoice will not be available.

func (Product_Upgrade_Request) GetObject 

func (r Product_Upgrade_Request) GetObject() (resp datatypes.Product_Upgrade_Request, err error)

getObject retrieves a SoftLayer_Product_Upgrade_Request object on your account whose ID corresponds to the ID of the init parameter passed to the SoftLayer_Product_Upgrade_Request service.

func (Product_Upgrade_Request) GetOrder 

func (r Product_Upgrade_Request) GetOrder() (resp datatypes.Billing_Order, err error)

Retrieve An order record associated to the upgrade request

func (Product_Upgrade_Request) GetServer 

func (r Product_Upgrade_Request) GetServer() (resp datatypes.Hardware, err error)

Retrieve A server object associated with the upgrade request if any.

func (Product_Upgrade_Request) GetStatus 

func (r Product_Upgrade_Request) GetStatus() (resp datatypes.Product_Upgrade_Request_Status, err error)

Retrieve The current status of the upgrade request.

func (Product_Upgrade_Request) GetTicket 

func (r Product_Upgrade_Request) GetTicket() (resp datatypes.Ticket, err error)

Retrieve The ticket that is used to coordinate the upgrade process.

func (Product_Upgrade_Request) GetUser 

func (r Product_Upgrade_Request) GetUser() (resp datatypes.User_Customer, err error)

Retrieve The user that placed the order.

func (Product_Upgrade_Request) GetVirtualGuest 

func (r Product_Upgrade_Request) GetVirtualGuest() (resp datatypes.Virtual_Guest, err error)

Retrieve A virtual server object associated with the upgrade request if any.

func (Product_Upgrade_Request) Id 

func (r Product_Upgrade_Request) Id(id int) Product_Upgrade_Request

func (Product_Upgrade_Request) Limit 

func (r Product_Upgrade_Request) Limit(limit int) Product_Upgrade_Request

func (Product_Upgrade_Request) Mask 

func (r Product_Upgrade_Request) Mask(mask string) Product_Upgrade_Request

func (Product_Upgrade_Request) Offset 

func (r Product_Upgrade_Request) Offset(offset int) Product_Upgrade_Request

func (Product_Upgrade_Request) UpdateMaintenanceWindow 

func (r Product_Upgrade_Request) UpdateMaintenanceWindow(maintenanceStartTime *string, maintenanceWindowId *int) (resp bool, err error)

In case an upgrade cannot be performed, the maintenance window needs to be updated to a future date.

type Provisioning_Hook 

type Provisioning_Hook struct {
	Session session.SLSession
	Options sl.Options
}

The SoftLayer_Provisioning_Hook contains all the information needed to add a hook into a server/Virtual provision and os reload.

func GetProvisioningHookService 

func GetProvisioningHookService(sess session.SLSession) Provisioning_Hook

GetProvisioningHookService returns an instance of the Provisioning_Hook SoftLayer service

func (Provisioning_Hook) CreateObject 

func (r Provisioning_Hook) CreateObject(templateObject *datatypes.Provisioning_Hook) (resp datatypes.Provisioning_Hook, err error)

no documentation yet

func (Provisioning_Hook) DeleteObject 

func (r Provisioning_Hook) DeleteObject() (resp bool, err error)

no documentation yet

func (Provisioning_Hook) EditObject 

func (r Provisioning_Hook) EditObject(templateObject *datatypes.Provisioning_Hook) (resp bool, err error)

no documentation yet

func (Provisioning_Hook) Filter 

func (r Provisioning_Hook) Filter(filter string) Provisioning_Hook

func (Provisioning_Hook) GetAccount 

func (r Provisioning_Hook) GetAccount() (resp datatypes.Account, err error)

Retrieve

func (Provisioning_Hook) GetHookType 

func (r Provisioning_Hook) GetHookType() (resp datatypes.Provisioning_Hook_Type, err error)

Retrieve

func (Provisioning_Hook) GetObject 

func (r Provisioning_Hook) GetObject() (resp datatypes.Provisioning_Hook, err error)

no documentation yet

func (Provisioning_Hook) Id 

func (r Provisioning_Hook) Id(id int) Provisioning_Hook

func (Provisioning_Hook) Limit 

func (r Provisioning_Hook) Limit(limit int) Provisioning_Hook

func (Provisioning_Hook) Mask 

func (r Provisioning_Hook) Mask(mask string) Provisioning_Hook

func (Provisioning_Hook) Offset 

func (r Provisioning_Hook) Offset(offset int) Provisioning_Hook

type Provisioning_Hook_Type 

type Provisioning_Hook_Type struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetProvisioningHookTypeService 

func GetProvisioningHookTypeService(sess session.SLSession) Provisioning_Hook_Type

GetProvisioningHookTypeService returns an instance of the Provisioning_Hook_Type SoftLayer service

func (Provisioning_Hook_Type) Filter 

func (r Provisioning_Hook_Type) Filter(filter string) Provisioning_Hook_Type

func (Provisioning_Hook_Type) GetAllHookTypes 

func (r Provisioning_Hook_Type) GetAllHookTypes() (resp []datatypes.Provisioning_Hook_Type, err error)

no documentation yet

func (Provisioning_Hook_Type) GetObject 

func (r Provisioning_Hook_Type) GetObject() (resp datatypes.Provisioning_Hook_Type, err error)

no documentation yet

func (Provisioning_Hook_Type) Id 

func (r Provisioning_Hook_Type) Id(id int) Provisioning_Hook_Type

func (Provisioning_Hook_Type) Limit 

func (r Provisioning_Hook_Type) Limit(limit int) Provisioning_Hook_Type

func (Provisioning_Hook_Type) Mask 

func (r Provisioning_Hook_Type) Mask(mask string) Provisioning_Hook_Type

func (Provisioning_Hook_Type) Offset 

func (r Provisioning_Hook_Type) Offset(offset int) Provisioning_Hook_Type

type Provisioning_Maintenance_Classification 

type Provisioning_Maintenance_Classification struct {
	Session session.SLSession
	Options sl.Options
}

The SoftLayer_Provisioning_Maintenance_Classification represent a maintenance type for the specific hardware maintenance desired.

func GetProvisioningMaintenanceClassificationService 

func GetProvisioningMaintenanceClassificationService(sess session.SLSession) Provisioning_Maintenance_Classification

GetProvisioningMaintenanceClassificationService returns an instance of the Provisioning_Maintenance_Classification SoftLayer service

func (Provisioning_Maintenance_Classification) Filter 

func (r Provisioning_Maintenance_Classification) Filter(filter string) Provisioning_Maintenance_Classification

func (Provisioning_Maintenance_Classification) GetItemCategories 

func (r Provisioning_Maintenance_Classification) GetItemCategories() (resp []datatypes.Provisioning_Maintenance_Classification_Item_Category, err error)

Retrieve

func (Provisioning_Maintenance_Classification) GetMaintenanceClassification 

func (r Provisioning_Maintenance_Classification) GetMaintenanceClassification(maintenanceClassificationId *int) (resp []datatypes.Provisioning_Maintenance_Classification, err error)

Retrieve an array of SoftLayer_Provisioning_Maintenance_Classification data types, which contain all maintenance classifications.

func (Provisioning_Maintenance_Classification) GetMaintenanceClassificationsByItemCategory 

func (r Provisioning_Maintenance_Classification) GetMaintenanceClassificationsByItemCategory() (resp []datatypes.Provisioning_Maintenance_Classification_Item_Category, err error)

Retrieve an array of SoftLayer_Provisioning_Maintenance_Classification data types, which contain all maintenance classifications.

func (Provisioning_Maintenance_Classification) GetObject 

func (r Provisioning_Maintenance_Classification) GetObject() (resp datatypes.Provisioning_Maintenance_Classification, err error)

no documentation yet

func (Provisioning_Maintenance_Classification) Id 

func (r Provisioning_Maintenance_Classification) Id(id int) Provisioning_Maintenance_Classification

func (Provisioning_Maintenance_Classification) Limit 

func (r Provisioning_Maintenance_Classification) Limit(limit int) Provisioning_Maintenance_Classification

func (Provisioning_Maintenance_Classification) Mask 

func (r Provisioning_Maintenance_Classification) Mask(mask string) Provisioning_Maintenance_Classification

func (Provisioning_Maintenance_Classification) Offset 

func (r Provisioning_Maintenance_Classification) Offset(offset int) Provisioning_Maintenance_Classification

type Provisioning_Maintenance_Classification_Item_Category 

type Provisioning_Maintenance_Classification_Item_Category struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetProvisioningMaintenanceClassificationItemCategoryService 

func GetProvisioningMaintenanceClassificationItemCategoryService(sess session.SLSession) Provisioning_Maintenance_Classification_Item_Category

GetProvisioningMaintenanceClassificationItemCategoryService returns an instance of the Provisioning_Maintenance_Classification_Item_Category SoftLayer service

func (Provisioning_Maintenance_Classification_Item_Category) Filter 

func (r Provisioning_Maintenance_Classification_Item_Category) Filter(filter string) Provisioning_Maintenance_Classification_Item_Category

func (Provisioning_Maintenance_Classification_Item_Category) GetMaintenanceClassification 

func (r Provisioning_Maintenance_Classification_Item_Category) GetMaintenanceClassification() (resp datatypes.Provisioning_Maintenance_Classification, err error)

Retrieve

func (Provisioning_Maintenance_Classification_Item_Category) GetObject 

func (r Provisioning_Maintenance_Classification_Item_Category) GetObject() (resp datatypes.Provisioning_Maintenance_Classification_Item_Category, err error)

no documentation yet

func (Provisioning_Maintenance_Classification_Item_Category) Id 

func (r Provisioning_Maintenance_Classification_Item_Category) Id(id int) Provisioning_Maintenance_Classification_Item_Category

func (Provisioning_Maintenance_Classification_Item_Category) Limit 

func (r Provisioning_Maintenance_Classification_Item_Category) Limit(limit int) Provisioning_Maintenance_Classification_Item_Category

func (Provisioning_Maintenance_Classification_Item_Category) Mask 

func (r Provisioning_Maintenance_Classification_Item_Category) Mask(mask string) Provisioning_Maintenance_Classification_Item_Category

func (Provisioning_Maintenance_Classification_Item_Category) Offset 

func (r Provisioning_Maintenance_Classification_Item_Category) Offset(offset int) Provisioning_Maintenance_Classification_Item_Category

type Provisioning_Maintenance_Slots 

type Provisioning_Maintenance_Slots struct {
	Session session.SLSession
	Options sl.Options
}

The SoftLayer_Provisioning_Maintenance_Slots represent the available slots for a given maintenance window at a SoftLayer data center.

func GetProvisioningMaintenanceSlotsService 

func GetProvisioningMaintenanceSlotsService(sess session.SLSession) Provisioning_Maintenance_Slots

GetProvisioningMaintenanceSlotsService returns an instance of the Provisioning_Maintenance_Slots SoftLayer service

func (Provisioning_Maintenance_Slots) Filter 

func (r Provisioning_Maintenance_Slots) Filter(filter string) Provisioning_Maintenance_Slots

func (Provisioning_Maintenance_Slots) GetObject 

func (r Provisioning_Maintenance_Slots) GetObject() (resp datatypes.Provisioning_Maintenance_Slots, err error)

no documentation yet

func (Provisioning_Maintenance_Slots) Id 

func (r Provisioning_Maintenance_Slots) Id(id int) Provisioning_Maintenance_Slots

func (Provisioning_Maintenance_Slots) Limit 

func (r Provisioning_Maintenance_Slots) Limit(limit int) Provisioning_Maintenance_Slots

func (Provisioning_Maintenance_Slots) Mask 

func (r Provisioning_Maintenance_Slots) Mask(mask string) Provisioning_Maintenance_Slots

func (Provisioning_Maintenance_Slots) Offset 

func (r Provisioning_Maintenance_Slots) Offset(offset int) Provisioning_Maintenance_Slots

type Provisioning_Maintenance_Ticket 

type Provisioning_Maintenance_Ticket struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetProvisioningMaintenanceTicketService 

func GetProvisioningMaintenanceTicketService(sess session.SLSession) Provisioning_Maintenance_Ticket

GetProvisioningMaintenanceTicketService returns an instance of the Provisioning_Maintenance_Ticket SoftLayer service

func (Provisioning_Maintenance_Ticket) Filter 

func (r Provisioning_Maintenance_Ticket) Filter(filter string) Provisioning_Maintenance_Ticket

func (Provisioning_Maintenance_Ticket) GetAvailableSlots 

func (r Provisioning_Maintenance_Ticket) GetAvailableSlots() (resp datatypes.Provisioning_Maintenance_Slots, err error)

Retrieve

func (Provisioning_Maintenance_Ticket) GetMaintenanceClass 

func (r Provisioning_Maintenance_Ticket) GetMaintenanceClass() (resp datatypes.Provisioning_Maintenance_Classification, err error)

Retrieve

func (Provisioning_Maintenance_Ticket) GetObject 

func (r Provisioning_Maintenance_Ticket) GetObject() (resp datatypes.Provisioning_Maintenance_Ticket, err error)

no documentation yet

func (Provisioning_Maintenance_Ticket) GetTicket 

func (r Provisioning_Maintenance_Ticket) GetTicket() (resp datatypes.Ticket, err error)

Retrieve

func (Provisioning_Maintenance_Ticket) Id 

func (r Provisioning_Maintenance_Ticket) Id(id int) Provisioning_Maintenance_Ticket

func (Provisioning_Maintenance_Ticket) Limit 

func (r Provisioning_Maintenance_Ticket) Limit(limit int) Provisioning_Maintenance_Ticket

func (Provisioning_Maintenance_Ticket) Mask 

func (r Provisioning_Maintenance_Ticket) Mask(mask string) Provisioning_Maintenance_Ticket

func (Provisioning_Maintenance_Ticket) Offset 

func (r Provisioning_Maintenance_Ticket) Offset(offset int) Provisioning_Maintenance_Ticket

type Provisioning_Maintenance_Window 

type Provisioning_Maintenance_Window struct {
	Session session.SLSession
	Options sl.Options
}

The SoftLayer_Provisioning_Maintenance_Window represent a time window that SoftLayer performs a hardware or software maintenance and upgrades.

func GetProvisioningMaintenanceWindowService 

func GetProvisioningMaintenanceWindowService(sess session.SLSession) Provisioning_Maintenance_Window

GetProvisioningMaintenanceWindowService returns an instance of the Provisioning_Maintenance_Window SoftLayer service

func (Provisioning_Maintenance_Window) AddCustomerUpgradeWindow 

func (r Provisioning_Maintenance_Window) AddCustomerUpgradeWindow(customerUpgradeWindow *datatypes.Container_Provisioning_Maintenance_Window) (resp bool, err error)

getMaintenceWindowForTicket() returns a boolean

func (Provisioning_Maintenance_Window) Filter 

func (r Provisioning_Maintenance_Window) Filter(filter string) Provisioning_Maintenance_Window

func (Provisioning_Maintenance_Window) GetMaintenanceClassifications 

func (r Provisioning_Maintenance_Window) GetMaintenanceClassifications() (resp []datatypes.Provisioning_Maintenance_Classification, err error)

Returns all the maintenance classifications.

func (Provisioning_Maintenance_Window) GetMaintenanceStartEndTime 

func (r Provisioning_Maintenance_Window) GetMaintenanceStartEndTime(ticketId *int) (resp datatypes.Provisioning_Maintenance_Window, err error)

getMaintenanceStartEndTime() returns a specific maintenance window

func (Provisioning_Maintenance_Window) GetMaintenanceWindowForTicket 

func (r Provisioning_Maintenance_Window) GetMaintenanceWindowForTicket(maintenanceWindowId *int) (resp datatypes.Provisioning_Maintenance_Window, err error)

Returns a specific maintenance window.

func (Provisioning_Maintenance_Window) GetMaintenanceWindowTicketsByTicketId 

func (r Provisioning_Maintenance_Window) GetMaintenanceWindowTicketsByTicketId(ticketId *int) (resp []datatypes.Provisioning_Maintenance_Ticket, err error)

getMaintenanceWindowTicketsByTicketId() returns a list maintenance window ticket records by ticket id

func (Provisioning_Maintenance_Window) GetMaintenanceWindows 

func (r Provisioning_Maintenance_Window) GetMaintenanceWindows(beginDate *datatypes.Time, endDate *datatypes.Time, locationId *int, slotsNeeded *int) (resp []datatypes.Provisioning_Maintenance_Window, err error)

This method returns a list of available maintenance windows

func (Provisioning_Maintenance_Window) GetMaintenceWindows 

func (r Provisioning_Maintenance_Window) GetMaintenceWindows(beginDate *datatypes.Time, endDate *datatypes.Time, locationId *int, slotsNeeded *int) (resp []datatypes.Provisioning_Maintenance_Window, err error)

(DEPRECATED) Use [[SoftLayer_Provisioning_Maintenance_Window::getMaintenanceWindows|getMaintenanceWindows]] method. Deprecated: This function has been marked as deprecated.

func (Provisioning_Maintenance_Window) Id 

func (r Provisioning_Maintenance_Window) Id(id int) Provisioning_Maintenance_Window

func (Provisioning_Maintenance_Window) Limit 

func (r Provisioning_Maintenance_Window) Limit(limit int) Provisioning_Maintenance_Window

func (Provisioning_Maintenance_Window) Mask 

func (r Provisioning_Maintenance_Window) Mask(mask string) Provisioning_Maintenance_Window

func (Provisioning_Maintenance_Window) Offset 

func (r Provisioning_Maintenance_Window) Offset(offset int) Provisioning_Maintenance_Window

type Provisioning_Version1_Transaction_Group 

type Provisioning_Version1_Transaction_Group struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetProvisioningVersion1TransactionGroupService 

func GetProvisioningVersion1TransactionGroupService(sess session.SLSession) Provisioning_Version1_Transaction_Group

GetProvisioningVersion1TransactionGroupService returns an instance of the Provisioning_Version1_Transaction_Group SoftLayer service

func (Provisioning_Version1_Transaction_Group) Filter 

func (r Provisioning_Version1_Transaction_Group) Filter(filter string) Provisioning_Version1_Transaction_Group

func (Provisioning_Version1_Transaction_Group) GetAllObjects 

func (r Provisioning_Version1_Transaction_Group) GetAllObjects() (resp []datatypes.Provisioning_Version1_Transaction_Group, err error)

no documentation yet

func (Provisioning_Version1_Transaction_Group) GetObject 

func (r Provisioning_Version1_Transaction_Group) GetObject() (resp datatypes.Provisioning_Version1_Transaction_Group, err error)

getObject retrieves the SoftLayer_Provisioning_Version1_Transaction_Group object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Provisioning_Version1_Transaction_Group service.

func (Provisioning_Version1_Transaction_Group) Id 

func (r Provisioning_Version1_Transaction_Group) Id(id int) Provisioning_Version1_Transaction_Group

func (Provisioning_Version1_Transaction_Group) Limit 

func (r Provisioning_Version1_Transaction_Group) Limit(limit int) Provisioning_Version1_Transaction_Group

func (Provisioning_Version1_Transaction_Group) Mask 

func (r Provisioning_Version1_Transaction_Group) Mask(mask string) Provisioning_Version1_Transaction_Group

func (Provisioning_Version1_Transaction_Group) Offset 

func (r Provisioning_Version1_Transaction_Group) Offset(offset int) Provisioning_Version1_Transaction_Group

type Provisioning_Version1_Transaction_OrderTracking added in v1.0.6 

type Provisioning_Version1_Transaction_OrderTracking struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetProvisioningVersion1TransactionOrderTrackingService added in v1.0.6 

func GetProvisioningVersion1TransactionOrderTrackingService(sess session.SLSession) Provisioning_Version1_Transaction_OrderTracking

GetProvisioningVersion1TransactionOrderTrackingService returns an instance of the Provisioning_Version1_Transaction_OrderTracking SoftLayer service

func (Provisioning_Version1_Transaction_OrderTracking) Filter added in v1.0.6 

func (r Provisioning_Version1_Transaction_OrderTracking) Filter(filter string) Provisioning_Version1_Transaction_OrderTracking

func (Provisioning_Version1_Transaction_OrderTracking) GetInvoiceId added in v1.0.6 

func (r Provisioning_Version1_Transaction_OrderTracking) GetInvoiceId() (resp int, err error)

Retrieve Invoice ID

func (Provisioning_Version1_Transaction_OrderTracking) GetObject added in v1.0.6 

func (r Provisioning_Version1_Transaction_OrderTracking) GetObject() (resp datatypes.Provisioning_Version1_Transaction_OrderTracking, err error)

no documentation yet

func (Provisioning_Version1_Transaction_OrderTracking) GetOrderTrackingState added in v1.0.6 

func (r Provisioning_Version1_Transaction_OrderTracking) GetOrderTrackingState() (resp datatypes.Provisioning_Version1_Transaction_OrderTrackingState, err error)

Retrieve

func (Provisioning_Version1_Transaction_OrderTracking) GetTransaction added in v1.0.6 

func (r Provisioning_Version1_Transaction_OrderTracking) GetTransaction() (resp datatypes.Provisioning_Version1_Transaction, err error)

Retrieve

func (Provisioning_Version1_Transaction_OrderTracking) Id added in v1.0.6 

func (r Provisioning_Version1_Transaction_OrderTracking) Id(id int) Provisioning_Version1_Transaction_OrderTracking

func (Provisioning_Version1_Transaction_OrderTracking) Limit added in v1.0.6 

func (r Provisioning_Version1_Transaction_OrderTracking) Limit(limit int) Provisioning_Version1_Transaction_OrderTracking

func (Provisioning_Version1_Transaction_OrderTracking) Mask added in v1.0.6 

func (r Provisioning_Version1_Transaction_OrderTracking) Mask(mask string) Provisioning_Version1_Transaction_OrderTracking

func (Provisioning_Version1_Transaction_OrderTracking) Offset added in v1.0.6 

func (r Provisioning_Version1_Transaction_OrderTracking) Offset(offset int) Provisioning_Version1_Transaction_OrderTracking

type Provisioning_Version1_Transaction_OrderTrackingState added in v1.0.6 

type Provisioning_Version1_Transaction_OrderTrackingState struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetProvisioningVersion1TransactionOrderTrackingStateService added in v1.0.6 

func GetProvisioningVersion1TransactionOrderTrackingStateService(sess session.SLSession) Provisioning_Version1_Transaction_OrderTrackingState

GetProvisioningVersion1TransactionOrderTrackingStateService returns an instance of the Provisioning_Version1_Transaction_OrderTrackingState SoftLayer service

func (Provisioning_Version1_Transaction_OrderTrackingState) Filter added in v1.0.6 

func (r Provisioning_Version1_Transaction_OrderTrackingState) Filter(filter string) Provisioning_Version1_Transaction_OrderTrackingState

func (Provisioning_Version1_Transaction_OrderTrackingState) GetObject added in v1.0.6 

func (r Provisioning_Version1_Transaction_OrderTrackingState) GetObject() (resp datatypes.Provisioning_Version1_Transaction_OrderTrackingState, err error)

no documentation yet

func (Provisioning_Version1_Transaction_OrderTrackingState) Id added in v1.0.6 

func (r Provisioning_Version1_Transaction_OrderTrackingState) Id(id int) Provisioning_Version1_Transaction_OrderTrackingState

func (Provisioning_Version1_Transaction_OrderTrackingState) Limit added in v1.0.6 

func (r Provisioning_Version1_Transaction_OrderTrackingState) Limit(limit int) Provisioning_Version1_Transaction_OrderTrackingState

func (Provisioning_Version1_Transaction_OrderTrackingState) Mask added in v1.0.6 

func (r Provisioning_Version1_Transaction_OrderTrackingState) Mask(mask string) Provisioning_Version1_Transaction_OrderTrackingState

func (Provisioning_Version1_Transaction_OrderTrackingState) Offset added in v1.0.6 

func (r Provisioning_Version1_Transaction_OrderTrackingState) Offset(offset int) Provisioning_Version1_Transaction_OrderTrackingState

type Resource_Configuration 

type Resource_Configuration struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetResourceConfigurationService 

func GetResourceConfigurationService(sess session.SLSession) Resource_Configuration

GetResourceConfigurationService returns an instance of the Resource_Configuration SoftLayer service

func (Resource_Configuration) Filter 

func (r Resource_Configuration) Filter(filter string) Resource_Configuration

func (Resource_Configuration) Id 

func (r Resource_Configuration) Id(id int) Resource_Configuration

func (Resource_Configuration) Limit 

func (r Resource_Configuration) Limit(limit int) Resource_Configuration

func (Resource_Configuration) Mask 

func (r Resource_Configuration) Mask(mask string) Resource_Configuration

func (Resource_Configuration) Offset 

func (r Resource_Configuration) Offset(offset int) Resource_Configuration

func (Resource_Configuration) SetOsPasswordFromEncrypted 

func (r Resource_Configuration) SetOsPasswordFromEncrypted(encryptedPassword *string) (resp bool, err error)

The setOsPasswordFromEncrypted method is used to set the operating system password from a key/pair encrypted password signed by SoftLayer.

type Resource_Group 

type Resource_Group struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetResourceGroupService 

func GetResourceGroupService(sess session.SLSession) Resource_Group

GetResourceGroupService returns an instance of the Resource_Group SoftLayer service

func (Resource_Group) EditObject 

func (r Resource_Group) EditObject(templateObject *datatypes.Resource_Group) (resp bool, err error)

no documentation yet

func (Resource_Group) Filter 

func (r Resource_Group) Filter(filter string) Resource_Group

func (Resource_Group) GetAncestorGroups 

func (r Resource_Group) GetAncestorGroups() (resp []datatypes.Resource_Group, err error)

Retrieve A resource group's associated group ancestors.

func (Resource_Group) GetAttributes 

func (r Resource_Group) GetAttributes() (resp []datatypes.Resource_Group_Attribute, err error)

Retrieve A resource group's associated attributes.

func (Resource_Group) GetHardwareMembers 

func (r Resource_Group) GetHardwareMembers() (resp []datatypes.Resource_Group_Member, err error)

Retrieve A resource group's associated hardware members.

func (Resource_Group) GetMembers 

func (r Resource_Group) GetMembers() (resp []datatypes.Resource_Group_Member, err error)

Retrieve A resource group's associated members.

func (Resource_Group) GetObject 

func (r Resource_Group) GetObject() (resp datatypes.Resource_Group, err error)

no documentation yet

func (Resource_Group) GetRootResourceGroup 

func (r Resource_Group) GetRootResourceGroup() (resp datatypes.Resource_Group, err error)

Retrieve A resource group's associated root resource group.

func (Resource_Group) GetSubnetMembers 

func (r Resource_Group) GetSubnetMembers() (resp []datatypes.Resource_Group_Member, err error)

Retrieve A resource group's associated subnet members.

func (Resource_Group) GetTemplate 

func (r Resource_Group) GetTemplate() (resp datatypes.Resource_Group_Template, err error)

Retrieve A resource group's associated template.

func (Resource_Group) GetVlanMembers 

func (r Resource_Group) GetVlanMembers() (resp []datatypes.Resource_Group_Member, err error)

Retrieve A resource group's associated VLAN members.

func (Resource_Group) Id 

func (r Resource_Group) Id(id int) Resource_Group

func (Resource_Group) Limit 

func (r Resource_Group) Limit(limit int) Resource_Group

func (Resource_Group) Mask 

func (r Resource_Group) Mask(mask string) Resource_Group

func (Resource_Group) Offset 

func (r Resource_Group) Offset(offset int) Resource_Group

type Resource_Group_Template 

type Resource_Group_Template struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetResourceGroupTemplateService 

func GetResourceGroupTemplateService(sess session.SLSession) Resource_Group_Template

GetResourceGroupTemplateService returns an instance of the Resource_Group_Template SoftLayer service

func (Resource_Group_Template) Filter 

func (r Resource_Group_Template) Filter(filter string) Resource_Group_Template

func (Resource_Group_Template) GetAllObjects 

func (r Resource_Group_Template) GetAllObjects() (resp []datatypes.Resource_Group_Template, err error)

no documentation yet

func (Resource_Group_Template) GetChildren 

func (r Resource_Group_Template) GetChildren() (resp []datatypes.Resource_Group_Template, err error)

Retrieve

func (Resource_Group_Template) GetMembers 

func (r Resource_Group_Template) GetMembers() (resp []datatypes.Resource_Group_Template_Member, err error)

Retrieve

func (Resource_Group_Template) GetObject 

func (r Resource_Group_Template) GetObject() (resp datatypes.Resource_Group_Template, err error)

no documentation yet

func (Resource_Group_Template) Id 

func (r Resource_Group_Template) Id(id int) Resource_Group_Template

func (Resource_Group_Template) Limit 

func (r Resource_Group_Template) Limit(limit int) Resource_Group_Template

func (Resource_Group_Template) Mask 

func (r Resource_Group_Template) Mask(mask string) Resource_Group_Template

func (Resource_Group_Template) Offset 

func (r Resource_Group_Template) Offset(offset int) Resource_Group_Template

type Resource_Metadata 

type Resource_Metadata struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetResourceMetadataService 

func GetResourceMetadataService(sess session.SLSession) Resource_Metadata

GetResourceMetadataService returns an instance of the Resource_Metadata SoftLayer service

func (Resource_Metadata) Filter 

func (r Resource_Metadata) Filter(filter string) Resource_Metadata

func (Resource_Metadata) GetAccountId added in v1.0.2 

func (r Resource_Metadata) GetAccountId() (resp int, err error)

The getAccountId retrieves the ID for the account on which the resource is located.

func (Resource_Metadata) GetBackendMacAddresses 

func (r Resource_Metadata) GetBackendMacAddresses() (resp []string, err error)

The getBackendMacAddresses method retrieves a list of backend MAC addresses for the resource

func (Resource_Metadata) GetDatacenter 

func (r Resource_Metadata) GetDatacenter() (resp string, err error)

The getDatacenter method retrieves the name of the datacenter in which the resource is located.

func (Resource_Metadata) GetDatacenterId 

func (r Resource_Metadata) GetDatacenterId() (resp int, err error)

The getDatacenterId retrieves the ID for the datacenter in which the resource is located.

func (Resource_Metadata) GetDomain 

func (r Resource_Metadata) GetDomain() (resp string, err error)

The getDomain method retrieves the hostname for the resource.

func (Resource_Metadata) GetFrontendMacAddresses 

func (r Resource_Metadata) GetFrontendMacAddresses() (resp []string, err error)

The getFrontendMacAddresses method retrieves a list of frontend MAC addresses for the resource

func (Resource_Metadata) GetFullyQualifiedDomainName 

func (r Resource_Metadata) GetFullyQualifiedDomainName() (resp string, err error)

The getFullyQualifiedDomainName method provides the user with a combined return which includes the hostname and domain for the resource. Because this method returns multiple pieces of information, it avoids the need to use multiple methods to return the desired information.

func (Resource_Metadata) GetGlobalIdentifier 

func (r Resource_Metadata) GetGlobalIdentifier() (resp string, err error)

The getId getGlobalIdentifier retrieves the globalIdentifier for the resource

func (Resource_Metadata) GetHostname 

func (r Resource_Metadata) GetHostname() (resp string, err error)

The getHostname method retrieves the hostname for the resource.

func (Resource_Metadata) GetId 

func (r Resource_Metadata) GetId() (resp int, err error)

The getId method retrieves the ID for the resource

func (Resource_Metadata) GetPrimaryBackendIpAddress 

func (r Resource_Metadata) GetPrimaryBackendIpAddress() (resp string, err error)

The getPrimaryBackendIpAddress method retrieves the primary backend IP address for the resource

func (Resource_Metadata) GetPrimaryIpAddress 

func (r Resource_Metadata) GetPrimaryIpAddress() (resp string, err error)

The getPrimaryIpAddress method retrieves the primary IP address for the resource. For resources with a frontend network, the frontend IP address will be returned. For resources that have been provisioned with only a backend network, the backend IP address will be returned, as a frontend address will not exist.

func (Resource_Metadata) GetProvisionState 

func (r Resource_Metadata) GetProvisionState() (resp string, err error)

The getProvisionState method retrieves the provision state of the resource. The provision state may be used to determine when it is considered safe to perform additional setup operations. The method returns 'PROCESSING' to indicate the provision is in progress and 'COMPLETE' when the provision is complete.

func (Resource_Metadata) GetRouter 

func (r Resource_Metadata) GetRouter(macAddress *string) (resp string, err error)

The getRouter method will return the router associated with a network component. When the router is redundant, the hostname of the redundant group will be returned, rather than the router hostname.

func (Resource_Metadata) GetServiceResource 

func (r Resource_Metadata) GetServiceResource(serviceName *string, index *int) (resp string, err error)

The getServiceResource method retrieves a specific service resource associated with the resource. Service resources are additional resources that may be used by this resource.

func (Resource_Metadata) GetServiceResources 

func (r Resource_Metadata) GetServiceResources() (resp []datatypes.Container_Resource_Metadata_ServiceResource, err error)

The getServiceResources method retrieves all service resources associated with the resource. Service resources are additional resources that may be used by this resource. The output format is <type>=<address> for each service resource.

func (Resource_Metadata) GetTags 

func (r Resource_Metadata) GetTags() (resp []string, err error)

The getTags method retrieves all tags associated with the resource. Tags are single keywords assigned to a resource that assist the user in identifying the resource and its roles when performing a simple search. Tags are assigned by any user with access to the resource.

func (Resource_Metadata) GetUserMetadata 

func (r Resource_Metadata) GetUserMetadata() (resp string, err error)

The getUserMetadata method retrieves metadata completed by users who interact with the resource. Metadata gathered using this method is unique to parameters set using the ”'setUserMetadata”' method, which must be executed prior to completing this method. User metadata may also be provided while placing an order for a resource.

func (Resource_Metadata) GetVlanIds 

func (r Resource_Metadata) GetVlanIds(macAddress *string) (resp []int, err error)

The getVlanIds method returns a list of VLAN IDs for the network component matching the provided MAC address associated with the resource. For each return, the native VLAN will appear first, followed by any trunked VLANs associated with the network component.

func (Resource_Metadata) GetVlans 

func (r Resource_Metadata) GetVlans(macAddress *string) (resp []int, err error)

The getVlans method returns a list of VLAN numbers for the network component matching the provided MAC address associated with the resource. For each return, the native VLAN will appear first, followed by any trunked VLANs associated with the network component.

func (Resource_Metadata) Id 

func (r Resource_Metadata) Id(id int) Resource_Metadata

func (Resource_Metadata) Limit 

func (r Resource_Metadata) Limit(limit int) Resource_Metadata

func (Resource_Metadata) Mask 

func (r Resource_Metadata) Mask(mask string) Resource_Metadata

func (Resource_Metadata) Offset 

func (r Resource_Metadata) Offset(offset int) Resource_Metadata

type Sales_Presale_Event 

type Sales_Presale_Event struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetSalesPresaleEventService 

func GetSalesPresaleEventService(sess session.SLSession) Sales_Presale_Event

GetSalesPresaleEventService returns an instance of the Sales_Presale_Event SoftLayer service

func (Sales_Presale_Event) Filter 

func (r Sales_Presale_Event) Filter(filter string) Sales_Presale_Event

func (Sales_Presale_Event) GetActiveFlag 

func (r Sales_Presale_Event) GetActiveFlag() (resp bool, err error)

Retrieve A flag to indicate that the presale event is currently active. A presale event is active if the current time is between the start and end dates.

func (Sales_Presale_Event) GetAllObjects 

func (r Sales_Presale_Event) GetAllObjects() (resp []datatypes.Sales_Presale_Event, err error)

no documentation yet

func (Sales_Presale_Event) GetExpiredFlag 

func (r Sales_Presale_Event) GetExpiredFlag() (resp bool, err error)

Retrieve A flag to indicate that the presale event is expired. A presale event is expired if the current time is after the end date.

func (Sales_Presale_Event) GetItem 

func (r Sales_Presale_Event) GetItem() (resp datatypes.Product_Item, err error)

Retrieve The [[SoftLayer_Product_Item]] associated with the presale event.

func (Sales_Presale_Event) GetLocation 

func (r Sales_Presale_Event) GetLocation() (resp datatypes.Location, err error)

Retrieve The [[SoftLayer_Location]] associated with the presale event.

func (Sales_Presale_Event) GetObject 

func (r Sales_Presale_Event) GetObject() (resp datatypes.Sales_Presale_Event, err error)

”'getObject”' retrieves the [[SoftLayer_Sales_Presale_Event]] object whose id number corresponds to the id number of the init parameter passed to the SoftLayer_Sales_Presale_Event service. Customers may only retrieve presale events that are currently active.

func (Sales_Presale_Event) GetOrders 

func (r Sales_Presale_Event) GetOrders() (resp []datatypes.Billing_Order, err error)

Retrieve The orders ([[SoftLayer_Billing_Order]]) associated with this presale event that were created for the customer's account.

func (Sales_Presale_Event) Id 

func (r Sales_Presale_Event) Id(id int) Sales_Presale_Event

func (Sales_Presale_Event) Limit 

func (r Sales_Presale_Event) Limit(limit int) Sales_Presale_Event

func (Sales_Presale_Event) Mask 

func (r Sales_Presale_Event) Mask(mask string) Sales_Presale_Event

func (Sales_Presale_Event) Offset 

func (r Sales_Presale_Event) Offset(offset int) Sales_Presale_Event
type Search struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetSearchService 

func GetSearchService(sess session.SLSession) Search

GetSearchService returns an instance of the Search SoftLayer service

func (Search) AdvancedSearch 

func (r Search) AdvancedSearch(searchString *string) (resp []datatypes.Container_Search_Result, err error)

This method allows for searching for SoftLayer resources by simple terms and operators. Fields that are used for searching will be available at sldn.softlayer.com. It returns a collection or array of [[SoftLayer_Container_Search_Result]] objects that have search metadata for each result and the resulting resource found.

The advancedSearch() method recognizes the special <code>_objectType:</code></b> quantifier in search strings. See the documentation for the [SoftLayer_Search/search] method on how to restrict searches using object types.

The advancedSearch() method recognizes [[SoftLayer_Container_Search_ObjectType_Property]], which can also be used to limit searches. Example:

<code>_objectType:Type_1 propertyA:</code><i><code>value</code></i>

A search string can specify multiple properties, separated with spaces. Example:

<code>_objectType:Type_1 propertyA:</code><i><code>value</code></i> <code>propertyB:</code><i><code>value</code></i>

A collection of available object types and their properties can be retrieved by calling the [SoftLayer_Search/getObjectTypes] method.

#### Exact Match on Text Fields To enforce an exact match on text fields, encapsulate the term in double quotes. For example, given a set of device host names:

<ul> <li>baremetal-a</li> <li>baremetal-b</li> <li>a-virtual-guest</li> <li>b-virtual-guest</li> <li>edge-router</li> </ul>

An exact search (double-quote) for "baremetal-a" will return only the exact match of <u>baremetal-a</u>.

A fuzzy search (no double-quote) for baremetal-a will return <u>baremetal</u>-<u>a</u>, <u>baremetal</u>-b, <u>a</u>-virtu<u>a</u>l-guest, b-virtu<u>a</u>l-guest but will omit edge-router.

func (Search) Filter 

func (r Search) Filter(filter string) Search

func (Search) GetObjectTypes 

func (r Search) GetObjectTypes() (resp []datatypes.Container_Search_ObjectType, err error)

This method returns a collection of [[SoftLayer_Container_Search_ObjectType]] containers that specify which indexed object types and properties are exposed for the current user. These object types can be used to discover searchable data and to create or validate object index search strings.

Refer to the [SoftLayer_Search/search] and [SoftLayer_Search/advancedSearch] methods for information on using object types and properties in search strings.

func (Search) Id 

func (r Search) Id(id int) Search

func (Search) Limit 

func (r Search) Limit(limit int) Search

func (Search) Mask 

func (r Search) Mask(mask string) Search

func (Search) Offset 

func (r Search) Offset(offset int) Search

func (Search) Search 

func (r Search) Search(searchString *string) (resp []datatypes.Container_Search_Result, err error)

This method allows for searching for SoftLayer resources by simple phrase. It returns a collection or array of [[SoftLayer_Container_Search_Result]] objects that have search metadata for each result and the resulting resource found.

This method recognizes the special <b><code>_objectType:</code></b> quantifier in search strings. This quantifier can be used to restrict a search to specific object types. Example usage:

<code>_objectType:Type_1 </code><i><code>(other search terms...)</code></i>

A search string can specify multiple object types, separated by commas (no spaces are permitted between the type names). Example:

<code>_objectType:Type_1,Type_2,Type_3 </code><i><code>(other search terms...)</code></i>

If the list of object types is prefixed with a hyphen or minus sign (-), then the specified types are excluded from the search. Example:

<code>_objectType:-Type_4,Type_5 </code><i><code>(other search terms...)</code></i>

A collection of available object types can be retrieved by calling the [SoftLayer_Search/getObjectTypes] method.

#### Exact Match on Text Fields To enforce an exact match on text fields, encapsulate the term in double quotes. For example, given a set of device host names:

<ul> <li>baremetal-a</li> <li>baremetal-b</li> <li>a-virtual-guest</li> <li>b-virtual-guest</li> <li>edge-router</li> </ul>

An exact search (double-quote) for "baremetal-a" will return only the exact match of <u>baremetal-a</u>.

A fuzzy search (no double-quote) for baremetal-a will return <u>baremetal</u>-<u>a</u>, <u>baremetal</u>-b, <u>a</u>-virtu<u>a</u>l-guest, b-virtu<u>a</u>l-guest but will omit edge-router.

type Security_Certificate 

type Security_Certificate struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetSecurityCertificateService 

func GetSecurityCertificateService(sess session.SLSession) Security_Certificate

GetSecurityCertificateService returns an instance of the Security_Certificate SoftLayer service

func (Security_Certificate) CreateObject 

func (r Security_Certificate) CreateObject(templateObject *datatypes.Security_Certificate) (resp datatypes.Security_Certificate, err error)

Add a certificate to your account for your records, or for use with various services. Only the certificate and private key are usually required. If your issuer provided an intermediate certificate, you must also provide that certificate. Details will be extracted from the certificate. Validation will be performed between the certificate and the private key as well as the certificate and the intermediate certificate, if provided.

The certificate signing request is not required, but can be provided for your records.

func (Security_Certificate) DeleteObject 

func (r Security_Certificate) DeleteObject() (resp bool, err error)

Remove a certificate from your account. You may not remove a certificate with associated services.

func (Security_Certificate) EditObject 

func (r Security_Certificate) EditObject(templateObject *datatypes.Security_Certificate) (resp bool, err error)

Update a certificate. Modifications are restricted to the note and CSR if the are any services associated with the certificate. There are no modification restrictions for a certificate with no associated services.

func (Security_Certificate) Filter 

func (r Security_Certificate) Filter(filter string) Security_Certificate

func (Security_Certificate) FindByCommonName 

func (r Security_Certificate) FindByCommonName(commonName *string) (resp []datatypes.Security_Certificate, err error)

Locate certificates by their common name, traditionally a domain name.

func (Security_Certificate) GetAssociatedServiceCount 

func (r Security_Certificate) GetAssociatedServiceCount() (resp int, err error)

Retrieve The number of services currently associated with the certificate.

func (Security_Certificate) GetLbaasListeners added in v1.0.2 

func (r Security_Certificate) GetLbaasListeners() (resp []datatypes.Network_LBaaS_Listener, err error)

Retrieve Cloud Load Balancer [LBaaS] listeners currently associated with the certificate.

func (Security_Certificate) GetLoadBalancerVirtualIpAddresses 

func (r Security_Certificate) GetLoadBalancerVirtualIpAddresses() (resp []datatypes.Network_Application_Delivery_Controller_LoadBalancer_VirtualIpAddress, err error)

Retrieve The load balancers virtual IP addresses currently associated with the certificate.

func (Security_Certificate) GetObject 

func (r Security_Certificate) GetObject() (resp datatypes.Security_Certificate, err error)

no documentation yet

func (Security_Certificate) GetPemFormat 

func (r Security_Certificate) GetPemFormat() (resp string, err error)

Retrieve the certificate in PEM (Privacy Enhanced Mail) format, which is a string containing all base64 encoded (DER) certificates delimited by -----BEGIN/END *----- clauses.

func (Security_Certificate) Id 

func (r Security_Certificate) Id(id int) Security_Certificate

func (Security_Certificate) Limit 

func (r Security_Certificate) Limit(limit int) Security_Certificate

func (Security_Certificate) Mask 

func (r Security_Certificate) Mask(mask string) Security_Certificate

func (Security_Certificate) Offset 

func (r Security_Certificate) Offset(offset int) Security_Certificate

type Security_Certificate_Request 

type Security_Certificate_Request struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetSecurityCertificateRequestService 

func GetSecurityCertificateRequestService(sess session.SLSession) Security_Certificate_Request

GetSecurityCertificateRequestService returns an instance of the Security_Certificate_Request SoftLayer service

func (Security_Certificate_Request) CancelSslOrder 

func (r Security_Certificate_Request) CancelSslOrder() (resp bool, err error)

Cancels a pending SSL certificate order at the Certificate Authority

func (Security_Certificate_Request) Filter 

func (r Security_Certificate_Request) Filter(filter string) Security_Certificate_Request

func (Security_Certificate_Request) GetAccount 

func (r Security_Certificate_Request) GetAccount() (resp datatypes.Account, err error)

Retrieve The account to which a SSL certificate request belongs.

func (Security_Certificate_Request) GetAdministratorEmailDomains 

func (r Security_Certificate_Request) GetAdministratorEmailDomains(commonName *string) (resp []string, err error)

Gets the email domains that can be used to validate a certificate to a domain.

func (Security_Certificate_Request) GetAdministratorEmailPrefixes 

func (r Security_Certificate_Request) GetAdministratorEmailPrefixes() (resp []string, err error)

Gets the email accounts that can be used to validate a certificate to a domain.

func (Security_Certificate_Request) GetObject 

func (r Security_Certificate_Request) GetObject() (resp datatypes.Security_Certificate_Request, err error)

no documentation yet

func (Security_Certificate_Request) GetOrder 

func (r Security_Certificate_Request) GetOrder() (resp datatypes.Billing_Order, err error)

Retrieve The order contains the information related to a SSL certificate request.

func (Security_Certificate_Request) GetOrderItem 

func (r Security_Certificate_Request) GetOrderItem() (resp datatypes.Billing_Order_Item, err error)

Retrieve The associated order item for this SSL certificate request.

func (Security_Certificate_Request) GetPreviousOrderData 

func (r Security_Certificate_Request) GetPreviousOrderData() (resp datatypes.Container_Product_Order_Security_Certificate, err error)

Returns previous SSL certificate order data. You can use this data for to place a renewal order for a completed SSL certificate.

func (Security_Certificate_Request) GetSslCertificateRequests 

func (r Security_Certificate_Request) GetSslCertificateRequests(accountId *int) (resp []datatypes.Security_Certificate_Request, err error)

Returns all the SSL certificate requests.

func (Security_Certificate_Request) GetStatus 

func (r Security_Certificate_Request) GetStatus() (resp datatypes.Security_Certificate_Request_Status, err error)

Retrieve The status of a SSL certificate request.

func (Security_Certificate_Request) Id 

func (r Security_Certificate_Request) Id(id int) Security_Certificate_Request

func (Security_Certificate_Request) Limit 

func (r Security_Certificate_Request) Limit(limit int) Security_Certificate_Request

func (Security_Certificate_Request) Mask 

func (r Security_Certificate_Request) Mask(mask string) Security_Certificate_Request

func (Security_Certificate_Request) Offset 

func (r Security_Certificate_Request) Offset(offset int) Security_Certificate_Request

func (Security_Certificate_Request) ResendEmail 

func (r Security_Certificate_Request) ResendEmail(emailType *string) (resp bool, err error)

A Certificate Authority sends out various emails to your domain administrator or your technical contact. Use this service to have these emails re-sent.

func (Security_Certificate_Request) ValidateCsr 

func (r Security_Certificate_Request) ValidateCsr(csr *string, validityMonths *int, itemId *int, serverType *string) (resp bool, err error)

Allows you to validate a Certificate Signing Request (CSR) required for an SSL certificate with the certificate authority (CA). This method sends the CSR, the length of the subscription in months, the certificate type, and the server type for validation against requirements of the CA. Returns true if valid.

More information on CSR generation can be found at: [http://en.wikipedia.org/wiki/Certificate_signing_request Wikipedia] [https://www.digicert.com/csr-creation.htm DigiCert]

type Security_Certificate_Request_ServerType 

type Security_Certificate_Request_ServerType struct {
	Session session.SLSession
	Options sl.Options
}

Represents a server type that can be specified when ordering an SSL certificate.

func GetSecurityCertificateRequestServerTypeService 

func GetSecurityCertificateRequestServerTypeService(sess session.SLSession) Security_Certificate_Request_ServerType

GetSecurityCertificateRequestServerTypeService returns an instance of the Security_Certificate_Request_ServerType SoftLayer service

func (Security_Certificate_Request_ServerType) Filter 

func (r Security_Certificate_Request_ServerType) Filter(filter string) Security_Certificate_Request_ServerType

func (Security_Certificate_Request_ServerType) GetAllObjects 

func (r Security_Certificate_Request_ServerType) GetAllObjects() (resp []datatypes.Security_Certificate_Request_ServerType, err error)

Returns all SSL certificate server types, which are passed in on a [[SoftLayer_Container_Product_Order_Security_Certificate|certificate order]].

func (Security_Certificate_Request_ServerType) GetObject 

func (r Security_Certificate_Request_ServerType) GetObject() (resp datatypes.Security_Certificate_Request_ServerType, err error)

no documentation yet

func (Security_Certificate_Request_ServerType) Id 

func (r Security_Certificate_Request_ServerType) Id(id int) Security_Certificate_Request_ServerType

func (Security_Certificate_Request_ServerType) Limit 

func (r Security_Certificate_Request_ServerType) Limit(limit int) Security_Certificate_Request_ServerType

func (Security_Certificate_Request_ServerType) Mask 

func (r Security_Certificate_Request_ServerType) Mask(mask string) Security_Certificate_Request_ServerType

func (Security_Certificate_Request_ServerType) Offset 

func (r Security_Certificate_Request_ServerType) Offset(offset int) Security_Certificate_Request_ServerType

type Security_Certificate_Request_Status 

type Security_Certificate_Request_Status struct {
	Session session.SLSession
	Options sl.Options
}

Represents the status of an SSL certificate request.

func GetSecurityCertificateRequestStatusService 

func GetSecurityCertificateRequestStatusService(sess session.SLSession) Security_Certificate_Request_Status

GetSecurityCertificateRequestStatusService returns an instance of the Security_Certificate_Request_Status SoftLayer service

func (Security_Certificate_Request_Status) Filter 

func (r Security_Certificate_Request_Status) Filter(filter string) Security_Certificate_Request_Status

func (Security_Certificate_Request_Status) GetObject 

func (r Security_Certificate_Request_Status) GetObject() (resp datatypes.Security_Certificate_Request_Status, err error)

no documentation yet

func (Security_Certificate_Request_Status) GetSslRequestStatuses 

func (r Security_Certificate_Request_Status) GetSslRequestStatuses() (resp []datatypes.Security_Certificate_Request_Status, err error)

Returns all SSL certificate request status objects

func (Security_Certificate_Request_Status) Id 

func (r Security_Certificate_Request_Status) Id(id int) Security_Certificate_Request_Status

func (Security_Certificate_Request_Status) Limit 

func (r Security_Certificate_Request_Status) Limit(limit int) Security_Certificate_Request_Status

func (Security_Certificate_Request_Status) Mask 

func (r Security_Certificate_Request_Status) Mask(mask string) Security_Certificate_Request_Status

func (Security_Certificate_Request_Status) Offset 

func (r Security_Certificate_Request_Status) Offset(offset int) Security_Certificate_Request_Status

type Security_Ssh_Key 

type Security_Ssh_Key struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetSecuritySshKeyService 

func GetSecuritySshKeyService(sess session.SLSession) Security_Ssh_Key

GetSecuritySshKeyService returns an instance of the Security_Ssh_Key SoftLayer service

func (Security_Ssh_Key) CreateObject 

func (r Security_Ssh_Key) CreateObject(templateObject *datatypes.Security_Ssh_Key) (resp datatypes.Security_Ssh_Key, err error)

Add a ssh key to your account for use during server provisioning and os reloads.

func (Security_Ssh_Key) DeleteObject 

func (r Security_Ssh_Key) DeleteObject() (resp bool, err error)

Remove a ssh key from your account.

func (Security_Ssh_Key) EditObject 

func (r Security_Ssh_Key) EditObject(templateObject *datatypes.Security_Ssh_Key) (resp bool, err error)

Update a ssh key.

func (Security_Ssh_Key) Filter 

func (r Security_Ssh_Key) Filter(filter string) Security_Ssh_Key

func (Security_Ssh_Key) GetAccount 

func (r Security_Ssh_Key) GetAccount() (resp datatypes.Account, err error)

Retrieve

func (Security_Ssh_Key) GetBlockDeviceTemplateGroups 

func (r Security_Ssh_Key) GetBlockDeviceTemplateGroups() (resp []datatypes.Virtual_Guest_Block_Device_Template_Group, err error)

Retrieve The image template groups that are linked to an SSH key.

func (Security_Ssh_Key) GetObject 

func (r Security_Ssh_Key) GetObject() (resp datatypes.Security_Ssh_Key, err error)

no documentation yet

func (Security_Ssh_Key) GetSoftwarePasswords 

func (r Security_Ssh_Key) GetSoftwarePasswords() (resp []datatypes.Software_Component_Password, err error)

Retrieve The OS root users that are linked to an SSH key.

func (Security_Ssh_Key) Id 

func (r Security_Ssh_Key) Id(id int) Security_Ssh_Key

func (Security_Ssh_Key) Limit 

func (r Security_Ssh_Key) Limit(limit int) Security_Ssh_Key

func (Security_Ssh_Key) Mask 

func (r Security_Ssh_Key) Mask(mask string) Security_Ssh_Key

func (Security_Ssh_Key) Offset 

func (r Security_Ssh_Key) Offset(offset int) Security_Ssh_Key

type Software_AccountLicense 

type Software_AccountLicense struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetSoftwareAccountLicenseService 

func GetSoftwareAccountLicenseService(sess session.SLSession) Software_AccountLicense

GetSoftwareAccountLicenseService returns an instance of the Software_AccountLicense SoftLayer service

func (Software_AccountLicense) Filter 

func (r Software_AccountLicense) Filter(filter string) Software_AccountLicense

func (Software_AccountLicense) GetAccount 

func (r Software_AccountLicense) GetAccount() (resp datatypes.Account, err error)

Retrieve The customer account this Account License belongs to.

func (Software_AccountLicense) GetAllObjects 

func (r Software_AccountLicense) GetAllObjects() (resp []datatypes.Software_AccountLicense, err error)

no documentation yet

func (Software_AccountLicense) GetBillingItem 

func (r Software_AccountLicense) GetBillingItem() (resp datatypes.Billing_Item, err error)

Retrieve The billing item for a software account license.

func (Software_AccountLicense) GetObject 

func (r Software_AccountLicense) GetObject() (resp datatypes.Software_AccountLicense, err error)

no documentation yet

func (Software_AccountLicense) GetSoftwareDescription 

func (r Software_AccountLicense) GetSoftwareDescription() (resp datatypes.Software_Description, err error)

Retrieve The SoftLayer_Software_Description that this account license is for.

func (Software_AccountLicense) Id 

func (r Software_AccountLicense) Id(id int) Software_AccountLicense

func (Software_AccountLicense) Limit 

func (r Software_AccountLicense) Limit(limit int) Software_AccountLicense

func (Software_AccountLicense) Mask 

func (r Software_AccountLicense) Mask(mask string) Software_AccountLicense

func (Software_AccountLicense) Offset 

func (r Software_AccountLicense) Offset(offset int) Software_AccountLicense

type Software_Component 

type Software_Component struct {
	Session session.SLSession
	Options sl.Options
}

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>

func GetSoftwareComponentService 

func GetSoftwareComponentService(sess session.SLSession) Software_Component

GetSoftwareComponentService returns an instance of the Software_Component SoftLayer service

func (Software_Component) Filter 

func (r Software_Component) Filter(filter string) Software_Component

func (Software_Component) GetAverageInstallationDuration 

func (r Software_Component) GetAverageInstallationDuration() (resp uint, err error)

Retrieve The average amount of time that a software component takes to install.

func (Software_Component) GetBillingItem 

func (r Software_Component) GetBillingItem() (resp datatypes.Billing_Item, err error)

Retrieve The billing item for a software component.

func (Software_Component) GetHardware 

func (r Software_Component) GetHardware() (resp datatypes.Hardware, err error)

Retrieve The hardware this Software Component is installed upon.

func (Software_Component) GetLicenseFile 

func (r Software_Component) GetLicenseFile() (resp string, err error)

Attempt to retrieve the file associated with a software component. If the software component does not support downloading license files an exception will be thrown.

func (Software_Component) GetObject 

func (r Software_Component) GetObject() (resp datatypes.Software_Component, err error)

getObject retrieves the SoftLayer_Software_Component object whose ID corresponds to the ID number of the init parameter passed to the SoftLayer_Software_Component service.

The best way to get software components is through getSoftwareComponents from the Hardware service.

func (Software_Component) GetPasswordHistory 

func (r Software_Component) GetPasswordHistory() (resp []datatypes.Software_Component_Password_History, err error)

Retrieve History Records for Software Passwords.

func (Software_Component) GetPasswords 

func (r Software_Component) GetPasswords() (resp []datatypes.Software_Component_Password, err error)

Retrieve Username/Password pairs used for access to this Software Installation.

func (Software_Component) GetSoftwareDescription 

func (r Software_Component) GetSoftwareDescription() (resp datatypes.Software_Description, err error)

Retrieve The Software Description of this Software Component.

func (Software_Component) GetSoftwareLicense 

func (r Software_Component) GetSoftwareLicense() (resp datatypes.Software_License, err error)

Retrieve The License this Software Component uses.

func (Software_Component) GetVendorSetUpConfiguration 

func (r Software_Component) GetVendorSetUpConfiguration() (resp string, err error)

no documentation yet

func (Software_Component) GetVirtualGuest 

func (r Software_Component) GetVirtualGuest() (resp datatypes.Virtual_Guest, err error)

Retrieve The virtual guest this software component is installed upon.

func (Software_Component) Id 

func (r Software_Component) Id(id int) Software_Component

func (Software_Component) Limit 

func (r Software_Component) Limit(limit int) Software_Component

func (Software_Component) Mask 

func (r Software_Component) Mask(mask string) Software_Component

func (Software_Component) Offset 

func (r Software_Component) Offset(offset int) Software_Component

type Software_Component_AntivirusSpyware 

type Software_Component_AntivirusSpyware struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetSoftwareComponentAntivirusSpywareService 

func GetSoftwareComponentAntivirusSpywareService(sess session.SLSession) Software_Component_AntivirusSpyware

GetSoftwareComponentAntivirusSpywareService returns an instance of the Software_Component_AntivirusSpyware SoftLayer service

func (Software_Component_AntivirusSpyware) Filter 

func (r Software_Component_AntivirusSpyware) Filter(filter string) Software_Component_AntivirusSpyware

func (Software_Component_AntivirusSpyware) GetAverageInstallationDuration 

func (r Software_Component_AntivirusSpyware) GetAverageInstallationDuration() (resp uint, err error)

Retrieve The average amount of time that a software component takes to install.

func (Software_Component_AntivirusSpyware) GetBillingItem 

func (r Software_Component_AntivirusSpyware) GetBillingItem() (resp datatypes.Billing_Item, err error)

Retrieve The billing item for a software component.

func (Software_Component_AntivirusSpyware) GetHardware 

func (r Software_Component_AntivirusSpyware) GetHardware() (resp datatypes.Hardware, err error)

Retrieve The hardware this Software Component is installed upon.

func (Software_Component_AntivirusSpyware) GetLicenseFile 

func (r Software_Component_AntivirusSpyware) GetLicenseFile() (resp string, err error)

Attempt to retrieve the file associated with a software component. If the software component does not support downloading license files an exception will be thrown.

func (Software_Component_AntivirusSpyware) GetObject 

func (r Software_Component_AntivirusSpyware) GetObject() (resp datatypes.Software_Component_AntivirusSpyware, err error)

no documentation yet

func (Software_Component_AntivirusSpyware) GetPasswordHistory 

func (r Software_Component_AntivirusSpyware) GetPasswordHistory() (resp []datatypes.Software_Component_Password_History, err error)

Retrieve History Records for Software Passwords.

func (Software_Component_AntivirusSpyware) GetPasswords 

func (r Software_Component_AntivirusSpyware) GetPasswords() (resp []datatypes.Software_Component_Password, err error)

Retrieve Username/Password pairs used for access to this Software Installation.

func (Software_Component_AntivirusSpyware) GetSoftwareDescription 

func (r Software_Component_AntivirusSpyware) GetSoftwareDescription() (resp datatypes.Software_Description, err error)

Retrieve The Software Description of this Software Component.

func (Software_Component_AntivirusSpyware) GetSoftwareLicense 

func (r Software_Component_AntivirusSpyware) GetSoftwareLicense() (resp datatypes.Software_License, err error)

Retrieve The License this Software Component uses.

func (Software_Component_AntivirusSpyware) GetVendorSetUpConfiguration 

func (r Software_Component_AntivirusSpyware) GetVendorSetUpConfiguration() (resp string, err error)

no documentation yet

func (Software_Component_AntivirusSpyware) GetVirtualGuest 

func (r Software_Component_AntivirusSpyware) GetVirtualGuest() (resp datatypes.Virtual_Guest, err error)

Retrieve The virtual guest this software component is installed upon.

func (Software_Component_AntivirusSpyware) Id 

func (r Software_Component_AntivirusSpyware) Id(id int) Software_Component_AntivirusSpyware

func (Software_Component_AntivirusSpyware) Limit 

func (r Software_Component_AntivirusSpyware) Limit(limit int) Software_Component_AntivirusSpyware

func (Software_Component_AntivirusSpyware) Mask 

func (r Software_Component_AntivirusSpyware) Mask(mask string) Software_Component_AntivirusSpyware

func (Software_Component_AntivirusSpyware) Offset 

func (r Software_Component_AntivirusSpyware) Offset(offset int) Software_Component_AntivirusSpyware

func (Software_Component_AntivirusSpyware) UpdateAntivirusSpywarePolicy 

func (r Software_Component_AntivirusSpyware) UpdateAntivirusSpywarePolicy(newPolicy *string, enforce *bool) (resp bool, err error)

Update an anti-virus/spyware policy. The policy options that it accepts are the following: *1 - Minimal *2 - Relaxed *3 - Default *4 - High *5 - Ultimate

type Software_Component_HostIps 

type Software_Component_HostIps struct {
	Session session.SLSession
	Options sl.Options
}

This object specifies a specific type of Software Component: A Host Intrusion Protection System instance.

func GetSoftwareComponentHostIpsService 

func GetSoftwareComponentHostIpsService(sess session.SLSession) Software_Component_HostIps

GetSoftwareComponentHostIpsService returns an instance of the Software_Component_HostIps SoftLayer service

func (Software_Component_HostIps) Filter 

func (r Software_Component_HostIps) Filter(filter string) Software_Component_HostIps

func (Software_Component_HostIps) GetAverageInstallationDuration 

func (r Software_Component_HostIps) GetAverageInstallationDuration() (resp uint, err error)

Retrieve The average amount of time that a software component takes to install.

func (Software_Component_HostIps) GetBillingItem 

func (r Software_Component_HostIps) GetBillingItem() (resp datatypes.Billing_Item, err error)

Retrieve The billing item for a software component.

func (Software_Component_HostIps) GetCurrentHostIpsPolicies 

func (r Software_Component_HostIps) GetCurrentHostIpsPolicies() (resp []datatypes.Container_Software_Component_HostIps_Policy, err error)

Get the current Host IPS policies.

func (Software_Component_HostIps) GetHardware 

func (r Software_Component_HostIps) GetHardware() (resp datatypes.Hardware, err error)

Retrieve The hardware this Software Component is installed upon.

func (Software_Component_HostIps) GetLicenseFile 

func (r Software_Component_HostIps) GetLicenseFile() (resp string, err error)

Attempt to retrieve the file associated with a software component. If the software component does not support downloading license files an exception will be thrown.

func (Software_Component_HostIps) GetObject 

func (r Software_Component_HostIps) GetObject() (resp datatypes.Software_Component_HostIps, err error)

no documentation yet

func (Software_Component_HostIps) GetPasswordHistory 

func (r Software_Component_HostIps) GetPasswordHistory() (resp []datatypes.Software_Component_Password_History, err error)

Retrieve History Records for Software Passwords.

func (Software_Component_HostIps) GetPasswords 

func (r Software_Component_HostIps) GetPasswords() (resp []datatypes.Software_Component_Password, err error)

Retrieve Username/Password pairs used for access to this Software Installation.

func (Software_Component_HostIps) GetSoftwareDescription 

func (r Software_Component_HostIps) GetSoftwareDescription() (resp datatypes.Software_Description, err error)

Retrieve The Software Description of this Software Component.

func (Software_Component_HostIps) GetSoftwareLicense 

func (r Software_Component_HostIps) GetSoftwareLicense() (resp datatypes.Software_License, err error)

Retrieve The License this Software Component uses.

func (Software_Component_HostIps) GetVendorSetUpConfiguration 

func (r Software_Component_HostIps) GetVendorSetUpConfiguration() (resp string, err error)

no documentation yet

func (Software_Component_HostIps) GetVirtualGuest 

func (r Software_Component_HostIps) GetVirtualGuest() (resp datatypes.Virtual_Guest, err error)

Retrieve The virtual guest this software component is installed upon.

func (Software_Component_HostIps) Id 

func (r Software_Component_HostIps) Id(id int) Software_Component_HostIps

func (Software_Component_HostIps) Limit 

func (r Software_Component_HostIps) Limit(limit int) Software_Component_HostIps

func (Software_Component_HostIps) Mask 

func (r Software_Component_HostIps) Mask(mask string) Software_Component_HostIps

func (Software_Component_HostIps) Offset 

func (r Software_Component_HostIps) Offset(offset int) Software_Component_HostIps

func (Software_Component_HostIps) UpdateHipsPolicies 

func (r Software_Component_HostIps) UpdateHipsPolicies(newIpsMode *string, newIpsProtection *string, newFirewallMode *string, newFirewallRuleset *string, newApplicationMode *string, newApplicationRuleset *string, newEnforcementPolicy *string) (resp bool, err error)

Update the Host IPS policies. To retrieve valid policy options you must use the provided relationships.

type Software_Component_Password 

type Software_Component_Password struct {
	Session session.SLSession
	Options sl.Options
}

This SoftLayer_Software_Component_Password data type contains a password for a specific software component instance.

func GetSoftwareComponentPasswordService 

func GetSoftwareComponentPasswordService(sess session.SLSession) Software_Component_Password

GetSoftwareComponentPasswordService returns an instance of the Software_Component_Password SoftLayer service

func (Software_Component_Password) CreateObject 

func (r Software_Component_Password) CreateObject(templateObject *datatypes.Software_Component_Password) (resp datatypes.Software_Component_Password, err error)

Create a password for a software component.

func (Software_Component_Password) CreateObjects 

func (r Software_Component_Password) CreateObjects(templateObjects []datatypes.Software_Component_Password) (resp bool, err error)

Create more than one password for a software component.

func (Software_Component_Password) DeleteObject 

func (r Software_Component_Password) DeleteObject() (resp bool, err error)

Delete a password from a software component.

func (Software_Component_Password) DeleteObjects 

func (r Software_Component_Password) DeleteObjects(templateObjects []datatypes.Software_Component_Password) (resp bool, err error)

Delete more than one passwords from a software component.

func (Software_Component_Password) EditObject 

func (r Software_Component_Password) EditObject(templateObject *datatypes.Software_Component_Password) (resp bool, err error)

Edit the properties of a software component password such as the username, password, port, and notes.

func (Software_Component_Password) EditObjects 

func (r Software_Component_Password) EditObjects(templateObjects []datatypes.Software_Component_Password) (resp bool, err error)

Edit more than one password from a software component.

func (Software_Component_Password) Filter 

func (r Software_Component_Password) Filter(filter string) Software_Component_Password

func (Software_Component_Password) GetObject 

func (r Software_Component_Password) GetObject() (resp datatypes.Software_Component_Password, err error)

no documentation yet

func (Software_Component_Password) GetSoftware 

func (r Software_Component_Password) GetSoftware() (resp datatypes.Software_Component, err error)

Retrieve The SoftLayer_Software_Component instance that this username/password pair is valid for.

func (Software_Component_Password) GetSshKeys 

func (r Software_Component_Password) GetSshKeys() (resp []datatypes.Security_Ssh_Key, err error)

Retrieve SSH keys to be installed on the server during provisioning or an OS reload.

func (Software_Component_Password) Id 

func (r Software_Component_Password) Id(id int) Software_Component_Password

func (Software_Component_Password) Limit 

func (r Software_Component_Password) Limit(limit int) Software_Component_Password

func (Software_Component_Password) Mask 

func (r Software_Component_Password) Mask(mask string) Software_Component_Password

func (Software_Component_Password) Offset 

func (r Software_Component_Password) Offset(offset int) Software_Component_Password

type Software_Component_Trellix added in v1.0.6 

type Software_Component_Trellix struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetSoftwareComponentTrellixService added in v1.0.6 

func GetSoftwareComponentTrellixService(sess session.SLSession) Software_Component_Trellix

GetSoftwareComponentTrellixService returns an instance of the Software_Component_Trellix SoftLayer service

func (Software_Component_Trellix) Filter added in v1.0.6 

func (r Software_Component_Trellix) Filter(filter string) Software_Component_Trellix

func (Software_Component_Trellix) GetAverageInstallationDuration added in v1.0.6 

func (r Software_Component_Trellix) GetAverageInstallationDuration() (resp uint, err error)

Retrieve The average amount of time that a software component takes to install.

func (Software_Component_Trellix) GetBillingItem added in v1.0.6 

func (r Software_Component_Trellix) GetBillingItem() (resp datatypes.Billing_Item, err error)

Retrieve The billing item for a software component.

func (Software_Component_Trellix) GetCurrentHostIpsPolicies added in v1.0.6 

func (r Software_Component_Trellix) GetCurrentHostIpsPolicies() (resp []datatypes.Container_Software_Component_HostIps_Policy, err error)

Get the current Host IPS policies.

func (Software_Component_Trellix) GetHardware added in v1.0.6 

func (r Software_Component_Trellix) GetHardware() (resp datatypes.Hardware, err error)

Retrieve The hardware this Software Component is installed upon.

func (Software_Component_Trellix) GetLicenseFile added in v1.0.6 

func (r Software_Component_Trellix) GetLicenseFile() (resp string, err error)

Attempt to retrieve the file associated with a software component. If the software component does not support downloading license files an exception will be thrown.

func (Software_Component_Trellix) GetObject added in v1.0.6 

func (r Software_Component_Trellix) GetObject() (resp datatypes.Software_Component_Trellix, err error)

no documentation yet

func (Software_Component_Trellix) GetPasswordHistory added in v1.0.6 

func (r Software_Component_Trellix) GetPasswordHistory() (resp []datatypes.Software_Component_Password_History, err error)

Retrieve History Records for Software Passwords.

func (Software_Component_Trellix) GetPasswords added in v1.0.6 

func (r Software_Component_Trellix) GetPasswords() (resp []datatypes.Software_Component_Password, err error)

Retrieve Username/Password pairs used for access to this Software Installation.

func (Software_Component_Trellix) GetSoftwareDescription added in v1.0.6 

func (r Software_Component_Trellix) GetSoftwareDescription() (resp datatypes.Software_Description, err error)

Retrieve The Software Description of this Software Component.

func (Software_Component_Trellix) GetSoftwareLicense added in v1.0.6 

func (r Software_Component_Trellix) GetSoftwareLicense() (resp datatypes.Software_License, err error)

Retrieve The License this Software Component uses.

func (Software_Component_Trellix) GetVendorSetUpConfiguration added in v1.0.6 

func (r Software_Component_Trellix) GetVendorSetUpConfiguration() (resp string, err error)

no documentation yet

func (Software_Component_Trellix) GetVirtualGuest added in v1.0.6 

func (r Software_Component_Trellix) GetVirtualGuest() (resp datatypes.Virtual_Guest, err error)

Retrieve The virtual guest this software component is installed upon.

func (Software_Component_Trellix) Id added in v1.0.6 

func (r Software_Component_Trellix) Id(id int) Software_Component_Trellix

func (Software_Component_Trellix) Limit added in v1.0.6 

func (r Software_Component_Trellix) Limit(limit int) Software_Component_Trellix

func (Software_Component_Trellix) Mask added in v1.0.6 

func (r Software_Component_Trellix) Mask(mask string) Software_Component_Trellix

func (Software_Component_Trellix) Offset added in v1.0.6 

func (r Software_Component_Trellix) Offset(offset int) Software_Component_Trellix

func (Software_Component_Trellix) UpdateAntivirusSpywarePolicy added in v1.0.6 

func (r Software_Component_Trellix) UpdateAntivirusSpywarePolicy(newPolicy *string, enforce *bool) (resp bool, err error)

Update an anti-virus/spyware policy. The policy options that it accepts are the following: *1 - Minimal *2 - Relaxed *3 - Default *4 - High *5 - Ultimate

func (Software_Component_Trellix) UpdateHipsPolicies added in v1.0.6 

func (r Software_Component_Trellix) UpdateHipsPolicies(newIpsMode *string, newIpsProtection *string, newFirewallMode *string, newFirewallRuleset *string, newApplicationMode *string, newApplicationRuleset *string, newEnforcementPolicy *string) (resp bool, err error)

Update the Host IPS policies. To retrieve valid policy options you must use the provided relationships.

type Software_Description 

type Software_Description struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetSoftwareDescriptionService 

func GetSoftwareDescriptionService(sess session.SLSession) Software_Description

GetSoftwareDescriptionService returns an instance of the Software_Description SoftLayer service

func (Software_Description) Filter 

func (r Software_Description) Filter(filter string) Software_Description

func (Software_Description) GetAllObjects 

func (r Software_Description) GetAllObjects() (resp []datatypes.Software_Description, err error)

no documentation yet

func (Software_Description) GetAttributes 

func (r Software_Description) GetAttributes() (resp []datatypes.Software_Description_Attribute, err error)

Retrieve

func (Software_Description) GetAverageInstallationDuration 

func (r Software_Description) GetAverageInstallationDuration() (resp int, err error)

Retrieve The average amount of time that a software description takes to install.

func (Software_Description) GetCompatibleSoftwareDescriptions 

func (r Software_Description) GetCompatibleSoftwareDescriptions() (resp []datatypes.Software_Description, err error)

Retrieve A list of the software descriptions that are compatible with this software description.

func (Software_Description) GetCustomerOwnedLicenseDescriptions 

func (r Software_Description) GetCustomerOwnedLicenseDescriptions() (resp []datatypes.Software_Description, err error)

no documentation yet

func (Software_Description) GetFeatures 

func (r Software_Description) GetFeatures() (resp []datatypes.Software_Description_Feature, err error)

Retrieve The feature attributes of a software description.

func (Software_Description) GetLatestVersion 

func (r Software_Description) GetLatestVersion() (resp []datatypes.Software_Description, err error)

Retrieve The latest version of a software description.

func (Software_Description) GetObject 

func (r Software_Description) GetObject() (resp datatypes.Software_Description, err error)

no documentation yet

func (Software_Description) GetProductItems 

func (r Software_Description) GetProductItems() (resp []datatypes.Product_Item, err error)

Retrieve The various product items to which this software description is linked.

func (Software_Description) GetProvisionTransactionGroup 

func (r Software_Description) GetProvisionTransactionGroup() (resp datatypes.Provisioning_Version1_Transaction_Group, err error)

Retrieve This details the provisioning transaction group for this software. This is only valid for Operating System software.

func (Software_Description) GetReloadTransactionGroup 

func (r Software_Description) GetReloadTransactionGroup() (resp datatypes.Provisioning_Version1_Transaction_Group, err error)

Retrieve The transaction group that a software description belongs to. A transaction group is a sequence of transactions that must be performed in a specific order for the installation of software.

func (Software_Description) GetRequiredUser 

func (r Software_Description) GetRequiredUser() (resp string, err error)

Retrieve The default user created for a given a software description.

func (Software_Description) GetSoftwareLicenses 

func (r Software_Description) GetSoftwareLicenses() (resp []datatypes.Software_License, err error)

Retrieve Software Licenses that govern this Software Description.

func (Software_Description) GetUpgradeSoftwareDescription 

func (r Software_Description) GetUpgradeSoftwareDescription() (resp datatypes.Software_Description, err error)

Retrieve A suggestion for an upgrade path from this Software Description

func (Software_Description) GetUpgradeSwDesc 

func (r Software_Description) GetUpgradeSwDesc() (resp datatypes.Software_Description, err error)

Retrieve A suggestion for an upgrade path from this Software Description (Deprecated - Use upgradeSoftwareDescription)

func (Software_Description) GetValidFilesystemTypes 

func (r Software_Description) GetValidFilesystemTypes() (resp []datatypes.Configuration_Storage_Filesystem_Type, err error)

Retrieve

func (Software_Description) Id 

func (r Software_Description) Id(id int) Software_Description

func (Software_Description) Limit 

func (r Software_Description) Limit(limit int) Software_Description

func (Software_Description) Mask 

func (r Software_Description) Mask(mask string) Software_Description

func (Software_Description) Offset 

func (r Software_Description) Offset(offset int) Software_Description

type Software_VirtualLicense 

type Software_VirtualLicense struct {
	Session session.SLSession
	Options sl.Options
}

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".

func GetSoftwareVirtualLicenseService 

func GetSoftwareVirtualLicenseService(sess session.SLSession) Software_VirtualLicense

GetSoftwareVirtualLicenseService returns an instance of the Software_VirtualLicense SoftLayer service

func (Software_VirtualLicense) Filter 

func (r Software_VirtualLicense) Filter(filter string) Software_VirtualLicense

func (Software_VirtualLicense) GetAccount 

func (r Software_VirtualLicense) GetAccount() (resp datatypes.Account, err error)

Retrieve The customer account this Virtual License belongs to.

func (Software_VirtualLicense) GetBillingItem 

func (r Software_VirtualLicense) GetBillingItem() (resp datatypes.Billing_Item, err error)

Retrieve The billing item for a software virtual license.

func (Software_VirtualLicense) GetHostHardware 

func (r Software_VirtualLicense) GetHostHardware() (resp datatypes.Hardware_Server, err error)

Retrieve The hardware record to which the software virtual license is assigned.

func (Software_VirtualLicense) GetIpAddressRecord 

func (r Software_VirtualLicense) GetIpAddressRecord() (resp datatypes.Network_Subnet_IpAddress, err error)

Retrieve The IP Address record associated with a virtual license.

func (Software_VirtualLicense) GetLicenseFile 

func (r Software_VirtualLicense) GetLicenseFile() (resp []byte, err error)

Attempt to retrieve the file associated with a virtual license, if such a file exists. If there is no file for this virtual license, calling this method will either throw an exception or return false.

func (Software_VirtualLicense) GetObject 

func (r Software_VirtualLicense) GetObject() (resp datatypes.Software_VirtualLicense, err error)

getObject retrieves the SoftLayer_Software_VirtualLicense object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Software_VirtualLicense service. You can only retrieve Virtual Licenses assigned to your account number.

func (Software_VirtualLicense) GetSoftwareDescription 

func (r Software_VirtualLicense) GetSoftwareDescription() (resp datatypes.Software_Description, err error)

Retrieve The SoftLayer_Software_Description that this virtual license is for.

func (Software_VirtualLicense) GetSubnet 

func (r Software_VirtualLicense) GetSubnet() (resp datatypes.Network_Subnet, err error)

Retrieve The subnet this Virtual License's IP address belongs to.

func (Software_VirtualLicense) Id 

func (r Software_VirtualLicense) Id(id int) Software_VirtualLicense

func (Software_VirtualLicense) Limit 

func (r Software_VirtualLicense) Limit(limit int) Software_VirtualLicense

func (Software_VirtualLicense) Mask 

func (r Software_VirtualLicense) Mask(mask string) Software_VirtualLicense

func (Software_VirtualLicense) Offset 

func (r Software_VirtualLicense) Offset(offset int) Software_VirtualLicense

type Survey 

type Survey struct {
	Session session.SLSession
	Options sl.Options
}

The SoftLayer_Survey data type contains general information relating to a single SoftLayer survey.

func GetSurveyService 

func GetSurveyService(sess session.SLSession) Survey

GetSurveyService returns an instance of the Survey SoftLayer service

func (Survey) Filter 

func (r Survey) Filter(filter string) Survey

func (Survey) GetActiveSurveyByType 

func (r Survey) GetActiveSurveyByType(typ *string) (resp datatypes.Survey, err error)

Provides survey details for the given type

func (Survey) GetObject 

func (r Survey) GetObject() (resp datatypes.Survey, err error)

getObject retrieves the SoftLayer_Survey object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Survey service. You can only retrieve the survey that your portal user has taken.

func (Survey) GetQuestions 

func (r Survey) GetQuestions() (resp []datatypes.Survey_Question, err error)

Retrieve The questions for a survey.

func (Survey) GetStatus 

func (r Survey) GetStatus() (resp datatypes.Survey_Status, err error)

Retrieve The status of the survey

func (Survey) GetType 

func (r Survey) GetType() (resp datatypes.Survey_Type, err error)

Retrieve The type of survey

func (Survey) Id 

func (r Survey) Id(id int) Survey

func (Survey) Limit 

func (r Survey) Limit(limit int) Survey

func (Survey) Mask 

func (r Survey) Mask(mask string) Survey

func (Survey) Offset 

func (r Survey) Offset(offset int) Survey

func (Survey) TakeSurvey 

func (r Survey) TakeSurvey(responses []datatypes.Survey_Response) (resp bool, err error)

Response to a SoftLayer survey's questions.

type Tag 

type Tag struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetTagService 

func GetTagService(sess session.SLSession) Tag

GetTagService returns an instance of the Tag SoftLayer service

func (Tag) AutoComplete 

func (r Tag) AutoComplete(tag *string) (resp []datatypes.Tag, err error)

This function is responsible for setting the Tags values. The internal flag is set to 0 if the user is a customer, and 1 otherwise. AccountId is set to the account bound to the user, and the tags name is set to the clean version of the tag inputted by the user.

func (Tag) DeleteTag 

func (r Tag) DeleteTag(tagName *string) (resp bool, err error)

Delete a tag for an object.

func (Tag) Filter 

func (r Tag) Filter(filter string) Tag

func (Tag) GetAccount 

func (r Tag) GetAccount() (resp datatypes.Account, err error)

Retrieve The account to which the tag is tied.

func (Tag) GetAllTagTypes 

func (r Tag) GetAllTagTypes() (resp []datatypes.Tag_Type, err error)

Returns all tags of a given object type.

func (Tag) GetAttachedTagsForCurrentUser added in v1.0.1 

func (r Tag) GetAttachedTagsForCurrentUser() (resp []datatypes.Tag, err error)

Get all tags with at least one reference attached to it for the current account. The total items header for this method contains the total number of attached tags even if a result limit is applied.

func (Tag) GetObject 

func (r Tag) GetObject() (resp datatypes.Tag, err error)

no documentation yet

func (Tag) GetReferences 

func (r Tag) GetReferences() (resp []datatypes.Tag_Reference, err error)

Retrieve References that tie object to the tag.

func (Tag) GetTagByTagName 

func (r Tag) GetTagByTagName(tagList *string) (resp []datatypes.Tag, err error)

Returns the Tag object with a given name. The user types in the tag name and this method returns the tag with that name.

func (Tag) GetUnattachedTagsForCurrentUser added in v1.0.1 

func (r Tag) GetUnattachedTagsForCurrentUser() (resp []datatypes.Tag, err error)

Get all tags with no references attached to it for the current account. The total items header for this method contains the total number of unattached tags even if a result limit is applied.

func (Tag) Id 

func (r Tag) Id(id int) Tag

func (Tag) Limit 

func (r Tag) Limit(limit int) Tag

func (Tag) Mask 

func (r Tag) Mask(mask string) Tag

func (Tag) Offset 

func (r Tag) Offset(offset int) Tag

func (Tag) SetTags 

func (r Tag) SetTags(tags *string, keyName *string, resourceTableId *int) (resp bool, err error)

Tag an object by passing in one or more tags separated by a comma. Tag references are cleared out every time this method is called. If your object is already tagged you will need to pass the current tags along with any new ones. To remove all tag references pass an empty string. To remove one or more tags omit them from the tag list. The characters permitted are A-Z, 0-9, whitespace, _ (underscore), - (hypen), . (period), and : (colon). All other characters will be stripped away. You must pass 3 string arguments into this method or you will receive an exception.

type Ticket 

type Ticket struct {
	Session session.SLSession
	Options sl.Options
}

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]].

func GetTicketService 

func GetTicketService(sess session.SLSession) Ticket

GetTicketService returns an instance of the Ticket SoftLayer service

func (Ticket) AddAssignedAgent 

func (r Ticket) AddAssignedAgent(agentId *int) (err error)

func (Ticket) AddAttachedAdditionalEmails 

func (r Ticket) AddAttachedAdditionalEmails(emails []string) (resp bool, err error)

Creates new additional emails for assigned user if new emails are provided. Attaches any newly created additional emails to ticket.

func (Ticket) AddAttachedDedicatedHost 

func (r Ticket) AddAttachedDedicatedHost(dedicatedHostId *int) (resp datatypes.Ticket_Attachment_Dedicated_Host, err error)

Attach the given Dedicated Host to a SoftLayer ticket. An attachment provides an easy way for SoftLayer's employees to quickly look up your records in the case of specific issues.

func (Ticket) AddAttachedFile 

func (r Ticket) AddAttachedFile(fileAttachment *datatypes.Container_Utility_File_Attachment) (resp datatypes.Ticket_Attachment_File, err error)

Attach the given file to a SoftLayer ticket. A file attachment is a convenient way to submit non-textual error reports to SoftLayer employees in a ticket. File attachments to tickets must have a unique name.

func (Ticket) AddAttachedHardware 

func (r Ticket) AddAttachedHardware(hardwareId *int) (resp datatypes.Ticket_Attachment_Hardware, err error)

Attach the given hardware to a SoftLayer ticket. A hardware attachment provides an easy way for SoftLayer's employees to quickly look up your hardware records in the case of hardware-specific issues.

func (Ticket) AddAttachedVirtualGuest 

func (r Ticket) AddAttachedVirtualGuest(guestId *int, callCommit *bool) (resp datatypes.Ticket_Attachment_Virtual_Guest, err error)

Attach the given CloudLayer Computing Instance to a SoftLayer ticket. An attachment provides an easy way for SoftLayer's employees to quickly look up your records in the case of specific issues.

func (Ticket) AddFinalComments 

func (r Ticket) AddFinalComments(finalComments *string) (resp bool, err error)

As part of the customer service process SoftLayer has provided a quick feedback mechanism for its customers to rate their overall experience with SoftLayer after a ticket is closed. addFinalComments() sets these comments for a ticket update made by a SoftLayer employee. Final comments may only be set on closed tickets, can only be set once, and may not exceed 4000 characters in length. Once the comments are set ”addFinalComments()” returns a boolean true.

func (Ticket) AddScheduledAlert 

func (r Ticket) AddScheduledAlert(activationTime *string) (err error)

no documentation yet

func (Ticket) AddScheduledAutoClose 

func (r Ticket) AddScheduledAutoClose(activationTime *string) (err error)

no documentation yet

func (Ticket) AddUpdate 

func (r Ticket) AddUpdate(templateObject *datatypes.Ticket_Update, attachedFiles []datatypes.Container_Utility_File_Attachment) (resp []datatypes.Ticket_Update, err error)

Add an update to a ticket. A ticket update's entry has a maximum length of 4000 characters, so ”addUpdate()” splits the ”entry” property in the ”templateObject” parameter into 3900 character blocks and creates one entry per 3900 character block. Once complete ”addUpdate()” emails the ticket's owner and additional email addresses with an update message if the ticket's ”notifyUserOnUpdateFlag” is set. If the ticket is a Legal or Abuse ticket, then the account's abuse emails are also notified when the updates are processed. Finally, ”addUpdate()” returns an array of the newly created ticket updates.

func (Ticket) CreateAdministrativeTicket 

func (r Ticket) CreateAdministrativeTicket(templateObject *datatypes.Ticket, contents *string, attachmentId *int, rootPassword *string, controlPanelPassword *string, accessPort *string, attachedFiles []datatypes.Container_Utility_File_Attachment, attachmentType *string) (resp datatypes.Ticket, err error)

Create an administrative support ticket. Use an administrative ticket if you require SoftLayer's assistance managing your server or content. If you are experiencing an issue with SoftLayer's hardware, network, or services then please open a standard support ticket.

Support tickets may only be created in the open state. The SoftLayer API defaults new ticket properties ”userEditableFlag” to true, ”accountId” to the id of the account that your API user belongs to, and ”statusId” to 1001 (or "open"). You may not assign your new to ticket to users that your API user does not have access to.

Once your ticket is created it is placed in a queue for SoftLayer employees to work. As they update the ticket new [[SoftLayer_Ticket_Update]] entries are added to the ticket object.

Administrative support tickets add a one-time $3USD charge to your account.

func (Ticket) CreateCancelServerTicket 

func (r Ticket) CreateCancelServerTicket(attachmentId *int, reason *string, content *string, cancelAssociatedItems *bool, attachmentType *string) (resp datatypes.Ticket, err error)

A cancel server request creates a ticket to cancel the resource on next bill date. The hardware ID parameter is required to determine which server is to be cancelled. NOTE: Hourly bare metal servers will be cancelled on next bill date.

The reason parameter could be from the list below: * "No longer needed" * "Business closing down" * "Server / Upgrade Costs" * "Migrating to larger server" * "Migrating to smaller server" * "Migrating to a different SoftLayer datacenter" * "Network performance / latency" * "Support response / timing" * "Sales process / upgrades" * "Moving to competitor"

The content parameter describes further the reason for cancelling the server.

func (Ticket) CreateCancelServiceTicket 

func (r Ticket) CreateCancelServiceTicket(attachmentId *int, reason *string, content *string, attachmentType *string) (resp datatypes.Ticket, err error)

A cancel service request creates a sales ticket. The hardware ID parameter is required to determine which server is to be cancelled.

The reason parameter could be from the list below: * "No longer needed" * "Business closing down" * "Server / Upgrade Costs" * "Migrating to larger server" * "Migrating to smaller server" * "Migrating to a different SoftLayer datacenter" * "Network performance / latency" * "Support response / timing" * "Sales process / upgrades" * "Moving to competitor"

The content parameter describes further the reason for cancelling service.

func (Ticket) CreateStandardTicket 

func (r Ticket) CreateStandardTicket(templateObject *datatypes.Ticket, contents *string, attachmentId *int, rootPassword *string, controlPanelPassword *string, accessPort *string, attachedFiles []datatypes.Container_Utility_File_Attachment, attachmentType *string) (resp datatypes.Ticket, err error)

Create a standard support ticket. Use a standard support ticket if you need to work out a problem related to SoftLayer's hardware, network, or services. If you require SoftLayer's assistance managing your server or content then please open an administrative ticket.

Support tickets may only be created in the open state. The SoftLayer API defaults new ticket properties ”userEditableFlag” to true, ”accountId” to the id of the account that your API user belongs to, and ”statusId” to 1001 (or "open"). You may not assign your new to ticket to users that your API user does not have access to.

Once your ticket is created it is placed in a queue for SoftLayer employees to work. As they update the ticket new [[SoftLayer_Ticket_Update]] entries are added to the ticket object.

func (Ticket) CreateUpgradeTicket 

func (r Ticket) CreateUpgradeTicket(attachmentId *int, genericUpgrade *string, upgradeMaintenanceWindow *string, details *string, attachmentType *string, title *string) (resp datatypes.Ticket, err error)

Create a ticket for the SoftLayer sales team to perform a hardware or service upgrade. Our sales team will work with you on upgrade feasibility and pricing and then send the upgrade ticket to the proper department to perform the actual upgrade. Service affecting upgrades, such as server hardware or CloudLayer Computing Instance upgrades that require the server powered down must have a two hour maintenance specified for our datacenter engineers to perform your upgrade. Account level upgrades, such as adding PPTP VPN users, CDNLayer accounts, and monitoring services are processed much faster and do not require a maintenance window.

func (Ticket) Edit 

func (r Ticket) Edit(templateObject *datatypes.Ticket, contents *string, attachedFiles []datatypes.Container_Utility_File_Attachment) (resp datatypes.Ticket, err error)

Edit a SoftLayer ticket. The edit method is two-fold. You may either edit a ticket itself, add an update to a ticket, attach up to two files to a ticket, or perform all of these tasks. The SoftLayer API ignores changes made to the ”userEditableFlag” and ”accountId” properties. You may not assign a ticket to a user that your API account does not have access to. You may not enter a custom title for standard support tickets, buy may do so when editing an administrative ticket. Finally, you may not close a ticket using this method. Please contact SoftLayer if you need a ticket closed.

If you need to only add an update to a ticket then please use the [[SoftLayer_Ticket::addUpdate|addUpdate]] method in this service. Likewise if you need to only attach a file to a ticket then use the [[SoftLayer_Ticket::addAttachedFile|addAttachedFile]] method. The edit method exists as a convenience if you need to perform all these tasks at once.

func (Ticket) Filter 

func (r Ticket) Filter(filter string) Ticket

func (Ticket) GetAccount 

func (r Ticket) GetAccount() (resp datatypes.Account, err error)

Retrieve The SoftLayer customer account associated with a ticket.

func (Ticket) GetAllTicketGroups 

func (r Ticket) GetAllTicketGroups() (resp []datatypes.Ticket_Group, err error)

getAllTicketGroups() retrieves a list of all groups that a ticket may be assigned to. Ticket groups represent the internal department at SoftLayer who a ticket is assigned to.

Every SoftLayer ticket has groupId and ticketGroup properties that correspond to one of the groups returned by getAllTicketGroups().

func (Ticket) GetAllTicketStatuses 

func (r Ticket) GetAllTicketStatuses() (resp []datatypes.Ticket_Status, err error)

getAllTicketStatuses() retrieves a list of all statuses that a ticket may exist in. Ticket status represent the current state of a ticket, usually "open", "assigned", and "closed".

Every SoftLayer ticket has statusId and status properties that correspond to one of the statuses returned by getAllTicketStatuses().

func (Ticket) GetAssignedAgents 

func (r Ticket) GetAssignedAgents() (resp []datatypes.User_Customer, err error)

Retrieve

func (Ticket) GetAssignedUser 

func (r Ticket) GetAssignedUser() (resp datatypes.User_Customer, err error)

Retrieve The portal user that a ticket is assigned to.

func (Ticket) GetAttachedAdditionalEmails 

func (r Ticket) GetAttachedAdditionalEmails() (resp []datatypes.User_Customer_AdditionalEmail, err error)

Retrieve The list of additional emails to notify when a ticket update is made.

func (Ticket) GetAttachedDedicatedHosts 

func (r Ticket) GetAttachedDedicatedHosts() (resp []datatypes.Virtual_DedicatedHost, err error)

Retrieve The Dedicated Hosts associated with a ticket. This is used in cases where a ticket is directly associated with one or more Dedicated Hosts.

func (Ticket) GetAttachedFile 

func (r Ticket) GetAttachedFile(attachmentId *int) (resp []byte, err error)

Retrieve the file attached to a SoftLayer ticket by it's given identifier. To retrieve a list of files attached to a ticket either call the SoftLayer_Ticket::getAttachedFiles method or call SoftLayer_Ticket::getObject with ”attachedFiles” defined in an object mask.

func (Ticket) GetAttachedFiles 

func (r Ticket) GetAttachedFiles() (resp []datatypes.Ticket_Attachment_File, err error)

Retrieve The files attached to a ticket.

func (Ticket) GetAttachedHardware 

func (r Ticket) GetAttachedHardware() (resp []datatypes.Hardware, err error)

Retrieve The hardware associated with a ticket. This is used in cases where a ticket is directly associated with one or more pieces of hardware.

func (Ticket) GetAttachedHardwareCount 

func (r Ticket) GetAttachedHardwareCount() (resp uint, err error)

Retrieve

func (Ticket) GetAttachedResources 

func (r Ticket) GetAttachedResources() (resp []datatypes.Ticket_Attachment, err error)

Retrieve

func (Ticket) GetAttachedVirtualGuests 

func (r Ticket) GetAttachedVirtualGuests() (resp []datatypes.Virtual_Guest, err error)

Retrieve The virtual guests associated with a ticket. This is used in cases where a ticket is directly associated with one or more virtualized guests installations or Virtual Servers.

func (Ticket) GetAwaitingUserResponseFlag 

func (r Ticket) GetAwaitingUserResponseFlag() (resp bool, err error)

Retrieve Ticket is waiting on a response from a customer flag.

func (Ticket) GetBnppSupportedFlag added in v1.0.2 

func (r Ticket) GetBnppSupportedFlag() (resp bool, err error)

Retrieve A ticket's associated BNPP compliant record

func (Ticket) GetCancellationRequest 

func (r Ticket) GetCancellationRequest() (resp datatypes.Billing_Item_Cancellation_Request, err error)

Retrieve A service cancellation request.

func (Ticket) GetEmployeeAttachments 

func (r Ticket) GetEmployeeAttachments() (resp []datatypes.User_Employee, err error)

Retrieve

func (Ticket) GetEuSupportedFlag 

func (r Ticket) GetEuSupportedFlag() (resp bool, err error)

Retrieve A ticket's associated EU compliant record

func (Ticket) GetFirstAttachedResource 

func (r Ticket) GetFirstAttachedResource() (resp datatypes.Ticket_Attachment, err error)

Retrieve The first physical or virtual server attached to a ticket.

func (Ticket) GetFirstUpdate 

func (r Ticket) GetFirstUpdate() (resp datatypes.Ticket_Update, err error)

Retrieve The first update made to a ticket. This is typically the contents of a ticket when it's created.

func (Ticket) GetFsboaSupportedFlag added in v1.0.2 

func (r Ticket) GetFsboaSupportedFlag() (resp bool, err error)

Retrieve A ticket's associated FSBOA compliant record

func (Ticket) GetGroup 

func (r Ticket) GetGroup() (resp datatypes.Ticket_Group, err error)

Retrieve The SoftLayer department that a ticket is assigned to.

func (Ticket) GetInvoiceItems 

func (r Ticket) GetInvoiceItems() (resp []datatypes.Billing_Invoice_Item, err error)

Retrieve The invoice items associated with a ticket. Ticket based invoice items only exist when a ticket incurs a fee that has been invoiced.

func (Ticket) GetLastActivity 

func (r Ticket) GetLastActivity() (resp datatypes.Ticket_Activity, err error)

Retrieve

func (Ticket) GetLastEditor 

func (r Ticket) GetLastEditor() (resp datatypes.User_Interface, err error)

Retrieve

func (Ticket) GetLastUpdate 

func (r Ticket) GetLastUpdate() (resp datatypes.Ticket_Update, err error)

Retrieve The last update made to a ticket.

func (Ticket) GetLocation 

func (r Ticket) GetLocation() (resp datatypes.Location, err error)

Retrieve A ticket's associated location within the SoftLayer location hierarchy.

func (Ticket) GetNewUpdatesFlag 

func (r Ticket) GetNewUpdatesFlag() (resp bool, err error)

Retrieve True if there are new, unread updates to this ticket for the current user, False otherwise.

func (Ticket) GetObject 

func (r Ticket) GetObject() (resp datatypes.Ticket, err error)

getObject retrieves the SoftLayer_Ticket object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Ticket service. You can only retrieve tickets that are associated with your SoftLayer customer account.

func (Ticket) GetScheduledActions 

func (r Ticket) GetScheduledActions() (resp []datatypes.Provisioning_Version1_Transaction, err error)

Retrieve

func (Ticket) GetServerAdministrationBillingInvoice 

func (r Ticket) GetServerAdministrationBillingInvoice() (resp datatypes.Billing_Invoice, err error)

Retrieve The invoice associated with a ticket. Only tickets with an associated administrative charge have an invoice.

func (Ticket) GetServerAdministrationRefundInvoice 

func (r Ticket) GetServerAdministrationRefundInvoice() (resp datatypes.Billing_Invoice, err error)

Retrieve The refund invoice associated with a ticket. Only tickets with a refund applied in them have an associated refund invoice.

func (Ticket) GetServiceProvider 

func (r Ticket) GetServiceProvider() (resp datatypes.Service_Provider, err error)

Retrieve

func (Ticket) GetState 

func (r Ticket) GetState() (resp []datatypes.Ticket_State, err error)

Retrieve

func (Ticket) GetStatus 

func (r Ticket) GetStatus() (resp datatypes.Ticket_Status, err error)

Retrieve A ticket's status.

func (Ticket) GetSubject 

func (r Ticket) GetSubject() (resp datatypes.Ticket_Subject, err error)

Retrieve A ticket's subject. Only standard support tickets have an associated subject. A standard support ticket's title corresponds with it's subject's name.

func (Ticket) GetTagReferences 

func (r Ticket) GetTagReferences() (resp []datatypes.Tag_Reference, err error)

Retrieve

func (Ticket) GetTicketsClosedSinceDate 

func (r Ticket) GetTicketsClosedSinceDate(closeDate *datatypes.Time) (resp []datatypes.Ticket, err error)

Retrieve all tickets closed since a given date.

func (Ticket) GetUpdateRatingFlag 

func (r Ticket) GetUpdateRatingFlag() (resp bool, err error)

Retrieve Whether employees' updates of this ticket could be rated by customer

func (Ticket) GetUpdates 

func (r Ticket) GetUpdates() (resp []datatypes.Ticket_Update, err error)

Retrieve A ticket's updates.

func (Ticket) Id 

func (r Ticket) Id(id int) Ticket

func (Ticket) Limit 

func (r Ticket) Limit(limit int) Ticket

func (Ticket) MarkAsViewed 

func (r Ticket) MarkAsViewed() (err error)

Mark a ticket as viewed. All currently posted updates will be marked as viewed. The lastViewedDate property will be updated to the current time.

func (Ticket) Mask 

func (r Ticket) Mask(mask string) Ticket

func (Ticket) Offset 

func (r Ticket) Offset(offset int) Ticket

func (Ticket) RemoveAssignedAgent 

func (r Ticket) RemoveAssignedAgent(agentId *int) (err error)

func (Ticket) RemoveAttachedAdditionalEmails 

func (r Ticket) RemoveAttachedAdditionalEmails(emails []string) (resp bool, err error)

removeAttachedAdditionalEmails() removes the specified email addresses from a ticket's notification list. If one of the provided email addresses is not attached to the ticket then ”removeAttachedAdditiaonalEmails()” ignores it and continues to the next one. Once the email addresses are removed ”removeAttachedAdditiaonalEmails()” returns a boolean true.

func (Ticket) RemoveAttachedHardware 

func (r Ticket) RemoveAttachedHardware(hardwareId *int) (resp bool, err error)

detach the given hardware from a SoftLayer ticket. Removing a hardware attachment may delay ticket processing time if the hardware removed is relevant to the ticket's issue. Return a boolean true upon successful hardware detachment.

func (Ticket) RemoveAttachedVirtualGuest 

func (r Ticket) RemoveAttachedVirtualGuest(guestId *int) (resp bool, err error)

Detach the given CloudLayer Computing Instance from a SoftLayer ticket. Removing an attachment may delay ticket processing time if the instance removed is relevant to the ticket's issue. Return a boolean true upon successful detachment.

func (Ticket) RemoveScheduledAlert 

func (r Ticket) RemoveScheduledAlert() (err error)

no documentation yet

func (Ticket) RemoveScheduledAutoClose 

func (r Ticket) RemoveScheduledAutoClose() (err error)

no documentation yet

func (Ticket) SetTags 

func (r Ticket) SetTags(tags *string) (resp bool, err error)

no documentation yet

func (Ticket) SurveyEligible 

func (r Ticket) SurveyEligible() (resp bool, err error)

(DEPRECATED) Use [[SoftLayer_Ticket_Survey::getPreference]] method. Deprecated: This function has been marked as deprecated.

func (Ticket) UpdateAttachedAdditionalEmails 

func (r Ticket) UpdateAttachedAdditionalEmails(emails []string) (resp bool, err error)

Creates new additional emails for assigned user if new emails are provided. Attaches any newly created additional emails to ticket. Remove any additional emails from a ticket that are not provided as part of $emails

type Ticket_Attachment_File 

type Ticket_Attachment_File struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetTicketAttachmentFileService 

func GetTicketAttachmentFileService(sess session.SLSession) Ticket_Attachment_File

GetTicketAttachmentFileService returns an instance of the Ticket_Attachment_File SoftLayer service

func (Ticket_Attachment_File) Filter 

func (r Ticket_Attachment_File) Filter(filter string) Ticket_Attachment_File

func (Ticket_Attachment_File) GetExtensionWhitelist 

func (r Ticket_Attachment_File) GetExtensionWhitelist() (resp []string, err error)

no documentation yet

func (Ticket_Attachment_File) GetObject 

func (r Ticket_Attachment_File) GetObject() (resp datatypes.Ticket_Attachment_File, err error)

no documentation yet

func (Ticket_Attachment_File) GetTicket 

func (r Ticket_Attachment_File) GetTicket() (resp datatypes.Ticket, err error)

Retrieve

func (Ticket_Attachment_File) GetUpdate 

func (r Ticket_Attachment_File) GetUpdate() (resp datatypes.Ticket_Update, err error)

Retrieve The ticket that a file is attached to.

func (Ticket_Attachment_File) Id 

func (r Ticket_Attachment_File) Id(id int) Ticket_Attachment_File

func (Ticket_Attachment_File) Limit 

func (r Ticket_Attachment_File) Limit(limit int) Ticket_Attachment_File

func (Ticket_Attachment_File) Mask 

func (r Ticket_Attachment_File) Mask(mask string) Ticket_Attachment_File

func (Ticket_Attachment_File) Offset 

func (r Ticket_Attachment_File) Offset(offset int) Ticket_Attachment_File

type Ticket_Attachment_File_ServiceNow 

type Ticket_Attachment_File_ServiceNow struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetTicketAttachmentFileServiceNowService 

func GetTicketAttachmentFileServiceNowService(sess session.SLSession) Ticket_Attachment_File_ServiceNow

GetTicketAttachmentFileServiceNowService returns an instance of the Ticket_Attachment_File_ServiceNow SoftLayer service

func (Ticket_Attachment_File_ServiceNow) Filter 

func (r Ticket_Attachment_File_ServiceNow) Filter(filter string) Ticket_Attachment_File_ServiceNow

func (Ticket_Attachment_File_ServiceNow) GetExtensionWhitelist 

func (r Ticket_Attachment_File_ServiceNow) GetExtensionWhitelist() (resp []string, err error)

no documentation yet

func (Ticket_Attachment_File_ServiceNow) GetObject 

func (r Ticket_Attachment_File_ServiceNow) GetObject() (resp datatypes.Ticket_Attachment_File_ServiceNow, err error)

no documentation yet

func (Ticket_Attachment_File_ServiceNow) GetTicket 

func (r Ticket_Attachment_File_ServiceNow) GetTicket() (resp datatypes.Ticket, err error)

Retrieve

func (Ticket_Attachment_File_ServiceNow) GetUpdate 

func (r Ticket_Attachment_File_ServiceNow) GetUpdate() (resp datatypes.Ticket_Update, err error)

Retrieve The ticket that a file is attached to.

func (Ticket_Attachment_File_ServiceNow) Id 

func (r Ticket_Attachment_File_ServiceNow) Id(id int) Ticket_Attachment_File_ServiceNow

func (Ticket_Attachment_File_ServiceNow) Limit 

func (r Ticket_Attachment_File_ServiceNow) Limit(limit int) Ticket_Attachment_File_ServiceNow

func (Ticket_Attachment_File_ServiceNow) Mask 

func (r Ticket_Attachment_File_ServiceNow) Mask(mask string) Ticket_Attachment_File_ServiceNow

func (Ticket_Attachment_File_ServiceNow) Offset 

func (r Ticket_Attachment_File_ServiceNow) Offset(offset int) Ticket_Attachment_File_ServiceNow

type Ticket_Priority 

type Ticket_Priority struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetTicketPriorityService 

func GetTicketPriorityService(sess session.SLSession) Ticket_Priority

GetTicketPriorityService returns an instance of the Ticket_Priority SoftLayer service

func (Ticket_Priority) Filter 

func (r Ticket_Priority) Filter(filter string) Ticket_Priority

func (Ticket_Priority) GetPriorities 

func (r Ticket_Priority) GetPriorities() (resp []datatypes.Container_Ticket_Priority, err error)

no documentation yet

func (Ticket_Priority) Id 

func (r Ticket_Priority) Id(id int) Ticket_Priority

func (Ticket_Priority) Limit 

func (r Ticket_Priority) Limit(limit int) Ticket_Priority

func (Ticket_Priority) Mask 

func (r Ticket_Priority) Mask(mask string) Ticket_Priority

func (Ticket_Priority) Offset 

func (r Ticket_Priority) Offset(offset int) Ticket_Priority

type Ticket_Subject 

type Ticket_Subject struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetTicketSubjectService 

func GetTicketSubjectService(sess session.SLSession) Ticket_Subject

GetTicketSubjectService returns an instance of the Ticket_Subject SoftLayer service

func (Ticket_Subject) Filter 

func (r Ticket_Subject) Filter(filter string) Ticket_Subject

func (Ticket_Subject) GetAllObjects 

func (r Ticket_Subject) GetAllObjects() (resp []datatypes.Ticket_Subject, err error)

Retrieve all possible ticket subjects. The SoftLayer customer portal uses this method in the add standard support ticket form.

func (Ticket_Subject) GetCategory 

func (r Ticket_Subject) GetCategory() (resp datatypes.Ticket_Subject_Category, err error)

Retrieve

func (Ticket_Subject) GetChildren 

func (r Ticket_Subject) GetChildren() (resp []datatypes.Ticket_Subject, err error)

Retrieve A child subject

func (Ticket_Subject) GetGroup 

func (r Ticket_Subject) GetGroup() (resp datatypes.Ticket_Group, err error)

Retrieve

func (Ticket_Subject) GetObject 

func (r Ticket_Subject) GetObject() (resp datatypes.Ticket_Subject, err error)

getObject retrieves the SoftLayer_Ticket_Subject object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Ticket_Subject service.

func (Ticket_Subject) GetParent 

func (r Ticket_Subject) GetParent() (resp datatypes.Ticket_Subject, err error)

Retrieve A parent subject

func (Ticket_Subject) GetTopFiveKnowledgeLayerQuestions 

func (r Ticket_Subject) GetTopFiveKnowledgeLayerQuestions() (resp []datatypes.Container_KnowledgeLayer_QuestionAnswer, err error)

SoftLayer maintains relationships between the generic subjects for standard administration and the top five commonly asked questions about these subjects. getTopFileKnowledgeLayerQuestions() retrieves the top five questions and answers from the SoftLayer KnowledgeLayer related to the given ticket subject.

func (Ticket_Subject) Id 

func (r Ticket_Subject) Id(id int) Ticket_Subject

func (Ticket_Subject) Limit 

func (r Ticket_Subject) Limit(limit int) Ticket_Subject

func (Ticket_Subject) Mask 

func (r Ticket_Subject) Mask(mask string) Ticket_Subject

func (Ticket_Subject) Offset 

func (r Ticket_Subject) Offset(offset int) Ticket_Subject

type Ticket_Subject_Category 

type Ticket_Subject_Category struct {
	Session session.SLSession
	Options sl.Options
}

SoftLayer_Ticket_Subject_Category groups ticket subjects into logical group.

func GetTicketSubjectCategoryService 

func GetTicketSubjectCategoryService(sess session.SLSession) Ticket_Subject_Category

GetTicketSubjectCategoryService returns an instance of the Ticket_Subject_Category SoftLayer service

func (Ticket_Subject_Category) Filter 

func (r Ticket_Subject_Category) Filter(filter string) Ticket_Subject_Category

func (Ticket_Subject_Category) GetAllObjects 

func (r Ticket_Subject_Category) GetAllObjects() (resp []datatypes.Ticket_Subject_Category, err error)

Retrieve all ticket subject categories.

func (Ticket_Subject_Category) GetObject 

func (r Ticket_Subject_Category) GetObject() (resp datatypes.Ticket_Subject_Category, err error)

no documentation yet

func (Ticket_Subject_Category) GetSubjects 

func (r Ticket_Subject_Category) GetSubjects() (resp []datatypes.Ticket_Subject, err error)

Retrieve

func (Ticket_Subject_Category) Id 

func (r Ticket_Subject_Category) Id(id int) Ticket_Subject_Category

func (Ticket_Subject_Category) Limit 

func (r Ticket_Subject_Category) Limit(limit int) Ticket_Subject_Category

func (Ticket_Subject_Category) Mask 

func (r Ticket_Subject_Category) Mask(mask string) Ticket_Subject_Category

func (Ticket_Subject_Category) Offset 

func (r Ticket_Subject_Category) Offset(offset int) Ticket_Subject_Category

type Ticket_Survey 

type Ticket_Survey struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet Deprecated: This function has been marked as deprecated.

func GetTicketSurveyService 

func GetTicketSurveyService(sess session.SLSession) Ticket_Survey

GetTicketSurveyService returns an instance of the Ticket_Survey SoftLayer service

func (Ticket_Survey) Filter 

func (r Ticket_Survey) Filter(filter string) Ticket_Survey

func (Ticket_Survey) GetPreference 

func (r Ticket_Survey) GetPreference() (err error)

(DEPRECATED) To opt in or out of future surveys, please follow the link found in the email survey. Deprecated: This function has been marked as deprecated.

func (Ticket_Survey) Id 

func (r Ticket_Survey) Id(id int) Ticket_Survey

func (Ticket_Survey) Limit 

func (r Ticket_Survey) Limit(limit int) Ticket_Survey

func (Ticket_Survey) Mask 

func (r Ticket_Survey) Mask(mask string) Ticket_Survey

func (Ticket_Survey) Offset 

func (r Ticket_Survey) Offset(offset int) Ticket_Survey

func (Ticket_Survey) OptIn 

func (r Ticket_Survey) OptIn() (err error)

(DEPRECATED) To opt in of future surveys, please follow the link found in the email survey. Deprecated: This function has been marked as deprecated.

func (Ticket_Survey) OptOut 

func (r Ticket_Survey) OptOut() (err error)

(DEPRECATED) To opt out of future surveys, please follow the link found in the email survey. Deprecated: This function has been marked as deprecated.

type Ticket_Update_Employee 

type Ticket_Update_Employee struct {
	Session session.SLSession
	Options sl.Options
}

The SoftLayer_Ticket_Update_Employee data type models an update to a ticket made by a SoftLayer employee.

func GetTicketUpdateEmployeeService 

func GetTicketUpdateEmployeeService(sess session.SLSession) Ticket_Update_Employee

GetTicketUpdateEmployeeService returns an instance of the Ticket_Update_Employee SoftLayer service

func (Ticket_Update_Employee) AddResponseRating 

func (r Ticket_Update_Employee) AddResponseRating(responseRating *int, responseIndex *int) (resp bool, err error)

As part of the customer service process SoftLayer has provided a quick feedback mechanism for its customers to rate the responses that its employees give on tickets. addResponseRating() sets the rating for a single ticket update made by a SoftLayer employee. Ticket ratings have the integer values 1 through 5, with 1 being the worst and 5 being the best. Once the rating is set ”addResponseRating()” returns a boolean true.

func (Ticket_Update_Employee) Filter 

func (r Ticket_Update_Employee) Filter(filter string) Ticket_Update_Employee

func (Ticket_Update_Employee) GetObject 

func (r Ticket_Update_Employee) GetObject() (resp datatypes.Ticket_Update_Employee, err error)

getObject retrieves the SoftLayer_Ticket_Update_Employee object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Ticket_Update_Employee service. You can only retrieve employee updates to tickets that your API account has access to.

func (Ticket_Update_Employee) Id 

func (r Ticket_Update_Employee) Id(id int) Ticket_Update_Employee

func (Ticket_Update_Employee) Limit 

func (r Ticket_Update_Employee) Limit(limit int) Ticket_Update_Employee

func (Ticket_Update_Employee) Mask 

func (r Ticket_Update_Employee) Mask(mask string) Ticket_Update_Employee

func (Ticket_Update_Employee) Offset 

func (r Ticket_Update_Employee) Offset(offset int) Ticket_Update_Employee

type User_Customer 

type User_Customer struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetUserCustomerService 

func GetUserCustomerService(sess session.SLSession) User_Customer

GetUserCustomerService returns an instance of the User_Customer SoftLayer service

func (User_Customer) AcknowledgeSupportPolicy 

func (r User_Customer) AcknowledgeSupportPolicy() (err error)

no documentation yet

func (User_Customer) AddApiAuthenticationKey 

func (r User_Customer) AddApiAuthenticationKey() (resp string, err error)

Create a user's API authentication key, allowing that user access to query the SoftLayer API. addApiAuthenticationKey() returns the user's new API key. Each portal user is allowed only one API key.

func (User_Customer) AddBulkDedicatedHostAccess 

func (r User_Customer) AddBulkDedicatedHostAccess(dedicatedHostIds []int) (resp bool, err error)

Grants the user access to one or more dedicated host devices. The user will only be allowed to see and access devices in both the portal and the API to which they have been granted access. If the user's account has devices to which the user has not been granted access, then "not found" exceptions are thrown if the user attempts to access any of these devices.

Users can assign device access to their child users, but not to themselves. An account's master has access to all devices on their customer account and can set dedicated host access for any of the other users on their account.

func (User_Customer) AddBulkHardwareAccess 

func (r User_Customer) AddBulkHardwareAccess(hardwareIds []int) (resp bool, err error)

Add multiple hardware to a portal user's hardware access list. A user's hardware access list controls which of an account's hardware objects a user has access to in the SoftLayer customer portal and API. Hardware does not exist in the SoftLayer portal and returns "not found" exceptions in the API if the user doesn't have access to it. addBulkHardwareAccess() does not attempt to add hardware access if the given user already has access to that hardware object.

Users can assign hardware access to their child users, but not to themselves. An account's master has access to all hardware on their customer account and can set hardware access for any of the other users on their account.

func (User_Customer) AddBulkPortalPermission 

func (r User_Customer) AddBulkPortalPermission(permissions []datatypes.User_Customer_CustomerPermission_Permission) (resp bool, err error)

Add multiple permissions to a portal user's permission set. [[SoftLayer_User_Customer_CustomerPermission_Permission]] control which features in the SoftLayer customer portal and API a user may use. addBulkPortalPermission() does not attempt to add permissions already assigned to the user.

Users can assign permissions to their child users, but not to themselves. An account's master has all portal permissions and can set permissions for any of the other users on their account.

Use the [[SoftLayer_User_Customer_CustomerPermission_Permission::getAllObjects]] method to retrieve a list of all permissions available in the SoftLayer customer portal and API. Permissions are removed based on the keyName property of the permission objects within the permissions parameter.

func (User_Customer) AddBulkRoles 

func (r User_Customer) AddBulkRoles(roles []datatypes.User_Permission_Role) (err error)

no documentation yet

func (User_Customer) AddBulkVirtualGuestAccess 

func (r User_Customer) AddBulkVirtualGuestAccess(virtualGuestIds []int) (resp bool, err error)

Add multiple CloudLayer Computing Instances to a portal user's access list. A user's CloudLayer Computing Instance access list controls which of an account's CloudLayer Computing Instance objects a user has access to in the SoftLayer customer portal and API. CloudLayer Computing Instances do not exist in the SoftLayer portal and returns "not found" exceptions in the API if the user doesn't have access to it. addBulkVirtualGuestAccess() does not attempt to add CloudLayer Computing Instance access if the given user already has access to that CloudLayer Computing Instance object.

Users can assign CloudLayer Computing Instance access to their child users, but not to themselves. An account's master has access to all CloudLayer Computing Instances on their customer account and can set CloudLayer Computing Instance access for any of the other users on their account.

func (User_Customer) AddDedicatedHostAccess 

func (r User_Customer) AddDedicatedHostAccess(dedicatedHostId *int) (resp bool, err error)

Grants the user access to a single dedicated host device. The user will only be allowed to see and access devices in both the portal and the API to which they have been granted access. If the user's account has devices to which the user has not been granted access, then "not found" exceptions are thrown if the user attempts to access any of these devices.

Users can assign device access to their child users, but not to themselves. An account's master has access to all devices on their customer account and can set dedicated host access for any of the other users on their account.

Only the USER_MANAGE permission is required to execute this.

func (User_Customer) AddExternalBinding 

func (r User_Customer) AddExternalBinding(externalBinding *datatypes.User_External_Binding) (resp datatypes.User_Customer_External_Binding, err error)

no documentation yet

func (User_Customer) AddHardwareAccess 

func (r User_Customer) AddHardwareAccess(hardwareId *int) (resp bool, err error)

Add hardware to a portal user's hardware access list. A user's hardware access list controls which of an account's hardware objects a user has access to in the SoftLayer customer portal and API. Hardware does not exist in the SoftLayer portal and returns "not found" exceptions in the API if the user doesn't have access to it. If a user already has access to the hardware you're attempting to add then addHardwareAccess() returns true.

Users can assign hardware access to their child users, but not to themselves. An account's master has access to all hardware on their customer account and can set hardware access for any of the other users on their account.

Only the USER_MANAGE permission is required to execute this.

func (User_Customer) AddNotificationSubscriber 

func (r User_Customer) AddNotificationSubscriber(notificationKeyName *string) (resp bool, err error)

Create a notification subscription record for the user. If a subscription record exists for the notification, the record will be set to active, if currently inactive.

func (User_Customer) AddPortalPermission 

func (r User_Customer) AddPortalPermission(permission *datatypes.User_Customer_CustomerPermission_Permission) (resp bool, err error)

Add a permission to a portal user's permission set. [[SoftLayer_User_Customer_CustomerPermission_Permission]] control which features in the SoftLayer customer portal and API a user may use. If the user already has the permission you're attempting to add then addPortalPermission() returns true.

Users can assign permissions to their child users, but not to themselves. An account's master has all portal permissions and can set permissions for any of the other users on their account.

Use the [[SoftLayer_User_Customer_CustomerPermission_Permission::getAllObjects]] method to retrieve a list of all permissions available in the SoftLayer customer portal and API. Permissions are added based on the keyName property of the permission parameter.

func (User_Customer) AddRole 

func (r User_Customer) AddRole(role *datatypes.User_Permission_Role) (err error)

no documentation yet

func (User_Customer) AddVirtualGuestAccess 

func (r User_Customer) AddVirtualGuestAccess(virtualGuestId *int) (resp bool, err error)

Add a CloudLayer Computing Instance to a portal user's access list. A user's CloudLayer Computing Instance access list controls which of an account's CloudLayer Computing Instance objects a user has access to in the SoftLayer customer portal and API. CloudLayer Computing Instances do not exist in the SoftLayer portal and returns "not found" exceptions in the API if the user doesn't have access to it. If a user already has access to the CloudLayer Computing Instance you're attempting to add then addVirtualGuestAccess() returns true.

Users can assign CloudLayer Computing Instance access to their child users, but not to themselves. An account's master has access to all CloudLayer Computing Instances on their customer account and can set CloudLayer Computing Instance access for any of the other users on their account.

Only the USER_MANAGE permission is required to execute this.

func (User_Customer) AssignNewParentId 

func (r User_Customer) AssignNewParentId(parentId *int, cascadePermissionsFlag *bool) (resp datatypes.User_Customer, err error)

This method can be used in place of [[SoftLayer_User_Customer::editObject]] to change the parent user of this user.

The new parent must be a user on the same account, and must not be a child of this user. A user is not allowed to change their own parent.

If the cascadeFlag is set to false, then an exception will be thrown if the new parent does not have all of the permissions that this user possesses. If the cascadeFlag is set to true, then permissions will be removed from this user and the descendants of this user as necessary so that no children of the parent will have permissions that the parent does not possess. However, setting the cascadeFlag to true will not remove the access all device permissions from this user. The customer portal will need to be used to remove these permissions.

func (User_Customer) ChangePreference 

func (r User_Customer) ChangePreference(preferenceTypeKeyName *string, value *string) (resp []datatypes.User_Preference, err error)

Select a type of preference you would like to modify using [[SoftLayer_User_Customer::getPreferenceTypes|getPreferenceTypes]] and invoke this method using that preference type key name.

func (User_Customer) CreateNotificationSubscriber 

func (r User_Customer) CreateNotificationSubscriber(keyName *string, resourceTableId *int) (resp bool, err error)

Create a new subscriber for a given resource.

func (User_Customer) CreateObject 

func (r User_Customer) CreateObject(templateObject *datatypes.User_Customer, password *string, vpnPassword *string) (resp datatypes.User_Customer, err error)

Create a new user in the SoftLayer customer portal. It is not possible to set up SLL enable flags during object creation. These flags are ignored during object creation. You will need to make a subsequent call to edit object in order to enable VPN access.

An account's master user and sub-users who have the User Manage permission can add new users.

Users are created with a default permission set. After adding a user it may be helpful to set their permissions and device access.

secondaryPasswordTimeoutDays will be set to the system configured default value if the attribute is not provided or the attribute is not a valid value.

Note, neither password nor vpnPassword parameters are required.

Password When a new user is created, an email will be sent to the new user's email address with a link to a url that will allow the new user to create or change their password for the SoftLayer customer portal.

If the password parameter is provided and is not null, then that value will be validated. If it is a valid password, then the user will be created with this password. This user will still receive a portal password email. It can be used within 24 hours to change their password, or it can be allowed to expire, and the password provided during user creation will remain as the user's password.

If the password parameter is not provided or the value is null, the user must set their portal password using the link sent in email within 24 hours.  If the user fails to set their password within 24 hours, then a non-master user can use the "Reset Password" link on the login page of the portal to request a new email. A master user can use the link to retrieve a phone number to call to assist in resetting their password.

The password parameter is ignored for VPN_ONLY users or for IBMid authenticated users.

vpnPassword If the vpnPassword is provided, then the user's vpnPassword will be set to the provided password.  When creating a vpn only user, the vpnPassword MUST be supplied.  If the vpnPassword is not provided, then the user will need to use the portal to edit their profile and set the vpnPassword.

IBMid considerations When a SoftLayer account is linked to a Platform Services (PaaS, formerly Bluemix) account, AND the trait on the SoftLayer Account indicating IBMid authentication is set, then SoftLayer will delegate the creation of an ACTIVE user to PaaS. This means that even though the request to create a new user in such an account may start at the IMS API, via this delegation we effectively turn it into a request that is driven by PaaS. In particular this means that any "invitation email" that comes to the user, will come from PaaS, not from IMS via IBMid.

Users created in states other than ACTIVE (for example, a VPN_ONLY user) will be created directly in IMS without delegation (but note that no invitation is sent for a user created in any state other than ACTIVE).

func (User_Customer) CreateSubscriberDeliveryMethods 

func (r User_Customer) CreateSubscriberDeliveryMethods(notificationKeyName *string, deliveryMethodKeyNames []string) (resp bool, err error)

Create delivery methods for a notification that the user is subscribed to. Multiple delivery method keyNames can be supplied to create multiple delivery methods for the specified notification. Available delivery methods - 'EMAIL'. Available notifications - 'PLANNED_MAINTENANCE', 'UNPLANNED_INCIDENT'.

func (User_Customer) DeactivateNotificationSubscriber 

func (r User_Customer) DeactivateNotificationSubscriber(keyName *string, resourceTableId *int) (resp bool, err error)

Create a new subscriber for a given resource.

func (User_Customer) EditObject 

func (r User_Customer) EditObject(templateObject *datatypes.User_Customer) (resp bool, err error)

Account master users and sub-users who have the User Manage permission in the SoftLayer customer portal can update other user's information. Use editObject() if you wish to edit a single user account. Users who do not have the User Manage permission can only update their own information.

func (User_Customer) EditObjects 

func (r User_Customer) EditObjects(templateObjects []datatypes.User_Customer) (resp bool, err error)

Account master users and sub-users who have the User Manage permission in the SoftLayer customer portal can update other user's information. Use editObjects() if you wish to edit multiple users at once. Users who do not have the User Manage permission can only update their own information.

func (User_Customer) Filter 

func (r User_Customer) Filter(filter string) User_Customer

func (User_Customer) FindUserPreference 

func (r User_Customer) FindUserPreference(profileName *string, containerKeyname *string, preferenceKeyname *string) (resp []datatypes.Layout_Profile, err error)

no documentation yet

func (User_Customer) GetAccount 

func (r User_Customer) GetAccount() (resp datatypes.Account, err error)

Retrieve The customer account that a user belongs to.

func (User_Customer) GetActions 

func (r User_Customer) GetActions() (resp []datatypes.User_Permission_Action, err error)

Retrieve

func (User_Customer) GetActiveExternalAuthenticationVendors 

func (r User_Customer) GetActiveExternalAuthenticationVendors() (resp []datatypes.Container_User_Customer_External_Binding_Vendor, err error)

The getActiveExternalAuthenticationVendors method will return a list of available external vendors that a SoftLayer user can authenticate against. The list will only contain vendors for which the user has at least one active external binding.

func (User_Customer) GetAdditionalEmails 

func (r User_Customer) GetAdditionalEmails() (resp []datatypes.User_Customer_AdditionalEmail, err error)

Retrieve A portal user's additional email addresses. These email addresses are contacted when updates are made to support tickets.

func (User_Customer) GetAgentImpersonationToken added in v1.0.2 

func (r User_Customer) GetAgentImpersonationToken() (resp string, err error)

no documentation yet

func (User_Customer) GetAllowedDedicatedHostIds 

func (r User_Customer) GetAllowedDedicatedHostIds() (resp []int, err error)

no documentation yet

func (User_Customer) GetAllowedHardwareIds 

func (r User_Customer) GetAllowedHardwareIds() (resp []int, err error)

no documentation yet

func (User_Customer) GetAllowedVirtualGuestIds 

func (r User_Customer) GetAllowedVirtualGuestIds() (resp []int, err error)

no documentation yet

func (User_Customer) GetApiAuthenticationKeys 

func (r User_Customer) GetApiAuthenticationKeys() (resp []datatypes.User_Customer_ApiAuthentication, err error)

Retrieve A portal user's API Authentication keys. There is a max limit of one API key per user.

func (User_Customer) GetAuthenticationToken 

func (r User_Customer) GetAuthenticationToken(token *datatypes.Container_User_Authentication_Token) (resp datatypes.Container_User_Authentication_Token, err error)

This method generate user authentication token and return [[SoftLayer_Container_User_Authentication_Token]] object which will be used to authenticate user to login to SoftLayer customer portal.

func (User_Customer) GetChildUsers 

func (r User_Customer) GetChildUsers() (resp []datatypes.User_Customer, err error)

Retrieve A portal user's child users. Some portal users may not have child users.

func (User_Customer) GetClosedTickets 

func (r User_Customer) GetClosedTickets() (resp []datatypes.Ticket, err error)

Retrieve An user's associated closed tickets.

func (User_Customer) GetDedicatedHosts 

func (r User_Customer) GetDedicatedHosts() (resp []datatypes.Virtual_DedicatedHost, err error)

Retrieve The dedicated hosts to which the user has been granted access.

func (User_Customer) GetDefaultAccount 

func (r User_Customer) GetDefaultAccount(providerType *string) (resp datatypes.Account, err error)

This method is not applicable to legacy SoftLayer-authenticated users and can only be invoked for IBMid-authenticated users.

func (User_Customer) GetExternalBindings 

func (r User_Customer) GetExternalBindings() (resp []datatypes.User_External_Binding, err error)

Retrieve The external authentication bindings that link an external identifier to a SoftLayer user.

func (User_Customer) GetHardware 

func (r User_Customer) GetHardware() (resp []datatypes.Hardware, err error)

Retrieve A portal user's accessible hardware. These permissions control which hardware a user has access to in the SoftLayer customer portal.

func (User_Customer) GetHardwareCount 

func (r User_Customer) GetHardwareCount() (resp int, err error)

Retrieve the number of servers that a portal user has access to. Portal users can have restrictions set to limit services for and to perform actions on hardware. You can set these permissions in the portal by clicking the "administrative" then "user admin" links.

func (User_Customer) GetHardwareNotifications 

func (r User_Customer) GetHardwareNotifications() (resp []datatypes.User_Customer_Notification_Hardware, err error)

Retrieve Hardware notifications associated with this user. A hardware notification links a user to a piece of hardware, and that user will be notified if any monitors on that hardware fail, if the monitors have a status of 'Notify User'.

func (User_Customer) GetHasAcknowledgedSupportPolicyFlag 

func (r User_Customer) GetHasAcknowledgedSupportPolicyFlag() (resp bool, err error)

Retrieve Whether or not a user has acknowledged the support policy.

func (User_Customer) GetHasFullDedicatedHostAccessFlag 

func (r User_Customer) GetHasFullDedicatedHostAccessFlag() (resp bool, err error)

Retrieve Permission granting the user access to all Dedicated Host devices on the account.

func (User_Customer) GetHasFullHardwareAccessFlag 

func (r User_Customer) GetHasFullHardwareAccessFlag() (resp bool, err error)

Retrieve Whether or not a portal user has access to all hardware on their account.

func (User_Customer) GetHasFullVirtualGuestAccessFlag 

func (r User_Customer) GetHasFullVirtualGuestAccessFlag() (resp bool, err error)

Retrieve Whether or not a portal user has access to all virtual guests on their account. 

func (r User_Customer) GetIbmIdLink() (resp datatypes.User_Customer_Link, err error)

Retrieve Specifically relating the Customer instance to an IBMid. A Customer instance may or may not have an IBMid link.

func (User_Customer) GetImpersonationToken 

func (r User_Customer) GetImpersonationToken() (resp string, err error)

no documentation yet

func (User_Customer) GetLayoutProfiles 

func (r User_Customer) GetLayoutProfiles() (resp []datatypes.Layout_Profile, err error)

Retrieve Contains the definition of the layout profile.

func (User_Customer) GetLocale 

func (r User_Customer) GetLocale() (resp datatypes.Locale, err error)

Retrieve A user's locale. Locale holds user's language and region information.

func (User_Customer) GetLoginAttempts 

func (r User_Customer) GetLoginAttempts() (resp []datatypes.User_Customer_Access_Authentication, err error)

Retrieve A user's attempts to log into the SoftLayer customer portal.

func (User_Customer) GetLoginToken 

func (r User_Customer) GetLoginToken(request *datatypes.Container_Authentication_Request_Contract) (resp datatypes.Container_Authentication_Response_Common, err error)

Attempt to authenticate a user to the SoftLayer customer portal using the provided authentication container. Depending on the specific type of authentication container that is used, this API will leverage the appropriate authentication protocol. If authentication is successful then the API returns a list of linked accounts for the user, a token containing the ID of the authenticated user and a hash key used by the SoftLayer customer portal to maintain authentication.

func (User_Customer) GetMappedAccounts 

func (r User_Customer) GetMappedAccounts(providerType *string) (resp []datatypes.Account, err error)

An OpenIdConnect identity, for example an IBMid, can be linked or mapped to one or more individual SoftLayer users, but no more than one SoftLayer user per account. This effectively links the OpenIdConnect identity to those accounts. This API returns a list of all the accounts for which there is a link between the OpenIdConnect identity and a SoftLayer user. Invoke this only on IBMid-authenticated users.

func (User_Customer) GetNotificationSubscribers 

func (r User_Customer) GetNotificationSubscribers() (resp []datatypes.Notification_Subscriber, err error)

Retrieve Notification subscription records for the user.

func (User_Customer) GetObject 

func (r User_Customer) GetObject() (resp datatypes.User_Customer, err error)

getObject retrieves the SoftLayer_User_Customer object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_User_Customer service. You can only retrieve users that are assigned to the customer account belonging to the user making the API call.

func (User_Customer) GetOpenIdConnectMigrationState 

func (r User_Customer) GetOpenIdConnectMigrationState() (resp datatypes.Container_User_Customer_OpenIdConnect_MigrationState, err error)

This API returns a SoftLayer_Container_User_Customer_OpenIdConnect_MigrationState object containing the necessary information to determine what migration state the user is in. If the account is not OpenIdConnect authenticated, then an exception is thrown.

func (User_Customer) GetOpenTickets 

func (r User_Customer) GetOpenTickets() (resp []datatypes.Ticket, err error)

Retrieve An user's associated open tickets.

func (User_Customer) GetOverrides 

func (r User_Customer) GetOverrides() (resp []datatypes.Network_Service_Vpn_Overrides, err error)

Retrieve A portal user's vpn accessible subnets.

func (User_Customer) GetParent 

func (r User_Customer) GetParent() (resp datatypes.User_Customer, err error)

Retrieve A portal user's parent user. If a SoftLayer_User_Customer has a null parentId property then it doesn't have a parent user.

func (User_Customer) GetPasswordRequirements added in v1.0.1 

func (r User_Customer) GetPasswordRequirements(isVpn *bool) (resp datatypes.Container_User_Customer_PasswordSet, err error)

no documentation yet

func (User_Customer) GetPermissions 

func (r User_Customer) GetPermissions() (resp []datatypes.User_Customer_CustomerPermission_Permission, err error)

Retrieve A portal user's permissions. These permissions control that user's access to functions within the SoftLayer customer portal and API.

func (User_Customer) GetPortalLoginToken 

func (r User_Customer) GetPortalLoginToken(username *string, password *string, securityQuestionId *int, securityQuestionAnswer *string) (resp datatypes.Container_User_Customer_Portal_Token, err error)

Attempt to authenticate a username and password to the SoftLayer customer portal. Many portal user accounts are configured to require answering a security question on login. In this case getPortalLoginToken() also verifies the given security question ID and answer. If authentication is successful then the API returns a token containing the ID of the authenticated user and a hash key used by the SoftLayer customer portal to maintain authentication.

func (User_Customer) GetPreference 

func (r User_Customer) GetPreference(preferenceTypeKeyName *string) (resp datatypes.User_Preference, err error)

Select a type of preference you would like to get using [[SoftLayer_User_Customer::getPreferenceTypes|getPreferenceTypes]] and invoke this method using that preference type key name.

func (User_Customer) GetPreferenceTypes 

func (r User_Customer) GetPreferenceTypes() (resp []datatypes.User_Preference_Type, err error)

Use any of the preference types to fetch or modify user preferences using [[SoftLayer_User_Customer::getPreference|getPreference]] or [[SoftLayer_User_Customer::changePreference|changePreference]], respectively.

func (User_Customer) GetPreferences 

func (r User_Customer) GetPreferences() (resp []datatypes.User_Preference, err error)

Retrieve Data type contains a single user preference to a specific preference type.

func (User_Customer) GetRequirementsForPasswordSet 

func (r User_Customer) GetRequirementsForPasswordSet(passwordSet *datatypes.Container_User_Customer_PasswordSet) (resp datatypes.Container_User_Customer_PasswordSet, err error)

Retrieve the authentication requirements for an outstanding password set/reset request. The requirements returned in the same SoftLayer_Container_User_Customer_PasswordSet container which is provided as a parameter into this request. The SoftLayer_Container_User_Customer_PasswordSet::authenticationMethods array will contain an entry for each authentication method required for the user. See SoftLayer_Container_User_Customer_PasswordSet for more details.

If the user has required authentication methods, then authentication information will be supplied to the SoftLayer_User_Customer::processPasswordSetRequest method within this same SoftLayer_Container_User_Customer_PasswordSet container. All existing information in the container must continue to exist in the container to complete the password set/reset process.

func (User_Customer) GetRoles 

func (r User_Customer) GetRoles() (resp []datatypes.User_Permission_Role, err error)

Retrieve

func (User_Customer) GetSecurityAnswers 

func (r User_Customer) GetSecurityAnswers() (resp []datatypes.User_Customer_Security_Answer, err error)

Retrieve A portal user's security question answers. Some portal users may not have security answers or may not be configured to require answering a security question on login.

func (User_Customer) GetSubscribers 

func (r User_Customer) GetSubscribers() (resp []datatypes.Notification_User_Subscriber, err error)

Retrieve A user's notification subscription records.

func (User_Customer) GetSuccessfulLogins 

func (r User_Customer) GetSuccessfulLogins() (resp []datatypes.User_Customer_Access_Authentication, err error)

Retrieve A user's successful attempts to log into the SoftLayer customer portal.

func (User_Customer) GetSupportPolicyAcknowledgementRequiredFlag 

func (r User_Customer) GetSupportPolicyAcknowledgementRequiredFlag() (resp int, err error)

Retrieve Whether or not a user is required to acknowledge the support policy for portal access.

func (User_Customer) GetSupportPolicyDocument 

func (r User_Customer) GetSupportPolicyDocument() (resp []byte, err error)

no documentation yet

func (User_Customer) GetSupportPolicyName 

func (r User_Customer) GetSupportPolicyName() (resp string, err error)

no documentation yet

func (User_Customer) GetSupportedLocales 

func (r User_Customer) GetSupportedLocales() (resp []datatypes.Locale, err error)

no documentation yet

func (User_Customer) GetSurveyRequiredFlag 

func (r User_Customer) GetSurveyRequiredFlag() (resp bool, err error)

Retrieve Whether or not a user must take a brief survey the next time they log into the SoftLayer customer portal.

func (User_Customer) GetSurveys 

func (r User_Customer) GetSurveys() (resp []datatypes.Survey, err error)

Retrieve The surveys that a user has taken in the SoftLayer customer portal.

func (User_Customer) GetTickets 

func (r User_Customer) GetTickets() (resp []datatypes.Ticket, err error)

Retrieve An user's associated tickets.

func (User_Customer) GetTimezone 

func (r User_Customer) GetTimezone() (resp datatypes.Locale_Timezone, err error)

Retrieve A portal user's time zone.

func (User_Customer) GetUnsuccessfulLogins 

func (r User_Customer) GetUnsuccessfulLogins() (resp []datatypes.User_Customer_Access_Authentication, err error)

Retrieve A user's unsuccessful attempts to log into the SoftLayer customer portal.

func (User_Customer) GetUserIdForPasswordSet 

func (r User_Customer) GetUserIdForPasswordSet(key *string) (resp int, err error)

Retrieve a user id using a password token provided to the user in an email generated by the SoftLayer_User_Customer::initiatePortalPasswordChange request. Password recovery keys are valid for 24 hours after they're generated.

When a new user is created or when a user has requested a password change using initiatePortalPasswordChange, they will have received an email that contains a url with a token. That token is used as the parameter for getUserIdForPasswordSet. Once the user id is known, then the SoftLayer_User_Customer object can be retrieved which is necessary to complete the process to set or reset a user's password. 

func (r User_Customer) GetUserLinks() (resp []datatypes.User_Customer_Link, err error)

Retrieve User customer link with IBMid and IAMid.

func (User_Customer) GetUserPreferences 

func (r User_Customer) GetUserPreferences(profileName *string, containerKeyname *string) (resp []datatypes.Layout_Profile, err error)

no documentation yet

func (User_Customer) GetUserStatus 

func (r User_Customer) GetUserStatus() (resp datatypes.User_Customer_Status, err error)

Retrieve A portal user's status, which controls overall access to the SoftLayer customer portal and VPN access to the private network.

func (User_Customer) GetVirtualGuestCount 

func (r User_Customer) GetVirtualGuestCount() (resp int, err error)

Retrieve the number of CloudLayer Computing Instances that a portal user has access to. Portal users can have restrictions set to limit services for and to perform actions on CloudLayer Computing Instances. You can set these permissions in the portal by clicking the "administrative" then "user admin" links.

func (User_Customer) GetVirtualGuests 

func (r User_Customer) GetVirtualGuests() (resp []datatypes.Virtual_Guest, err error)

Retrieve A portal user's accessible CloudLayer Computing Instances. These permissions control which CloudLayer Computing Instances a user has access to in the SoftLayer customer portal.

func (User_Customer) Id 

func (r User_Customer) Id(id int) User_Customer

func (User_Customer) InTerminalStatus 

func (r User_Customer) InTerminalStatus() (resp bool, err error)

no documentation yet

func (User_Customer) InitiatePortalPasswordChange 

func (r User_Customer) InitiatePortalPasswordChange(username *string) (resp bool, err error)

Sends password change email to the user containing url that allows the user the change their password. This is the first step when a user wishes to change their password. The url that is generated contains a one-time use token that is valid for only 24-hours.

If this is a new master user who has never logged into the portal, then password reset will be initiated. Once a master user has logged into the portal, they must setup their security questions prior to logging out because master users are required to answer a security question during the password reset process. Should a master user not have security questions defined and not remember their password in order to define the security questions, then they will need to contact support at live chat or Revenue Services for assistance.

Due to security reasons, the number of reset requests per username are limited within a undisclosed timeframe.

func (User_Customer) InitiatePortalPasswordChangeByBrandAgent 

func (r User_Customer) InitiatePortalPasswordChangeByBrandAgent(username *string) (resp bool, err error)

A Brand Agent that has permissions to Add Customer Accounts will be able to request the password email be sent to the Master User of a Customer Account created by the same Brand as the agent making the request. Due to security reasons, the number of reset requests are limited within an undisclosed timeframe.

func (User_Customer) InviteUserToLinkOpenIdConnect 

func (r User_Customer) InviteUserToLinkOpenIdConnect(providerType *string) (err error)

Send email invitation to a user to join a SoftLayer account and authenticate with OpenIdConnect. Throws an exception on error.

func (User_Customer) IsMasterUser 

func (r User_Customer) IsMasterUser() (resp bool, err error)

Portal users are considered master users if they don't have an associated parent user. The only users who don't have parent users are users whose username matches their SoftLayer account name. Master users have special permissions throughout the SoftLayer customer portal. Deprecated: This function has been marked as deprecated.

func (User_Customer) IsValidPortalPassword 

func (r User_Customer) IsValidPortalPassword(password *string) (resp bool, err error)

Determine if a string is the given user's login password to the SoftLayer customer portal.

func (User_Customer) Limit 

func (r User_Customer) Limit(limit int) User_Customer

func (User_Customer) Mask 

func (r User_Customer) Mask(mask string) User_Customer

func (User_Customer) Offset 

func (r User_Customer) Offset(offset int) User_Customer

func (User_Customer) PerformExternalAuthentication 

func (r User_Customer) PerformExternalAuthentication(authenticationContainer *datatypes.Container_User_Customer_External_Binding) (resp datatypes.Container_User_Customer_Portal_Token, err error)

The perform external authentication method will authenticate the given external authentication container with an external vendor. The authentication container and its contents will be verified before an attempt is made to authenticate the contents of the container with an external vendor.

func (User_Customer) ProcessPasswordSetRequest 

func (r User_Customer) ProcessPasswordSetRequest(passwordSet *datatypes.Container_User_Customer_PasswordSet, authenticationContainer *datatypes.Container_User_Customer_External_Binding) (resp bool, err error)

Set the password for a user who has an outstanding password request. A user with an outstanding password request will have an unused and unexpired password key. The password key is part of the url provided to the user in the email sent to the user with information on how to set their password. The email was generated by the SoftLayer_User_Customer::initiatePortalPasswordRequest request. Password recovery keys are valid for 24 hours after they're generated.

If the user has required authentication methods as specified by in the SoftLayer_Container_User_Customer_PasswordSet container returned from the SoftLayer_User_Customer::getRequirementsForPasswordSet request, then additional requests must be made to processPasswordSetRequest to authenticate the user before changing the password. First, if the user has security questions set on their profile, they will be required to answer one of their questions correctly. Next, if the user has Verisign or Google Authentication on their account, they must authenticate according to the two-factor provider. All of this authentication is done using the SoftLayer_Container_User_Customer_PasswordSet container.

User portal passwords must match the following restrictions. Portal passwords must... * ...be over eight characters long. * ...be under twenty characters long. * ...contain at least one uppercase letter * ...contain at least one lowercase letter * ...contain at least one number * ...contain one of the special characters _ - | @ . , ? / ! ~ # $ % ^ & * ( ) { } [ ] \ + = * ...not match your username

func (User_Customer) RemoveAllDedicatedHostAccessForThisUser 

func (r User_Customer) RemoveAllDedicatedHostAccessForThisUser() (resp bool, err error)

Revoke access to all dedicated hosts on the account for this user. The user will only be allowed to see and access devices in both the portal and the API to which they have been granted access. If the user's account has devices to which the user has not been granted access or the access has been revoked, then "not found" exceptions are thrown if the user attempts to access any of these devices. If the current user does not have administrative privileges over this user, an inadequate permissions exception will get thrown.

Users can call this function on child users, but not to themselves. An account's master has access to all users permissions on their account.

func (User_Customer) RemoveAllHardwareAccessForThisUser 

func (r User_Customer) RemoveAllHardwareAccessForThisUser() (resp bool, err error)

Remove all hardware from a portal user's hardware access list. A user's hardware access list controls which of an account's hardware objects a user has access to in the SoftLayer customer portal and API. If the current user does not have administrative privileges over this user, an inadequate permissions exception will get thrown.

Users can call this function on child users, but not to themselves. An account's master has access to all users permissions on their account.

func (User_Customer) RemoveAllVirtualAccessForThisUser 

func (r User_Customer) RemoveAllVirtualAccessForThisUser() (resp bool, err error)

Remove all cloud computing instances from a portal user's instance access list. A user's instance access list controls which of an account's computing instance objects a user has access to in the SoftLayer customer portal and API. If the current user does not have administrative privileges over this user, an inadequate permissions exception will get thrown.

Users can call this function on child users, but not to themselves. An account's master has access to all users permissions on their account.

func (User_Customer) RemoveApiAuthenticationKey 

func (r User_Customer) RemoveApiAuthenticationKey(keyId *int) (resp bool, err error)

Remove a user's API authentication key, removing that user's access to query the SoftLayer API.

func (User_Customer) RemoveBulkDedicatedHostAccess 

func (r User_Customer) RemoveBulkDedicatedHostAccess(dedicatedHostIds []int) (resp bool, err error)

Revokes access for the user to one or more dedicated host devices. The user will only be allowed to see and access devices in both the portal and the API to which they have been granted access. If the user's account has devices to which the user has not been granted access or the access has been revoked, then "not found" exceptions are thrown if the user attempts to access any of these devices.

Users can assign device access to their child users, but not to themselves. An account's master has access to all devices on their customer account and can set dedicated host access for any of the other users on their account.

If the user has full dedicatedHost access, then it will provide access to "ALL but passed in" dedicatedHost ids.

func (User_Customer) RemoveBulkHardwareAccess 

func (r User_Customer) RemoveBulkHardwareAccess(hardwareIds []int) (resp bool, err error)

Remove multiple hardware from a portal user's hardware access list. A user's hardware access list controls which of an account's hardware objects a user has access to in the SoftLayer customer portal and API. Hardware does not exist in the SoftLayer portal and returns "not found" exceptions in the API if the user doesn't have access to it. If a user does not has access to the hardware you're attempting to remove then removeBulkHardwareAccess() returns true.

Users can assign hardware access to their child users, but not to themselves. An account's master has access to all hardware on their customer account and can set hardware access for any of the other users on their account.

If the user has full hardware access, then it will provide access to "ALL but passed in" hardware ids.

func (User_Customer) RemoveBulkPortalPermission 

func (r User_Customer) RemoveBulkPortalPermission(permissions []datatypes.User_Customer_CustomerPermission_Permission, cascadePermissionsFlag *bool) (resp bool, err error)

Remove (revoke) multiple permissions from a portal user's permission set. [[SoftLayer_User_Customer_CustomerPermission_Permission]] control which features in the SoftLayer customer portal and API a user may use. Removing a user's permission will affect that user's portal and API access. removePortalPermission() does not attempt to remove permissions that are not assigned to the user.

Users can grant or revoke permissions to their child users, but not to themselves. An account's master has all portal permissions and can grant permissions for any of the other users on their account.

If the cascadePermissionsFlag is set to true, then removing the permissions from a user will cascade down the child hierarchy and remove the permissions from this user along with all child users who also have the permission.

If the cascadePermissionsFlag is not provided or is set to false and the user has children users who have the permission, then an exception will be thrown, and the permission will not be removed from this user.

Use the [[SoftLayer_User_Customer_CustomerPermission_Permission::getAllObjects]] method to retrieve a list of all permissions available in the SoftLayer customer portal and API. Permissions are removed based on the keyName property of the permission objects within the permissions parameter.

func (User_Customer) RemoveBulkRoles 

func (r User_Customer) RemoveBulkRoles(roles []datatypes.User_Permission_Role) (err error)

no documentation yet

func (User_Customer) RemoveBulkVirtualGuestAccess 

func (r User_Customer) RemoveBulkVirtualGuestAccess(virtualGuestIds []int) (resp bool, err error)

Remove multiple CloudLayer Computing Instances from a portal user's access list. A user's CloudLayer Computing Instance access list controls which of an account's CloudLayer Computing Instance objects a user has access to in the SoftLayer customer portal and API. CloudLayer Computing Instances do not exist in the SoftLayer portal and returns "not found" exceptions in the API if the user doesn't have access to it. If a user does not has access to the CloudLayer Computing Instance you're attempting remove add then removeBulkVirtualGuestAccess() returns true.

Users can assign CloudLayer Computing Instance access to their child users, but not to themselves. An account's master has access to all CloudLayer Computing Instances on their customer account and can set hardware access for any of the other users on their account.

func (User_Customer) RemoveDedicatedHostAccess 

func (r User_Customer) RemoveDedicatedHostAccess(dedicatedHostId *int) (resp bool, err error)

Revokes access for the user to a single dedicated host device. The user will only be allowed to see and access devices in both the portal and the API to which they have been granted access. If the user's account has devices to which the user has not been granted access or the access has been revoked, then "not found" exceptions are thrown if the user attempts to access any of these devices.

Users can assign device access to their child users, but not to themselves. An account's master has access to all devices on their customer account and can set dedicated host access for any of the other users on their account.

func (User_Customer) RemoveExternalBinding 

func (r User_Customer) RemoveExternalBinding(externalBinding *datatypes.User_External_Binding) (resp bool, err error)

no documentation yet

func (User_Customer) RemoveHardwareAccess 

func (r User_Customer) RemoveHardwareAccess(hardwareId *int) (resp bool, err error)

Remove hardware from a portal user's hardware access list. A user's hardware access list controls which of an account's hardware objects a user has access to in the SoftLayer customer portal and API. Hardware does not exist in the SoftLayer portal and returns "not found" exceptions in the API if the user doesn't have access to it. If a user does not has access to the hardware you're attempting remove add then removeHardwareAccess() returns true.

Users can assign hardware access to their child users, but not to themselves. An account's master has access to all hardware on their customer account and can set hardware access for any of the other users on their account.

func (User_Customer) RemovePortalPermission 

func (r User_Customer) RemovePortalPermission(permission *datatypes.User_Customer_CustomerPermission_Permission, cascadePermissionsFlag *bool) (resp bool, err error)

Remove (revoke) a permission from a portal user's permission set. [[SoftLayer_User_Customer_CustomerPermission_Permission]] control which features in the SoftLayer customer portal and API a user may use. Removing a user's permission will affect that user's portal and API access. If the user does not have the permission you're attempting to remove then removePortalPermission() returns true.

Users can assign permissions to their child users, but not to themselves. An account's master has all portal permissions and can set permissions for any of the other users on their account.

If the cascadePermissionsFlag is set to true, then removing the permission from a user will cascade down the child hierarchy and remove the permission from this user and all child users who also have the permission.

If the cascadePermissionsFlag is not set or is set to false and the user has children users who have the permission, then an exception will be thrown, and the permission will not be removed from this user.

Use the [[SoftLayer_User_Customer_CustomerPermission_Permission::getAllObjects]] method to retrieve a list of all permissions available in the SoftLayer customer portal and API. Permissions are removed based on the keyName property of the permission parameter.

func (User_Customer) RemoveRole 

func (r User_Customer) RemoveRole(role *datatypes.User_Permission_Role) (err error)

no documentation yet

func (User_Customer) RemoveSecurityAnswers 

func (r User_Customer) RemoveSecurityAnswers() (resp bool, err error)

no documentation yet

func (User_Customer) RemoveVirtualGuestAccess 

func (r User_Customer) RemoveVirtualGuestAccess(virtualGuestId *int) (resp bool, err error)

Remove a CloudLayer Computing Instance from a portal user's access list. A user's CloudLayer Computing Instance access list controls which of an account's computing instances a user has access to in the SoftLayer customer portal and API. CloudLayer Computing Instances do not exist in the SoftLayer portal and returns "not found" exceptions in the API if the user doesn't have access to it. If a user does not has access to the CloudLayer Computing Instance you're attempting remove add then removeVirtualGuestAccess() returns true.

Users can assign CloudLayer Computing Instance access to their child users, but not to themselves. An account's master has access to all CloudLayer Computing Instances on their customer account and can set instance access for any of the other users on their account. 

func (r User_Customer) ResetOpenIdConnectLink(providerType *string, newIbmIdUsername *string, removeSecuritySettings *bool) (err error)

This method will change the IBMid that a SoftLayer user is linked to, if we need to do that for some reason. It will do this by modifying the link to the desired new IBMid. NOTE: This method cannot be used to "un-link" a SoftLayer user. Once linked, a SoftLayer user can never be un-linked. Also, this method cannot be used to reset the link if the user account is already Bluemix linked. To reset a link for the Bluemix-linked user account, use resetOpenIdConnectLinkUnifiedUserManagementMode.

func (User_Customer) ResetOpenIdConnectLinkUnifiedUserManagementMode added in v1.0.4 

func (r User_Customer) ResetOpenIdConnectLinkUnifiedUserManagementMode(providerType *string, newIbmIdUsername *string, removeSecuritySettings *bool) (err error)

This method will change the IBMid that a SoftLayer master user is linked to, if we need to do that for some reason. It will do this by unlinking the new owner IBMid from its current user association in this account, if there is one (note that the new owner IBMid is not required to already be a member of the IMS account). Then it will modify the existing IBMid link for the master user to use the new owner IBMid-realm IAMid. At this point, if the new owner IBMid isn't already a member of the PaaS account, it will attempt to add it. As a last step, it will call PaaS to modify the owner on that side, if necessary. Only when all those steps are complete, it will commit the IMS-side DB changes. Then, it will clean up the SoftLayer user that was linked to the new owner IBMid (this user became unlinked as the first step in this process). It will also call BSS to delete the old owner IBMid. NOTE: This method cannot be used to "un-link" a SoftLayer user. Once linked, a SoftLayer user can never be un-linked. Also, this method cannot be used to reset the link if the user account is not Bluemix linked. To reset a link for the user account not linked to Bluemix, use resetOpenIdConnectLink.

func (User_Customer) SamlAuthenticate 

func (r User_Customer) SamlAuthenticate(accountId *string, samlResponse *string) (resp datatypes.Container_User_Customer_Portal_Token, err error)

no documentation yet

func (User_Customer) SamlBeginAuthentication 

func (r User_Customer) SamlBeginAuthentication(accountId *int) (resp string, err error)

no documentation yet

func (User_Customer) SamlBeginLogout 

func (r User_Customer) SamlBeginLogout() (resp string, err error)

no documentation yet

func (User_Customer) SamlLogout 

func (r User_Customer) SamlLogout(samlResponse *string) (err error)

no documentation yet

func (User_Customer) SelfPasswordChange 

func (r User_Customer) SelfPasswordChange(currentPassword *string, newPassword *string) (err error)

no documentation yet

func (User_Customer) SetDefaultAccount 

func (r User_Customer) SetDefaultAccount(providerType *string, accountId *int) (resp datatypes.Account, err error)

An OpenIdConnect identity, for example an IBMid, can be linked or mapped to one or more individual SoftLayer users, but no more than one per account. If an OpenIdConnect identity is mapped to multiple accounts in this manner, one such account should be identified as the default account for that identity. Invoke this only on IBMid-authenticated users.

func (User_Customer) SilentlyMigrateUserOpenIdConnect 

func (r User_Customer) SilentlyMigrateUserOpenIdConnect(providerType *string) (resp bool, err error)

As master user, calling this api for the IBMid provider type when there is an existing IBMid for the email on the SL account will silently (without sending an invitation email) create a link for the IBMid. NOTE: If the SoftLayer user is already linked to IBMid, this call will fail. If the IBMid specified by the email of this user, is already used in a link to another user in this account, this call will fail. If there is already an open invitation from this SoftLayer user to this or any IBMid, this call will fail. If there is already an open invitation from some other SoftLayer user in this account to this IBMid, then this call will fail.

func (User_Customer) TurnOffMasterUserPermissionCheckMode added in v1.1.2 

func (r User_Customer) TurnOffMasterUserPermissionCheckMode() (err error)

This method allows the master user of an account to undo the designation of this user as an alternate master user. This can not be applied to the true master user of the account.

Note that this method, by itself, WILL NOT affect the IAM Policies granted this user. This API is not intended for general customer use. It is intended to be called by IAM, in concert with other actions taken by IAM when the master user / account owner turns off an "alternate/auxiliary master user / account owner".

func (User_Customer) TurnOnMasterUserPermissionCheckMode added in v1.1.2 

func (r User_Customer) TurnOnMasterUserPermissionCheckMode() (err error)

This method allows the master user of an account to designate this user as an alternate master user. Effectively this means that this user should have "all the same IMS permissions as a master user".

Note that this method, by itself, WILL NOT affect the IAM Policies granted to this user. This API is not intended for general customer use. It is intended to be called by IAM, in concert with other actions taken by IAM when the master user / account owner designates an "alternate/auxiliary master user / account owner".

func (User_Customer) UpdateNotificationSubscriber 

func (r User_Customer) UpdateNotificationSubscriber(notificationKeyName *string, active *int) (resp bool, err error)

Update the active status for a notification that the user is subscribed to. A notification along with an active flag can be supplied to update the active status for a particular notification subscription.

func (User_Customer) UpdateSecurityAnswers 

func (r User_Customer) UpdateSecurityAnswers(questions []datatypes.User_Security_Question, answers []string) (resp bool, err error)

Update a user's login security questions and answers on the SoftLayer customer portal. These questions and answers are used to optionally log into the SoftLayer customer portal using two-factor authentication. Each user must have three distinct questions set with a unique answer for each question, and each answer may only contain alphanumeric or the . , - _ ( ) [ ] : ; > < characters. Existing user security questions and answers are deleted before new ones are set, and users may only update their own security questions and answers.

func (User_Customer) UpdateSubscriberDeliveryMethod 

func (r User_Customer) UpdateSubscriberDeliveryMethod(notificationKeyName *string, deliveryMethodKeyNames []string, active *int) (resp bool, err error)

Update a delivery method for a notification that the user is subscribed to. A delivery method keyName along with an active flag can be supplied to update the active status of the delivery methods for the specified notification. Available delivery methods - 'EMAIL'. Available notifications - 'PLANNED_MAINTENANCE', 'UNPLANNED_INCIDENT'.

func (User_Customer) UpdateVpnPassword 

func (r User_Customer) UpdateVpnPassword(password *string) (resp bool, err error)

Update a user's VPN password on the SoftLayer customer portal. As with portal passwords, VPN passwords must match the following restrictions. VPN passwords must... * ...be over eight characters long. * ...be under twenty characters long. * ...contain at least one uppercase letter * ...contain at least one lowercase letter * ...contain at least one number * ...contain one of the special characters _ - | @ . , ? / ! ~ # $ % ^ & * ( ) { } [ ] \ = * ...not match your username Finally, users can only update their own VPN password. An account's master user can update any of their account users' VPN passwords.

func (User_Customer) UpdateVpnUser 

func (r User_Customer) UpdateVpnUser() (resp bool, err error)

Always call this function to enable changes when manually configuring VPN subnet access.

func (User_Customer) ValidateAuthenticationToken 

func (r User_Customer) ValidateAuthenticationToken(authenticationToken *datatypes.Container_User_Authentication_Token) (resp datatypes.Container_User_Customer_Portal_Token, err error)

This method validate the given authentication token using the user id by comparing it with the actual user authentication token and return [[SoftLayer_Container_User_Customer_Portal_Token]] object

type User_Customer_ApiAuthentication 

type User_Customer_ApiAuthentication struct {
	Session session.SLSession
	Options sl.Options
}

The SoftLayer_User_Customer_ApiAuthentication type contains user's authentication key(s).

func GetUserCustomerApiAuthenticationService 

func GetUserCustomerApiAuthenticationService(sess session.SLSession) User_Customer_ApiAuthentication

GetUserCustomerApiAuthenticationService returns an instance of the User_Customer_ApiAuthentication SoftLayer service

func (User_Customer_ApiAuthentication) EditObject 

func (r User_Customer_ApiAuthentication) EditObject(templateObject *datatypes.User_Customer_ApiAuthentication) (resp datatypes.User_Customer_ApiAuthentication, err error)

Edit the properties of customer ApiAuthentication record by passing in a modified instance of a SoftLayer_User_Customer_ApiAuthentication object. Only the ipAddressRestriction property can be modified.

func (User_Customer_ApiAuthentication) Filter 

func (r User_Customer_ApiAuthentication) Filter(filter string) User_Customer_ApiAuthentication

func (User_Customer_ApiAuthentication) GetObject 

func (r User_Customer_ApiAuthentication) GetObject() (resp datatypes.User_Customer_ApiAuthentication, err error)

getObject retrieves the SoftLayer_User_Customer_ApiAuthentication object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_User_Customer_ApiAuthentication service.

func (User_Customer_ApiAuthentication) GetUser 

func (r User_Customer_ApiAuthentication) GetUser() (resp datatypes.User_Customer, err error)

Retrieve The user who owns the api authentication key.

func (User_Customer_ApiAuthentication) Id 

func (r User_Customer_ApiAuthentication) Id(id int) User_Customer_ApiAuthentication

func (User_Customer_ApiAuthentication) Limit 

func (r User_Customer_ApiAuthentication) Limit(limit int) User_Customer_ApiAuthentication

func (User_Customer_ApiAuthentication) Mask 

func (r User_Customer_ApiAuthentication) Mask(mask string) User_Customer_ApiAuthentication

func (User_Customer_ApiAuthentication) Offset 

func (r User_Customer_ApiAuthentication) Offset(offset int) User_Customer_ApiAuthentication

type User_Customer_CustomerPermission_Permission 

type User_Customer_CustomerPermission_Permission struct {
	Session session.SLSession
	Options sl.Options
}

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. Deprecated: This function has been marked as deprecated.

func GetUserCustomerCustomerPermissionPermissionService 

func GetUserCustomerCustomerPermissionPermissionService(sess session.SLSession) User_Customer_CustomerPermission_Permission

GetUserCustomerCustomerPermissionPermissionService returns an instance of the User_Customer_CustomerPermission_Permission SoftLayer service

func (User_Customer_CustomerPermission_Permission) Filter 

func (r User_Customer_CustomerPermission_Permission) Filter(filter string) User_Customer_CustomerPermission_Permission

func (User_Customer_CustomerPermission_Permission) GetAllObjects 

func (r User_Customer_CustomerPermission_Permission) GetAllObjects() (resp []datatypes.User_Customer_CustomerPermission_Permission, err error)

Retrieve all available permissions. Deprecated: This function has been marked as deprecated.

func (User_Customer_CustomerPermission_Permission) GetObject 

func (r User_Customer_CustomerPermission_Permission) GetObject() (resp datatypes.User_Customer_CustomerPermission_Permission, err error)

getObject retrieves the SoftLayer_User_Customer_CustomerPermission_Permission object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_User_Customer_CustomerPermission_Permission service.

func (User_Customer_CustomerPermission_Permission) Id 

func (r User_Customer_CustomerPermission_Permission) Id(id int) User_Customer_CustomerPermission_Permission

func (User_Customer_CustomerPermission_Permission) Limit 

func (r User_Customer_CustomerPermission_Permission) Limit(limit int) User_Customer_CustomerPermission_Permission

func (User_Customer_CustomerPermission_Permission) Mask 

func (r User_Customer_CustomerPermission_Permission) Mask(mask string) User_Customer_CustomerPermission_Permission

func (User_Customer_CustomerPermission_Permission) Offset 

func (r User_Customer_CustomerPermission_Permission) Offset(offset int) User_Customer_CustomerPermission_Permission

type User_Customer_External_Binding 

type User_Customer_External_Binding struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetUserCustomerExternalBindingService 

func GetUserCustomerExternalBindingService(sess session.SLSession) User_Customer_External_Binding

GetUserCustomerExternalBindingService returns an instance of the User_Customer_External_Binding SoftLayer service

func (User_Customer_External_Binding) DeleteObject 

func (r User_Customer_External_Binding) DeleteObject() (resp bool, err error)

Delete an external authentication binding. If the external binding currently has an active billing item associated you will be prevented from deleting the binding. The alternative method to remove an external authentication binding is to use the service cancellation form.

func (User_Customer_External_Binding) Disable 

func (r User_Customer_External_Binding) Disable(reason *string) (resp bool, err error)

Disabling an external binding will allow you to keep the external binding on your SoftLayer account, but will not require you to authentication with our trusted 2 form factor vendor when logging into the SoftLayer customer portal.

You may supply one of the following reason when you disable an external binding: *Unspecified *TemporarilyUnavailable *Lost *Stolen

func (User_Customer_External_Binding) Enable 

func (r User_Customer_External_Binding) Enable() (resp bool, err error)

Enabling an external binding will activate the binding on your account and require you to authenticate with our trusted 3rd party 2 form factor vendor when logging into the SoftLayer customer portal.

Please note that API access will be disabled for users that have an active external binding.

func (User_Customer_External_Binding) Filter 

func (r User_Customer_External_Binding) Filter(filter string) User_Customer_External_Binding

func (User_Customer_External_Binding) GetAttributes 

func (r User_Customer_External_Binding) GetAttributes() (resp []datatypes.User_External_Binding_Attribute, err error)

Retrieve Attributes of an external authentication binding.

func (User_Customer_External_Binding) GetBillingItem 

func (r User_Customer_External_Binding) GetBillingItem() (resp datatypes.Billing_Item, err error)

Retrieve Information regarding the billing item for external authentication.

func (User_Customer_External_Binding) GetNote 

func (r User_Customer_External_Binding) GetNote() (resp string, err error)

Retrieve An optional note for identifying the external binding.

func (User_Customer_External_Binding) GetObject 

func (r User_Customer_External_Binding) GetObject() (resp datatypes.User_Customer_External_Binding, err error)

no documentation yet

func (User_Customer_External_Binding) GetType 

func (r User_Customer_External_Binding) GetType() (resp datatypes.User_External_Binding_Type, err error)

Retrieve The type of external authentication binding.

func (User_Customer_External_Binding) GetUser 

func (r User_Customer_External_Binding) GetUser() (resp datatypes.User_Customer, err error)

Retrieve The SoftLayer user that the external authentication binding belongs to.

func (User_Customer_External_Binding) GetVendor 

func (r User_Customer_External_Binding) GetVendor() (resp datatypes.User_External_Binding_Vendor, err error)

Retrieve The vendor of an external authentication binding.

func (User_Customer_External_Binding) Id 

func (r User_Customer_External_Binding) Id(id int) User_Customer_External_Binding

func (User_Customer_External_Binding) Limit 

func (r User_Customer_External_Binding) Limit(limit int) User_Customer_External_Binding

func (User_Customer_External_Binding) Mask 

func (r User_Customer_External_Binding) Mask(mask string) User_Customer_External_Binding

func (User_Customer_External_Binding) Offset 

func (r User_Customer_External_Binding) Offset(offset int) User_Customer_External_Binding

func (User_Customer_External_Binding) UpdateNote 

func (r User_Customer_External_Binding) UpdateNote(text *string) (resp bool, err error)

Update the note of an external binding. The note is an optional property that is used to store information about a binding.

type User_Customer_External_Binding_Totp 

type User_Customer_External_Binding_Totp struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetUserCustomerExternalBindingTotpService 

func GetUserCustomerExternalBindingTotpService(sess session.SLSession) User_Customer_External_Binding_Totp

GetUserCustomerExternalBindingTotpService returns an instance of the User_Customer_External_Binding_Totp SoftLayer service

func (User_Customer_External_Binding_Totp) Activate 

func (r User_Customer_External_Binding_Totp) Activate() (resp bool, err error)

no documentation yet

func (User_Customer_External_Binding_Totp) Deactivate 

func (r User_Customer_External_Binding_Totp) Deactivate() (resp bool, err error)

no documentation yet

func (User_Customer_External_Binding_Totp) DeleteObject 

func (r User_Customer_External_Binding_Totp) DeleteObject() (resp bool, err error)

Delete an external authentication binding. If the external binding currently has an active billing item associated you will be prevented from deleting the binding. The alternative method to remove an external authentication binding is to use the service cancellation form.

func (User_Customer_External_Binding_Totp) Disable 

func (r User_Customer_External_Binding_Totp) Disable(reason *string) (resp bool, err error)

Disabling an external binding will allow you to keep the external binding on your SoftLayer account, but will not require you to authentication with our trusted 2 form factor vendor when logging into the SoftLayer customer portal.

You may supply one of the following reason when you disable an external binding: *Unspecified *TemporarilyUnavailable *Lost *Stolen

func (User_Customer_External_Binding_Totp) Enable 

func (r User_Customer_External_Binding_Totp) Enable() (resp bool, err error)

Enabling an external binding will activate the binding on your account and require you to authenticate with our trusted 3rd party 2 form factor vendor when logging into the SoftLayer customer portal.

Please note that API access will be disabled for users that have an active external binding.

func (User_Customer_External_Binding_Totp) Filter 

func (r User_Customer_External_Binding_Totp) Filter(filter string) User_Customer_External_Binding_Totp

func (User_Customer_External_Binding_Totp) GenerateSecretKey 

func (r User_Customer_External_Binding_Totp) GenerateSecretKey() (resp string, err error)

no documentation yet

func (User_Customer_External_Binding_Totp) GetAttributes 

func (r User_Customer_External_Binding_Totp) GetAttributes() (resp []datatypes.User_External_Binding_Attribute, err error)

Retrieve Attributes of an external authentication binding.

func (User_Customer_External_Binding_Totp) GetBillingItem 

func (r User_Customer_External_Binding_Totp) GetBillingItem() (resp datatypes.Billing_Item, err error)

Retrieve Information regarding the billing item for external authentication.

func (User_Customer_External_Binding_Totp) GetNote 

func (r User_Customer_External_Binding_Totp) GetNote() (resp string, err error)

Retrieve An optional note for identifying the external binding.

func (User_Customer_External_Binding_Totp) GetObject 

func (r User_Customer_External_Binding_Totp) GetObject() (resp datatypes.User_Customer_External_Binding_Totp, err error)

no documentation yet

func (User_Customer_External_Binding_Totp) GetType 

func (r User_Customer_External_Binding_Totp) GetType() (resp datatypes.User_External_Binding_Type, err error)

Retrieve The type of external authentication binding.

func (User_Customer_External_Binding_Totp) GetUser 

func (r User_Customer_External_Binding_Totp) GetUser() (resp datatypes.User_Customer, err error)

Retrieve The SoftLayer user that the external authentication binding belongs to.

func (User_Customer_External_Binding_Totp) GetVendor 

func (r User_Customer_External_Binding_Totp) GetVendor() (resp datatypes.User_External_Binding_Vendor, err error)

Retrieve The vendor of an external authentication binding.

func (User_Customer_External_Binding_Totp) Id 

func (r User_Customer_External_Binding_Totp) Id(id int) User_Customer_External_Binding_Totp

func (User_Customer_External_Binding_Totp) Limit 

func (r User_Customer_External_Binding_Totp) Limit(limit int) User_Customer_External_Binding_Totp

func (User_Customer_External_Binding_Totp) Mask 

func (r User_Customer_External_Binding_Totp) Mask(mask string) User_Customer_External_Binding_Totp

func (User_Customer_External_Binding_Totp) Offset 

func (r User_Customer_External_Binding_Totp) Offset(offset int) User_Customer_External_Binding_Totp

func (User_Customer_External_Binding_Totp) UpdateNote 

func (r User_Customer_External_Binding_Totp) UpdateNote(text *string) (resp bool, err error)

Update the note of an external binding. The note is an optional property that is used to store information about a binding.

type User_Customer_External_Binding_Vendor 

type User_Customer_External_Binding_Vendor struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetUserCustomerExternalBindingVendorService 

func GetUserCustomerExternalBindingVendorService(sess session.SLSession) User_Customer_External_Binding_Vendor

GetUserCustomerExternalBindingVendorService returns an instance of the User_Customer_External_Binding_Vendor SoftLayer service

func (User_Customer_External_Binding_Vendor) Filter 

func (r User_Customer_External_Binding_Vendor) Filter(filter string) User_Customer_External_Binding_Vendor

func (User_Customer_External_Binding_Vendor) GetAllObjects 

func (r User_Customer_External_Binding_Vendor) GetAllObjects() (resp []datatypes.User_External_Binding_Vendor, err error)

getAllObjects() will return a list of the available external binding vendors that SoftLayer supports. Use this list to select the appropriate vendor when creating a new external binding.

func (User_Customer_External_Binding_Vendor) GetObject 

func (r User_Customer_External_Binding_Vendor) GetObject() (resp datatypes.User_Customer_External_Binding_Vendor, err error)

no documentation yet

func (User_Customer_External_Binding_Vendor) Id 

func (r User_Customer_External_Binding_Vendor) Id(id int) User_Customer_External_Binding_Vendor

func (User_Customer_External_Binding_Vendor) Limit 

func (r User_Customer_External_Binding_Vendor) Limit(limit int) User_Customer_External_Binding_Vendor

func (User_Customer_External_Binding_Vendor) Mask 

func (r User_Customer_External_Binding_Vendor) Mask(mask string) User_Customer_External_Binding_Vendor

func (User_Customer_External_Binding_Vendor) Offset 

func (r User_Customer_External_Binding_Vendor) Offset(offset int) User_Customer_External_Binding_Vendor

type User_Customer_External_Binding_Verisign 

type User_Customer_External_Binding_Verisign struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetUserCustomerExternalBindingVerisignService 

func GetUserCustomerExternalBindingVerisignService(sess session.SLSession) User_Customer_External_Binding_Verisign

GetUserCustomerExternalBindingVerisignService returns an instance of the User_Customer_External_Binding_Verisign SoftLayer service

func (User_Customer_External_Binding_Verisign) DeleteObject 

func (r User_Customer_External_Binding_Verisign) DeleteObject() (resp bool, err error)

Delete a VeriSign external binding. The only VeriSign external binding that can be deleted through this method is the free VeriSign external binding for the master user of a SoftLayer account. All other external bindings must be canceled using the SoftLayer service cancellation form.

When a VeriSign external binding is deleted the credential is deactivated in VeriSign's system for use on the SoftLayer site and the $0 billing item associated with the free VeriSign external binding is cancelled.

func (User_Customer_External_Binding_Verisign) Disable 

func (r User_Customer_External_Binding_Verisign) Disable(reason *string) (resp bool, err error)

Disabling an external binding will allow you to keep the external binding on your SoftLayer account, but will not require you to authentication with our trusted 2 form factor vendor when logging into the SoftLayer customer portal.

You may supply one of the following reason when you disable an external binding: *Unspecified *TemporarilyUnavailable *Lost *Stolen

func (User_Customer_External_Binding_Verisign) Enable 

func (r User_Customer_External_Binding_Verisign) Enable() (resp bool, err error)

Enabling an external binding will activate the binding on your account and require you to authenticate with our trusted 3rd party 2 form factor vendor when logging into the SoftLayer customer portal.

Please note that API access will be disabled for users that have an active external binding.

func (User_Customer_External_Binding_Verisign) Filter 

func (r User_Customer_External_Binding_Verisign) Filter(filter string) User_Customer_External_Binding_Verisign

func (User_Customer_External_Binding_Verisign) GetActivationCodeForMobileClient 

func (r User_Customer_External_Binding_Verisign) GetActivationCodeForMobileClient() (resp string, err error)

An activation code is required when provisioning a new mobile credential from Verisign. This method will return the required activation code.

func (User_Customer_External_Binding_Verisign) GetAttributes 

func (r User_Customer_External_Binding_Verisign) GetAttributes() (resp []datatypes.User_External_Binding_Attribute, err error)

Retrieve Attributes of an external authentication binding.

func (User_Customer_External_Binding_Verisign) GetBillingItem 

func (r User_Customer_External_Binding_Verisign) GetBillingItem() (resp datatypes.Billing_Item, err error)

Retrieve Information regarding the billing item for external authentication.

func (User_Customer_External_Binding_Verisign) GetCredentialExpirationDate 

func (r User_Customer_External_Binding_Verisign) GetCredentialExpirationDate() (resp string, err error)

Retrieve The date that a VeriSign credential expires.

func (User_Customer_External_Binding_Verisign) GetCredentialLastUpdateDate 

func (r User_Customer_External_Binding_Verisign) GetCredentialLastUpdateDate() (resp string, err error)

Retrieve The last time a VeriSign credential was updated.

func (User_Customer_External_Binding_Verisign) GetCredentialState 

func (r User_Customer_External_Binding_Verisign) GetCredentialState() (resp string, err error)

Retrieve The current state of a VeriSign credential. This can be 'Enabled', 'Disabled', or 'Locked'.

func (User_Customer_External_Binding_Verisign) GetCredentialType 

func (r User_Customer_External_Binding_Verisign) GetCredentialType() (resp string, err error)

Retrieve The type of VeriSign credential. This can be either 'Hardware' or 'Software'.

func (User_Customer_External_Binding_Verisign) GetNote 

func (r User_Customer_External_Binding_Verisign) GetNote() (resp string, err error)

Retrieve An optional note for identifying the external binding.

func (User_Customer_External_Binding_Verisign) GetObject 

func (r User_Customer_External_Binding_Verisign) GetObject() (resp datatypes.User_Customer_External_Binding_Verisign, err error)

no documentation yet

func (User_Customer_External_Binding_Verisign) GetType 

func (r User_Customer_External_Binding_Verisign) GetType() (resp datatypes.User_External_Binding_Type, err error)

Retrieve The type of external authentication binding.

func (User_Customer_External_Binding_Verisign) GetUser 

func (r User_Customer_External_Binding_Verisign) GetUser() (resp datatypes.User_Customer, err error)

Retrieve The SoftLayer user that the external authentication binding belongs to.

func (User_Customer_External_Binding_Verisign) GetVendor 

func (r User_Customer_External_Binding_Verisign) GetVendor() (resp datatypes.User_External_Binding_Vendor, err error)

Retrieve The vendor of an external authentication binding.

func (User_Customer_External_Binding_Verisign) Id 

func (r User_Customer_External_Binding_Verisign) Id(id int) User_Customer_External_Binding_Verisign

func (User_Customer_External_Binding_Verisign) Limit 

func (r User_Customer_External_Binding_Verisign) Limit(limit int) User_Customer_External_Binding_Verisign

func (User_Customer_External_Binding_Verisign) Mask 

func (r User_Customer_External_Binding_Verisign) Mask(mask string) User_Customer_External_Binding_Verisign

func (User_Customer_External_Binding_Verisign) Offset 

func (r User_Customer_External_Binding_Verisign) Offset(offset int) User_Customer_External_Binding_Verisign

func (User_Customer_External_Binding_Verisign) Unlock 

func (r User_Customer_External_Binding_Verisign) Unlock(securityCode *string) (resp bool, err error)

If a VeriSign credential becomes locked because of too many failed login attempts the unlock method can be used to unlock a VeriSign credential. As a security precaution a valid security code generated by the credential will be required before the credential is unlocked.

func (User_Customer_External_Binding_Verisign) UpdateNote 

func (r User_Customer_External_Binding_Verisign) UpdateNote(text *string) (resp bool, err error)

Update the note of an external binding. The note is an optional property that is used to store information about a binding.

func (User_Customer_External_Binding_Verisign) ValidateCredentialId 

func (r User_Customer_External_Binding_Verisign) ValidateCredentialId(userId *int, externalId *string) (resp bool, err error)

Validate the user id and VeriSign credential id used to create an external authentication binding.

type User_Customer_Invitation 

type User_Customer_Invitation struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetUserCustomerInvitationService 

func GetUserCustomerInvitationService(sess session.SLSession) User_Customer_Invitation

GetUserCustomerInvitationService returns an instance of the User_Customer_Invitation SoftLayer service

func (User_Customer_Invitation) Filter 

func (r User_Customer_Invitation) Filter(filter string) User_Customer_Invitation

func (User_Customer_Invitation) GetObject 

func (r User_Customer_Invitation) GetObject() (resp datatypes.User_Customer_Invitation, err error)

no documentation yet

func (User_Customer_Invitation) GetUser 

func (r User_Customer_Invitation) GetUser() (resp datatypes.User_Customer, err error)

Retrieve

func (User_Customer_Invitation) Id 

func (r User_Customer_Invitation) Id(id int) User_Customer_Invitation

func (User_Customer_Invitation) Limit 

func (r User_Customer_Invitation) Limit(limit int) User_Customer_Invitation

func (User_Customer_Invitation) Mask 

func (r User_Customer_Invitation) Mask(mask string) User_Customer_Invitation

func (User_Customer_Invitation) Offset 

func (r User_Customer_Invitation) Offset(offset int) User_Customer_Invitation

type User_Customer_Notification_Hardware 

type User_Customer_Notification_Hardware struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetUserCustomerNotificationHardwareService 

func GetUserCustomerNotificationHardwareService(sess session.SLSession) User_Customer_Notification_Hardware

GetUserCustomerNotificationHardwareService returns an instance of the User_Customer_Notification_Hardware SoftLayer service

func (User_Customer_Notification_Hardware) CreateObject 

func (r User_Customer_Notification_Hardware) CreateObject(templateObject *datatypes.User_Customer_Notification_Hardware) (resp datatypes.User_Customer_Notification_Hardware, err error)

Passing in an unsaved instances of a Customer_Notification_Hardware object into this function will create the object and return the results to the user.

func (User_Customer_Notification_Hardware) CreateObjects 

func (r User_Customer_Notification_Hardware) CreateObjects(templateObjects []datatypes.User_Customer_Notification_Hardware) (resp []datatypes.User_Customer_Notification_Hardware, err error)

Passing in a collection of unsaved instances of Customer_Notification_Hardware objects into this function will create all objects and return the results to the user.

func (User_Customer_Notification_Hardware) DeleteObjects 

func (r User_Customer_Notification_Hardware) DeleteObjects(templateObjects []datatypes.User_Customer_Notification_Hardware) (resp bool, err error)

Like any other API object, the customer notification objects can be deleted by passing an instance of them into this function. The ID on the object must be set.

func (User_Customer_Notification_Hardware) Filter 

func (r User_Customer_Notification_Hardware) Filter(filter string) User_Customer_Notification_Hardware

func (User_Customer_Notification_Hardware) FindByHardwareId 

func (r User_Customer_Notification_Hardware) FindByHardwareId(hardwareId *int) (resp []datatypes.User_Customer_Notification_Hardware, err error)

This method returns all Customer_Notification_Hardware objects associated with the passed in hardware ID as long as that hardware ID is owned by the current user's account.

This behavior can also be accomplished by simply tapping monitoringUserNotification on the Hardware_Server object.

func (User_Customer_Notification_Hardware) GetHardware 

func (r User_Customer_Notification_Hardware) GetHardware() (resp datatypes.Hardware, err error)

Retrieve The hardware object that will be monitored.

func (User_Customer_Notification_Hardware) GetObject 

func (r User_Customer_Notification_Hardware) GetObject() (resp datatypes.User_Customer_Notification_Hardware, err error)

getObject retrieves the SoftLayer_User_Customer_Notification_Hardware object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_User_Customer_Notification_Hardware service. You can only retrieve hardware notifications attached to hardware and users that belong to your account

func (User_Customer_Notification_Hardware) GetUser 

func (r User_Customer_Notification_Hardware) GetUser() (resp datatypes.User_Customer, err error)

Retrieve The user that will be notified when the associated hardware object fails a monitoring instance.

func (User_Customer_Notification_Hardware) Id 

func (r User_Customer_Notification_Hardware) Id(id int) User_Customer_Notification_Hardware

func (User_Customer_Notification_Hardware) Limit 

func (r User_Customer_Notification_Hardware) Limit(limit int) User_Customer_Notification_Hardware

func (User_Customer_Notification_Hardware) Mask 

func (r User_Customer_Notification_Hardware) Mask(mask string) User_Customer_Notification_Hardware

func (User_Customer_Notification_Hardware) Offset 

func (r User_Customer_Notification_Hardware) Offset(offset int) User_Customer_Notification_Hardware

type User_Customer_Notification_Virtual_Guest 

type User_Customer_Notification_Virtual_Guest struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetUserCustomerNotificationVirtualGuestService 

func GetUserCustomerNotificationVirtualGuestService(sess session.SLSession) User_Customer_Notification_Virtual_Guest

GetUserCustomerNotificationVirtualGuestService returns an instance of the User_Customer_Notification_Virtual_Guest SoftLayer service

func (User_Customer_Notification_Virtual_Guest) CreateObject 

func (r User_Customer_Notification_Virtual_Guest) CreateObject(templateObject *datatypes.User_Customer_Notification_Virtual_Guest) (resp datatypes.User_Customer_Notification_Virtual_Guest, err error)

Passing in an unsaved instance of a SoftLayer_Customer_Notification_Virtual_Guest object into this function will create the object and return the results to the user.

func (User_Customer_Notification_Virtual_Guest) CreateObjects 

func (r User_Customer_Notification_Virtual_Guest) CreateObjects(templateObjects []datatypes.User_Customer_Notification_Virtual_Guest) (resp []datatypes.User_Customer_Notification_Virtual_Guest, err error)

Passing in a collection of unsaved instances of SoftLayer_Customer_Notification_Virtual_Guest objects into this function will create all objects and return the results to the user.

func (User_Customer_Notification_Virtual_Guest) DeleteObjects 

func (r User_Customer_Notification_Virtual_Guest) DeleteObjects(templateObjects []datatypes.User_Customer_Notification_Virtual_Guest) (resp bool, err error)

Like any other API object, the customer notification objects can be deleted by passing an instance of them into this function. The ID on the object must be set.

func (User_Customer_Notification_Virtual_Guest) Filter 

func (r User_Customer_Notification_Virtual_Guest) Filter(filter string) User_Customer_Notification_Virtual_Guest

func (User_Customer_Notification_Virtual_Guest) FindByGuestId 

func (r User_Customer_Notification_Virtual_Guest) FindByGuestId(id *int) (resp []datatypes.User_Customer_Notification_Virtual_Guest, err error)

This method returns all SoftLayer_User_Customer_Notification_Virtual_Guest objects associated with the passed in ID as long as that Virtual Guest ID is owned by the current user's account.

This behavior can also be accomplished by simply tapping monitoringUserNotification on the Virtual_Guest object.

func (User_Customer_Notification_Virtual_Guest) GetGuest 

func (r User_Customer_Notification_Virtual_Guest) GetGuest() (resp datatypes.Virtual_Guest, err error)

Retrieve The virtual guest object that will be monitored.

func (User_Customer_Notification_Virtual_Guest) GetObject 

func (r User_Customer_Notification_Virtual_Guest) GetObject() (resp datatypes.User_Customer_Notification_Virtual_Guest, err error)

getObject retrieves the SoftLayer_User_Customer_Notification_Virtual_Guest object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_User_Customer_Notification_Virtual_Guest service. You can only retrieve guest notifications attached to virtual guests and users that belong to your account

func (User_Customer_Notification_Virtual_Guest) GetUser 

func (r User_Customer_Notification_Virtual_Guest) GetUser() (resp datatypes.User_Customer, err error)

Retrieve The user that will be notified when the associated virtual guest object fails a monitoring instance.

func (User_Customer_Notification_Virtual_Guest) Id 

func (r User_Customer_Notification_Virtual_Guest) Id(id int) User_Customer_Notification_Virtual_Guest

func (User_Customer_Notification_Virtual_Guest) Limit 

func (r User_Customer_Notification_Virtual_Guest) Limit(limit int) User_Customer_Notification_Virtual_Guest

func (User_Customer_Notification_Virtual_Guest) Mask 

func (r User_Customer_Notification_Virtual_Guest) Mask(mask string) User_Customer_Notification_Virtual_Guest

func (User_Customer_Notification_Virtual_Guest) Offset 

func (r User_Customer_Notification_Virtual_Guest) Offset(offset int) User_Customer_Notification_Virtual_Guest

type User_Customer_OpenIdConnect 

type User_Customer_OpenIdConnect struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetUserCustomerOpenIdConnectService 

func GetUserCustomerOpenIdConnectService(sess session.SLSession) User_Customer_OpenIdConnect

GetUserCustomerOpenIdConnectService returns an instance of the User_Customer_OpenIdConnect SoftLayer service

func (User_Customer_OpenIdConnect) AcknowledgeSupportPolicy 

func (r User_Customer_OpenIdConnect) AcknowledgeSupportPolicy() (err error)

no documentation yet

func (User_Customer_OpenIdConnect) ActivateOpenIdConnectUser 

func (r User_Customer_OpenIdConnect) ActivateOpenIdConnectUser(verificationCode *string, userInfo *datatypes.User_Customer, iamId *string) (err error)

Completes invitation process for an OpenIdConnect user created by Bluemix Unified User Console.

func (User_Customer_OpenIdConnect) AddApiAuthenticationKey 

func (r User_Customer_OpenIdConnect) AddApiAuthenticationKey() (resp string, err error)

Create a user's API authentication key, allowing that user access to query the SoftLayer API. addApiAuthenticationKey() returns the user's new API key. Each portal user is allowed only one API key.

func (User_Customer_OpenIdConnect) AddBulkDedicatedHostAccess 

func (r User_Customer_OpenIdConnect) AddBulkDedicatedHostAccess(dedicatedHostIds []int) (resp bool, err error)

Grants the user access to one or more dedicated host devices. The user will only be allowed to see and access devices in both the portal and the API to which they have been granted access. If the user's account has devices to which the user has not been granted access, then "not found" exceptions are thrown if the user attempts to access any of these devices.

Users can assign device access to their child users, but not to themselves. An account's master has access to all devices on their customer account and can set dedicated host access for any of the other users on their account.

func (User_Customer_OpenIdConnect) AddBulkHardwareAccess 

func (r User_Customer_OpenIdConnect) AddBulkHardwareAccess(hardwareIds []int) (resp bool, err error)

Add multiple hardware to a portal user's hardware access list. A user's hardware access list controls which of an account's hardware objects a user has access to in the SoftLayer customer portal and API. Hardware does not exist in the SoftLayer portal and returns "not found" exceptions in the API if the user doesn't have access to it. addBulkHardwareAccess() does not attempt to add hardware access if the given user already has access to that hardware object.

Users can assign hardware access to their child users, but not to themselves. An account's master has access to all hardware on their customer account and can set hardware access for any of the other users on their account.

func (User_Customer_OpenIdConnect) AddBulkPortalPermission 

func (r User_Customer_OpenIdConnect) AddBulkPortalPermission(permissions []datatypes.User_Customer_CustomerPermission_Permission) (resp bool, err error)

Add multiple permissions to a portal user's permission set. [[SoftLayer_User_Customer_CustomerPermission_Permission]] control which features in the SoftLayer customer portal and API a user may use. addBulkPortalPermission() does not attempt to add permissions already assigned to the user.

Users can assign permissions to their child users, but not to themselves. An account's master has all portal permissions and can set permissions for any of the other users on their account.

Use the [[SoftLayer_User_Customer_CustomerPermission_Permission::getAllObjects]] method to retrieve a list of all permissions available in the SoftLayer customer portal and API. Permissions are removed based on the keyName property of the permission objects within the permissions parameter.

func (User_Customer_OpenIdConnect) AddBulkRoles 

func (r User_Customer_OpenIdConnect) AddBulkRoles(roles []datatypes.User_Permission_Role) (err error)

no documentation yet

func (User_Customer_OpenIdConnect) AddBulkVirtualGuestAccess 

func (r User_Customer_OpenIdConnect) AddBulkVirtualGuestAccess(virtualGuestIds []int) (resp bool, err error)

Add multiple CloudLayer Computing Instances to a portal user's access list. A user's CloudLayer Computing Instance access list controls which of an account's CloudLayer Computing Instance objects a user has access to in the SoftLayer customer portal and API. CloudLayer Computing Instances do not exist in the SoftLayer portal and returns "not found" exceptions in the API if the user doesn't have access to it. addBulkVirtualGuestAccess() does not attempt to add CloudLayer Computing Instance access if the given user already has access to that CloudLayer Computing Instance object.

Users can assign CloudLayer Computing Instance access to their child users, but not to themselves. An account's master has access to all CloudLayer Computing Instances on their customer account and can set CloudLayer Computing Instance access for any of the other users on their account.

func (User_Customer_OpenIdConnect) AddDedicatedHostAccess 

func (r User_Customer_OpenIdConnect) AddDedicatedHostAccess(dedicatedHostId *int) (resp bool, err error)

Grants the user access to a single dedicated host device. The user will only be allowed to see and access devices in both the portal and the API to which they have been granted access. If the user's account has devices to which the user has not been granted access, then "not found" exceptions are thrown if the user attempts to access any of these devices.

Users can assign device access to their child users, but not to themselves. An account's master has access to all devices on their customer account and can set dedicated host access for any of the other users on their account.

Only the USER_MANAGE permission is required to execute this.

func (User_Customer_OpenIdConnect) AddExternalBinding 

func (r User_Customer_OpenIdConnect) AddExternalBinding(externalBinding *datatypes.User_External_Binding) (resp datatypes.User_Customer_External_Binding, err error)

no documentation yet

func (User_Customer_OpenIdConnect) AddHardwareAccess 

func (r User_Customer_OpenIdConnect) AddHardwareAccess(hardwareId *int) (resp bool, err error)

Add hardware to a portal user's hardware access list. A user's hardware access list controls which of an account's hardware objects a user has access to in the SoftLayer customer portal and API. Hardware does not exist in the SoftLayer portal and returns "not found" exceptions in the API if the user doesn't have access to it. If a user already has access to the hardware you're attempting to add then addHardwareAccess() returns true.

Users can assign hardware access to their child users, but not to themselves. An account's master has access to all hardware on their customer account and can set hardware access for any of the other users on their account.

Only the USER_MANAGE permission is required to execute this.

func (User_Customer_OpenIdConnect) AddNotificationSubscriber 

func (r User_Customer_OpenIdConnect) AddNotificationSubscriber(notificationKeyName *string) (resp bool, err error)

Create a notification subscription record for the user. If a subscription record exists for the notification, the record will be set to active, if currently inactive.

func (User_Customer_OpenIdConnect) AddPortalPermission 

func (r User_Customer_OpenIdConnect) AddPortalPermission(permission *datatypes.User_Customer_CustomerPermission_Permission) (resp bool, err error)

Add a permission to a portal user's permission set. [[SoftLayer_User_Customer_CustomerPermission_Permission]] control which features in the SoftLayer customer portal and API a user may use. If the user already has the permission you're attempting to add then addPortalPermission() returns true.

Users can assign permissions to their child users, but not to themselves. An account's master has all portal permissions and can set permissions for any of the other users on their account.

Use the [[SoftLayer_User_Customer_CustomerPermission_Permission::getAllObjects]] method to retrieve a list of all permissions available in the SoftLayer customer portal and API. Permissions are added based on the keyName property of the permission parameter.

func (User_Customer_OpenIdConnect) AddRole 

func (r User_Customer_OpenIdConnect) AddRole(role *datatypes.User_Permission_Role) (err error)

no documentation yet

func (User_Customer_OpenIdConnect) AddVirtualGuestAccess 

func (r User_Customer_OpenIdConnect) AddVirtualGuestAccess(virtualGuestId *int) (resp bool, err error)

Add a CloudLayer Computing Instance to a portal user's access list. A user's CloudLayer Computing Instance access list controls which of an account's CloudLayer Computing Instance objects a user has access to in the SoftLayer customer portal and API. CloudLayer Computing Instances do not exist in the SoftLayer portal and returns "not found" exceptions in the API if the user doesn't have access to it. If a user already has access to the CloudLayer Computing Instance you're attempting to add then addVirtualGuestAccess() returns true.

Users can assign CloudLayer Computing Instance access to their child users, but not to themselves. An account's master has access to all CloudLayer Computing Instances on their customer account and can set CloudLayer Computing Instance access for any of the other users on their account.

Only the USER_MANAGE permission is required to execute this.

func (User_Customer_OpenIdConnect) AssignNewParentId 

func (r User_Customer_OpenIdConnect) AssignNewParentId(parentId *int, cascadePermissionsFlag *bool) (resp datatypes.User_Customer, err error)

This method can be used in place of [[SoftLayer_User_Customer::editObject]] to change the parent user of this user.

The new parent must be a user on the same account, and must not be a child of this user. A user is not allowed to change their own parent.

If the cascadeFlag is set to false, then an exception will be thrown if the new parent does not have all of the permissions that this user possesses. If the cascadeFlag is set to true, then permissions will be removed from this user and the descendants of this user as necessary so that no children of the parent will have permissions that the parent does not possess. However, setting the cascadeFlag to true will not remove the access all device permissions from this user. The customer portal will need to be used to remove these permissions.

func (User_Customer_OpenIdConnect) ChangePreference 

func (r User_Customer_OpenIdConnect) ChangePreference(preferenceTypeKeyName *string, value *string) (resp []datatypes.User_Preference, err error)

Select a type of preference you would like to modify using [[SoftLayer_User_Customer::getPreferenceTypes|getPreferenceTypes]] and invoke this method using that preference type key name.

func (User_Customer_OpenIdConnect) CompleteInvitationAfterLogin 

func (r User_Customer_OpenIdConnect) CompleteInvitationAfterLogin(providerType *string, accessToken *string, emailRegistrationCode *string) (err error)

no documentation yet

func (User_Customer_OpenIdConnect) CreateNotificationSubscriber 

func (r User_Customer_OpenIdConnect) CreateNotificationSubscriber(keyName *string, resourceTableId *int) (resp bool, err error)

Create a new subscriber for a given resource.

func (User_Customer_OpenIdConnect) CreateObject 

func (r User_Customer_OpenIdConnect) CreateObject(templateObject *datatypes.User_Customer_OpenIdConnect, password *string, vpnPassword *string) (resp datatypes.User_Customer_OpenIdConnect, err error)

Create a new user in the SoftLayer customer portal. It is not possible to set up SLL enable flags during object creation. These flags are ignored during object creation. You will need to make a subsequent call to edit object in order to enable VPN access.

An account's master user and sub-users who have the User Manage permission can add new users.

Users are created with a default permission set. After adding a user it may be helpful to set their permissions and device access.

secondaryPasswordTimeoutDays will be set to the system configured default value if the attribute is not provided or the attribute is not a valid value.

Note, neither password nor vpnPassword parameters are required.

Password When a new user is created, an email will be sent to the new user's email address with a link to a url that will allow the new user to create or change their password for the SoftLayer customer portal.

If the password parameter is provided and is not null, then that value will be validated. If it is a valid password, then the user will be created with this password. This user will still receive a portal password email. It can be used within 24 hours to change their password, or it can be allowed to expire, and the password provided during user creation will remain as the user's password.

If the password parameter is not provided or the value is null, the user must set their portal password using the link sent in email within 24 hours.  If the user fails to set their password within 24 hours, then a non-master user can use the "Reset Password" link on the login page of the portal to request a new email. A master user can use the link to retrieve a phone number to call to assist in resetting their password.

The password parameter is ignored for VPN_ONLY users or for IBMid authenticated users.

vpnPassword If the vpnPassword is provided, then the user's vpnPassword will be set to the provided password.  When creating a vpn only user, the vpnPassword MUST be supplied.  If the vpnPassword is not provided, then the user will need to use the portal to edit their profile and set the vpnPassword.

IBMid considerations When a SoftLayer account is linked to a Platform Services (PaaS, formerly Bluemix) account, AND the trait on the SoftLayer Account indicating IBMid authentication is set, then SoftLayer will delegate the creation of an ACTIVE user to PaaS. This means that even though the request to create a new user in such an account may start at the IMS API, via this delegation we effectively turn it into a request that is driven by PaaS. In particular this means that any "invitation email" that comes to the user, will come from PaaS, not from IMS via IBMid.

Users created in states other than ACTIVE (for example, a VPN_ONLY user) will be created directly in IMS without delegation (but note that no invitation is sent for a user created in any state other than ACTIVE).

func (User_Customer_OpenIdConnect) CreateOpenIdConnectUserAndCompleteInvitation 

func (r User_Customer_OpenIdConnect) CreateOpenIdConnectUserAndCompleteInvitation(providerType *string, user *datatypes.User_Customer, password *string, registrationCode *string) (err error)

no documentation yet

func (User_Customer_OpenIdConnect) CreateSubscriberDeliveryMethods 

func (r User_Customer_OpenIdConnect) CreateSubscriberDeliveryMethods(notificationKeyName *string, deliveryMethodKeyNames []string) (resp bool, err error)

Create delivery methods for a notification that the user is subscribed to. Multiple delivery method keyNames can be supplied to create multiple delivery methods for the specified notification. Available delivery methods - 'EMAIL'. Available notifications - 'PLANNED_MAINTENANCE', 'UNPLANNED_INCIDENT'.

func (User_Customer_OpenIdConnect) DeactivateNotificationSubscriber 

func (r User_Customer_OpenIdConnect) DeactivateNotificationSubscriber(keyName *string, resourceTableId *int) (resp bool, err error)

Create a new subscriber for a given resource.

func (User_Customer_OpenIdConnect) DeclineInvitation 

func (r User_Customer_OpenIdConnect) DeclineInvitation(providerType *string, registrationCode *string) (err error)

Declines an invitation to link an OpenIdConnect identity to a SoftLayer (Atlas) identity and account. Note that this uses a registration code that is likely a one-time-use-only token, so if an invitation has already been processed (accepted or previously declined) it will not be possible to process it a second time.

func (User_Customer_OpenIdConnect) EditObject 

func (r User_Customer_OpenIdConnect) EditObject(templateObject *datatypes.User_Customer) (resp bool, err error)

Account master users and sub-users who have the User Manage permission in the SoftLayer customer portal can update other user's information. Use editObject() if you wish to edit a single user account. Users who do not have the User Manage permission can only update their own information.

func (User_Customer_OpenIdConnect) EditObjects 

func (r User_Customer_OpenIdConnect) EditObjects(templateObjects []datatypes.User_Customer) (resp bool, err error)

Account master users and sub-users who have the User Manage permission in the SoftLayer customer portal can update other user's information. Use editObjects() if you wish to edit multiple users at once. Users who do not have the User Manage permission can only update their own information.

func (User_Customer_OpenIdConnect) Filter 

func (r User_Customer_OpenIdConnect) Filter(filter string) User_Customer_OpenIdConnect

func (User_Customer_OpenIdConnect) FindUserPreference 

func (r User_Customer_OpenIdConnect) FindUserPreference(profileName *string, containerKeyname *string, preferenceKeyname *string) (resp []datatypes.Layout_Profile, err error)

no documentation yet

func (User_Customer_OpenIdConnect) GetAccount 

func (r User_Customer_OpenIdConnect) GetAccount() (resp datatypes.Account, err error)

Retrieve The customer account that a user belongs to.

func (User_Customer_OpenIdConnect) GetActions 

func (r User_Customer_OpenIdConnect) GetActions() (resp []datatypes.User_Permission_Action, err error)

Retrieve

func (User_Customer_OpenIdConnect) GetActiveExternalAuthenticationVendors 

func (r User_Customer_OpenIdConnect) GetActiveExternalAuthenticationVendors() (resp []datatypes.Container_User_Customer_External_Binding_Vendor, err error)

The getActiveExternalAuthenticationVendors method will return a list of available external vendors that a SoftLayer user can authenticate against. The list will only contain vendors for which the user has at least one active external binding.

func (User_Customer_OpenIdConnect) GetAdditionalEmails 

func (r User_Customer_OpenIdConnect) GetAdditionalEmails() (resp []datatypes.User_Customer_AdditionalEmail, err error)

Retrieve A portal user's additional email addresses. These email addresses are contacted when updates are made to support tickets.

func (User_Customer_OpenIdConnect) GetAgentImpersonationToken added in v1.0.2 

func (r User_Customer_OpenIdConnect) GetAgentImpersonationToken() (resp string, err error)

no documentation yet

func (User_Customer_OpenIdConnect) GetAllowedDedicatedHostIds 

func (r User_Customer_OpenIdConnect) GetAllowedDedicatedHostIds() (resp []int, err error)

no documentation yet

func (User_Customer_OpenIdConnect) GetAllowedHardwareIds 

func (r User_Customer_OpenIdConnect) GetAllowedHardwareIds() (resp []int, err error)

no documentation yet

func (User_Customer_OpenIdConnect) GetAllowedVirtualGuestIds 

func (r User_Customer_OpenIdConnect) GetAllowedVirtualGuestIds() (resp []int, err error)

no documentation yet

func (User_Customer_OpenIdConnect) GetApiAuthenticationKeys 

func (r User_Customer_OpenIdConnect) GetApiAuthenticationKeys() (resp []datatypes.User_Customer_ApiAuthentication, err error)

Retrieve A portal user's API Authentication keys. There is a max limit of one API key per user.

func (User_Customer_OpenIdConnect) GetAuthenticationToken 

func (r User_Customer_OpenIdConnect) GetAuthenticationToken(token *datatypes.Container_User_Authentication_Token) (resp datatypes.Container_User_Authentication_Token, err error)

This method generate user authentication token and return [[SoftLayer_Container_User_Authentication_Token]] object which will be used to authenticate user to login to SoftLayer customer portal.

func (User_Customer_OpenIdConnect) GetChildUsers 

func (r User_Customer_OpenIdConnect) GetChildUsers() (resp []datatypes.User_Customer, err error)

Retrieve A portal user's child users. Some portal users may not have child users.

func (User_Customer_OpenIdConnect) GetClosedTickets 

func (r User_Customer_OpenIdConnect) GetClosedTickets() (resp []datatypes.Ticket, err error)

Retrieve An user's associated closed tickets.

func (User_Customer_OpenIdConnect) GetDedicatedHosts 

func (r User_Customer_OpenIdConnect) GetDedicatedHosts() (resp []datatypes.Virtual_DedicatedHost, err error)

Retrieve The dedicated hosts to which the user has been granted access.

func (User_Customer_OpenIdConnect) GetDefaultAccount 

func (r User_Customer_OpenIdConnect) GetDefaultAccount(providerType *string) (resp datatypes.Account, err error)

This API gets the account associated with the default user for the OpenIdConnect identity that is linked to the current active SoftLayer user identity. When a single active user is found for that IAMid, it becomes the default user and the associated account is returned. When multiple default users are found only the first is preserved and the associated account is returned (remaining defaults see their default flag unset). If the current SoftLayer user identity isn't linked to any OpenIdConnect identity, or if none of the linked users were found as defaults, the API returns null. Invoke this only on IAMid-authenticated users.

func (User_Customer_OpenIdConnect) GetExternalBindings 

func (r User_Customer_OpenIdConnect) GetExternalBindings() (resp []datatypes.User_External_Binding, err error)

Retrieve The external authentication bindings that link an external identifier to a SoftLayer user.

func (User_Customer_OpenIdConnect) GetHardware 

func (r User_Customer_OpenIdConnect) GetHardware() (resp []datatypes.Hardware, err error)

Retrieve A portal user's accessible hardware. These permissions control which hardware a user has access to in the SoftLayer customer portal.

func (User_Customer_OpenIdConnect) GetHardwareCount 

func (r User_Customer_OpenIdConnect) GetHardwareCount() (resp int, err error)

Retrieve the number of servers that a portal user has access to. Portal users can have restrictions set to limit services for and to perform actions on hardware. You can set these permissions in the portal by clicking the "administrative" then "user admin" links.

func (User_Customer_OpenIdConnect) GetHardwareNotifications 

func (r User_Customer_OpenIdConnect) GetHardwareNotifications() (resp []datatypes.User_Customer_Notification_Hardware, err error)

Retrieve Hardware notifications associated with this user. A hardware notification links a user to a piece of hardware, and that user will be notified if any monitors on that hardware fail, if the monitors have a status of 'Notify User'.

func (User_Customer_OpenIdConnect) GetHasAcknowledgedSupportPolicyFlag 

func (r User_Customer_OpenIdConnect) GetHasAcknowledgedSupportPolicyFlag() (resp bool, err error)

Retrieve Whether or not a user has acknowledged the support policy.

func (User_Customer_OpenIdConnect) GetHasFullDedicatedHostAccessFlag 

func (r User_Customer_OpenIdConnect) GetHasFullDedicatedHostAccessFlag() (resp bool, err error)

Retrieve Permission granting the user access to all Dedicated Host devices on the account.

func (User_Customer_OpenIdConnect) GetHasFullHardwareAccessFlag 

func (r User_Customer_OpenIdConnect) GetHasFullHardwareAccessFlag() (resp bool, err error)

Retrieve Whether or not a portal user has access to all hardware on their account.

func (User_Customer_OpenIdConnect) GetHasFullVirtualGuestAccessFlag 

func (r User_Customer_OpenIdConnect) GetHasFullVirtualGuestAccessFlag() (resp bool, err error)

Retrieve Whether or not a portal user has access to all virtual guests on their account. 

func (r User_Customer_OpenIdConnect) GetIbmIdLink() (resp datatypes.User_Customer_Link, err error)

Retrieve Specifically relating the Customer instance to an IBMid. A Customer instance may or may not have an IBMid link.

func (User_Customer_OpenIdConnect) GetImpersonationToken 

func (r User_Customer_OpenIdConnect) GetImpersonationToken() (resp string, err error)

no documentation yet

func (User_Customer_OpenIdConnect) GetLayoutProfiles 

func (r User_Customer_OpenIdConnect) GetLayoutProfiles() (resp []datatypes.Layout_Profile, err error)

Retrieve Contains the definition of the layout profile.

func (User_Customer_OpenIdConnect) GetLocale 

func (r User_Customer_OpenIdConnect) GetLocale() (resp datatypes.Locale, err error)

Retrieve A user's locale. Locale holds user's language and region information.

func (User_Customer_OpenIdConnect) GetLoginAccountInfoOpenIdConnect 

func (r User_Customer_OpenIdConnect) GetLoginAccountInfoOpenIdConnect(providerType *string, accessToken *string) (resp datatypes.Container_User_Customer_OpenIdConnect_LoginAccountInfo, err error)

Validates a supplied OpenIdConnect access token to the SoftLayer customer portal and returns the default account name and id for the active user. An exception will be thrown if no matching customer is found.

func (User_Customer_OpenIdConnect) GetLoginAttempts 

func (r User_Customer_OpenIdConnect) GetLoginAttempts() (resp []datatypes.User_Customer_Access_Authentication, err error)

Retrieve A user's attempts to log into the SoftLayer customer portal.

func (User_Customer_OpenIdConnect) GetLoginToken 

func (r User_Customer_OpenIdConnect) GetLoginToken(request *datatypes.Container_Authentication_Request_Contract) (resp datatypes.Container_Authentication_Response_Common, err error)

Attempt to authenticate a user to the SoftLayer customer portal using the provided authentication container. Depending on the specific type of authentication container that is used, this API will leverage the appropriate authentication protocol. If authentication is successful then the API returns a list of linked accounts for the user, a token containing the ID of the authenticated user and a hash key used by the SoftLayer customer portal to maintain authentication.

func (User_Customer_OpenIdConnect) GetMappedAccounts 

func (r User_Customer_OpenIdConnect) GetMappedAccounts(providerType *string) (resp []datatypes.Account, err error)

An OpenIdConnect identity, for example an IAMid, can be linked or mapped to one or more individual SoftLayer users, but no more than one SoftLayer user per account. This effectively links the OpenIdConnect identity to those accounts. This API returns a list of all active accounts for which there is a link between the OpenIdConnect identity and a SoftLayer user. Invoke this only on IAMid-authenticated users.

func (User_Customer_OpenIdConnect) GetNotificationSubscribers 

func (r User_Customer_OpenIdConnect) GetNotificationSubscribers() (resp []datatypes.Notification_Subscriber, err error)

Retrieve Notification subscription records for the user.

func (User_Customer_OpenIdConnect) GetObject 

func (r User_Customer_OpenIdConnect) GetObject() (resp datatypes.User_Customer_OpenIdConnect, err error)

no documentation yet

func (User_Customer_OpenIdConnect) GetOpenIdConnectMigrationState 

func (r User_Customer_OpenIdConnect) GetOpenIdConnectMigrationState() (resp datatypes.Container_User_Customer_OpenIdConnect_MigrationState, err error)

This API returns a SoftLayer_Container_User_Customer_OpenIdConnect_MigrationState object containing the necessary information to determine what migration state the user is in. If the account is not OpenIdConnect authenticated, then an exception is thrown.

func (User_Customer_OpenIdConnect) GetOpenIdRegistrationInfoFromCode 

func (r User_Customer_OpenIdConnect) GetOpenIdRegistrationInfoFromCode(providerType *string, registrationCode *string) (resp datatypes.Account_Authentication_OpenIdConnect_RegistrationInformation, err error)

no documentation yet

func (User_Customer_OpenIdConnect) GetOpenTickets 

func (r User_Customer_OpenIdConnect) GetOpenTickets() (resp []datatypes.Ticket, err error)

Retrieve An user's associated open tickets.

func (User_Customer_OpenIdConnect) GetOverrides 

func (r User_Customer_OpenIdConnect) GetOverrides() (resp []datatypes.Network_Service_Vpn_Overrides, err error)

Retrieve A portal user's vpn accessible subnets.

func (User_Customer_OpenIdConnect) GetParent 

func (r User_Customer_OpenIdConnect) GetParent() (resp datatypes.User_Customer, err error)

Retrieve A portal user's parent user. If a SoftLayer_User_Customer has a null parentId property then it doesn't have a parent user.

func (User_Customer_OpenIdConnect) GetPasswordRequirements added in v1.0.1 

func (r User_Customer_OpenIdConnect) GetPasswordRequirements(isVpn *bool) (resp datatypes.Container_User_Customer_PasswordSet, err error)

no documentation yet

func (User_Customer_OpenIdConnect) GetPermissions 

func (r User_Customer_OpenIdConnect) GetPermissions() (resp []datatypes.User_Customer_CustomerPermission_Permission, err error)

Retrieve A portal user's permissions. These permissions control that user's access to functions within the SoftLayer customer portal and API.

func (User_Customer_OpenIdConnect) GetPortalLoginToken 

func (r User_Customer_OpenIdConnect) GetPortalLoginToken(username *string, password *string, securityQuestionId *int, securityQuestionAnswer *string) (resp datatypes.Container_User_Customer_Portal_Token, err error)

Attempt to authenticate a username and password to the SoftLayer customer portal. Many portal user accounts are configured to require answering a security question on login. In this case getPortalLoginToken() also verifies the given security question ID and answer. If authentication is successful then the API returns a token containing the ID of the authenticated user and a hash key used by the SoftLayer customer portal to maintain authentication.

func (User_Customer_OpenIdConnect) GetPortalLoginTokenOpenIdConnect 

func (r User_Customer_OpenIdConnect) GetPortalLoginTokenOpenIdConnect(providerType *string, accessToken *string, accountId *int, securityQuestionId *int, securityQuestionAnswer *string) (resp datatypes.Container_User_Customer_Portal_Token, err error)

Attempt to authenticate a supplied OpenIdConnect access token to the SoftLayer customer portal. If authentication is successful then the API returns a token containing the ID of the authenticated user and a hash key used by the SoftLayer customer portal to maintain authentication. Deprecated: This function has been marked as deprecated.

func (User_Customer_OpenIdConnect) GetPreference 

func (r User_Customer_OpenIdConnect) GetPreference(preferenceTypeKeyName *string) (resp datatypes.User_Preference, err error)

Select a type of preference you would like to get using [[SoftLayer_User_Customer::getPreferenceTypes|getPreferenceTypes]] and invoke this method using that preference type key name.

func (User_Customer_OpenIdConnect) GetPreferenceTypes 

func (r User_Customer_OpenIdConnect) GetPreferenceTypes() (resp []datatypes.User_Preference_Type, err error)

Use any of the preference types to fetch or modify user preferences using [[SoftLayer_User_Customer::getPreference|getPreference]] or [[SoftLayer_User_Customer::changePreference|changePreference]], respectively.

func (User_Customer_OpenIdConnect) GetPreferences 

func (r User_Customer_OpenIdConnect) GetPreferences() (resp []datatypes.User_Preference, err error)

Retrieve Data type contains a single user preference to a specific preference type.

func (User_Customer_OpenIdConnect) GetRequirementsForPasswordSet 

func (r User_Customer_OpenIdConnect) GetRequirementsForPasswordSet(passwordSet *datatypes.Container_User_Customer_PasswordSet) (resp datatypes.Container_User_Customer_PasswordSet, err error)

Retrieve the authentication requirements for an outstanding password set/reset request. The requirements returned in the same SoftLayer_Container_User_Customer_PasswordSet container which is provided as a parameter into this request. The SoftLayer_Container_User_Customer_PasswordSet::authenticationMethods array will contain an entry for each authentication method required for the user. See SoftLayer_Container_User_Customer_PasswordSet for more details.

If the user has required authentication methods, then authentication information will be supplied to the SoftLayer_User_Customer::processPasswordSetRequest method within this same SoftLayer_Container_User_Customer_PasswordSet container. All existing information in the container must continue to exist in the container to complete the password set/reset process.

func (User_Customer_OpenIdConnect) GetRoles 

func (r User_Customer_OpenIdConnect) GetRoles() (resp []datatypes.User_Permission_Role, err error)

Retrieve

func (User_Customer_OpenIdConnect) GetSecurityAnswers 

func (r User_Customer_OpenIdConnect) GetSecurityAnswers() (resp []datatypes.User_Customer_Security_Answer, err error)

Retrieve A portal user's security question answers. Some portal users may not have security answers or may not be configured to require answering a security question on login.

func (User_Customer_OpenIdConnect) GetSubscribers 

func (r User_Customer_OpenIdConnect) GetSubscribers() (resp []datatypes.Notification_User_Subscriber, err error)

Retrieve A user's notification subscription records.

func (User_Customer_OpenIdConnect) GetSuccessfulLogins 

func (r User_Customer_OpenIdConnect) GetSuccessfulLogins() (resp []datatypes.User_Customer_Access_Authentication, err error)

Retrieve A user's successful attempts to log into the SoftLayer customer portal.

func (User_Customer_OpenIdConnect) GetSupportPolicyAcknowledgementRequiredFlag 

func (r User_Customer_OpenIdConnect) GetSupportPolicyAcknowledgementRequiredFlag() (resp int, err error)

Retrieve Whether or not a user is required to acknowledge the support policy for portal access.

func (User_Customer_OpenIdConnect) GetSupportPolicyDocument 

func (r User_Customer_OpenIdConnect) GetSupportPolicyDocument() (resp []byte, err error)

no documentation yet

func (User_Customer_OpenIdConnect) GetSupportPolicyName 

func (r User_Customer_OpenIdConnect) GetSupportPolicyName() (resp string, err error)

no documentation yet

func (User_Customer_OpenIdConnect) GetSupportedLocales 

func (r User_Customer_OpenIdConnect) GetSupportedLocales() (resp []datatypes.Locale, err error)

no documentation yet

func (User_Customer_OpenIdConnect) GetSurveyRequiredFlag 

func (r User_Customer_OpenIdConnect) GetSurveyRequiredFlag() (resp bool, err error)

Retrieve Whether or not a user must take a brief survey the next time they log into the SoftLayer customer portal.

func (User_Customer_OpenIdConnect) GetSurveys 

func (r User_Customer_OpenIdConnect) GetSurveys() (resp []datatypes.Survey, err error)

Retrieve The surveys that a user has taken in the SoftLayer customer portal.

func (User_Customer_OpenIdConnect) GetTickets 

func (r User_Customer_OpenIdConnect) GetTickets() (resp []datatypes.Ticket, err error)

Retrieve An user's associated tickets.

func (User_Customer_OpenIdConnect) GetTimezone 

func (r User_Customer_OpenIdConnect) GetTimezone() (resp datatypes.Locale_Timezone, err error)

Retrieve A portal user's time zone.

func (User_Customer_OpenIdConnect) GetUnsuccessfulLogins 

func (r User_Customer_OpenIdConnect) GetUnsuccessfulLogins() (resp []datatypes.User_Customer_Access_Authentication, err error)

Retrieve A user's unsuccessful attempts to log into the SoftLayer customer portal.

func (User_Customer_OpenIdConnect) GetUserForUnifiedInvitation 

func (r User_Customer_OpenIdConnect) GetUserForUnifiedInvitation(openIdConnectUserId *string, uniqueIdentifier *string, searchInvitationsNotLinksFlag *string, accountId *string) (resp datatypes.User_Customer_OpenIdConnect, err error)

Returns an IMS User Object from the provided OpenIdConnect User ID or IBMid Unique Identifier for the Account of the active user. Enforces the User Management permissions for the Active User. An exception will be thrown if no matching IMS User is found. NOTE that providing IBMid Unique Identifier is optional, but it will be preferred over OpenIdConnect User ID if provided.

func (User_Customer_OpenIdConnect) GetUserIdForPasswordSet 

func (r User_Customer_OpenIdConnect) GetUserIdForPasswordSet(key *string) (resp int, err error)

Retrieve a user id using a password token provided to the user in an email generated by the SoftLayer_User_Customer::initiatePortalPasswordChange request. Password recovery keys are valid for 24 hours after they're generated.

When a new user is created or when a user has requested a password change using initiatePortalPasswordChange, they will have received an email that contains a url with a token. That token is used as the parameter for getUserIdForPasswordSet. Once the user id is known, then the SoftLayer_User_Customer object can be retrieved which is necessary to complete the process to set or reset a user's password. 

func (r User_Customer_OpenIdConnect) GetUserLinks() (resp []datatypes.User_Customer_Link, err error)

Retrieve User customer link with IBMid and IAMid.

func (User_Customer_OpenIdConnect) GetUserPreferences 

func (r User_Customer_OpenIdConnect) GetUserPreferences(profileName *string, containerKeyname *string) (resp []datatypes.Layout_Profile, err error)

no documentation yet

func (User_Customer_OpenIdConnect) GetUserStatus 

func (r User_Customer_OpenIdConnect) GetUserStatus() (resp datatypes.User_Customer_Status, err error)

Retrieve A portal user's status, which controls overall access to the SoftLayer customer portal and VPN access to the private network.

func (User_Customer_OpenIdConnect) GetVirtualGuestCount 

func (r User_Customer_OpenIdConnect) GetVirtualGuestCount() (resp int, err error)

Retrieve the number of CloudLayer Computing Instances that a portal user has access to. Portal users can have restrictions set to limit services for and to perform actions on CloudLayer Computing Instances. You can set these permissions in the portal by clicking the "administrative" then "user admin" links.

func (User_Customer_OpenIdConnect) GetVirtualGuests 

func (r User_Customer_OpenIdConnect) GetVirtualGuests() (resp []datatypes.Virtual_Guest, err error)

Retrieve A portal user's accessible CloudLayer Computing Instances. These permissions control which CloudLayer Computing Instances a user has access to in the SoftLayer customer portal.

func (User_Customer_OpenIdConnect) Id 

func (r User_Customer_OpenIdConnect) Id(id int) User_Customer_OpenIdConnect

func (User_Customer_OpenIdConnect) InTerminalStatus 

func (r User_Customer_OpenIdConnect) InTerminalStatus() (resp bool, err error)

no documentation yet

func (User_Customer_OpenIdConnect) InitiatePortalPasswordChange 

func (r User_Customer_OpenIdConnect) InitiatePortalPasswordChange(username *string) (resp bool, err error)

Sends password change email to the user containing url that allows the user the change their password. This is the first step when a user wishes to change their password. The url that is generated contains a one-time use token that is valid for only 24-hours.

If this is a new master user who has never logged into the portal, then password reset will be initiated. Once a master user has logged into the portal, they must setup their security questions prior to logging out because master users are required to answer a security question during the password reset process. Should a master user not have security questions defined and not remember their password in order to define the security questions, then they will need to contact support at live chat or Revenue Services for assistance.

Due to security reasons, the number of reset requests per username are limited within a undisclosed timeframe.

func (User_Customer_OpenIdConnect) InitiatePortalPasswordChangeByBrandAgent 

func (r User_Customer_OpenIdConnect) InitiatePortalPasswordChangeByBrandAgent(username *string) (resp bool, err error)

A Brand Agent that has permissions to Add Customer Accounts will be able to request the password email be sent to the Master User of a Customer Account created by the same Brand as the agent making the request. Due to security reasons, the number of reset requests are limited within an undisclosed timeframe.

func (User_Customer_OpenIdConnect) InviteUserToLinkOpenIdConnect 

func (r User_Customer_OpenIdConnect) InviteUserToLinkOpenIdConnect(providerType *string) (err error)

Send email invitation to a user to join a SoftLayer account and authenticate with OpenIdConnect. Throws an exception on error.

func (User_Customer_OpenIdConnect) IsMasterUser 

func (r User_Customer_OpenIdConnect) IsMasterUser() (resp bool, err error)

Portal users are considered master users if they don't have an associated parent user. The only users who don't have parent users are users whose username matches their SoftLayer account name. Master users have special permissions throughout the SoftLayer customer portal. Deprecated: This function has been marked as deprecated.

func (User_Customer_OpenIdConnect) IsValidPortalPassword 

func (r User_Customer_OpenIdConnect) IsValidPortalPassword(password *string) (resp bool, err error)

Determine if a string is the given user's login password to the SoftLayer customer portal.

func (User_Customer_OpenIdConnect) Limit 

func (r User_Customer_OpenIdConnect) Limit(limit int) User_Customer_OpenIdConnect

func (User_Customer_OpenIdConnect) Mask 

func (r User_Customer_OpenIdConnect) Mask(mask string) User_Customer_OpenIdConnect

func (User_Customer_OpenIdConnect) Offset 

func (r User_Customer_OpenIdConnect) Offset(offset int) User_Customer_OpenIdConnect

func (User_Customer_OpenIdConnect) PerformExternalAuthentication 

func (r User_Customer_OpenIdConnect) PerformExternalAuthentication(authenticationContainer *datatypes.Container_User_Customer_External_Binding) (resp datatypes.Container_User_Customer_Portal_Token, err error)

The perform external authentication method will authenticate the given external authentication container with an external vendor. The authentication container and its contents will be verified before an attempt is made to authenticate the contents of the container with an external vendor.

func (User_Customer_OpenIdConnect) ProcessPasswordSetRequest 

func (r User_Customer_OpenIdConnect) ProcessPasswordSetRequest(passwordSet *datatypes.Container_User_Customer_PasswordSet, authenticationContainer *datatypes.Container_User_Customer_External_Binding) (resp bool, err error)

Set the password for a user who has an outstanding password request. A user with an outstanding password request will have an unused and unexpired password key. The password key is part of the url provided to the user in the email sent to the user with information on how to set their password. The email was generated by the SoftLayer_User_Customer::initiatePortalPasswordRequest request. Password recovery keys are valid for 24 hours after they're generated.

If the user has required authentication methods as specified by in the SoftLayer_Container_User_Customer_PasswordSet container returned from the SoftLayer_User_Customer::getRequirementsForPasswordSet request, then additional requests must be made to processPasswordSetRequest to authenticate the user before changing the password. First, if the user has security questions set on their profile, they will be required to answer one of their questions correctly. Next, if the user has Verisign or Google Authentication on their account, they must authenticate according to the two-factor provider. All of this authentication is done using the SoftLayer_Container_User_Customer_PasswordSet container.

User portal passwords must match the following restrictions. Portal passwords must... * ...be over eight characters long. * ...be under twenty characters long. * ...contain at least one uppercase letter * ...contain at least one lowercase letter * ...contain at least one number * ...contain one of the special characters _ - | @ . , ? / ! ~ # $ % ^ & * ( ) { } [ ] \ + = * ...not match your username

func (User_Customer_OpenIdConnect) RemoveAllDedicatedHostAccessForThisUser 

func (r User_Customer_OpenIdConnect) RemoveAllDedicatedHostAccessForThisUser() (resp bool, err error)

Revoke access to all dedicated hosts on the account for this user. The user will only be allowed to see and access devices in both the portal and the API to which they have been granted access. If the user's account has devices to which the user has not been granted access or the access has been revoked, then "not found" exceptions are thrown if the user attempts to access any of these devices. If the current user does not have administrative privileges over this user, an inadequate permissions exception will get thrown.

Users can call this function on child users, but not to themselves. An account's master has access to all users permissions on their account.

func (User_Customer_OpenIdConnect) RemoveAllHardwareAccessForThisUser 

func (r User_Customer_OpenIdConnect) RemoveAllHardwareAccessForThisUser() (resp bool, err error)

Remove all hardware from a portal user's hardware access list. A user's hardware access list controls which of an account's hardware objects a user has access to in the SoftLayer customer portal and API. If the current user does not have administrative privileges over this user, an inadequate permissions exception will get thrown.

Users can call this function on child users, but not to themselves. An account's master has access to all users permissions on their account.

func (User_Customer_OpenIdConnect) RemoveAllVirtualAccessForThisUser 

func (r User_Customer_OpenIdConnect) RemoveAllVirtualAccessForThisUser() (resp bool, err error)

Remove all cloud computing instances from a portal user's instance access list. A user's instance access list controls which of an account's computing instance objects a user has access to in the SoftLayer customer portal and API. If the current user does not have administrative privileges over this user, an inadequate permissions exception will get thrown.

Users can call this function on child users, but not to themselves. An account's master has access to all users permissions on their account.

func (User_Customer_OpenIdConnect) RemoveApiAuthenticationKey 

func (r User_Customer_OpenIdConnect) RemoveApiAuthenticationKey(keyId *int) (resp bool, err error)

Remove a user's API authentication key, removing that user's access to query the SoftLayer API.

func (User_Customer_OpenIdConnect) RemoveBulkDedicatedHostAccess 

func (r User_Customer_OpenIdConnect) RemoveBulkDedicatedHostAccess(dedicatedHostIds []int) (resp bool, err error)

Revokes access for the user to one or more dedicated host devices. The user will only be allowed to see and access devices in both the portal and the API to which they have been granted access. If the user's account has devices to which the user has not been granted access or the access has been revoked, then "not found" exceptions are thrown if the user attempts to access any of these devices.

Users can assign device access to their child users, but not to themselves. An account's master has access to all devices on their customer account and can set dedicated host access for any of the other users on their account.

If the user has full dedicatedHost access, then it will provide access to "ALL but passed in" dedicatedHost ids.

func (User_Customer_OpenIdConnect) RemoveBulkHardwareAccess 

func (r User_Customer_OpenIdConnect) RemoveBulkHardwareAccess(hardwareIds []int) (resp bool, err error)

Remove multiple hardware from a portal user's hardware access list. A user's hardware access list controls which of an account's hardware objects a user has access to in the SoftLayer customer portal and API. Hardware does not exist in the SoftLayer portal and returns "not found" exceptions in the API if the user doesn't have access to it. If a user does not has access to the hardware you're attempting to remove then removeBulkHardwareAccess() returns true.

Users can assign hardware access to their child users, but not to themselves. An account's master has access to all hardware on their customer account and can set hardware access for any of the other users on their account.

If the user has full hardware access, then it will provide access to "ALL but passed in" hardware ids.

func (User_Customer_OpenIdConnect) RemoveBulkPortalPermission 

func (r User_Customer_OpenIdConnect) RemoveBulkPortalPermission(permissions []datatypes.User_Customer_CustomerPermission_Permission, cascadePermissionsFlag *bool) (resp bool, err error)

Remove (revoke) multiple permissions from a portal user's permission set. [[SoftLayer_User_Customer_CustomerPermission_Permission]] control which features in the SoftLayer customer portal and API a user may use. Removing a user's permission will affect that user's portal and API access. removePortalPermission() does not attempt to remove permissions that are not assigned to the user.

Users can grant or revoke permissions to their child users, but not to themselves. An account's master has all portal permissions and can grant permissions for any of the other users on their account.

If the cascadePermissionsFlag is set to true, then removing the permissions from a user will cascade down the child hierarchy and remove the permissions from this user along with all child users who also have the permission.

If the cascadePermissionsFlag is not provided or is set to false and the user has children users who have the permission, then an exception will be thrown, and the permission will not be removed from this user.

Use the [[SoftLayer_User_Customer_CustomerPermission_Permission::getAllObjects]] method to retrieve a list of all permissions available in the SoftLayer customer portal and API. Permissions are removed based on the keyName property of the permission objects within the permissions parameter.

func (User_Customer_OpenIdConnect) RemoveBulkRoles 

func (r User_Customer_OpenIdConnect) RemoveBulkRoles(roles []datatypes.User_Permission_Role) (err error)

no documentation yet

func (User_Customer_OpenIdConnect) RemoveBulkVirtualGuestAccess 

func (r User_Customer_OpenIdConnect) RemoveBulkVirtualGuestAccess(virtualGuestIds []int) (resp bool, err error)

Remove multiple CloudLayer Computing Instances from a portal user's access list. A user's CloudLayer Computing Instance access list controls which of an account's CloudLayer Computing Instance objects a user has access to in the SoftLayer customer portal and API. CloudLayer Computing Instances do not exist in the SoftLayer portal and returns "not found" exceptions in the API if the user doesn't have access to it. If a user does not has access to the CloudLayer Computing Instance you're attempting remove add then removeBulkVirtualGuestAccess() returns true.

Users can assign CloudLayer Computing Instance access to their child users, but not to themselves. An account's master has access to all CloudLayer Computing Instances on their customer account and can set hardware access for any of the other users on their account.

func (User_Customer_OpenIdConnect) RemoveDedicatedHostAccess 

func (r User_Customer_OpenIdConnect) RemoveDedicatedHostAccess(dedicatedHostId *int) (resp bool, err error)

Revokes access for the user to a single dedicated host device. The user will only be allowed to see and access devices in both the portal and the API to which they have been granted access. If the user's account has devices to which the user has not been granted access or the access has been revoked, then "not found" exceptions are thrown if the user attempts to access any of these devices.

Users can assign device access to their child users, but not to themselves. An account's master has access to all devices on their customer account and can set dedicated host access for any of the other users on their account.

func (User_Customer_OpenIdConnect) RemoveExternalBinding 

func (r User_Customer_OpenIdConnect) RemoveExternalBinding(externalBinding *datatypes.User_External_Binding) (resp bool, err error)

no documentation yet

func (User_Customer_OpenIdConnect) RemoveHardwareAccess 

func (r User_Customer_OpenIdConnect) RemoveHardwareAccess(hardwareId *int) (resp bool, err error)

Remove hardware from a portal user's hardware access list. A user's hardware access list controls which of an account's hardware objects a user has access to in the SoftLayer customer portal and API. Hardware does not exist in the SoftLayer portal and returns "not found" exceptions in the API if the user doesn't have access to it. If a user does not has access to the hardware you're attempting remove add then removeHardwareAccess() returns true.

Users can assign hardware access to their child users, but not to themselves. An account's master has access to all hardware on their customer account and can set hardware access for any of the other users on their account.

func (User_Customer_OpenIdConnect) RemovePortalPermission 

func (r User_Customer_OpenIdConnect) RemovePortalPermission(permission *datatypes.User_Customer_CustomerPermission_Permission, cascadePermissionsFlag *bool) (resp bool, err error)

Remove (revoke) a permission from a portal user's permission set. [[SoftLayer_User_Customer_CustomerPermission_Permission]] control which features in the SoftLayer customer portal and API a user may use. Removing a user's permission will affect that user's portal and API access. If the user does not have the permission you're attempting to remove then removePortalPermission() returns true.

Users can assign permissions to their child users, but not to themselves. An account's master has all portal permissions and can set permissions for any of the other users on their account.

If the cascadePermissionsFlag is set to true, then removing the permission from a user will cascade down the child hierarchy and remove the permission from this user and all child users who also have the permission.

If the cascadePermissionsFlag is not set or is set to false and the user has children users who have the permission, then an exception will be thrown, and the permission will not be removed from this user.

Use the [[SoftLayer_User_Customer_CustomerPermission_Permission::getAllObjects]] method to retrieve a list of all permissions available in the SoftLayer customer portal and API. Permissions are removed based on the keyName property of the permission parameter.

func (User_Customer_OpenIdConnect) RemoveRole 

func (r User_Customer_OpenIdConnect) RemoveRole(role *datatypes.User_Permission_Role) (err error)

no documentation yet

func (User_Customer_OpenIdConnect) RemoveSecurityAnswers 

func (r User_Customer_OpenIdConnect) RemoveSecurityAnswers() (resp bool, err error)

no documentation yet

func (User_Customer_OpenIdConnect) RemoveVirtualGuestAccess 

func (r User_Customer_OpenIdConnect) RemoveVirtualGuestAccess(virtualGuestId *int) (resp bool, err error)

Remove a CloudLayer Computing Instance from a portal user's access list. A user's CloudLayer Computing Instance access list controls which of an account's computing instances a user has access to in the SoftLayer customer portal and API. CloudLayer Computing Instances do not exist in the SoftLayer portal and returns "not found" exceptions in the API if the user doesn't have access to it. If a user does not has access to the CloudLayer Computing Instance you're attempting remove add then removeVirtualGuestAccess() returns true.

Users can assign CloudLayer Computing Instance access to their child users, but not to themselves. An account's master has access to all CloudLayer Computing Instances on their customer account and can set instance access for any of the other users on their account. 

func (r User_Customer_OpenIdConnect) ResetOpenIdConnectLink(providerType *string, newIbmIdUsername *string, removeSecuritySettings *bool) (err error)

This method will change the IBMid that a SoftLayer user is linked to, if we need to do that for some reason. It will do this by modifying the link to the desired new IBMid. NOTE: This method cannot be used to "un-link" a SoftLayer user. Once linked, a SoftLayer user can never be un-linked. Also, this method cannot be used to reset the link if the user account is already Bluemix linked. To reset a link for the Bluemix-linked user account, use resetOpenIdConnectLinkUnifiedUserManagementMode.

func (User_Customer_OpenIdConnect) ResetOpenIdConnectLinkUnifiedUserManagementMode added in v1.0.4 

func (r User_Customer_OpenIdConnect) ResetOpenIdConnectLinkUnifiedUserManagementMode(providerType *string, newIbmIdUsername *string, removeSecuritySettings *bool) (err error)

This method will change the IBMid that a SoftLayer master user is linked to, if we need to do that for some reason. It will do this by unlinking the new owner IBMid from its current user association in this account, if there is one (note that the new owner IBMid is not required to already be a member of the IMS account). Then it will modify the existing IBMid link for the master user to use the new owner IBMid-realm IAMid. At this point, if the new owner IBMid isn't already a member of the PaaS account, it will attempt to add it. As a last step, it will call PaaS to modify the owner on that side, if necessary. Only when all those steps are complete, it will commit the IMS-side DB changes. Then, it will clean up the SoftLayer user that was linked to the new owner IBMid (this user became unlinked as the first step in this process). It will also call BSS to delete the old owner IBMid. NOTE: This method cannot be used to "un-link" a SoftLayer user. Once linked, a SoftLayer user can never be un-linked. Also, this method cannot be used to reset the link if the user account is not Bluemix linked. To reset a link for the user account not linked to Bluemix, use resetOpenIdConnectLink.

func (User_Customer_OpenIdConnect) SamlAuthenticate 

func (r User_Customer_OpenIdConnect) SamlAuthenticate(accountId *string, samlResponse *string) (resp datatypes.Container_User_Customer_Portal_Token, err error)

no documentation yet

func (User_Customer_OpenIdConnect) SamlBeginAuthentication 

func (r User_Customer_OpenIdConnect) SamlBeginAuthentication(accountId *int) (resp string, err error)

no documentation yet

func (User_Customer_OpenIdConnect) SamlBeginLogout 

func (r User_Customer_OpenIdConnect) SamlBeginLogout() (resp string, err error)

no documentation yet

func (User_Customer_OpenIdConnect) SamlLogout 

func (r User_Customer_OpenIdConnect) SamlLogout(samlResponse *string) (err error)

no documentation yet

func (User_Customer_OpenIdConnect) SelfPasswordChange 

func (r User_Customer_OpenIdConnect) SelfPasswordChange(currentPassword *string, newPassword *string) (err error)

no documentation yet

func (User_Customer_OpenIdConnect) SetDefaultAccount 

func (r User_Customer_OpenIdConnect) SetDefaultAccount(providerType *string, accountId *int) (resp datatypes.Account, err error)

An OpenIdConnect identity, for example an IAMid, can be linked or mapped to one or more individual SoftLayer users, but no more than one per account. If an OpenIdConnect identity is mapped to multiple accounts in this manner, one such account should be identified as the default account for that identity. Invoke this only on IBMid-authenticated users.

func (User_Customer_OpenIdConnect) SilentlyMigrateUserOpenIdConnect 

func (r User_Customer_OpenIdConnect) SilentlyMigrateUserOpenIdConnect(providerType *string) (resp bool, err error)

As master user, calling this api for the IBMid provider type when there is an existing IBMid for the email on the SL account will silently (without sending an invitation email) create a link for the IBMid. NOTE: If the SoftLayer user is already linked to IBMid, this call will fail. If the IBMid specified by the email of this user, is already used in a link to another user in this account, this call will fail. If there is already an open invitation from this SoftLayer user to this or any IBMid, this call will fail. If there is already an open invitation from some other SoftLayer user in this account to this IBMid, then this call will fail.

func (User_Customer_OpenIdConnect) TurnOffMasterUserPermissionCheckMode added in v1.1.2 

func (r User_Customer_OpenIdConnect) TurnOffMasterUserPermissionCheckMode() (err error)

This method allows the master user of an account to undo the designation of this user as an alternate master user. This can not be applied to the true master user of the account.

Note that this method, by itself, WILL NOT affect the IAM Policies granted this user. This API is not intended for general customer use. It is intended to be called by IAM, in concert with other actions taken by IAM when the master user / account owner turns off an "alternate/auxiliary master user / account owner".

func (User_Customer_OpenIdConnect) TurnOnMasterUserPermissionCheckMode added in v1.1.2 

func (r User_Customer_OpenIdConnect) TurnOnMasterUserPermissionCheckMode() (err error)

This method allows the master user of an account to designate this user as an alternate master user. Effectively this means that this user should have "all the same IMS permissions as a master user".

Note that this method, by itself, WILL NOT affect the IAM Policies granted to this user. This API is not intended for general customer use. It is intended to be called by IAM, in concert with other actions taken by IAM when the master user / account owner designates an "alternate/auxiliary master user / account owner".

func (User_Customer_OpenIdConnect) UpdateNotificationSubscriber 

func (r User_Customer_OpenIdConnect) UpdateNotificationSubscriber(notificationKeyName *string, active *int) (resp bool, err error)

Update the active status for a notification that the user is subscribed to. A notification along with an active flag can be supplied to update the active status for a particular notification subscription.

func (User_Customer_OpenIdConnect) UpdateSecurityAnswers 

func (r User_Customer_OpenIdConnect) UpdateSecurityAnswers(questions []datatypes.User_Security_Question, answers []string) (resp bool, err error)

Update a user's login security questions and answers on the SoftLayer customer portal. These questions and answers are used to optionally log into the SoftLayer customer portal using two-factor authentication. Each user must have three distinct questions set with a unique answer for each question, and each answer may only contain alphanumeric or the . , - _ ( ) [ ] : ; > < characters. Existing user security questions and answers are deleted before new ones are set, and users may only update their own security questions and answers.

func (User_Customer_OpenIdConnect) UpdateSubscriberDeliveryMethod 

func (r User_Customer_OpenIdConnect) UpdateSubscriberDeliveryMethod(notificationKeyName *string, deliveryMethodKeyNames []string, active *int) (resp bool, err error)

Update a delivery method for a notification that the user is subscribed to. A delivery method keyName along with an active flag can be supplied to update the active status of the delivery methods for the specified notification. Available delivery methods - 'EMAIL'. Available notifications - 'PLANNED_MAINTENANCE', 'UNPLANNED_INCIDENT'.

func (User_Customer_OpenIdConnect) UpdateVpnPassword 

func (r User_Customer_OpenIdConnect) UpdateVpnPassword(password *string) (resp bool, err error)

Update a user's VPN password on the SoftLayer customer portal. As with portal passwords, VPN passwords must match the following restrictions. VPN passwords must... * ...be over eight characters long. * ...be under twenty characters long. * ...contain at least one uppercase letter * ...contain at least one lowercase letter * ...contain at least one number * ...contain one of the special characters _ - | @ . , ? / ! ~ # $ % ^ & * ( ) { } [ ] \ = * ...not match your username Finally, users can only update their own VPN password. An account's master user can update any of their account users' VPN passwords.

func (User_Customer_OpenIdConnect) UpdateVpnUser 

func (r User_Customer_OpenIdConnect) UpdateVpnUser() (resp bool, err error)

Always call this function to enable changes when manually configuring VPN subnet access.

func (User_Customer_OpenIdConnect) ValidateAuthenticationToken 

func (r User_Customer_OpenIdConnect) ValidateAuthenticationToken(authenticationToken *datatypes.Container_User_Authentication_Token) (resp datatypes.Container_User_Customer_Portal_Token, err error)

This method validate the given authentication token using the user id by comparing it with the actual user authentication token and return [[SoftLayer_Container_User_Customer_Portal_Token]] object

type User_Customer_OpenIdConnect_TrustedProfile added in v1.0.4 

type User_Customer_OpenIdConnect_TrustedProfile struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetUserCustomerOpenIdConnectTrustedProfileService added in v1.0.4 

func GetUserCustomerOpenIdConnectTrustedProfileService(sess session.SLSession) User_Customer_OpenIdConnect_TrustedProfile

GetUserCustomerOpenIdConnectTrustedProfileService returns an instance of the User_Customer_OpenIdConnect_TrustedProfile SoftLayer service

func (User_Customer_OpenIdConnect_TrustedProfile) AcknowledgeSupportPolicy added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) AcknowledgeSupportPolicy() (err error)

no documentation yet

func (User_Customer_OpenIdConnect_TrustedProfile) ActivateOpenIdConnectUser added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) ActivateOpenIdConnectUser(verificationCode *string, userInfo *datatypes.User_Customer, iamId *string) (err error)

Completes invitation process for an OpenIdConnect user created by Bluemix Unified User Console.

func (User_Customer_OpenIdConnect_TrustedProfile) AddApiAuthenticationKey added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) AddApiAuthenticationKey() (resp string, err error)

Create a user's API authentication key, allowing that user access to query the SoftLayer API. addApiAuthenticationKey() returns the user's new API key. Each portal user is allowed only one API key.

func (User_Customer_OpenIdConnect_TrustedProfile) AddBulkDedicatedHostAccess added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) AddBulkDedicatedHostAccess(dedicatedHostIds []int) (resp bool, err error)

Grants the user access to one or more dedicated host devices. The user will only be allowed to see and access devices in both the portal and the API to which they have been granted access. If the user's account has devices to which the user has not been granted access, then "not found" exceptions are thrown if the user attempts to access any of these devices.

Users can assign device access to their child users, but not to themselves. An account's master has access to all devices on their customer account and can set dedicated host access for any of the other users on their account.

func (User_Customer_OpenIdConnect_TrustedProfile) AddBulkHardwareAccess added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) AddBulkHardwareAccess(hardwareIds []int) (resp bool, err error)

Add multiple hardware to a portal user's hardware access list. A user's hardware access list controls which of an account's hardware objects a user has access to in the SoftLayer customer portal and API. Hardware does not exist in the SoftLayer portal and returns "not found" exceptions in the API if the user doesn't have access to it. addBulkHardwareAccess() does not attempt to add hardware access if the given user already has access to that hardware object.

Users can assign hardware access to their child users, but not to themselves. An account's master has access to all hardware on their customer account and can set hardware access for any of the other users on their account.

func (User_Customer_OpenIdConnect_TrustedProfile) AddBulkPortalPermission added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) AddBulkPortalPermission(permissions []datatypes.User_Customer_CustomerPermission_Permission) (resp bool, err error)

Add multiple permissions to a portal user's permission set. [[SoftLayer_User_Customer_CustomerPermission_Permission]] control which features in the SoftLayer customer portal and API a user may use. addBulkPortalPermission() does not attempt to add permissions already assigned to the user.

Users can assign permissions to their child users, but not to themselves. An account's master has all portal permissions and can set permissions for any of the other users on their account.

Use the [[SoftLayer_User_Customer_CustomerPermission_Permission::getAllObjects]] method to retrieve a list of all permissions available in the SoftLayer customer portal and API. Permissions are removed based on the keyName property of the permission objects within the permissions parameter.

func (User_Customer_OpenIdConnect_TrustedProfile) AddBulkRoles added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) AddBulkRoles(roles []datatypes.User_Permission_Role) (err error)

no documentation yet

func (User_Customer_OpenIdConnect_TrustedProfile) AddBulkVirtualGuestAccess added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) AddBulkVirtualGuestAccess(virtualGuestIds []int) (resp bool, err error)

Add multiple CloudLayer Computing Instances to a portal user's access list. A user's CloudLayer Computing Instance access list controls which of an account's CloudLayer Computing Instance objects a user has access to in the SoftLayer customer portal and API. CloudLayer Computing Instances do not exist in the SoftLayer portal and returns "not found" exceptions in the API if the user doesn't have access to it. addBulkVirtualGuestAccess() does not attempt to add CloudLayer Computing Instance access if the given user already has access to that CloudLayer Computing Instance object.

Users can assign CloudLayer Computing Instance access to their child users, but not to themselves. An account's master has access to all CloudLayer Computing Instances on their customer account and can set CloudLayer Computing Instance access for any of the other users on their account.

func (User_Customer_OpenIdConnect_TrustedProfile) AddDedicatedHostAccess added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) AddDedicatedHostAccess(dedicatedHostId *int) (resp bool, err error)

Grants the user access to a single dedicated host device. The user will only be allowed to see and access devices in both the portal and the API to which they have been granted access. If the user's account has devices to which the user has not been granted access, then "not found" exceptions are thrown if the user attempts to access any of these devices.

Users can assign device access to their child users, but not to themselves. An account's master has access to all devices on their customer account and can set dedicated host access for any of the other users on their account.

Only the USER_MANAGE permission is required to execute this.

func (User_Customer_OpenIdConnect_TrustedProfile) AddExternalBinding added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) AddExternalBinding(externalBinding *datatypes.User_External_Binding) (resp datatypes.User_Customer_External_Binding, err error)

no documentation yet

func (User_Customer_OpenIdConnect_TrustedProfile) AddHardwareAccess added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) AddHardwareAccess(hardwareId *int) (resp bool, err error)

Add hardware to a portal user's hardware access list. A user's hardware access list controls which of an account's hardware objects a user has access to in the SoftLayer customer portal and API. Hardware does not exist in the SoftLayer portal and returns "not found" exceptions in the API if the user doesn't have access to it. If a user already has access to the hardware you're attempting to add then addHardwareAccess() returns true.

Users can assign hardware access to their child users, but not to themselves. An account's master has access to all hardware on their customer account and can set hardware access for any of the other users on their account.

Only the USER_MANAGE permission is required to execute this.

func (User_Customer_OpenIdConnect_TrustedProfile) AddNotificationSubscriber added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) AddNotificationSubscriber(notificationKeyName *string) (resp bool, err error)

Create a notification subscription record for the user. If a subscription record exists for the notification, the record will be set to active, if currently inactive.

func (User_Customer_OpenIdConnect_TrustedProfile) AddPortalPermission added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) AddPortalPermission(permission *datatypes.User_Customer_CustomerPermission_Permission) (resp bool, err error)

Add a permission to a portal user's permission set. [[SoftLayer_User_Customer_CustomerPermission_Permission]] control which features in the SoftLayer customer portal and API a user may use. If the user already has the permission you're attempting to add then addPortalPermission() returns true.

Users can assign permissions to their child users, but not to themselves. An account's master has all portal permissions and can set permissions for any of the other users on their account.

Use the [[SoftLayer_User_Customer_CustomerPermission_Permission::getAllObjects]] method to retrieve a list of all permissions available in the SoftLayer customer portal and API. Permissions are added based on the keyName property of the permission parameter.

func (User_Customer_OpenIdConnect_TrustedProfile) AddRole added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) AddRole(role *datatypes.User_Permission_Role) (err error)

no documentation yet

func (User_Customer_OpenIdConnect_TrustedProfile) AddVirtualGuestAccess added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) AddVirtualGuestAccess(virtualGuestId *int) (resp bool, err error)

Add a CloudLayer Computing Instance to a portal user's access list. A user's CloudLayer Computing Instance access list controls which of an account's CloudLayer Computing Instance objects a user has access to in the SoftLayer customer portal and API. CloudLayer Computing Instances do not exist in the SoftLayer portal and returns "not found" exceptions in the API if the user doesn't have access to it. If a user already has access to the CloudLayer Computing Instance you're attempting to add then addVirtualGuestAccess() returns true.

Users can assign CloudLayer Computing Instance access to their child users, but not to themselves. An account's master has access to all CloudLayer Computing Instances on their customer account and can set CloudLayer Computing Instance access for any of the other users on their account.

Only the USER_MANAGE permission is required to execute this.

func (User_Customer_OpenIdConnect_TrustedProfile) AssignNewParentId added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) AssignNewParentId(parentId *int, cascadePermissionsFlag *bool) (resp datatypes.User_Customer, err error)

This method can be used in place of [[SoftLayer_User_Customer::editObject]] to change the parent user of this user.

The new parent must be a user on the same account, and must not be a child of this user. A user is not allowed to change their own parent.

If the cascadeFlag is set to false, then an exception will be thrown if the new parent does not have all of the permissions that this user possesses. If the cascadeFlag is set to true, then permissions will be removed from this user and the descendants of this user as necessary so that no children of the parent will have permissions that the parent does not possess. However, setting the cascadeFlag to true will not remove the access all device permissions from this user. The customer portal will need to be used to remove these permissions.

func (User_Customer_OpenIdConnect_TrustedProfile) ChangePreference added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) ChangePreference(preferenceTypeKeyName *string, value *string) (resp []datatypes.User_Preference, err error)

Select a type of preference you would like to modify using [[SoftLayer_User_Customer::getPreferenceTypes|getPreferenceTypes]] and invoke this method using that preference type key name.

func (User_Customer_OpenIdConnect_TrustedProfile) CompleteInvitationAfterLogin added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) CompleteInvitationAfterLogin(providerType *string, accessToken *string, emailRegistrationCode *string) (err error)

no documentation yet

func (User_Customer_OpenIdConnect_TrustedProfile) CreateNotificationSubscriber added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) CreateNotificationSubscriber(keyName *string, resourceTableId *int) (resp bool, err error)

Create a new subscriber for a given resource.

func (User_Customer_OpenIdConnect_TrustedProfile) CreateObject added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) CreateObject(templateObject *datatypes.User_Customer_OpenIdConnect_TrustedProfile, password *string, vpnPassword *string) (resp datatypes.User_Customer_OpenIdConnect_TrustedProfile, err error)

no documentation yet

func (User_Customer_OpenIdConnect_TrustedProfile) CreateOpenIdConnectUserAndCompleteInvitation added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) CreateOpenIdConnectUserAndCompleteInvitation(providerType *string, user *datatypes.User_Customer, password *string, registrationCode *string) (err error)

no documentation yet

func (User_Customer_OpenIdConnect_TrustedProfile) CreateSubscriberDeliveryMethods added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) CreateSubscriberDeliveryMethods(notificationKeyName *string, deliveryMethodKeyNames []string) (resp bool, err error)

Create delivery methods for a notification that the user is subscribed to. Multiple delivery method keyNames can be supplied to create multiple delivery methods for the specified notification. Available delivery methods - 'EMAIL'. Available notifications - 'PLANNED_MAINTENANCE', 'UNPLANNED_INCIDENT'.

func (User_Customer_OpenIdConnect_TrustedProfile) DeactivateNotificationSubscriber added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) DeactivateNotificationSubscriber(keyName *string, resourceTableId *int) (resp bool, err error)

Create a new subscriber for a given resource.

func (User_Customer_OpenIdConnect_TrustedProfile) DeclineInvitation added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) DeclineInvitation(providerType *string, registrationCode *string) (err error)

Declines an invitation to link an OpenIdConnect identity to a SoftLayer (Atlas) identity and account. Note that this uses a registration code that is likely a one-time-use-only token, so if an invitation has already been processed (accepted or previously declined) it will not be possible to process it a second time.

func (User_Customer_OpenIdConnect_TrustedProfile) EditObject added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) EditObject(templateObject *datatypes.User_Customer) (resp bool, err error)

Account master users and sub-users who have the User Manage permission in the SoftLayer customer portal can update other user's information. Use editObject() if you wish to edit a single user account. Users who do not have the User Manage permission can only update their own information.

func (User_Customer_OpenIdConnect_TrustedProfile) EditObjects added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) EditObjects(templateObjects []datatypes.User_Customer) (resp bool, err error)

Account master users and sub-users who have the User Manage permission in the SoftLayer customer portal can update other user's information. Use editObjects() if you wish to edit multiple users at once. Users who do not have the User Manage permission can only update their own information.

func (User_Customer_OpenIdConnect_TrustedProfile) Filter added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) Filter(filter string) User_Customer_OpenIdConnect_TrustedProfile

func (User_Customer_OpenIdConnect_TrustedProfile) FindUserPreference added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) FindUserPreference(profileName *string, containerKeyname *string, preferenceKeyname *string) (resp []datatypes.Layout_Profile, err error)

no documentation yet

func (User_Customer_OpenIdConnect_TrustedProfile) GetAccount added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetAccount() (resp datatypes.Account, err error)

Retrieve The customer account that a user belongs to.

func (User_Customer_OpenIdConnect_TrustedProfile) GetActions added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetActions() (resp []datatypes.User_Permission_Action, err error)

Retrieve

func (User_Customer_OpenIdConnect_TrustedProfile) GetActiveExternalAuthenticationVendors added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetActiveExternalAuthenticationVendors() (resp []datatypes.Container_User_Customer_External_Binding_Vendor, err error)

The getActiveExternalAuthenticationVendors method will return a list of available external vendors that a SoftLayer user can authenticate against. The list will only contain vendors for which the user has at least one active external binding.

func (User_Customer_OpenIdConnect_TrustedProfile) GetAdditionalEmails added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetAdditionalEmails() (resp []datatypes.User_Customer_AdditionalEmail, err error)

Retrieve A portal user's additional email addresses. These email addresses are contacted when updates are made to support tickets.

func (User_Customer_OpenIdConnect_TrustedProfile) GetAgentImpersonationToken added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetAgentImpersonationToken() (resp string, err error)

no documentation yet

func (User_Customer_OpenIdConnect_TrustedProfile) GetAllowedDedicatedHostIds added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetAllowedDedicatedHostIds() (resp []int, err error)

no documentation yet

func (User_Customer_OpenIdConnect_TrustedProfile) GetAllowedHardwareIds added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetAllowedHardwareIds() (resp []int, err error)

no documentation yet

func (User_Customer_OpenIdConnect_TrustedProfile) GetAllowedVirtualGuestIds added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetAllowedVirtualGuestIds() (resp []int, err error)

no documentation yet

func (User_Customer_OpenIdConnect_TrustedProfile) GetApiAuthenticationKeys added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetApiAuthenticationKeys() (resp []datatypes.User_Customer_ApiAuthentication, err error)

Retrieve A portal user's API Authentication keys. There is a max limit of one API key per user.

func (User_Customer_OpenIdConnect_TrustedProfile) GetAuthenticationToken added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetAuthenticationToken(token *datatypes.Container_User_Authentication_Token) (resp datatypes.Container_User_Authentication_Token, err error)

This method generate user authentication token and return [[SoftLayer_Container_User_Authentication_Token]] object which will be used to authenticate user to login to SoftLayer customer portal.

func (User_Customer_OpenIdConnect_TrustedProfile) GetChildUsers added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetChildUsers() (resp []datatypes.User_Customer, err error)

Retrieve A portal user's child users. Some portal users may not have child users.

func (User_Customer_OpenIdConnect_TrustedProfile) GetClosedTickets added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetClosedTickets() (resp []datatypes.Ticket, err error)

Retrieve An user's associated closed tickets.

func (User_Customer_OpenIdConnect_TrustedProfile) GetDedicatedHosts added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetDedicatedHosts() (resp []datatypes.Virtual_DedicatedHost, err error)

Retrieve The dedicated hosts to which the user has been granted access.

func (User_Customer_OpenIdConnect_TrustedProfile) GetDefaultAccount added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetDefaultAccount(providerType *string) (resp datatypes.Account, err error)

This API gets the account associated with the default user for the OpenIdConnect identity that is linked to the current active SoftLayer user identity. When a single active user is found for that IAMid, it becomes the default user and the associated account is returned. When multiple default users are found only the first is preserved and the associated account is returned (remaining defaults see their default flag unset). If the current SoftLayer user identity isn't linked to any OpenIdConnect identity, or if none of the linked users were found as defaults, the API returns null. Invoke this only on IAMid-authenticated users.

func (User_Customer_OpenIdConnect_TrustedProfile) GetExternalBindings added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetExternalBindings() (resp []datatypes.User_External_Binding, err error)

Retrieve The external authentication bindings that link an external identifier to a SoftLayer user.

func (User_Customer_OpenIdConnect_TrustedProfile) GetHardware added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetHardware() (resp []datatypes.Hardware, err error)

Retrieve A portal user's accessible hardware. These permissions control which hardware a user has access to in the SoftLayer customer portal.

func (User_Customer_OpenIdConnect_TrustedProfile) GetHardwareCount added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetHardwareCount() (resp int, err error)

Retrieve the number of servers that a portal user has access to. Portal users can have restrictions set to limit services for and to perform actions on hardware. You can set these permissions in the portal by clicking the "administrative" then "user admin" links.

func (User_Customer_OpenIdConnect_TrustedProfile) GetHardwareNotifications added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetHardwareNotifications() (resp []datatypes.User_Customer_Notification_Hardware, err error)

Retrieve Hardware notifications associated with this user. A hardware notification links a user to a piece of hardware, and that user will be notified if any monitors on that hardware fail, if the monitors have a status of 'Notify User'.

func (User_Customer_OpenIdConnect_TrustedProfile) GetHasAcknowledgedSupportPolicyFlag added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetHasAcknowledgedSupportPolicyFlag() (resp bool, err error)

Retrieve Whether or not a user has acknowledged the support policy.

func (User_Customer_OpenIdConnect_TrustedProfile) GetHasFullDedicatedHostAccessFlag added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetHasFullDedicatedHostAccessFlag() (resp bool, err error)

Retrieve Permission granting the user access to all Dedicated Host devices on the account.

func (User_Customer_OpenIdConnect_TrustedProfile) GetHasFullHardwareAccessFlag added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetHasFullHardwareAccessFlag() (resp bool, err error)

Retrieve Whether or not a portal user has access to all hardware on their account.

func (User_Customer_OpenIdConnect_TrustedProfile) GetHasFullVirtualGuestAccessFlag added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetHasFullVirtualGuestAccessFlag() (resp bool, err error)

Retrieve Whether or not a portal user has access to all virtual guests on their account. 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetIbmIdLink() (resp datatypes.User_Customer_Link, err error)

Retrieve Specifically relating the Customer instance to an IBMid. A Customer instance may or may not have an IBMid link.

func (User_Customer_OpenIdConnect_TrustedProfile) GetImpersonationToken added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetImpersonationToken() (resp string, err error)

no documentation yet

func (User_Customer_OpenIdConnect_TrustedProfile) GetLayoutProfiles added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetLayoutProfiles() (resp []datatypes.Layout_Profile, err error)

Retrieve Contains the definition of the layout profile.

func (User_Customer_OpenIdConnect_TrustedProfile) GetLocale added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetLocale() (resp datatypes.Locale, err error)

Retrieve A user's locale. Locale holds user's language and region information.

func (User_Customer_OpenIdConnect_TrustedProfile) GetLoginAccountInfoOpenIdConnect added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetLoginAccountInfoOpenIdConnect(providerType *string, accessToken *string) (resp datatypes.Container_User_Customer_OpenIdConnect_LoginAccountInfo, err error)

Validates a supplied OpenIdConnect access token to the SoftLayer customer portal and returns the default account name and id for the active user. An exception will be thrown if no matching customer is found.

func (User_Customer_OpenIdConnect_TrustedProfile) GetLoginAttempts added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetLoginAttempts() (resp []datatypes.User_Customer_Access_Authentication, err error)

Retrieve A user's attempts to log into the SoftLayer customer portal.

func (User_Customer_OpenIdConnect_TrustedProfile) GetLoginToken added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetLoginToken(request *datatypes.Container_Authentication_Request_Contract) (resp datatypes.Container_Authentication_Response_Common, err error)

Attempt to authenticate a user to the SoftLayer customer portal using the provided authentication container. Depending on the specific type of authentication container that is used, this API will leverage the appropriate authentication protocol. If authentication is successful then the API returns a list of linked accounts for the user, a token containing the ID of the authenticated user and a hash key used by the SoftLayer customer portal to maintain authentication.

func (User_Customer_OpenIdConnect_TrustedProfile) GetMappedAccounts added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetMappedAccounts(providerType *string) (resp []datatypes.Account, err error)

An OpenIdConnect identity, for example an IAMid, can be linked or mapped to one or more individual SoftLayer users, but no more than one SoftLayer user per account. This effectively links the OpenIdConnect identity to those accounts. This API returns a list of all active accounts for which there is a link between the OpenIdConnect identity and a SoftLayer user. Invoke this only on IAMid-authenticated users.

func (User_Customer_OpenIdConnect_TrustedProfile) GetNotificationSubscribers added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetNotificationSubscribers() (resp []datatypes.Notification_Subscriber, err error)

Retrieve Notification subscription records for the user.

func (User_Customer_OpenIdConnect_TrustedProfile) GetObject added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetObject() (resp datatypes.User_Customer_OpenIdConnect_TrustedProfile, err error)

no documentation yet

func (User_Customer_OpenIdConnect_TrustedProfile) GetOpenIdConnectMigrationState added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetOpenIdConnectMigrationState() (resp datatypes.Container_User_Customer_OpenIdConnect_MigrationState, err error)

This API returns a SoftLayer_Container_User_Customer_OpenIdConnect_MigrationState object containing the necessary information to determine what migration state the user is in. If the account is not OpenIdConnect authenticated, then an exception is thrown.

func (User_Customer_OpenIdConnect_TrustedProfile) GetOpenIdRegistrationInfoFromCode added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetOpenIdRegistrationInfoFromCode(providerType *string, registrationCode *string) (resp datatypes.Account_Authentication_OpenIdConnect_RegistrationInformation, err error)

no documentation yet

func (User_Customer_OpenIdConnect_TrustedProfile) GetOpenTickets added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetOpenTickets() (resp []datatypes.Ticket, err error)

Retrieve An user's associated open tickets.

func (User_Customer_OpenIdConnect_TrustedProfile) GetOverrides added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetOverrides() (resp []datatypes.Network_Service_Vpn_Overrides, err error)

Retrieve A portal user's vpn accessible subnets.

func (User_Customer_OpenIdConnect_TrustedProfile) GetParent added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetParent() (resp datatypes.User_Customer, err error)

Retrieve A portal user's parent user. If a SoftLayer_User_Customer has a null parentId property then it doesn't have a parent user.

func (User_Customer_OpenIdConnect_TrustedProfile) GetPasswordRequirements added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetPasswordRequirements(isVpn *bool) (resp datatypes.Container_User_Customer_PasswordSet, err error)

no documentation yet

func (User_Customer_OpenIdConnect_TrustedProfile) GetPermissions added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetPermissions() (resp []datatypes.User_Customer_CustomerPermission_Permission, err error)

Retrieve A portal user's permissions. These permissions control that user's access to functions within the SoftLayer customer portal and API.

func (User_Customer_OpenIdConnect_TrustedProfile) GetPortalLoginToken added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetPortalLoginToken(username *string, password *string, securityQuestionId *int, securityQuestionAnswer *string) (resp datatypes.Container_User_Customer_Portal_Token, err error)

Attempt to authenticate a username and password to the SoftLayer customer portal. Many portal user accounts are configured to require answering a security question on login. In this case getPortalLoginToken() also verifies the given security question ID and answer. If authentication is successful then the API returns a token containing the ID of the authenticated user and a hash key used by the SoftLayer customer portal to maintain authentication.

func (User_Customer_OpenIdConnect_TrustedProfile) GetPortalLoginTokenOpenIdConnect added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetPortalLoginTokenOpenIdConnect(providerType *string, accessToken *string, accountId *int, securityQuestionId *int, securityQuestionAnswer *string) (resp datatypes.Container_User_Customer_Portal_Token, err error)

Attempt to authenticate a supplied OpenIdConnect access token to the SoftLayer customer portal. If authentication is successful then the API returns a token containing the ID of the authenticated user and a hash key used by the SoftLayer customer portal to maintain authentication. Deprecated: This function has been marked as deprecated.

func (User_Customer_OpenIdConnect_TrustedProfile) GetPreference added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetPreference(preferenceTypeKeyName *string) (resp datatypes.User_Preference, err error)

Select a type of preference you would like to get using [[SoftLayer_User_Customer::getPreferenceTypes|getPreferenceTypes]] and invoke this method using that preference type key name.

func (User_Customer_OpenIdConnect_TrustedProfile) GetPreferenceTypes added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetPreferenceTypes() (resp []datatypes.User_Preference_Type, err error)

Use any of the preference types to fetch or modify user preferences using [[SoftLayer_User_Customer::getPreference|getPreference]] or [[SoftLayer_User_Customer::changePreference|changePreference]], respectively.

func (User_Customer_OpenIdConnect_TrustedProfile) GetPreferences added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetPreferences() (resp []datatypes.User_Preference, err error)

Retrieve Data type contains a single user preference to a specific preference type.

func (User_Customer_OpenIdConnect_TrustedProfile) GetRequirementsForPasswordSet added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetRequirementsForPasswordSet(passwordSet *datatypes.Container_User_Customer_PasswordSet) (resp datatypes.Container_User_Customer_PasswordSet, err error)

Retrieve the authentication requirements for an outstanding password set/reset request. The requirements returned in the same SoftLayer_Container_User_Customer_PasswordSet container which is provided as a parameter into this request. The SoftLayer_Container_User_Customer_PasswordSet::authenticationMethods array will contain an entry for each authentication method required for the user. See SoftLayer_Container_User_Customer_PasswordSet for more details.

If the user has required authentication methods, then authentication information will be supplied to the SoftLayer_User_Customer::processPasswordSetRequest method within this same SoftLayer_Container_User_Customer_PasswordSet container. All existing information in the container must continue to exist in the container to complete the password set/reset process.

func (User_Customer_OpenIdConnect_TrustedProfile) GetRoles added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetRoles() (resp []datatypes.User_Permission_Role, err error)

Retrieve

func (User_Customer_OpenIdConnect_TrustedProfile) GetSecurityAnswers added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetSecurityAnswers() (resp []datatypes.User_Customer_Security_Answer, err error)

Retrieve A portal user's security question answers. Some portal users may not have security answers or may not be configured to require answering a security question on login.

func (User_Customer_OpenIdConnect_TrustedProfile) GetSubscribers added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetSubscribers() (resp []datatypes.Notification_User_Subscriber, err error)

Retrieve A user's notification subscription records.

func (User_Customer_OpenIdConnect_TrustedProfile) GetSuccessfulLogins added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetSuccessfulLogins() (resp []datatypes.User_Customer_Access_Authentication, err error)

Retrieve A user's successful attempts to log into the SoftLayer customer portal.

func (User_Customer_OpenIdConnect_TrustedProfile) GetSupportPolicyAcknowledgementRequiredFlag added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetSupportPolicyAcknowledgementRequiredFlag() (resp int, err error)

Retrieve Whether or not a user is required to acknowledge the support policy for portal access.

func (User_Customer_OpenIdConnect_TrustedProfile) GetSupportPolicyDocument added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetSupportPolicyDocument() (resp []byte, err error)

no documentation yet

func (User_Customer_OpenIdConnect_TrustedProfile) GetSupportPolicyName added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetSupportPolicyName() (resp string, err error)

no documentation yet

func (User_Customer_OpenIdConnect_TrustedProfile) GetSupportedLocales added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetSupportedLocales() (resp []datatypes.Locale, err error)

no documentation yet

func (User_Customer_OpenIdConnect_TrustedProfile) GetSurveyRequiredFlag added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetSurveyRequiredFlag() (resp bool, err error)

Retrieve Whether or not a user must take a brief survey the next time they log into the SoftLayer customer portal.

func (User_Customer_OpenIdConnect_TrustedProfile) GetSurveys added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetSurveys() (resp []datatypes.Survey, err error)

Retrieve The surveys that a user has taken in the SoftLayer customer portal.

func (User_Customer_OpenIdConnect_TrustedProfile) GetTickets added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetTickets() (resp []datatypes.Ticket, err error)

Retrieve An user's associated tickets.

func (User_Customer_OpenIdConnect_TrustedProfile) GetTimezone added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetTimezone() (resp datatypes.Locale_Timezone, err error)

Retrieve A portal user's time zone.

func (User_Customer_OpenIdConnect_TrustedProfile) GetUnsuccessfulLogins added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetUnsuccessfulLogins() (resp []datatypes.User_Customer_Access_Authentication, err error)

Retrieve A user's unsuccessful attempts to log into the SoftLayer customer portal.

func (User_Customer_OpenIdConnect_TrustedProfile) GetUserForUnifiedInvitation added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetUserForUnifiedInvitation(openIdConnectUserId *string, uniqueIdentifier *string, searchInvitationsNotLinksFlag *string, accountId *string) (resp datatypes.User_Customer_OpenIdConnect, err error)

Returns an IMS User Object from the provided OpenIdConnect User ID or IBMid Unique Identifier for the Account of the active user. Enforces the User Management permissions for the Active User. An exception will be thrown if no matching IMS User is found. NOTE that providing IBMid Unique Identifier is optional, but it will be preferred over OpenIdConnect User ID if provided.

func (User_Customer_OpenIdConnect_TrustedProfile) GetUserIdForPasswordSet added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetUserIdForPasswordSet(key *string) (resp int, err error)

Retrieve a user id using a password token provided to the user in an email generated by the SoftLayer_User_Customer::initiatePortalPasswordChange request. Password recovery keys are valid for 24 hours after they're generated.

When a new user is created or when a user has requested a password change using initiatePortalPasswordChange, they will have received an email that contains a url with a token. That token is used as the parameter for getUserIdForPasswordSet. Once the user id is known, then the SoftLayer_User_Customer object can be retrieved which is necessary to complete the process to set or reset a user's password. 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetUserLinks() (resp []datatypes.User_Customer_Link, err error)

Retrieve User customer link with IBMid and IAMid.

func (User_Customer_OpenIdConnect_TrustedProfile) GetUserPreferences added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetUserPreferences(profileName *string, containerKeyname *string) (resp []datatypes.Layout_Profile, err error)

no documentation yet

func (User_Customer_OpenIdConnect_TrustedProfile) GetUserStatus added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetUserStatus() (resp datatypes.User_Customer_Status, err error)

Retrieve A portal user's status, which controls overall access to the SoftLayer customer portal and VPN access to the private network.

func (User_Customer_OpenIdConnect_TrustedProfile) GetVirtualGuestCount added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetVirtualGuestCount() (resp int, err error)

Retrieve the number of CloudLayer Computing Instances that a portal user has access to. Portal users can have restrictions set to limit services for and to perform actions on CloudLayer Computing Instances. You can set these permissions in the portal by clicking the "administrative" then "user admin" links.

func (User_Customer_OpenIdConnect_TrustedProfile) GetVirtualGuests added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) GetVirtualGuests() (resp []datatypes.Virtual_Guest, err error)

Retrieve A portal user's accessible CloudLayer Computing Instances. These permissions control which CloudLayer Computing Instances a user has access to in the SoftLayer customer portal.

func (User_Customer_OpenIdConnect_TrustedProfile) Id added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) Id(id int) User_Customer_OpenIdConnect_TrustedProfile

func (User_Customer_OpenIdConnect_TrustedProfile) InTerminalStatus added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) InTerminalStatus() (resp bool, err error)

no documentation yet

func (User_Customer_OpenIdConnect_TrustedProfile) InitiatePortalPasswordChange added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) InitiatePortalPasswordChange(username *string) (resp bool, err error)

Sends password change email to the user containing url that allows the user the change their password. This is the first step when a user wishes to change their password. The url that is generated contains a one-time use token that is valid for only 24-hours.

If this is a new master user who has never logged into the portal, then password reset will be initiated. Once a master user has logged into the portal, they must setup their security questions prior to logging out because master users are required to answer a security question during the password reset process. Should a master user not have security questions defined and not remember their password in order to define the security questions, then they will need to contact support at live chat or Revenue Services for assistance.

Due to security reasons, the number of reset requests per username are limited within a undisclosed timeframe.

func (User_Customer_OpenIdConnect_TrustedProfile) InitiatePortalPasswordChangeByBrandAgent added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) InitiatePortalPasswordChangeByBrandAgent(username *string) (resp bool, err error)

A Brand Agent that has permissions to Add Customer Accounts will be able to request the password email be sent to the Master User of a Customer Account created by the same Brand as the agent making the request. Due to security reasons, the number of reset requests are limited within an undisclosed timeframe.

func (User_Customer_OpenIdConnect_TrustedProfile) InviteUserToLinkOpenIdConnect added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) InviteUserToLinkOpenIdConnect(providerType *string) (err error)

Send email invitation to a user to join a SoftLayer account and authenticate with OpenIdConnect. Throws an exception on error.

func (User_Customer_OpenIdConnect_TrustedProfile) IsMasterUser added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) IsMasterUser() (resp bool, err error)

Portal users are considered master users if they don't have an associated parent user. The only users who don't have parent users are users whose username matches their SoftLayer account name. Master users have special permissions throughout the SoftLayer customer portal. Deprecated: This function has been marked as deprecated.

func (User_Customer_OpenIdConnect_TrustedProfile) IsValidPortalPassword added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) IsValidPortalPassword(password *string) (resp bool, err error)

Determine if a string is the given user's login password to the SoftLayer customer portal.

func (User_Customer_OpenIdConnect_TrustedProfile) Limit added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) Limit(limit int) User_Customer_OpenIdConnect_TrustedProfile

func (User_Customer_OpenIdConnect_TrustedProfile) Mask added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) Mask(mask string) User_Customer_OpenIdConnect_TrustedProfile

func (User_Customer_OpenIdConnect_TrustedProfile) Offset added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) Offset(offset int) User_Customer_OpenIdConnect_TrustedProfile

func (User_Customer_OpenIdConnect_TrustedProfile) PerformExternalAuthentication added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) PerformExternalAuthentication(authenticationContainer *datatypes.Container_User_Customer_External_Binding) (resp datatypes.Container_User_Customer_Portal_Token, err error)

The perform external authentication method will authenticate the given external authentication container with an external vendor. The authentication container and its contents will be verified before an attempt is made to authenticate the contents of the container with an external vendor.

func (User_Customer_OpenIdConnect_TrustedProfile) ProcessPasswordSetRequest added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) ProcessPasswordSetRequest(passwordSet *datatypes.Container_User_Customer_PasswordSet, authenticationContainer *datatypes.Container_User_Customer_External_Binding) (resp bool, err error)

Set the password for a user who has an outstanding password request. A user with an outstanding password request will have an unused and unexpired password key. The password key is part of the url provided to the user in the email sent to the user with information on how to set their password. The email was generated by the SoftLayer_User_Customer::initiatePortalPasswordRequest request. Password recovery keys are valid for 24 hours after they're generated.

If the user has required authentication methods as specified by in the SoftLayer_Container_User_Customer_PasswordSet container returned from the SoftLayer_User_Customer::getRequirementsForPasswordSet request, then additional requests must be made to processPasswordSetRequest to authenticate the user before changing the password. First, if the user has security questions set on their profile, they will be required to answer one of their questions correctly. Next, if the user has Verisign or Google Authentication on their account, they must authenticate according to the two-factor provider. All of this authentication is done using the SoftLayer_Container_User_Customer_PasswordSet container.

User portal passwords must match the following restrictions. Portal passwords must... * ...be over eight characters long. * ...be under twenty characters long. * ...contain at least one uppercase letter * ...contain at least one lowercase letter * ...contain at least one number * ...contain one of the special characters _ - | @ . , ? / ! ~ # $ % ^ & * ( ) { } [ ] \ + = * ...not match your username

func (User_Customer_OpenIdConnect_TrustedProfile) RemoveAllDedicatedHostAccessForThisUser added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) RemoveAllDedicatedHostAccessForThisUser() (resp bool, err error)

Revoke access to all dedicated hosts on the account for this user. The user will only be allowed to see and access devices in both the portal and the API to which they have been granted access. If the user's account has devices to which the user has not been granted access or the access has been revoked, then "not found" exceptions are thrown if the user attempts to access any of these devices. If the current user does not have administrative privileges over this user, an inadequate permissions exception will get thrown.

Users can call this function on child users, but not to themselves. An account's master has access to all users permissions on their account.

func (User_Customer_OpenIdConnect_TrustedProfile) RemoveAllHardwareAccessForThisUser added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) RemoveAllHardwareAccessForThisUser() (resp bool, err error)

Remove all hardware from a portal user's hardware access list. A user's hardware access list controls which of an account's hardware objects a user has access to in the SoftLayer customer portal and API. If the current user does not have administrative privileges over this user, an inadequate permissions exception will get thrown.

Users can call this function on child users, but not to themselves. An account's master has access to all users permissions on their account.

func (User_Customer_OpenIdConnect_TrustedProfile) RemoveAllVirtualAccessForThisUser added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) RemoveAllVirtualAccessForThisUser() (resp bool, err error)

Remove all cloud computing instances from a portal user's instance access list. A user's instance access list controls which of an account's computing instance objects a user has access to in the SoftLayer customer portal and API. If the current user does not have administrative privileges over this user, an inadequate permissions exception will get thrown.

Users can call this function on child users, but not to themselves. An account's master has access to all users permissions on their account.

func (User_Customer_OpenIdConnect_TrustedProfile) RemoveApiAuthenticationKey added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) RemoveApiAuthenticationKey(keyId *int) (resp bool, err error)

Remove a user's API authentication key, removing that user's access to query the SoftLayer API.

func (User_Customer_OpenIdConnect_TrustedProfile) RemoveBulkDedicatedHostAccess added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) RemoveBulkDedicatedHostAccess(dedicatedHostIds []int) (resp bool, err error)

Revokes access for the user to one or more dedicated host devices. The user will only be allowed to see and access devices in both the portal and the API to which they have been granted access. If the user's account has devices to which the user has not been granted access or the access has been revoked, then "not found" exceptions are thrown if the user attempts to access any of these devices.

Users can assign device access to their child users, but not to themselves. An account's master has access to all devices on their customer account and can set dedicated host access for any of the other users on their account.

If the user has full dedicatedHost access, then it will provide access to "ALL but passed in" dedicatedHost ids.

func (User_Customer_OpenIdConnect_TrustedProfile) RemoveBulkHardwareAccess added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) RemoveBulkHardwareAccess(hardwareIds []int) (resp bool, err error)

Remove multiple hardware from a portal user's hardware access list. A user's hardware access list controls which of an account's hardware objects a user has access to in the SoftLayer customer portal and API. Hardware does not exist in the SoftLayer portal and returns "not found" exceptions in the API if the user doesn't have access to it. If a user does not has access to the hardware you're attempting to remove then removeBulkHardwareAccess() returns true.

Users can assign hardware access to their child users, but not to themselves. An account's master has access to all hardware on their customer account and can set hardware access for any of the other users on their account.

If the user has full hardware access, then it will provide access to "ALL but passed in" hardware ids.

func (User_Customer_OpenIdConnect_TrustedProfile) RemoveBulkPortalPermission added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) RemoveBulkPortalPermission(permissions []datatypes.User_Customer_CustomerPermission_Permission, cascadePermissionsFlag *bool) (resp bool, err error)

Remove (revoke) multiple permissions from a portal user's permission set. [[SoftLayer_User_Customer_CustomerPermission_Permission]] control which features in the SoftLayer customer portal and API a user may use. Removing a user's permission will affect that user's portal and API access. removePortalPermission() does not attempt to remove permissions that are not assigned to the user.

Users can grant or revoke permissions to their child users, but not to themselves. An account's master has all portal permissions and can grant permissions for any of the other users on their account.

If the cascadePermissionsFlag is set to true, then removing the permissions from a user will cascade down the child hierarchy and remove the permissions from this user along with all child users who also have the permission.

If the cascadePermissionsFlag is not provided or is set to false and the user has children users who have the permission, then an exception will be thrown, and the permission will not be removed from this user.

Use the [[SoftLayer_User_Customer_CustomerPermission_Permission::getAllObjects]] method to retrieve a list of all permissions available in the SoftLayer customer portal and API. Permissions are removed based on the keyName property of the permission objects within the permissions parameter.

func (User_Customer_OpenIdConnect_TrustedProfile) RemoveBulkRoles added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) RemoveBulkRoles(roles []datatypes.User_Permission_Role) (err error)

no documentation yet

func (User_Customer_OpenIdConnect_TrustedProfile) RemoveBulkVirtualGuestAccess added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) RemoveBulkVirtualGuestAccess(virtualGuestIds []int) (resp bool, err error)

Remove multiple CloudLayer Computing Instances from a portal user's access list. A user's CloudLayer Computing Instance access list controls which of an account's CloudLayer Computing Instance objects a user has access to in the SoftLayer customer portal and API. CloudLayer Computing Instances do not exist in the SoftLayer portal and returns "not found" exceptions in the API if the user doesn't have access to it. If a user does not has access to the CloudLayer Computing Instance you're attempting remove add then removeBulkVirtualGuestAccess() returns true.

Users can assign CloudLayer Computing Instance access to their child users, but not to themselves. An account's master has access to all CloudLayer Computing Instances on their customer account and can set hardware access for any of the other users on their account.

func (User_Customer_OpenIdConnect_TrustedProfile) RemoveDedicatedHostAccess added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) RemoveDedicatedHostAccess(dedicatedHostId *int) (resp bool, err error)

Revokes access for the user to a single dedicated host device. The user will only be allowed to see and access devices in both the portal and the API to which they have been granted access. If the user's account has devices to which the user has not been granted access or the access has been revoked, then "not found" exceptions are thrown if the user attempts to access any of these devices.

Users can assign device access to their child users, but not to themselves. An account's master has access to all devices on their customer account and can set dedicated host access for any of the other users on their account.

func (User_Customer_OpenIdConnect_TrustedProfile) RemoveExternalBinding added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) RemoveExternalBinding(externalBinding *datatypes.User_External_Binding) (resp bool, err error)

no documentation yet

func (User_Customer_OpenIdConnect_TrustedProfile) RemoveHardwareAccess added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) RemoveHardwareAccess(hardwareId *int) (resp bool, err error)

Remove hardware from a portal user's hardware access list. A user's hardware access list controls which of an account's hardware objects a user has access to in the SoftLayer customer portal and API. Hardware does not exist in the SoftLayer portal and returns "not found" exceptions in the API if the user doesn't have access to it. If a user does not has access to the hardware you're attempting remove add then removeHardwareAccess() returns true.

Users can assign hardware access to their child users, but not to themselves. An account's master has access to all hardware on their customer account and can set hardware access for any of the other users on their account.

func (User_Customer_OpenIdConnect_TrustedProfile) RemovePortalPermission added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) RemovePortalPermission(permission *datatypes.User_Customer_CustomerPermission_Permission, cascadePermissionsFlag *bool) (resp bool, err error)

Remove (revoke) a permission from a portal user's permission set. [[SoftLayer_User_Customer_CustomerPermission_Permission]] control which features in the SoftLayer customer portal and API a user may use. Removing a user's permission will affect that user's portal and API access. If the user does not have the permission you're attempting to remove then removePortalPermission() returns true.

Users can assign permissions to their child users, but not to themselves. An account's master has all portal permissions and can set permissions for any of the other users on their account.

If the cascadePermissionsFlag is set to true, then removing the permission from a user will cascade down the child hierarchy and remove the permission from this user and all child users who also have the permission.

If the cascadePermissionsFlag is not set or is set to false and the user has children users who have the permission, then an exception will be thrown, and the permission will not be removed from this user.

Use the [[SoftLayer_User_Customer_CustomerPermission_Permission::getAllObjects]] method to retrieve a list of all permissions available in the SoftLayer customer portal and API. Permissions are removed based on the keyName property of the permission parameter.

func (User_Customer_OpenIdConnect_TrustedProfile) RemoveRole added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) RemoveRole(role *datatypes.User_Permission_Role) (err error)

no documentation yet

func (User_Customer_OpenIdConnect_TrustedProfile) RemoveSecurityAnswers added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) RemoveSecurityAnswers() (resp bool, err error)

no documentation yet

func (User_Customer_OpenIdConnect_TrustedProfile) RemoveVirtualGuestAccess added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) RemoveVirtualGuestAccess(virtualGuestId *int) (resp bool, err error)

Remove a CloudLayer Computing Instance from a portal user's access list. A user's CloudLayer Computing Instance access list controls which of an account's computing instances a user has access to in the SoftLayer customer portal and API. CloudLayer Computing Instances do not exist in the SoftLayer portal and returns "not found" exceptions in the API if the user doesn't have access to it. If a user does not has access to the CloudLayer Computing Instance you're attempting remove add then removeVirtualGuestAccess() returns true.

Users can assign CloudLayer Computing Instance access to their child users, but not to themselves. An account's master has access to all CloudLayer Computing Instances on their customer account and can set instance access for any of the other users on their account. 

func (r User_Customer_OpenIdConnect_TrustedProfile) ResetOpenIdConnectLink(providerType *string, newIbmIdUsername *string, removeSecuritySettings *bool) (err error)

This method will change the IBMid that a SoftLayer user is linked to, if we need to do that for some reason. It will do this by modifying the link to the desired new IBMid. NOTE: This method cannot be used to "un-link" a SoftLayer user. Once linked, a SoftLayer user can never be un-linked. Also, this method cannot be used to reset the link if the user account is already Bluemix linked. To reset a link for the Bluemix-linked user account, use resetOpenIdConnectLinkUnifiedUserManagementMode.

func (User_Customer_OpenIdConnect_TrustedProfile) ResetOpenIdConnectLinkUnifiedUserManagementMode added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) ResetOpenIdConnectLinkUnifiedUserManagementMode(providerType *string, newIbmIdUsername *string, removeSecuritySettings *bool) (err error)

This method will change the IBMid that a SoftLayer master user is linked to, if we need to do that for some reason. It will do this by unlinking the new owner IBMid from its current user association in this account, if there is one (note that the new owner IBMid is not required to already be a member of the IMS account). Then it will modify the existing IBMid link for the master user to use the new owner IBMid-realm IAMid. At this point, if the new owner IBMid isn't already a member of the PaaS account, it will attempt to add it. As a last step, it will call PaaS to modify the owner on that side, if necessary. Only when all those steps are complete, it will commit the IMS-side DB changes. Then, it will clean up the SoftLayer user that was linked to the new owner IBMid (this user became unlinked as the first step in this process). It will also call BSS to delete the old owner IBMid. NOTE: This method cannot be used to "un-link" a SoftLayer user. Once linked, a SoftLayer user can never be un-linked. Also, this method cannot be used to reset the link if the user account is not Bluemix linked. To reset a link for the user account not linked to Bluemix, use resetOpenIdConnectLink.

func (User_Customer_OpenIdConnect_TrustedProfile) SamlAuthenticate added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) SamlAuthenticate(accountId *string, samlResponse *string) (resp datatypes.Container_User_Customer_Portal_Token, err error)

no documentation yet

func (User_Customer_OpenIdConnect_TrustedProfile) SamlBeginAuthentication added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) SamlBeginAuthentication(accountId *int) (resp string, err error)

no documentation yet

func (User_Customer_OpenIdConnect_TrustedProfile) SamlBeginLogout added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) SamlBeginLogout() (resp string, err error)

no documentation yet

func (User_Customer_OpenIdConnect_TrustedProfile) SamlLogout added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) SamlLogout(samlResponse *string) (err error)

no documentation yet

func (User_Customer_OpenIdConnect_TrustedProfile) SelfPasswordChange added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) SelfPasswordChange(currentPassword *string, newPassword *string) (err error)

no documentation yet

func (User_Customer_OpenIdConnect_TrustedProfile) SetDefaultAccount added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) SetDefaultAccount(providerType *string, accountId *int) (resp datatypes.Account, err error)

An OpenIdConnect identity, for example an IAMid, can be linked or mapped to one or more individual SoftLayer users, but no more than one per account. If an OpenIdConnect identity is mapped to multiple accounts in this manner, one such account should be identified as the default account for that identity. Invoke this only on IBMid-authenticated users.

func (User_Customer_OpenIdConnect_TrustedProfile) SilentlyMigrateUserOpenIdConnect added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) SilentlyMigrateUserOpenIdConnect(providerType *string) (resp bool, err error)

As master user, calling this api for the IBMid provider type when there is an existing IBMid for the email on the SL account will silently (without sending an invitation email) create a link for the IBMid. NOTE: If the SoftLayer user is already linked to IBMid, this call will fail. If the IBMid specified by the email of this user, is already used in a link to another user in this account, this call will fail. If there is already an open invitation from this SoftLayer user to this or any IBMid, this call will fail. If there is already an open invitation from some other SoftLayer user in this account to this IBMid, then this call will fail.

func (User_Customer_OpenIdConnect_TrustedProfile) TurnOffMasterUserPermissionCheckMode added in v1.1.2 

func (r User_Customer_OpenIdConnect_TrustedProfile) TurnOffMasterUserPermissionCheckMode() (err error)

This method allows the master user of an account to undo the designation of this user as an alternate master user. This can not be applied to the true master user of the account.

Note that this method, by itself, WILL NOT affect the IAM Policies granted this user. This API is not intended for general customer use. It is intended to be called by IAM, in concert with other actions taken by IAM when the master user / account owner turns off an "alternate/auxiliary master user / account owner".

func (User_Customer_OpenIdConnect_TrustedProfile) TurnOnMasterUserPermissionCheckMode added in v1.1.2 

func (r User_Customer_OpenIdConnect_TrustedProfile) TurnOnMasterUserPermissionCheckMode() (err error)

This method allows the master user of an account to designate this user as an alternate master user. Effectively this means that this user should have "all the same IMS permissions as a master user".

Note that this method, by itself, WILL NOT affect the IAM Policies granted to this user. This API is not intended for general customer use. It is intended to be called by IAM, in concert with other actions taken by IAM when the master user / account owner designates an "alternate/auxiliary master user / account owner".

func (User_Customer_OpenIdConnect_TrustedProfile) UpdateNotificationSubscriber added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) UpdateNotificationSubscriber(notificationKeyName *string, active *int) (resp bool, err error)

Update the active status for a notification that the user is subscribed to. A notification along with an active flag can be supplied to update the active status for a particular notification subscription.

func (User_Customer_OpenIdConnect_TrustedProfile) UpdateSecurityAnswers added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) UpdateSecurityAnswers(questions []datatypes.User_Security_Question, answers []string) (resp bool, err error)

Update a user's login security questions and answers on the SoftLayer customer portal. These questions and answers are used to optionally log into the SoftLayer customer portal using two-factor authentication. Each user must have three distinct questions set with a unique answer for each question, and each answer may only contain alphanumeric or the . , - _ ( ) [ ] : ; > < characters. Existing user security questions and answers are deleted before new ones are set, and users may only update their own security questions and answers.

func (User_Customer_OpenIdConnect_TrustedProfile) UpdateSubscriberDeliveryMethod added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) UpdateSubscriberDeliveryMethod(notificationKeyName *string, deliveryMethodKeyNames []string, active *int) (resp bool, err error)

Update a delivery method for a notification that the user is subscribed to. A delivery method keyName along with an active flag can be supplied to update the active status of the delivery methods for the specified notification. Available delivery methods - 'EMAIL'. Available notifications - 'PLANNED_MAINTENANCE', 'UNPLANNED_INCIDENT'.

func (User_Customer_OpenIdConnect_TrustedProfile) UpdateVpnPassword added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) UpdateVpnPassword(password *string) (resp bool, err error)

Update a user's VPN password on the SoftLayer customer portal. As with portal passwords, VPN passwords must match the following restrictions. VPN passwords must... * ...be over eight characters long. * ...be under twenty characters long. * ...contain at least one uppercase letter * ...contain at least one lowercase letter * ...contain at least one number * ...contain one of the special characters _ - | @ . , ? / ! ~ # $ % ^ & * ( ) { } [ ] \ = * ...not match your username Finally, users can only update their own VPN password. An account's master user can update any of their account users' VPN passwords.

func (User_Customer_OpenIdConnect_TrustedProfile) UpdateVpnUser added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) UpdateVpnUser() (resp bool, err error)

Always call this function to enable changes when manually configuring VPN subnet access.

func (User_Customer_OpenIdConnect_TrustedProfile) ValidateAuthenticationToken added in v1.0.4 

func (r User_Customer_OpenIdConnect_TrustedProfile) ValidateAuthenticationToken(authenticationToken *datatypes.Container_User_Authentication_Token) (resp datatypes.Container_User_Customer_Portal_Token, err error)

This method validate the given authentication token using the user id by comparing it with the actual user authentication token and return [[SoftLayer_Container_User_Customer_Portal_Token]] object

type User_Customer_Profile_Event_HyperWarp 

type User_Customer_Profile_Event_HyperWarp struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetUserCustomerProfileEventHyperWarpService 

func GetUserCustomerProfileEventHyperWarpService(sess session.SLSession) User_Customer_Profile_Event_HyperWarp

GetUserCustomerProfileEventHyperWarpService returns an instance of the User_Customer_Profile_Event_HyperWarp SoftLayer service

func (User_Customer_Profile_Event_HyperWarp) Filter 

func (r User_Customer_Profile_Event_HyperWarp) Filter(filter string) User_Customer_Profile_Event_HyperWarp

func (User_Customer_Profile_Event_HyperWarp) Id 

func (r User_Customer_Profile_Event_HyperWarp) Id(id int) User_Customer_Profile_Event_HyperWarp

func (User_Customer_Profile_Event_HyperWarp) Limit 

func (r User_Customer_Profile_Event_HyperWarp) Limit(limit int) User_Customer_Profile_Event_HyperWarp

func (User_Customer_Profile_Event_HyperWarp) Mask 

func (r User_Customer_Profile_Event_HyperWarp) Mask(mask string) User_Customer_Profile_Event_HyperWarp

func (User_Customer_Profile_Event_HyperWarp) Offset 

func (r User_Customer_Profile_Event_HyperWarp) Offset(offset int) User_Customer_Profile_Event_HyperWarp

func (User_Customer_Profile_Event_HyperWarp) ReceiveEventDirect 

func (r User_Customer_Profile_Event_HyperWarp) ReceiveEventDirect(eventJson *datatypes.Container_User_Customer_Profile_Event_HyperWarp_ProfileChange) (resp bool, err error)

no documentation yet

type User_Customer_Prospect_ServiceProvider_EnrollRequest 

type User_Customer_Prospect_ServiceProvider_EnrollRequest struct {
	Session session.SLSession
	Options sl.Options
}

Contains user information for Service Provider Enrollment.

func GetUserCustomerProspectServiceProviderEnrollRequestService 

func GetUserCustomerProspectServiceProviderEnrollRequestService(sess session.SLSession) User_Customer_Prospect_ServiceProvider_EnrollRequest

GetUserCustomerProspectServiceProviderEnrollRequestService returns an instance of the User_Customer_Prospect_ServiceProvider_EnrollRequest SoftLayer service

func (User_Customer_Prospect_ServiceProvider_EnrollRequest) Enroll 

func (r User_Customer_Prospect_ServiceProvider_EnrollRequest) Enroll(templateObject *datatypes.User_Customer_Prospect_ServiceProvider_EnrollRequest) (resp datatypes.User_Customer_Prospect_ServiceProvider_EnrollRequest, err error)

Create a new Service Provider Enrollment

func (User_Customer_Prospect_ServiceProvider_EnrollRequest) Filter 

func (r User_Customer_Prospect_ServiceProvider_EnrollRequest) Filter(filter string) User_Customer_Prospect_ServiceProvider_EnrollRequest

func (User_Customer_Prospect_ServiceProvider_EnrollRequest) GetCompanyType 

func (r User_Customer_Prospect_ServiceProvider_EnrollRequest) GetCompanyType() (resp datatypes.Catalyst_Company_Type, err error)

Retrieve Catalyst company types.

func (User_Customer_Prospect_ServiceProvider_EnrollRequest) GetObject 

func (r User_Customer_Prospect_ServiceProvider_EnrollRequest) GetObject() (resp datatypes.User_Customer_Prospect_ServiceProvider_EnrollRequest, err error)

no documentation yet

func (User_Customer_Prospect_ServiceProvider_EnrollRequest) Id 

func (r User_Customer_Prospect_ServiceProvider_EnrollRequest) Id(id int) User_Customer_Prospect_ServiceProvider_EnrollRequest

func (User_Customer_Prospect_ServiceProvider_EnrollRequest) Limit 

func (r User_Customer_Prospect_ServiceProvider_EnrollRequest) Limit(limit int) User_Customer_Prospect_ServiceProvider_EnrollRequest

func (User_Customer_Prospect_ServiceProvider_EnrollRequest) Mask 

func (r User_Customer_Prospect_ServiceProvider_EnrollRequest) Mask(mask string) User_Customer_Prospect_ServiceProvider_EnrollRequest

func (User_Customer_Prospect_ServiceProvider_EnrollRequest) Offset 

func (r User_Customer_Prospect_ServiceProvider_EnrollRequest) Offset(offset int) User_Customer_Prospect_ServiceProvider_EnrollRequest

type User_Customer_Security_Answer 

type User_Customer_Security_Answer struct {
	Session session.SLSession
	Options sl.Options
}

The SoftLayer_User_Customer_Security_Answer type contains user's answers to security questions.

func GetUserCustomerSecurityAnswerService 

func GetUserCustomerSecurityAnswerService(sess session.SLSession) User_Customer_Security_Answer

GetUserCustomerSecurityAnswerService returns an instance of the User_Customer_Security_Answer SoftLayer service

func (User_Customer_Security_Answer) Filter 

func (r User_Customer_Security_Answer) Filter(filter string) User_Customer_Security_Answer

func (User_Customer_Security_Answer) GetObject 

func (r User_Customer_Security_Answer) GetObject() (resp datatypes.User_Customer_Security_Answer, err error)

getObject retrieves the SoftLayer_User_Customer_Security_Answer object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_User_Customer_Security_Answer service.

func (User_Customer_Security_Answer) GetQuestion 

func (r User_Customer_Security_Answer) GetQuestion() (resp datatypes.User_Security_Question, err error)

Retrieve The question the security answer is associated with.

func (User_Customer_Security_Answer) GetUser 

func (r User_Customer_Security_Answer) GetUser() (resp datatypes.User_Customer, err error)

Retrieve The user who the security answer belongs to.

func (User_Customer_Security_Answer) Id 

func (r User_Customer_Security_Answer) Id(id int) User_Customer_Security_Answer

func (User_Customer_Security_Answer) Limit 

func (r User_Customer_Security_Answer) Limit(limit int) User_Customer_Security_Answer

func (User_Customer_Security_Answer) Mask 

func (r User_Customer_Security_Answer) Mask(mask string) User_Customer_Security_Answer

func (User_Customer_Security_Answer) Offset 

func (r User_Customer_Security_Answer) Offset(offset int) User_Customer_Security_Answer

type User_Customer_Status 

type User_Customer_Status struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetUserCustomerStatusService 

func GetUserCustomerStatusService(sess session.SLSession) User_Customer_Status

GetUserCustomerStatusService returns an instance of the User_Customer_Status SoftLayer service

func (User_Customer_Status) Filter 

func (r User_Customer_Status) Filter(filter string) User_Customer_Status

func (User_Customer_Status) GetAllObjects 

func (r User_Customer_Status) GetAllObjects() (resp []datatypes.User_Customer_Status, err error)

Retrieve all user status objects.

func (User_Customer_Status) GetObject 

func (r User_Customer_Status) GetObject() (resp datatypes.User_Customer_Status, err error)

getObject retrieves the SoftLayer_User_Customer_Status object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_User_Customer_Status service.

func (User_Customer_Status) Id 

func (r User_Customer_Status) Id(id int) User_Customer_Status

func (User_Customer_Status) Limit 

func (r User_Customer_Status) Limit(limit int) User_Customer_Status

func (User_Customer_Status) Mask 

func (r User_Customer_Status) Mask(mask string) User_Customer_Status

func (User_Customer_Status) Offset 

func (r User_Customer_Status) Offset(offset int) User_Customer_Status

type User_External_Binding 

type User_External_Binding struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetUserExternalBindingService 

func GetUserExternalBindingService(sess session.SLSession) User_External_Binding

GetUserExternalBindingService returns an instance of the User_External_Binding SoftLayer service

func (User_External_Binding) DeleteObject 

func (r User_External_Binding) DeleteObject() (resp bool, err error)

Delete an external authentication binding. If the external binding currently has an active billing item associated you will be prevented from deleting the binding. The alternative method to remove an external authentication binding is to use the service cancellation form.

func (User_External_Binding) Filter 

func (r User_External_Binding) Filter(filter string) User_External_Binding

func (User_External_Binding) GetAttributes 

func (r User_External_Binding) GetAttributes() (resp []datatypes.User_External_Binding_Attribute, err error)

Retrieve Attributes of an external authentication binding.

func (User_External_Binding) GetBillingItem 

func (r User_External_Binding) GetBillingItem() (resp datatypes.Billing_Item, err error)

Retrieve Information regarding the billing item for external authentication.

func (User_External_Binding) GetNote 

func (r User_External_Binding) GetNote() (resp string, err error)

Retrieve An optional note for identifying the external binding.

func (User_External_Binding) GetObject 

func (r User_External_Binding) GetObject() (resp datatypes.User_External_Binding, err error)

no documentation yet

func (User_External_Binding) GetType 

func (r User_External_Binding) GetType() (resp datatypes.User_External_Binding_Type, err error)

Retrieve The type of external authentication binding.

func (User_External_Binding) GetVendor 

func (r User_External_Binding) GetVendor() (resp datatypes.User_External_Binding_Vendor, err error)

Retrieve The vendor of an external authentication binding.

func (User_External_Binding) Id 

func (r User_External_Binding) Id(id int) User_External_Binding

func (User_External_Binding) Limit 

func (r User_External_Binding) Limit(limit int) User_External_Binding

func (User_External_Binding) Mask 

func (r User_External_Binding) Mask(mask string) User_External_Binding

func (User_External_Binding) Offset 

func (r User_External_Binding) Offset(offset int) User_External_Binding

func (User_External_Binding) UpdateNote 

func (r User_External_Binding) UpdateNote(text *string) (resp bool, err error)

Update the note of an external binding. The note is an optional property that is used to store information about a binding.

type User_External_Binding_Vendor 

type User_External_Binding_Vendor struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetUserExternalBindingVendorService 

func GetUserExternalBindingVendorService(sess session.SLSession) User_External_Binding_Vendor

GetUserExternalBindingVendorService returns an instance of the User_External_Binding_Vendor SoftLayer service

func (User_External_Binding_Vendor) Filter 

func (r User_External_Binding_Vendor) Filter(filter string) User_External_Binding_Vendor

func (User_External_Binding_Vendor) GetAllObjects 

func (r User_External_Binding_Vendor) GetAllObjects() (resp []datatypes.User_External_Binding_Vendor, err error)

getAllObjects() will return a list of the available external binding vendors that SoftLayer supports. Use this list to select the appropriate vendor when creating a new external binding.

func (User_External_Binding_Vendor) GetObject 

func (r User_External_Binding_Vendor) GetObject() (resp datatypes.User_External_Binding_Vendor, err error)

no documentation yet

func (User_External_Binding_Vendor) Id 

func (r User_External_Binding_Vendor) Id(id int) User_External_Binding_Vendor

func (User_External_Binding_Vendor) Limit 

func (r User_External_Binding_Vendor) Limit(limit int) User_External_Binding_Vendor

func (User_External_Binding_Vendor) Mask 

func (r User_External_Binding_Vendor) Mask(mask string) User_External_Binding_Vendor

func (User_External_Binding_Vendor) Offset 

func (r User_External_Binding_Vendor) Offset(offset int) User_External_Binding_Vendor

type User_Permission_Action 

type User_Permission_Action struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetUserPermissionActionService 

func GetUserPermissionActionService(sess session.SLSession) User_Permission_Action

GetUserPermissionActionService returns an instance of the User_Permission_Action SoftLayer service

func (User_Permission_Action) Filter 

func (r User_Permission_Action) Filter(filter string) User_Permission_Action

func (User_Permission_Action) GetAllObjects 

func (r User_Permission_Action) GetAllObjects() (resp []datatypes.User_Permission_Action, err error)

Object filters and result limits are enabled on this method.

func (User_Permission_Action) GetDepartment added in v1.1.5 

func (r User_Permission_Action) GetDepartment() (resp datatypes.User_Permission_Department, err error)

Retrieve

func (User_Permission_Action) GetObject 

func (r User_Permission_Action) GetObject() (resp datatypes.User_Permission_Action, err error)

no documentation yet

func (User_Permission_Action) Id 

func (r User_Permission_Action) Id(id int) User_Permission_Action

func (User_Permission_Action) Limit 

func (r User_Permission_Action) Limit(limit int) User_Permission_Action

func (User_Permission_Action) Mask 

func (r User_Permission_Action) Mask(mask string) User_Permission_Action

func (User_Permission_Action) Offset 

func (r User_Permission_Action) Offset(offset int) User_Permission_Action

type User_Permission_Department added in v1.1.5 

type User_Permission_Department struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetUserPermissionDepartmentService added in v1.1.5 

func GetUserPermissionDepartmentService(sess session.SLSession) User_Permission_Department

GetUserPermissionDepartmentService returns an instance of the User_Permission_Department SoftLayer service

func (User_Permission_Department) Filter added in v1.1.5 

func (r User_Permission_Department) Filter(filter string) User_Permission_Department

func (User_Permission_Department) GetAllObjects added in v1.1.5 

func (r User_Permission_Department) GetAllObjects() (resp []datatypes.User_Permission_Department, err error)

no documentation yet

func (User_Permission_Department) GetObject added in v1.1.5 

func (r User_Permission_Department) GetObject() (resp datatypes.User_Permission_Department, err error)

no documentation yet

func (User_Permission_Department) GetPermissions added in v1.1.5 

func (r User_Permission_Department) GetPermissions() (resp []datatypes.User_Permission_Action, err error)

Retrieve

func (User_Permission_Department) Id added in v1.1.5 

func (r User_Permission_Department) Id(id int) User_Permission_Department

func (User_Permission_Department) Limit added in v1.1.5 

func (r User_Permission_Department) Limit(limit int) User_Permission_Department

func (User_Permission_Department) Mask added in v1.1.5 

func (r User_Permission_Department) Mask(mask string) User_Permission_Department

func (User_Permission_Department) Offset added in v1.1.5 

func (r User_Permission_Department) Offset(offset int) User_Permission_Department

type User_Permission_Group 

type User_Permission_Group struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetUserPermissionGroupService 

func GetUserPermissionGroupService(sess session.SLSession) User_Permission_Group

GetUserPermissionGroupService returns an instance of the User_Permission_Group SoftLayer service

func (User_Permission_Group) AddAction 

func (r User_Permission_Group) AddAction(action *datatypes.User_Permission_Action) (err error)

Assigns a SoftLayer_User_Permission_Action object to the group.

func (User_Permission_Group) AddBulkActions 

func (r User_Permission_Group) AddBulkActions(actions []datatypes.User_Permission_Action) (err error)

Assigns multiple SoftLayer_User_Permission_Action objects to the group.

func (User_Permission_Group) AddBulkResourceObjects 

func (r User_Permission_Group) AddBulkResourceObjects(resourceObjects []datatypes.Entity, resourceTypeKeyName *string) (resp bool, err error)

Links multiple SoftLayer_Hardware_Server, SoftLayer_Virtual_Guest, or SoftLayer_Virtual_DedicatedHost objects to the group. All objects must be of the same type.

func (User_Permission_Group) AddResourceObject 

func (r User_Permission_Group) AddResourceObject(resourceObject *datatypes.Entity, resourceTypeKeyName *string) (resp bool, err error)

Links a SoftLayer_Hardware_Server, SoftLayer_Virtual_Guest, or SoftLayer_Virtual_DedicatedHost object to the group.

func (User_Permission_Group) CreateObject 

func (r User_Permission_Group) CreateObject(templateObject *datatypes.User_Permission_Group) (resp datatypes.User_Permission_Group, err error)

Customer created permission groups must be of type NORMAL. The SYSTEM type is reserved for internal use. The account id supplied in the template permission group must match account id of the user who is creating the permission group. The user who is creating the permission group must have the permission to manage users.

func (User_Permission_Group) DeleteObject 

func (r User_Permission_Group) DeleteObject() (resp bool, err error)

Customer users can only delete permission groups of type NORMAL. The SYSTEM type is reserved for internal use. The user who is creating the permission group must have the permission to manage users.

func (User_Permission_Group) EditObject 

func (r User_Permission_Group) EditObject(templateObject *datatypes.User_Permission_Group) (resp datatypes.User_Permission_Group, err error)

Allows a user to modify the name and description of an existing customer permission group. Customer permission groups must be of type NORMAL. The SYSTEM type is reserved for internal use. The account id supplied in the template permission group must match account id of the user who is creating the permission group. The user who is creating the permission group must have the permission to manage users.

func (User_Permission_Group) Filter 

func (r User_Permission_Group) Filter(filter string) User_Permission_Group

func (User_Permission_Group) GetAccount 

func (r User_Permission_Group) GetAccount() (resp datatypes.Account, err error)

Retrieve

func (User_Permission_Group) GetActions 

func (r User_Permission_Group) GetActions() (resp []datatypes.User_Permission_Action, err error)

Retrieve

func (User_Permission_Group) GetObject 

func (r User_Permission_Group) GetObject() (resp datatypes.User_Permission_Group, err error)

no documentation yet

func (User_Permission_Group) GetRoles 

func (r User_Permission_Group) GetRoles() (resp []datatypes.User_Permission_Role, err error)

Retrieve

func (User_Permission_Group) GetType 

func (r User_Permission_Group) GetType() (resp datatypes.User_Permission_Group_Type, err error)

Retrieve The type of the permission group.

func (User_Permission_Group) Id 

func (r User_Permission_Group) Id(id int) User_Permission_Group

func (User_Permission_Group) Limit 

func (r User_Permission_Group) Limit(limit int) User_Permission_Group

func (User_Permission_Group) LinkRole 

func (r User_Permission_Group) LinkRole(role *datatypes.User_Permission_Role) (err error)

Links a SoftLayer_User_Permission_Role object to the group.

func (User_Permission_Group) Mask 

func (r User_Permission_Group) Mask(mask string) User_Permission_Group

func (User_Permission_Group) Offset 

func (r User_Permission_Group) Offset(offset int) User_Permission_Group

func (User_Permission_Group) RemoveAction 

func (r User_Permission_Group) RemoveAction(action *datatypes.User_Permission_Action) (err error)

Unassigns a SoftLayer_User_Permission_Action object from the group.

func (User_Permission_Group) RemoveBulkActions 

func (r User_Permission_Group) RemoveBulkActions(actions []datatypes.User_Permission_Action) (err error)

Unassigns multiple SoftLayer_User_Permission_Action objects from the group.

func (User_Permission_Group) RemoveBulkResourceObjects 

func (r User_Permission_Group) RemoveBulkResourceObjects(resourceObjects []datatypes.Entity, resourceTypeKeyName *string) (resp bool, err error)

Unlinks multiple SoftLayer_Hardware_Server, SoftLayer_Virtual_Guest, or SoftLayer_Virtual_DedicatedHost objects from the group. All objects must be of the same type.

func (User_Permission_Group) RemoveResourceObject 

func (r User_Permission_Group) RemoveResourceObject(resourceObject *datatypes.Entity, resourceTypeKeyName *string) (resp bool, err error)

Unlinks a SoftLayer_Hardware_Server, SoftLayer_Virtual_Guest, or SoftLayer_Virtual_DedicatedHost object from the group.

func (User_Permission_Group) UnlinkRole 

func (r User_Permission_Group) UnlinkRole(role *datatypes.User_Permission_Role) (err error)

Removes a link from SoftLayer_User_Permission_Role object to the group.

type User_Permission_Group_Type 

type User_Permission_Group_Type struct {
	Session session.SLSession
	Options sl.Options
}

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]].

func GetUserPermissionGroupTypeService 

func GetUserPermissionGroupTypeService(sess session.SLSession) User_Permission_Group_Type

GetUserPermissionGroupTypeService returns an instance of the User_Permission_Group_Type SoftLayer service

func (User_Permission_Group_Type) Filter 

func (r User_Permission_Group_Type) Filter(filter string) User_Permission_Group_Type

func (User_Permission_Group_Type) GetGroups 

func (r User_Permission_Group_Type) GetGroups() (resp []datatypes.User_Permission_Group, err error)

Retrieve The groups that are of this type.

func (User_Permission_Group_Type) GetObject 

func (r User_Permission_Group_Type) GetObject() (resp datatypes.User_Permission_Group_Type, err error)

no documentation yet

func (User_Permission_Group_Type) Id 

func (r User_Permission_Group_Type) Id(id int) User_Permission_Group_Type

func (User_Permission_Group_Type) Limit 

func (r User_Permission_Group_Type) Limit(limit int) User_Permission_Group_Type

func (User_Permission_Group_Type) Mask 

func (r User_Permission_Group_Type) Mask(mask string) User_Permission_Group_Type

func (User_Permission_Group_Type) Offset 

func (r User_Permission_Group_Type) Offset(offset int) User_Permission_Group_Type

type User_Permission_Resource_Type added in v1.0.3 

type User_Permission_Resource_Type struct {
	Session session.SLSession
	Options sl.Options
}

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]].

func GetUserPermissionResourceTypeService added in v1.0.3 

func GetUserPermissionResourceTypeService(sess session.SLSession) User_Permission_Resource_Type

GetUserPermissionResourceTypeService returns an instance of the User_Permission_Resource_Type SoftLayer service

func (User_Permission_Resource_Type) Filter added in v1.0.3 

func (r User_Permission_Resource_Type) Filter(filter string) User_Permission_Resource_Type

func (User_Permission_Resource_Type) GetAllObjects added in v1.0.3 

func (r User_Permission_Resource_Type) GetAllObjects() (resp []datatypes.User_Permission_Resource_Type, err error)

Retrieve an array of SoftLayer_User_Permission_Resource_Type objects.

func (User_Permission_Resource_Type) GetObject added in v1.0.3 

func (r User_Permission_Resource_Type) GetObject() (resp datatypes.User_Permission_Resource_Type, err error)

no documentation yet

func (User_Permission_Resource_Type) Id added in v1.0.3 

func (r User_Permission_Resource_Type) Id(id int) User_Permission_Resource_Type

func (User_Permission_Resource_Type) Limit added in v1.0.3 

func (r User_Permission_Resource_Type) Limit(limit int) User_Permission_Resource_Type

func (User_Permission_Resource_Type) Mask added in v1.0.3 

func (r User_Permission_Resource_Type) Mask(mask string) User_Permission_Resource_Type

func (User_Permission_Resource_Type) Offset added in v1.0.3 

func (r User_Permission_Resource_Type) Offset(offset int) User_Permission_Resource_Type

type User_Permission_Role 

type User_Permission_Role struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetUserPermissionRoleService 

func GetUserPermissionRoleService(sess session.SLSession) User_Permission_Role

GetUserPermissionRoleService returns an instance of the User_Permission_Role SoftLayer service

func (User_Permission_Role) AddUser 

func (r User_Permission_Role) AddUser(user *datatypes.User_Customer) (err error)

Assigns a SoftLayer_User_Customer object to the role.

func (User_Permission_Role) CreateObject 

func (r User_Permission_Role) CreateObject(templateObject *datatypes.User_Permission_Role) (resp datatypes.User_Permission_Role, err error)

Customer created permission roles must set the systemFlag attribute to false. The SYSTEM type is reserved for internal use. The account id supplied in the template permission group must match account id of the user who is creating the permission group. The user who is creating the permission group must have the permission to manage users.

func (User_Permission_Role) DeleteObject 

func (r User_Permission_Role) DeleteObject() (resp bool, err error)

Customer users can only delete permission roles with systemFlag set to false. The SYSTEM type is reserved for internal use. The user who is creating the permission role must have the permission to manage users.

func (User_Permission_Role) EditObject 

func (r User_Permission_Role) EditObject(templateObject *datatypes.User_Permission_Role) (resp datatypes.User_Permission_Role, err error)

Allows a user to modify the name and description of an existing customer permission role. Customer permission roles must set the systemFlag attribute to false. The SYSTEM type is reserved for internal use. The account id supplied in the template permission role must match account id of the user who is creating the permission role. The user who is creating the permission role must have the permission to manage users.

func (User_Permission_Role) Filter 

func (r User_Permission_Role) Filter(filter string) User_Permission_Role

func (User_Permission_Role) GetAccount 

func (r User_Permission_Role) GetAccount() (resp datatypes.Account, err error)

Retrieve

func (User_Permission_Role) GetActions 

func (r User_Permission_Role) GetActions() (resp []datatypes.User_Permission_Action, err error)

Retrieve

func (User_Permission_Role) GetGroups 

func (r User_Permission_Role) GetGroups() (resp []datatypes.User_Permission_Group, err error)

Retrieve

func (User_Permission_Role) GetObject 

func (r User_Permission_Role) GetObject() (resp datatypes.User_Permission_Role, err error)

no documentation yet

func (User_Permission_Role) GetUsers 

func (r User_Permission_Role) GetUsers() (resp []datatypes.User_Customer, err error)

Retrieve

func (User_Permission_Role) Id 

func (r User_Permission_Role) Id(id int) User_Permission_Role

func (User_Permission_Role) Limit 

func (r User_Permission_Role) Limit(limit int) User_Permission_Role

func (User_Permission_Role) LinkGroup 

func (r User_Permission_Role) LinkGroup(group *datatypes.User_Permission_Group) (err error)

Links a SoftLayer_User_Permission_Group object to the role.

func (User_Permission_Role) Mask 

func (r User_Permission_Role) Mask(mask string) User_Permission_Role

func (User_Permission_Role) Offset 

func (r User_Permission_Role) Offset(offset int) User_Permission_Role

func (User_Permission_Role) RemoveUser 

func (r User_Permission_Role) RemoveUser(user *datatypes.User_Customer) (err error)

Unassigns a SoftLayer_User_Customer object from the role.

func (User_Permission_Role) UnlinkGroup 

func (r User_Permission_Role) UnlinkGroup(group *datatypes.User_Permission_Group) (err error)

Unlinks a SoftLayer_User_Permission_Group object to the role.

type User_Security_Question 

type User_Security_Question struct {
	Session session.SLSession
	Options sl.Options
}

The SoftLayer_User_Security_Question data type contains questions.

func GetUserSecurityQuestionService 

func GetUserSecurityQuestionService(sess session.SLSession) User_Security_Question

GetUserSecurityQuestionService returns an instance of the User_Security_Question SoftLayer service

func (User_Security_Question) Filter 

func (r User_Security_Question) Filter(filter string) User_Security_Question

func (User_Security_Question) GetAllObjects 

func (r User_Security_Question) GetAllObjects() (resp []datatypes.User_Security_Question, err error)

Retrieve all viewable security questions.

func (User_Security_Question) GetObject 

func (r User_Security_Question) GetObject() (resp datatypes.User_Security_Question, err error)

getAllObjects retrieves all the SoftLayer_User_Security_Question objects where it is set to be viewable.

func (User_Security_Question) Id 

func (r User_Security_Question) Id(id int) User_Security_Question

func (User_Security_Question) Limit 

func (r User_Security_Question) Limit(limit int) User_Security_Question

func (User_Security_Question) Mask 

func (r User_Security_Question) Mask(mask string) User_Security_Question

func (User_Security_Question) Offset 

func (r User_Security_Question) Offset(offset int) User_Security_Question

type Utility_Network 

type Utility_Network struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetUtilityNetworkService 

func GetUtilityNetworkService(sess session.SLSession) Utility_Network

GetUtilityNetworkService returns an instance of the Utility_Network SoftLayer service

func (Utility_Network) Filter 

func (r Utility_Network) Filter(filter string) Utility_Network

func (Utility_Network) Id 

func (r Utility_Network) Id(id int) Utility_Network

func (Utility_Network) Limit 

func (r Utility_Network) Limit(limit int) Utility_Network

func (Utility_Network) Mask 

func (r Utility_Network) Mask(mask string) Utility_Network

func (Utility_Network) NsLookup 

func (r Utility_Network) NsLookup(address *string, typ *string) (resp string, err error)

A method used to return the nameserver information for a given address

func (Utility_Network) Offset 

func (r Utility_Network) Offset(offset int) Utility_Network

func (Utility_Network) Whois 

func (r Utility_Network) Whois(address *string) (resp string, err error)

Perform a WHOIS lookup from SoftLayer's application servers on the given IP address or hostname and return the raw results of that command. The returned result is similar to the result received from running the command `whois` from a UNIX command shell. A WHOIS lookup queries a host's registrar to retrieve domain registrant information including registration date, expiry date, and the administrative, technical, billing, and abuse contacts responsible for a domain. WHOIS lookups are useful for determining a physical contact responsible for a particular domain. WHOIS lookups are also useful for determining domain availability. Running a WHOIS lookup on an IP address queries ARIN for that IP block's ownership, and is helpful for determining a physical entity responsible for a certain IP address.

type Verify_Api_HttpObj added in v1.1.3 

type Verify_Api_HttpObj struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetVerifyApiHttpObjService added in v1.1.3 

func GetVerifyApiHttpObjService(sess session.SLSession) Verify_Api_HttpObj

GetVerifyApiHttpObjService returns an instance of the Verify_Api_HttpObj SoftLayer service

func (Verify_Api_HttpObj) CreateObject added in v1.1.3 

func (r Verify_Api_HttpObj) CreateObject(templateObject *datatypes.Verify_Api_HttpObj) (resp datatypes.Verify_Api_HttpObj, err error)

no documentation yet

func (Verify_Api_HttpObj) DeleteObject added in v1.1.3 

func (r Verify_Api_HttpObj) DeleteObject() (resp bool, err error)

no documentation yet

func (Verify_Api_HttpObj) Filter added in v1.1.3 

func (r Verify_Api_HttpObj) Filter(filter string) Verify_Api_HttpObj

func (Verify_Api_HttpObj) GetAllObjects added in v1.1.3 

func (r Verify_Api_HttpObj) GetAllObjects() (resp []datatypes.Verify_Api_HttpObj, err error)

no documentation yet

func (Verify_Api_HttpObj) GetObject added in v1.1.3 

func (r Verify_Api_HttpObj) GetObject() (resp datatypes.Verify_Api_HttpObj, err error)

no documentation yet

func (Verify_Api_HttpObj) Id added in v1.1.3 

func (r Verify_Api_HttpObj) Id(id int) Verify_Api_HttpObj

func (Verify_Api_HttpObj) Limit added in v1.1.3 

func (r Verify_Api_HttpObj) Limit(limit int) Verify_Api_HttpObj

func (Verify_Api_HttpObj) Mask added in v1.1.3 

func (r Verify_Api_HttpObj) Mask(mask string) Verify_Api_HttpObj

func (Verify_Api_HttpObj) Offset added in v1.1.3 

func (r Verify_Api_HttpObj) Offset(offset int) Verify_Api_HttpObj

type Verify_Api_HttpsObj added in v1.1.3 

type Verify_Api_HttpsObj struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetVerifyApiHttpsObjService added in v1.1.3 

func GetVerifyApiHttpsObjService(sess session.SLSession) Verify_Api_HttpsObj

GetVerifyApiHttpsObjService returns an instance of the Verify_Api_HttpsObj SoftLayer service

func (Verify_Api_HttpsObj) CreateObject added in v1.1.3 

func (r Verify_Api_HttpsObj) CreateObject(templateObject *datatypes.Verify_Api_HttpsObj) (resp datatypes.Verify_Api_HttpsObj, err error)

no documentation yet

func (Verify_Api_HttpsObj) DeleteObject added in v1.1.3 

func (r Verify_Api_HttpsObj) DeleteObject() (resp bool, err error)

no documentation yet

func (Verify_Api_HttpsObj) Filter added in v1.1.3 

func (r Verify_Api_HttpsObj) Filter(filter string) Verify_Api_HttpsObj

func (Verify_Api_HttpsObj) GetAllObjects added in v1.1.3 

func (r Verify_Api_HttpsObj) GetAllObjects() (resp []datatypes.Verify_Api_HttpsObj, err error)

no documentation yet

func (Verify_Api_HttpsObj) GetObject added in v1.1.3 

func (r Verify_Api_HttpsObj) GetObject() (resp datatypes.Verify_Api_HttpsObj, err error)

no documentation yet

func (Verify_Api_HttpsObj) Id added in v1.1.3 

func (r Verify_Api_HttpsObj) Id(id int) Verify_Api_HttpsObj

func (Verify_Api_HttpsObj) Limit added in v1.1.3 

func (r Verify_Api_HttpsObj) Limit(limit int) Verify_Api_HttpsObj

func (Verify_Api_HttpsObj) Mask added in v1.1.3 

func (r Verify_Api_HttpsObj) Mask(mask string) Verify_Api_HttpsObj

func (Verify_Api_HttpsObj) Offset added in v1.1.3 

func (r Verify_Api_HttpsObj) Offset(offset int) Verify_Api_HttpsObj

type Virtual_DedicatedHost 

type Virtual_DedicatedHost struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetVirtualDedicatedHostService 

func GetVirtualDedicatedHostService(sess session.SLSession) Virtual_DedicatedHost

GetVirtualDedicatedHostService returns an instance of the Virtual_DedicatedHost SoftLayer service

func (Virtual_DedicatedHost) DeleteObject 

func (r Virtual_DedicatedHost) DeleteObject() (resp bool, err error)

This method will cancel a dedicated host immediately.

func (Virtual_DedicatedHost) EditObject 

func (r Virtual_DedicatedHost) EditObject(templateObject *datatypes.Virtual_DedicatedHost) (resp bool, err error)

Edit a dedicated host's properties.

func (Virtual_DedicatedHost) Filter 

func (r Virtual_DedicatedHost) Filter(filter string) Virtual_DedicatedHost

func (Virtual_DedicatedHost) GetAccount 

func (r Virtual_DedicatedHost) GetAccount() (resp datatypes.Account, err error)

Retrieve The account that the dedicated host belongs to.

func (Virtual_DedicatedHost) GetAllocationStatus 

func (r Virtual_DedicatedHost) GetAllocationStatus() (resp datatypes.Container_Virtual_DedicatedHost_AllocationStatus, err error)

Retrieve The container that represents allocations on the dedicated host.

func (Virtual_DedicatedHost) GetAvailableRouters 

func (r Virtual_DedicatedHost) GetAvailableRouters(dedicatedHost *datatypes.Virtual_DedicatedHost) (resp []datatypes.Hardware, err error)

This method will get the available backend routers to order a dedicated host.

func (Virtual_DedicatedHost) GetBackendRouter 

func (r Virtual_DedicatedHost) GetBackendRouter() (resp datatypes.Hardware_Router_Backend, err error)

Retrieve The backend router behind dedicated host's pool of resources.

func (Virtual_DedicatedHost) GetBillingItem 

func (r Virtual_DedicatedHost) GetBillingItem() (resp datatypes.Billing_Item_Virtual_DedicatedHost, err error)

Retrieve The billing item for the dedicated host.

func (Virtual_DedicatedHost) GetDatacenter 

func (r Virtual_DedicatedHost) GetDatacenter() (resp datatypes.Location, err error)

Retrieve The datacenter that the dedicated host resides in.

func (Virtual_DedicatedHost) GetGuests 

func (r Virtual_DedicatedHost) GetGuests() (resp []datatypes.Virtual_Guest, err error)

Retrieve The guests associated with the dedicated host.

func (Virtual_DedicatedHost) GetInternalTagReferences 

func (r Virtual_DedicatedHost) GetInternalTagReferences() (resp []datatypes.Tag_Reference, err error)

Retrieve

func (Virtual_DedicatedHost) GetObject 

func (r Virtual_DedicatedHost) GetObject() (resp datatypes.Virtual_DedicatedHost, err error)

no documentation yet

func (Virtual_DedicatedHost) GetPciDeviceAllocationStatus 

func (r Virtual_DedicatedHost) GetPciDeviceAllocationStatus() (resp datatypes.Container_Virtual_DedicatedHost_Pci_Device_AllocationStatus, err error)

Retrieve The container that represents PCI device allocations on the dedicated host.

func (Virtual_DedicatedHost) GetPciDevices 

func (r Virtual_DedicatedHost) GetPciDevices() (resp []datatypes.Virtual_Host_PciDevice, err error)

Retrieve A collection of SoftLayer_Virtual_Host_PciDevice objects on the host.

func (Virtual_DedicatedHost) GetTagReferences 

func (r Virtual_DedicatedHost) GetTagReferences() (resp []datatypes.Tag_Reference, err error)

Retrieve

func (Virtual_DedicatedHost) Id 

func (r Virtual_DedicatedHost) Id(id int) Virtual_DedicatedHost

func (Virtual_DedicatedHost) Limit 

func (r Virtual_DedicatedHost) Limit(limit int) Virtual_DedicatedHost

func (Virtual_DedicatedHost) Mask 

func (r Virtual_DedicatedHost) Mask(mask string) Virtual_DedicatedHost

func (Virtual_DedicatedHost) Offset 

func (r Virtual_DedicatedHost) Offset(offset int) Virtual_DedicatedHost

func (Virtual_DedicatedHost) SetTags 

func (r Virtual_DedicatedHost) SetTags(tags *string) (resp bool, err error)

no documentation yet

type Virtual_Disk_Image 

type Virtual_Disk_Image struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetVirtualDiskImageService 

func GetVirtualDiskImageService(sess session.SLSession) Virtual_Disk_Image

GetVirtualDiskImageService returns an instance of the Virtual_Disk_Image SoftLayer service

func (Virtual_Disk_Image) EditObject 

func (r Virtual_Disk_Image) EditObject(templateObject *datatypes.Virtual_Disk_Image) (resp bool, err error)

no documentation yet

func (Virtual_Disk_Image) Filter 

func (r Virtual_Disk_Image) Filter(filter string) Virtual_Disk_Image

func (Virtual_Disk_Image) GetAvailableBootModes 

func (r Virtual_Disk_Image) GetAvailableBootModes() (resp []string, err error)

Returns a collection of boot modes that are supported for primary disks.

func (Virtual_Disk_Image) GetBillingItem 

func (r Virtual_Disk_Image) GetBillingItem() (resp datatypes.Billing_Item_Virtual_Disk_Image, err error)

Retrieve The billing item for a virtual disk image.

func (Virtual_Disk_Image) GetBlockDevices 

func (r Virtual_Disk_Image) GetBlockDevices() (resp []datatypes.Virtual_Guest_Block_Device, err error)

Retrieve The block devices that a disk image is attached to. Block devices connect computing instances to disk images.

func (Virtual_Disk_Image) GetBootableVolumeFlag 

func (r Virtual_Disk_Image) GetBootableVolumeFlag() (resp bool, err error)

Retrieve

func (Virtual_Disk_Image) GetCloudInitFlag added in v1.0.2 

func (r Virtual_Disk_Image) GetCloudInitFlag() (resp bool, err error)

Retrieve Check if cloud-init is enabled.

func (Virtual_Disk_Image) GetCoalescedDiskImages 

func (r Virtual_Disk_Image) GetCoalescedDiskImages() (resp []datatypes.Virtual_Disk_Image, err error)

Retrieve

func (Virtual_Disk_Image) GetCopyOnWriteFlag 

func (r Virtual_Disk_Image) GetCopyOnWriteFlag() (resp bool, err error)

Retrieve

func (Virtual_Disk_Image) GetDiskFileExtension added in v1.0.2 

func (r Virtual_Disk_Image) GetDiskFileExtension() (resp string, err error)

Retrieve Return disk file extension

func (Virtual_Disk_Image) GetDiskImageStorageGroup added in v1.0.2 

func (r Virtual_Disk_Image) GetDiskImageStorageGroup() (resp datatypes.Configuration_Storage_Group, err error)

Retrieve

func (Virtual_Disk_Image) GetImportedDiskType 

func (r Virtual_Disk_Image) GetImportedDiskType() (resp string, err error)

Retrieve Return imported disk type

func (Virtual_Disk_Image) GetIsEncrypted 

func (r Virtual_Disk_Image) GetIsEncrypted() (resp bool, err error)

Retrieve Return if image is encrypted

func (Virtual_Disk_Image) GetLocalDiskFlag 

func (r Virtual_Disk_Image) GetLocalDiskFlag() (resp bool, err error)

Retrieve

func (Virtual_Disk_Image) GetMetadataFlag 

func (r Virtual_Disk_Image) GetMetadataFlag() (resp bool, err error)

Retrieve Whether this disk image is meant for storage of custom user data supplied with a Cloud Computing Instance order.

func (Virtual_Disk_Image) GetObject 

func (r Virtual_Disk_Image) GetObject() (resp datatypes.Virtual_Disk_Image, err error)

no documentation yet

func (Virtual_Disk_Image) GetPublicIsoImages 

func (r Virtual_Disk_Image) GetPublicIsoImages() (resp []datatypes.Virtual_Disk_Image, err error)

Retrieves images from the public ISO repository

func (Virtual_Disk_Image) GetSoftwareReferences 

func (r Virtual_Disk_Image) GetSoftwareReferences() (resp []datatypes.Virtual_Disk_Image_Software, err error)

Retrieve References to the software that resides on a disk image.

func (Virtual_Disk_Image) GetSourceDiskImage 

func (r Virtual_Disk_Image) GetSourceDiskImage() (resp datatypes.Virtual_Disk_Image, err error)

Retrieve The original disk image that the current disk image was cloned from.

func (Virtual_Disk_Image) GetStorageGroupDetails added in v1.0.2 

func (r Virtual_Disk_Image) GetStorageGroupDetails() (resp datatypes.Container_Image_StorageGroupDetails, err error)

Retrieve Return storage group details for symantec disk

func (Virtual_Disk_Image) GetStorageGroups added in v1.0.2 

func (r Virtual_Disk_Image) GetStorageGroups() (resp []datatypes.Configuration_Storage_Group, err error)

Retrieve The storage group for a virtual disk image.

func (Virtual_Disk_Image) GetStorageRepository 

func (r Virtual_Disk_Image) GetStorageRepository() (resp datatypes.Virtual_Storage_Repository, err error)

Retrieve The storage repository that a disk image resides in.

func (Virtual_Disk_Image) GetStorageRepositoryType 

func (r Virtual_Disk_Image) GetStorageRepositoryType() (resp datatypes.Virtual_Storage_Repository_Type, err error)

Retrieve The type of storage repository that a disk image resides in.

func (Virtual_Disk_Image) GetSupportedHardware added in v1.0.2 

func (r Virtual_Disk_Image) GetSupportedHardware() (resp string, err error)

Retrieve Return supported hardware component IDs for symantec disk

func (Virtual_Disk_Image) GetTemplateBlockDevice 

func (r Virtual_Disk_Image) GetTemplateBlockDevice() (resp datatypes.Virtual_Guest_Block_Device_Template, err error)

Retrieve The template that attaches a disk image to a [[SoftLayer_Virtual_Guest_Block_Device_Template_Group|archive]].

func (Virtual_Disk_Image) GetType 

func (r Virtual_Disk_Image) GetType() (resp datatypes.Virtual_Disk_Image_Type, err error)

Retrieve A virtual disk image's type.

func (Virtual_Disk_Image) Id 

func (r Virtual_Disk_Image) Id(id int) Virtual_Disk_Image

func (Virtual_Disk_Image) Limit 

func (r Virtual_Disk_Image) Limit(limit int) Virtual_Disk_Image

func (Virtual_Disk_Image) Mask 

func (r Virtual_Disk_Image) Mask(mask string) Virtual_Disk_Image

func (Virtual_Disk_Image) Offset 

func (r Virtual_Disk_Image) Offset(offset int) Virtual_Disk_Image

type Virtual_Guest 

type Virtual_Guest struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetVirtualGuestService 

func GetVirtualGuestService(sess session.SLSession) Virtual_Guest

GetVirtualGuestService returns an instance of the Virtual_Guest SoftLayer service

func (Virtual_Guest) ActivatePrivatePort 

func (r Virtual_Guest) ActivatePrivatePort() (resp bool, err error)

Activate the private network port

func (Virtual_Guest) ActivatePublicPort 

func (r Virtual_Guest) ActivatePublicPort() (resp bool, err error)

Activate the public network port

func (Virtual_Guest) AllowAccessToNetworkStorage 

func (r Virtual_Guest) AllowAccessToNetworkStorage(networkStorageTemplateObject *datatypes.Network_Storage) (resp bool, err error)

This method is used to allow access to a SoftLayer_Network_Storage volume that supports host- or network-level access control.

func (Virtual_Guest) AllowAccessToNetworkStorageList 

func (r Virtual_Guest) AllowAccessToNetworkStorageList(networkStorageTemplateObjects []datatypes.Network_Storage) (resp bool, err error)

This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support host- or network-level access control.

func (Virtual_Guest) AttachDiskImage 

func (r Virtual_Guest) AttachDiskImage(imageId *int) (resp datatypes.Provisioning_Version1_Transaction, err error)

Creates a transaction to attach a guest's disk image. If the disk image is already attached it will be ignored.

WARNING: SoftLayer_Virtual_Guest::checkHostDiskAvailability should be called before this method. If the SoftLayer_Virtual_Guest::checkHostDiskAvailability method is not called before this method, the guest migration will happen automatically.

func (Virtual_Guest) CancelIsolationForDestructiveAction 

func (r Virtual_Guest) CancelIsolationForDestructiveAction() (err error)

Reopens the public and/or private ports to reverse the changes made when the server was isolated for a destructive action.

func (Virtual_Guest) CaptureImage 

func (r Virtual_Guest) CaptureImage(captureTemplate *datatypes.Container_Disk_Image_Capture_Template) (resp datatypes.Virtual_Guest_Block_Device_Template_Group, err error)

Captures a Flex Image of the hard disk on the virtual machine, based on the capture template parameter. Returns the image template group containing the disk image.

func (Virtual_Guest) CheckHostDiskAvailability 

func (r Virtual_Guest) CheckHostDiskAvailability(diskCapacity *int) (resp bool, err error)

Checks the associated host for available disk space to determine if guest migration is necessary. This method is only used with local disks. If this method returns false, calling attachDiskImage($imageId) will automatically migrate the destination guest to a new host before attaching the portable volume.

func (Virtual_Guest) ConfigureMetadataDisk 

func (r Virtual_Guest) ConfigureMetadataDisk() (resp datatypes.Provisioning_Version1_Transaction, err error)

Creates a transaction to configure the guest's metadata disk. If the guest has user data associated with it, the transaction will create a small virtual drive and write the metadata to a file on the drive; if the drive already exists, the metadata will be rewritten. If the guest has no user data associated with it, the transaction will remove the virtual drive if it exists.

WARNING: The transaction created by this service will shut down the guest while the metadata disk is configured. The guest will be turned back on once this process is complete.

func (Virtual_Guest) CreateArchiveTemplate added in v1.0.2 

func (r Virtual_Guest) CreateArchiveTemplate(groupName *string, blockDevices []datatypes.Virtual_Guest_Block_Device, note *string) (resp datatypes.Virtual_Guest_Block_Device_Template_Group, err error)

Create a transaction to archive a computing instance's block devices

func (Virtual_Guest) CreateArchiveTransaction 

func (r Virtual_Guest) CreateArchiveTransaction(groupName *string, blockDevices []datatypes.Virtual_Guest_Block_Device, note *string) (resp datatypes.Provisioning_Version1_Transaction, err error)

Create a transaction to archive a computing instance's block devices Deprecated: This function has been marked as deprecated.

func (Virtual_Guest) CreateObject 

func (r Virtual_Guest) CreateObject(templateObject *datatypes.Virtual_Guest) (resp datatypes.Virtual_Guest, err error)

createObject() enables the creation of computing instances on an account. This method is a simplified alternative to interacting with the ordering system directly.

In order to create a computing instance, a template object must be sent in with a few required values.

When this method returns an order will have been placed for a computing instance of the specified configuration.

To determine when the instance is available you can poll the instance via [SoftLayer_Virtual_Guest/getObject], with an object mask requesting the `provisionDate` relational property. When `provisionDate` is not `null`, the instance will be ready.

> **Warning:** Computing instances created via this method will incur charges on your account. For testing input parameters see [SoftLayer_Virtual_Guest/generateOrderTemplate].

### Required Input [[SoftLayer_Virtual_Guest]]

- `Hostname` String **Required**

  • Hostname for the computing instance.

- `Domain` String **Required**

  • Domain for the computing instance.

- `startCpus` Integer **Required**

- `maxMemory` Integer **Required**

- `datacenter.name` *String* **Required**

- `hourlyBillingFlag` Boolean **Required**

  • Specifies the billing type for the instance.
  • True for hourly billing, False for monthly billing.

- `localDiskFlag` Boolean **Required**

  • Specifies the disk type for the instance.
  • True for local to the instance disks, False for SAN disks.

- `dedicatedAccountHostOnlyFlag` Boolean

  • When true this flag specifies that a compute instance is to run on hosts that only have guests from the same account.
  • Default: False

- `operatingSystemReferenceCode` String **Conditionally required**

  • An identifier for the operating system to provision the computing instance with.
  • Not required when using a `blockDeviceTemplateGroup.globalIdentifier`, as the template will have its own operating system.
  • See [SoftLayer_Virtual_Guest/getCreateObjectOptions] for available options.
  • **Notice**: Some operating systems are billed based on the number of CPUs the guest has. The price which is used can be determined by calling [SoftLayer_Virtual_Guest/generateOrderTemplate] with your desired device specifications.

- `blockDeviceTemplateGroup.globalIdentifier` String

- `networkComponents.maxSpeed` Integer

  • Specifies the connection speed for the instance's network components.
  • The `networkComponents` property is an array with a single [[SoftLayer_Virtual_Guest_Network_Component]] structure. The `maxSpeed` property must be set to specify the network uplink speed, in megabits per second, of the computing instance.
  • See [SoftLayer_Virtual_Guest/getCreateObjectOptions] for available options.
  • Default: 10
  • Example: `"networkComponents": [{"maxSpeed": 1000}]`

- `privateNetworkOnlyFlag` Boolean

  • When true this flag specifies that a compute instance is to only have access to the private network.
  • Default: False

- `primaryNetworkComponent.networkVlan.id` Integer

  • Specifies the network vlan which is to be used for the frontend interface of the computing instance.
  • The `primaryNetworkComponent` property is a [[SoftLayer_Virtual_Guest_Network_Component]] structure with the `networkVlan` property populated with a i [[SoftLayer_Network_Vlan]] structure. The `id` property must be set to specify the frontend network vlan of the computing instance.
  • *NOTE* This is the VLAN `id`, NOT the vlan number.
  • Example: `"primaryNetworkComponent":{"networkVlan": {"id": 1234567}}`

- `backendNetworkComponent.networkVlan.id` Integer

  • Specifies the network vlan which is to be used for the backend interface of the computing instance.
  • The `backendNetworkComponent` property is a [[SoftLayer_Virtual_Guest_Network_Component]] structure with the `networkVlan` property populated with a [[SoftLayer_Network_Vlan]] structure. The `id` property must be set to specify the backend network vlan of the computing instance.
  • *NOTE* This is the VLAN `id`, NOT the vlan number.
  • Example: `"backendNetworkComponent":{"networkVlan": {"id": 1234567}}`

- `primaryNetworkComponent.securityGroupBindings` [[SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding]][]

  • Specifies the security groups to be attached to this VSI's frontend network adapter
  • The `primaryNetworkComponent` property is a [[SoftLayer_Virtual_Guest_Network_Component]] structure with the `securityGroupBindings` property populated with an array of [[SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding]] structures. The `securityGroup` property in each must be set to specify the security group to be attached to the primary frontend network component.
  • Example: ``` "primaryNetworkComponent": { "securityGroupBindings": [ {"securityGroup":{"id": 5555555}}, {"securityGroup":{"id": 1112223}}, ] } ```

- `primaryBackendNetworkComponent.securityGroupBindings` [[SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding]][]

  • Specifies the security groups to be attached to this VSI's backend network adapter
  • The `primaryNetworkComponent` property is a [[SoftLayer_Virtual_Guest_Network_Component]] structure with the `securityGroupBindings` property populated with an array of [[SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding]] structures. The `securityGroup` property in each must be set to specify the security group to be attached to the primary frontend network component.
  • Example: ``` "primaryBackendNetworkComponent": { "securityGroupBindings": [ {"securityGroup":{"id": 33322211}}, {"securityGroup":{"id": 77777222}}, ] } ```

- `blockDevices` [[SoftLayer_Virtual_Guest_Block_Device]][]

  • Block device and disk image settings for the computing instance
  • The `blockDevices` property is an array of [[SoftLayer_Virtual_Guest_Block_Device]] structures. Each block device must specify the `device` property along with the `diskImage` property, which is a [[SoftLayer_Virtual_Disk_Image]] structure with the `capacity` property set. The `device` number `'1'` is reserved for the SWAP disk attached to the computing instance.
  • Default: The smallest available capacity for the primary disk will be used. If an image template is specified the disk capacity will be be provided by the template.
  • Example: ``` "blockDevices":[{"device": "0", "diskImage": {"capacity": 100}}], "localDiskFlag": true ```
  • See [SoftLayer_Virtual_Guest/getCreateObjectOptions] for available options.

- `userData.value` String

  • Arbitrary data to be made available to the computing instance.
  • The `userData` property is an array with a single [[SoftLayer_Virtual_Guest_Attribute]] structure with the `value` property set to an arbitrary value. This value can be retrieved via the [SoftLayer_Resource_Metadata/getUserMetadata] method from a request originating from the computing instance. This is primarily useful for providing data to software that may be on the instance and configured to execute upon first boot.
  • Example: `"userData":[{"value": "testData"}]`

- `sshKeys` [[SoftLayer_Security_Ssh_Key]][]

  • The `sshKeys` property is an array of [[SoftLayer_Security_Ssh_Key]] structures with the `id` property set to the value of an existing SSH key.
  • To create a new SSH key, call [[SoftLayer_Security_Ssh_Key/createObject|createObject]].
  • To obtain a list of existing SSH keys, call [SoftLayer_Account/getSshKeys]
  • Example: `"sshKeys":[{"id": 1234567}]`

- `postInstallScriptUri` String

  • Specifies the uri location of the script to be downloaded and run after installation is complete. Only scripts from HTTPS servers are executed on startup.

REST Example: ``` 

curl -X POST -d '{
    "parameters":[
        {
            "hostname": "host1",
            "domain": "example.com",
            "startCpus": 1,
            "maxMemory": 1024,
            "hourlyBillingFlag": true,
            "localDiskFlag": true,
            "operatingSystemReferenceCode": "UBUNTU_LATEST"
        }
}' https://api.softlayer.com/rest/v3.1/SoftLayer_Virtual_Guest/createObject.json

HTTP/1.1 201 Created Location: https://api.softlayer.com/rest/v3.1/SoftLayer_Virtual_Guest/1301396/getObject 

{
  "accountId": 232298,
  "createDate": "2012-11-30T16:28:17-06:00",
  "dedicatedAccountHostOnlyFlag": false,
  "domain": "example.com",
  "hostname": "host1",
  "id": 1301396,
  "lastPowerStateId": null,
  "lastVerifiedDate": null,
  "maxCpu": 1,
  "maxCpuUnits": "CORE",
  "maxMemory": 1024,
  "metricPollDate": null,
  "modifyDate": null,
  "privateNetworkOnlyFlag": false,
  "startCpus": 1,
  "statusId": 1001,
  "globalIdentifier": "2d203774-0ee1-49f5-9599-6ef67358dd31"
}

```

func (Virtual_Guest) CreateObjects 

func (r Virtual_Guest) CreateObjects(templateObjects []datatypes.Virtual_Guest) (resp []datatypes.Virtual_Guest, err error)

createObjects() enables the creation of multiple computing instances on an account in a single call. This method is a simplified alternative to interacting with the ordering system directly.

In order to create a computing instance a set of template objects must be sent in with a few required values.

<b>Warning:</b> Computing instances created via this method will incur charges on your account.

See [[SoftLayer_Virtual_Guest/createObject|createObject]] for specifics on the requirements of each template object.

<h1>Example</h1> 

<http title="Request">curl -X POST -d '{
 "parameters":[
     [
         {
             "hostname": "host1",
             "domain": "example.com",
             "startCpus": 1,
             "maxMemory": 1024,
             "hourlyBillingFlag": true,
             "localDiskFlag": true,
             "operatingSystemReferenceCode": "UBUNTU_LATEST"
         },
         {
             "hostname": "host2",
             "domain": "example.com",
             "startCpus": 1,
             "maxMemory": 1024,
             "hourlyBillingFlag": true,
             "localDiskFlag": true,
             "operatingSystemReferenceCode": "UBUNTU_LATEST"
         }
     ]
 ]
}' https://api.softlayer.com/rest/v3/SoftLayer_Virtual_Guest/createObjects.json

</http> <http title="Response">HTTP/1.1 200 OK

[ 

{
    "accountId": 232298,
    "createDate": "2012-11-30T23:56:48-06:00",
    "dedicatedAccountHostOnlyFlag": false,
    "domain": "softlayer.com",
    "hostname": "ubuntu1",
    "id": 1301456,
    "lastPowerStateId": null,
    "lastVerifiedDate": null,
    "maxCpu": 1,
    "maxCpuUnits": "CORE",
    "maxMemory": 1024,
    "metricPollDate": null,
    "modifyDate": null,
    "privateNetworkOnlyFlag": false,
    "startCpus": 1,
    "statusId": 1001,
    "globalIdentifier": "fed4c822-48c0-45d0-85e2-90476aa0c542"
},
{
    "accountId": 232298,
    "createDate": "2012-11-30T23:56:49-06:00",
    "dedicatedAccountHostOnlyFlag": false,
    "domain": "softlayer.com",
    "hostname": "ubuntu2",
    "id": 1301457,
    "lastPowerStateId": null,
    "lastVerifiedDate": null,
    "maxCpu": 1,
    "maxCpuUnits": "CORE",
    "maxMemory": 1024,
    "metricPollDate": null,
    "modifyDate": null,
    "privateNetworkOnlyFlag": false,
    "startCpus": 1,
    "statusId": 1001,
    "globalIdentifier": "bed4c686-9562-4ade-9049-dc4d5b6b200c"
}

] </http>

func (Virtual_Guest) CreatePostSoftwareInstallTransaction 

func (r Virtual_Guest) CreatePostSoftwareInstallTransaction(data *string, returnBoolean *bool) (resp bool, err error)

no documentation yet

func (Virtual_Guest) DeleteObject 

func (r Virtual_Guest) DeleteObject() (resp bool, err error)

This method will cancel a computing instance effective immediately. For instances billed hourly, the charges will stop immediately after the method returns.

func (Virtual_Guest) DeleteTag 

func (r Virtual_Guest) DeleteTag(tagName *string) (resp bool, err error)

no documentation yet

func (Virtual_Guest) DeleteTransientWebhook 

func (r Virtual_Guest) DeleteTransientWebhook() (err error)

no documentation yet

func (Virtual_Guest) DetachDiskImage 

func (r Virtual_Guest) DetachDiskImage(imageId *int) (resp datatypes.Provisioning_Version1_Transaction, err error)

Creates a transaction to detach a guest's disk image. If the disk image is already detached it will be ignored.

WARNING: The transaction created by this service will shut down the guest while the disk image is attached. The guest will be turned back on once this process is complete.

func (Virtual_Guest) EditObject 

func (r Virtual_Guest) EditObject(templateObject *datatypes.Virtual_Guest) (resp bool, err error)

Edit a computing instance's properties

func (Virtual_Guest) ExecuteIderaBareMetalRestore 

func (r Virtual_Guest) ExecuteIderaBareMetalRestore() (resp bool, err error)

Reboot a guest into the Idera Bare Metal Restore image.

func (Virtual_Guest) ExecuteR1SoftBareMetalRestore 

func (r Virtual_Guest) ExecuteR1SoftBareMetalRestore() (resp bool, err error)

Reboot a guest into the R1Soft Bare Metal Restore image.

func (Virtual_Guest) ExecuteRemoteScript 

func (r Virtual_Guest) ExecuteRemoteScript(uri *string) (err error)

Download and run remote script from uri on virtual guests.

func (Virtual_Guest) ExecuteRescueLayer 

func (r Virtual_Guest) ExecuteRescueLayer() (resp bool, err error)

Reboot a Linux guest into the Xen rescue image.

func (Virtual_Guest) Filter 

func (r Virtual_Guest) Filter(filter string) Virtual_Guest

func (Virtual_Guest) FindByHostname added in v1.0.2 

func (r Virtual_Guest) FindByHostname(hostname *string) (resp []datatypes.Virtual_Guest, err error)

Find VSIs by hostname.

func (Virtual_Guest) FindByIpAddress 

func (r Virtual_Guest) FindByIpAddress(ipAddress *string) (resp datatypes.Virtual_Guest, err error)

Find CCI by only its primary public or private IP address. IP addresses within secondary subnets tied to the CCI will not return the CCI. If no CCI is found, no errors are generated and no data is returned.

func (Virtual_Guest) GenerateOrderTemplate 

func (r Virtual_Guest) GenerateOrderTemplate(templateObject *datatypes.Virtual_Guest) (resp datatypes.Container_Product_Order, err error)

Obtain an [[SoftLayer_Container_Product_Order_Virtual_Guest (type)|order container]] that can be sent to [[SoftLayer_Product_Order/verifyOrder|verifyOrder]] or [[SoftLayer_Product_Order/placeOrder|placeOrder]].

This is primarily useful when there is a necessity to confirm the price which will be charged for an order.

See [[SoftLayer_Virtual_Guest/createObject|createObject]] for specifics on the requirements of the template object parameter.

func (Virtual_Guest) GetAccount 

func (r Virtual_Guest) GetAccount() (resp datatypes.Account, err error)

Retrieve The account that a virtual guest belongs to.

func (Virtual_Guest) GetAccountOwnedPoolFlag 

func (r Virtual_Guest) GetAccountOwnedPoolFlag() (resp bool, err error)

Retrieve

func (Virtual_Guest) GetActiveNetworkMonitorIncident 

func (r Virtual_Guest) GetActiveNetworkMonitorIncident() (resp []datatypes.Network_Monitor_Version1_Incident, err error)

Retrieve A virtual guest's currently active network monitoring incidents.

func (Virtual_Guest) GetActiveTickets 

func (r Virtual_Guest) GetActiveTickets() (resp []datatypes.Ticket, err error)

Retrieve

func (Virtual_Guest) GetActiveTransaction 

func (r Virtual_Guest) GetActiveTransaction() (resp datatypes.Provisioning_Version1_Transaction, err error)

Retrieve A transaction that is still be performed on a cloud server.

func (Virtual_Guest) GetActiveTransactions 

func (r Virtual_Guest) GetActiveTransactions() (resp []datatypes.Provisioning_Version1_Transaction, err error)

Retrieve Any active transaction(s) that are currently running for the server (example: os reload).

func (Virtual_Guest) GetAdditionalRequiredPricesForOsReload 

func (r Virtual_Guest) GetAdditionalRequiredPricesForOsReload(config *datatypes.Container_Hardware_Server_Configuration) (resp []datatypes.Product_Item_Price, err error)

Return a collection of SoftLayer_Item_Price objects for an OS reload

func (Virtual_Guest) GetAllowedHost 

func (r Virtual_Guest) GetAllowedHost() (resp datatypes.Network_Storage_Allowed_Host, err error)

Retrieve The SoftLayer_Network_Storage_Allowed_Host information to connect this Virtual Guest to Network Storage volumes that require access control lists.

func (Virtual_Guest) GetAllowedNetworkStorage 

func (r Virtual_Guest) GetAllowedNetworkStorage() (resp []datatypes.Network_Storage, err error)

Retrieve The SoftLayer_Network_Storage objects that this SoftLayer_Virtual_Guest has access to.

func (Virtual_Guest) GetAllowedNetworkStorageReplicas 

func (r Virtual_Guest) GetAllowedNetworkStorageReplicas() (resp []datatypes.Network_Storage, err error)

Retrieve The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Virtual_Guest has access to.

func (Virtual_Guest) GetAntivirusSpywareSoftwareComponent 

func (r Virtual_Guest) GetAntivirusSpywareSoftwareComponent() (resp datatypes.Software_Component, err error)

Retrieve A antivirus / spyware software component object.

func (Virtual_Guest) GetApplicationDeliveryController 

func (r Virtual_Guest) GetApplicationDeliveryController() (resp datatypes.Network_Application_Delivery_Controller, err error)

Retrieve

func (Virtual_Guest) GetAttachedNetworkStorages 

func (r Virtual_Guest) GetAttachedNetworkStorages(nasType *string) (resp []datatypes.Network_Storage, err error)

This method is retrieve a list of SoftLayer_Network_Storage volumes that are authorized access to this SoftLayer_Virtual_Guest.

func (Virtual_Guest) GetAttributes 

func (r Virtual_Guest) GetAttributes() (resp []datatypes.Virtual_Guest_Attribute, err error)

Retrieve

func (Virtual_Guest) GetAvailableBlockDevicePositions 

func (r Virtual_Guest) GetAvailableBlockDevicePositions() (resp []string, err error)

no documentation yet

func (Virtual_Guest) GetAvailableMonitoring 

func (r Virtual_Guest) GetAvailableMonitoring() (resp []datatypes.Network_Monitor_Version1_Query_Host_Stratum, err error)

Retrieve An object that stores the maximum level for the monitoring query types and response types.

func (Virtual_Guest) GetAvailableNetworkStorages 

func (r Virtual_Guest) GetAvailableNetworkStorages(nasType *string) (resp []datatypes.Network_Storage, err error)

This method retrieves a list of SoftLayer_Network_Storage volumes that can be authorized to this SoftLayer_Virtual_Guest.

func (Virtual_Guest) GetAverageDailyPrivateBandwidthUsage 

func (r Virtual_Guest) GetAverageDailyPrivateBandwidthUsage() (resp datatypes.Float64, err error)

Retrieve The average daily private bandwidth usage for the current billing cycle.

func (Virtual_Guest) GetAverageDailyPublicBandwidthUsage 

func (r Virtual_Guest) GetAverageDailyPublicBandwidthUsage() (resp datatypes.Float64, err error)

Retrieve The average daily public bandwidth usage for the current billing cycle.

func (Virtual_Guest) GetBackendNetworkComponents 

func (r Virtual_Guest) GetBackendNetworkComponents() (resp []datatypes.Virtual_Guest_Network_Component, err error)

Retrieve A guests's backend network components.

func (Virtual_Guest) GetBackendRouters 

func (r Virtual_Guest) GetBackendRouters() (resp []datatypes.Hardware, err error)

Retrieve A guest's backend or private router.

func (Virtual_Guest) GetBandwidthAllocation 

func (r Virtual_Guest) GetBandwidthAllocation() (resp datatypes.Float64, err error)

Retrieve A computing instance's allotted bandwidth (measured in GB).

func (Virtual_Guest) GetBandwidthAllotmentDetail 

func (r Virtual_Guest) GetBandwidthAllotmentDetail() (resp datatypes.Network_Bandwidth_Version1_Allotment_Detail, err error)

Retrieve A computing instance's allotted detail record. Allotment details link bandwidth allocation with allotments.

func (Virtual_Guest) GetBandwidthDataByDate 

func (r Virtual_Guest) GetBandwidthDataByDate(startDateTime *datatypes.Time, endDateTime *datatypes.Time, networkType *string) (resp []datatypes.Metric_Tracking_Object_Data, err error)

Use this method when needing the metric data for bandwidth for a single guest. It will gather the correct input parameters based on the date ranges

func (Virtual_Guest) GetBandwidthForDateRange 

func (r Virtual_Guest) GetBandwidthForDateRange(startDate *datatypes.Time, endDate *datatypes.Time) (resp []datatypes.Metric_Tracking_Object_Data, err error)

Retrieve a collection of bandwidth data from an individual public or private network tracking object. Data is ideal if you with to employ your own traffic storage and graphing systems.

func (Virtual_Guest) GetBandwidthTotal 

func (r Virtual_Guest) GetBandwidthTotal(startDateTime *datatypes.Time, endDateTime *datatypes.Time, direction *string, side *string) (resp uint, err error)

Returns the total amount of bandwidth used during the time specified for a computing instance.

func (Virtual_Guest) GetBillingCycleBandwidthUsage 

func (r Virtual_Guest) GetBillingCycleBandwidthUsage() (resp []datatypes.Network_Bandwidth_Usage, err error)

Retrieve The raw bandwidth usage data for the current billing cycle. One object will be returned for each network this server is attached to.

func (Virtual_Guest) GetBillingCyclePrivateBandwidthUsage 

func (r Virtual_Guest) GetBillingCyclePrivateBandwidthUsage() (resp datatypes.Network_Bandwidth_Usage, err error)

Retrieve The raw private bandwidth usage data for the current billing cycle.

func (Virtual_Guest) GetBillingCyclePublicBandwidthUsage 

func (r Virtual_Guest) GetBillingCyclePublicBandwidthUsage() (resp datatypes.Network_Bandwidth_Usage, err error)

Retrieve The raw public bandwidth usage data for the current billing cycle.

func (Virtual_Guest) GetBillingItem 

func (r Virtual_Guest) GetBillingItem() (resp datatypes.Billing_Item_Virtual_Guest, err error)

Retrieve The billing item for a CloudLayer Compute Instance.

func (Virtual_Guest) GetBlockCancelBecauseDisconnectedFlag 

func (r Virtual_Guest) GetBlockCancelBecauseDisconnectedFlag() (resp bool, err error)

Retrieve Determines whether the instance is ineligible for cancellation because it is disconnected.

func (Virtual_Guest) GetBlockDeviceTemplateGroup 

func (r Virtual_Guest) GetBlockDeviceTemplateGroup() (resp datatypes.Virtual_Guest_Block_Device_Template_Group, err error)

Retrieve The global identifier for the image template that was used to provision or reload a guest.

func (Virtual_Guest) GetBlockDevices 

func (r Virtual_Guest) GetBlockDevices() (resp []datatypes.Virtual_Guest_Block_Device, err error)

Retrieve A computing instance's block devices. Block devices link [[SoftLayer_Virtual_Disk_Image|disk images]] to computing instances.

func (Virtual_Guest) GetBootMode 

func (r Virtual_Guest) GetBootMode() (resp string, err error)

Retrieves the boot mode of the VSI.

func (Virtual_Guest) GetBootOrder 

func (r Virtual_Guest) GetBootOrder() (resp string, err error)

no documentation yet

func (Virtual_Guest) GetBrowserConsoleAccessLogs added in v1.0.4 

func (r Virtual_Guest) GetBrowserConsoleAccessLogs() (resp []datatypes.Virtual_BrowserConsoleAccessLog, err error)

Retrieve A virtual guest's browser access logs.

func (Virtual_Guest) GetConsoleAccessLog 

func (r Virtual_Guest) GetConsoleAccessLog() (resp []datatypes.Network_Logging_Syslog, err error)

Gets the console access logs for a computing instance

func (Virtual_Guest) GetConsoleData added in v1.0.4 

func (r Virtual_Guest) GetConsoleData() (resp datatypes.Container_Virtual_ConsoleData, err error)

Retrieve A container for a guest's console data

func (Virtual_Guest) GetConsoleIpAddressFlag 

func (r Virtual_Guest) GetConsoleIpAddressFlag() (resp bool, err error)

Retrieve [DEPRECATED] A flag indicating a computing instance's console IP address is assigned.

func (Virtual_Guest) GetConsoleIpAddressRecord 

func (r Virtual_Guest) GetConsoleIpAddressRecord() (resp datatypes.Virtual_Guest_Network_Component_IpAddress, err error)

Retrieve [DEPRECATED] A record containing information about a computing instance's console IP and port number.

func (Virtual_Guest) GetContinuousDataProtectionSoftwareComponent 

func (r Virtual_Guest) GetContinuousDataProtectionSoftwareComponent() (resp datatypes.Software_Component, err error)

Retrieve A continuous data protection software component object.

func (Virtual_Guest) GetControlPanel 

func (r Virtual_Guest) GetControlPanel() (resp datatypes.Software_Component, err error)

Retrieve A guest's control panel.

func (Virtual_Guest) GetCoreRestrictedOperatingSystemPrice 

func (r Virtual_Guest) GetCoreRestrictedOperatingSystemPrice() (resp datatypes.Product_Item_Price, err error)

If the virtual server currently has an operating system that has a core capacity restriction, return the associated core-restricted operating system item price. Some operating systems (e.g., Red Hat Enterprise Linux) may be billed by the number of processor cores, so therefore require that a certain number of cores be present on the server.

func (Virtual_Guest) GetCpuMetricDataByDate 

func (r Virtual_Guest) GetCpuMetricDataByDate(startDateTime *datatypes.Time, endDateTime *datatypes.Time, cpuIndexes []int) (resp []datatypes.Metric_Tracking_Object_Data, err error)

Use this method when needing the metric data for a single guest's CPUs. It will gather the correct input parameters based on the date ranges

func (Virtual_Guest) GetCreateObjectOptions 

func (r Virtual_Guest) GetCreateObjectOptions() (resp datatypes.Container_Virtual_Guest_Configuration, err error)

There are many options that may be provided while ordering a computing instance, this method can be used to determine what these options are.

Detailed information on the return value can be found on the data type page for [[SoftLayer_Container_Virtual_Guest_Configuration (type)]].

func (Virtual_Guest) GetCurrentBandwidthSummary 

func (r Virtual_Guest) GetCurrentBandwidthSummary() (resp datatypes.Metric_Tracking_Object_Bandwidth_Summary, err error)

Retrieve An object that provides commonly used bandwidth summary components for the current billing cycle.

func (Virtual_Guest) GetCurrentBillingDetail 

func (r Virtual_Guest) GetCurrentBillingDetail() (resp []datatypes.Billing_Item, err error)

Get the billing detail for this instance for the current billing period. This does not include bandwidth usage.

func (Virtual_Guest) GetCurrentBillingTotal 

func (r Virtual_Guest) GetCurrentBillingTotal() (resp datatypes.Float64, err error)

Get the total bill amount in US Dollars ($) for this instance in the current billing period. This includes all bandwidth used up to the point this method is called on the instance.

func (Virtual_Guest) GetDatacenter 

func (r Virtual_Guest) GetDatacenter() (resp datatypes.Location, err error)

Retrieve The datacenter that a virtual guest resides in.

func (Virtual_Guest) GetDedicatedHost 

func (r Virtual_Guest) GetDedicatedHost() (resp datatypes.Virtual_DedicatedHost, err error)

Retrieve The dedicated host associated with this guest.

func (Virtual_Guest) GetDeviceStatus added in v1.0.4 

func (r Virtual_Guest) GetDeviceStatus() (resp datatypes.Device_Status, err error)

Retrieve The device status of this virtual guest.

func (Virtual_Guest) GetDriveRetentionItemPrice 

func (r Virtual_Guest) GetDriveRetentionItemPrice() (resp datatypes.Product_Item_Price, err error)

Return a drive retention SoftLayer_Item_Price object for a guest.

func (Virtual_Guest) GetEvaultNetworkStorage 

func (r Virtual_Guest) GetEvaultNetworkStorage() (resp []datatypes.Network_Storage, err error)

Retrieve A guest's associated EVault network storage service account.

func (Virtual_Guest) GetFirewallProtectableSubnets 

func (r Virtual_Guest) GetFirewallProtectableSubnets() (resp []datatypes.Network_Subnet, err error)

Get the subnets associated with this CloudLayer computing instance that are protectable by a network component firewall.

func (Virtual_Guest) GetFirewallServiceComponent 

func (r Virtual_Guest) GetFirewallServiceComponent() (resp datatypes.Network_Component_Firewall, err error)

Retrieve A computing instance's hardware firewall services.

func (Virtual_Guest) GetFirstAvailableBlockDevicePosition 

func (r Virtual_Guest) GetFirstAvailableBlockDevicePosition() (resp string, err error)

no documentation yet

func (Virtual_Guest) GetFrontendNetworkComponents 

func (r Virtual_Guest) GetFrontendNetworkComponents() (resp []datatypes.Virtual_Guest_Network_Component, err error)

Retrieve A guest's frontend network components.

func (Virtual_Guest) GetFrontendRouters 

func (r Virtual_Guest) GetFrontendRouters() (resp datatypes.Hardware, err error)

Retrieve A guest's frontend or public router.

func (Virtual_Guest) GetGlobalIdentifier 

func (r Virtual_Guest) GetGlobalIdentifier() (resp string, err error)

Retrieve A guest's universally unique identifier.

func (Virtual_Guest) GetGpuCount 

func (r Virtual_Guest) GetGpuCount() (resp int, err error)

Retrieve The number of GPUs attached to the guest.

func (Virtual_Guest) GetGpuType 

func (r Virtual_Guest) GetGpuType() (resp string, err error)

Retrieve The name of the GPU type attached to the guest.

func (Virtual_Guest) GetGuestBootParameter 

func (r Virtual_Guest) GetGuestBootParameter() (resp datatypes.Virtual_Guest_Boot_Parameter, err error)

Retrieve

func (Virtual_Guest) GetHardwareFunctionDescription added in v1.0.4 

func (r Virtual_Guest) GetHardwareFunctionDescription() (resp string, err error)

Retrieve The object's function.

func (Virtual_Guest) GetHost 

func (r Virtual_Guest) GetHost() (resp datatypes.Virtual_Host, err error)

Retrieve The virtual host on which a virtual guest resides (available only on private clouds).

func (Virtual_Guest) GetHostIpsSoftwareComponent 

func (r Virtual_Guest) GetHostIpsSoftwareComponent() (resp datatypes.Software_Component, err error)

Retrieve A host IPS software component object.

func (Virtual_Guest) GetHourlyBillingFlag 

func (r Virtual_Guest) GetHourlyBillingFlag() (resp bool, err error)

Retrieve A guest's hourly billing status.

func (Virtual_Guest) GetInboundPrivateBandwidthUsage 

func (r Virtual_Guest) GetInboundPrivateBandwidthUsage() (resp datatypes.Float64, err error)

Retrieve The total private inbound bandwidth for this computing instance for the current billing cycle.

func (Virtual_Guest) GetInboundPublicBandwidthUsage 

func (r Virtual_Guest) GetInboundPublicBandwidthUsage() (resp datatypes.Float64, err error)

Retrieve The total public inbound bandwidth for this computing instance for the current billing cycle.

func (Virtual_Guest) GetInternalTagReferences 

func (r Virtual_Guest) GetInternalTagReferences() (resp []datatypes.Tag_Reference, err error)

Retrieve

func (Virtual_Guest) GetIsoBootImage 

func (r Virtual_Guest) GetIsoBootImage() (resp datatypes.Virtual_Disk_Image, err error)

no documentation yet

func (Virtual_Guest) GetItemPricesFromSoftwareDescriptions 

func (r Virtual_Guest) GetItemPricesFromSoftwareDescriptions(softwareDescriptions []datatypes.Software_Description, includeTranslationsFlag *bool, returnAllPricesFlag *bool) (resp []datatypes.Product_Item, err error)

Return a collection of SoftLayer_Item_Price objects from a collection of SoftLayer_Software_Description

func (Virtual_Guest) GetLastKnownPowerState 

func (r Virtual_Guest) GetLastKnownPowerState() (resp datatypes.Virtual_Guest_Power_State, err error)

Retrieve The last known power state of a virtual guest in the event the guest is turned off outside of IMS or has gone offline.

func (Virtual_Guest) GetLastOperatingSystemReload 

func (r Virtual_Guest) GetLastOperatingSystemReload() (resp datatypes.Provisioning_Version1_Transaction, err error)

Retrieve The last transaction that a cloud server's operating system was loaded.

func (Virtual_Guest) GetLastTransaction 

func (r Virtual_Guest) GetLastTransaction() (resp datatypes.Provisioning_Version1_Transaction, err error)

Retrieve The last transaction a cloud server had performed.

func (Virtual_Guest) GetLatestNetworkMonitorIncident 

func (r Virtual_Guest) GetLatestNetworkMonitorIncident() (resp datatypes.Network_Monitor_Version1_Incident, err error)

Retrieve A virtual guest's latest network monitoring incident.

func (Virtual_Guest) GetLocalDiskFlag 

func (r Virtual_Guest) GetLocalDiskFlag() (resp bool, err error)

Retrieve A flag indicating that the virtual guest has at least one disk which is local to the host it runs on. This does not include a SWAP device.

func (Virtual_Guest) GetLocation 

func (r Virtual_Guest) GetLocation() (resp datatypes.Location, err error)

Retrieve Where guest is located within SoftLayer's location hierarchy.

func (Virtual_Guest) GetManagedResourceFlag 

func (r Virtual_Guest) GetManagedResourceFlag() (resp bool, err error)

Retrieve A flag indicating that the virtual guest is a managed resource.

func (Virtual_Guest) GetMemoryMetricDataByDate 

func (r Virtual_Guest) GetMemoryMetricDataByDate(startDateTime *datatypes.Time, endDateTime *datatypes.Time) (resp []datatypes.Metric_Tracking_Object_Data, err error)

Use this method when needing the metric data for memory for a single computing instance.

func (Virtual_Guest) GetMetricTrackingObject 

func (r Virtual_Guest) GetMetricTrackingObject() (resp datatypes.Metric_Tracking_Object, err error)

Retrieve A guest's metric tracking object.

func (Virtual_Guest) GetMetricTrackingObjectId 

func (r Virtual_Guest) GetMetricTrackingObjectId() (resp int, err error)

Retrieve The metric tracking object id for this guest.

func (Virtual_Guest) GetMonitoringRobot 

func (r Virtual_Guest) GetMonitoringRobot() (resp datatypes.Monitoring_Robot, err error)

Retrieve

func (Virtual_Guest) GetMonitoringServiceComponent 

func (r Virtual_Guest) GetMonitoringServiceComponent() (resp datatypes.Network_Monitor_Version1_Query_Host_Stratum, err error)

Retrieve A virtual guest's network monitoring services.

func (Virtual_Guest) GetMonitoringServiceEligibilityFlag 

func (r Virtual_Guest) GetMonitoringServiceEligibilityFlag() (resp bool, err error)

Retrieve

func (Virtual_Guest) GetMonitoringUserNotification 

func (r Virtual_Guest) GetMonitoringUserNotification() (resp []datatypes.User_Customer_Notification_Virtual_Guest, err error)

Retrieve The monitoring notification objects for this guest. Each object links this guest instance to a user account that will be notified if monitoring on this guest object fails

func (Virtual_Guest) GetNetworkComponentFirewallProtectableIpAddresses 

func (r Virtual_Guest) GetNetworkComponentFirewallProtectableIpAddresses() (resp []datatypes.Network_Subnet_IpAddress, err error)

Get the IP addresses associated with this CloudLayer computing instance that are protectable by a network component firewall. Note, this may not return all values for IPv6 subnets for this CloudLayer computing instance. Please use getFirewallProtectableSubnets to get all protectable subnets.

func (Virtual_Guest) GetNetworkComponents 

func (r Virtual_Guest) GetNetworkComponents() (resp []datatypes.Virtual_Guest_Network_Component, err error)

Retrieve A guests's network components.

func (Virtual_Guest) GetNetworkMonitorIncidents 

func (r Virtual_Guest) GetNetworkMonitorIncidents() (resp []datatypes.Network_Monitor_Version1_Incident, err error)

Retrieve All of a virtual guest's network monitoring incidents.

func (Virtual_Guest) GetNetworkMonitors 

func (r Virtual_Guest) GetNetworkMonitors() (resp []datatypes.Network_Monitor_Version1_Query_Host, err error)

Retrieve A guests's network monitors.

func (Virtual_Guest) GetNetworkStorage 

func (r Virtual_Guest) GetNetworkStorage() (resp []datatypes.Network_Storage, err error)

Retrieve A guest's associated network storage accounts.

func (Virtual_Guest) GetNetworkVlans 

func (r Virtual_Guest) GetNetworkVlans() (resp []datatypes.Network_Vlan, err error)

Retrieve The network Vlans that a guest's network components are associated with.

func (Virtual_Guest) GetObject 

func (r Virtual_Guest) GetObject() (resp datatypes.Virtual_Guest, err error)

no documentation yet

func (Virtual_Guest) GetOpenCancellationTicket 

func (r Virtual_Guest) GetOpenCancellationTicket() (resp datatypes.Ticket, err error)

Retrieve An open ticket requesting cancellation of this server, if one exists.

func (Virtual_Guest) GetOperatingSystem 

func (r Virtual_Guest) GetOperatingSystem() (resp datatypes.Software_Component_OperatingSystem, err error)

Retrieve A guest's operating system.

func (Virtual_Guest) GetOperatingSystemReferenceCode 

func (r Virtual_Guest) GetOperatingSystemReferenceCode() (resp string, err error)

Retrieve A guest's operating system software description.

func (Virtual_Guest) GetOrderTemplate 

func (r Virtual_Guest) GetOrderTemplate(billingType *string, orderPrices []datatypes.Product_Item_Price) (resp datatypes.Container_Product_Order, err error)

Obtain an order container that is ready to be sent to the [[SoftLayer_Product_Order#placeOrder|SoftLayer_Product_Order::placeOrder]] method. This container will include all services that the selected computing instance has. If desired you may remove prices which were returned.

func (Virtual_Guest) GetOrderedPackageId 

func (r Virtual_Guest) GetOrderedPackageId() (resp string, err error)

Retrieve The original package id provided with the order for a Cloud Computing Instance.

func (Virtual_Guest) GetOutboundPrivateBandwidthUsage 

func (r Virtual_Guest) GetOutboundPrivateBandwidthUsage() (resp datatypes.Float64, err error)

Retrieve The total private outbound bandwidth for this computing instance for the current billing cycle.

func (Virtual_Guest) GetOutboundPublicBandwidthUsage 

func (r Virtual_Guest) GetOutboundPublicBandwidthUsage() (resp datatypes.Float64, err error)

Retrieve The total public outbound bandwidth for this computing instance for the current billing cycle.

func (Virtual_Guest) GetOverBandwidthAllocationFlag 

func (r Virtual_Guest) GetOverBandwidthAllocationFlag() (resp int, err error)

Retrieve Whether the bandwidth usage for this computing instance for the current billing cycle exceeds the allocation.

func (Virtual_Guest) GetPendingMaintenanceActions 

func (r Virtual_Guest) GetPendingMaintenanceActions() (resp []datatypes.Container_Virtual_Guest_PendingMaintenanceAction, err error)

Returns a list of all the pending maintenance actions affecting this guest.

func (Virtual_Guest) GetPendingMigrationFlag 

func (r Virtual_Guest) GetPendingMigrationFlag() (resp bool, err error)

Retrieve When true this virtual guest must be migrated using SoftLayer_Virtual_Guest::migrate.

func (Virtual_Guest) GetPlacementGroup 

func (r Virtual_Guest) GetPlacementGroup() (resp datatypes.Virtual_PlacementGroup, err error)

Retrieve The placement group that a virtual guest belongs to.

func (Virtual_Guest) GetPowerState 

func (r Virtual_Guest) GetPowerState() (resp datatypes.Virtual_Guest_Power_State, err error)

Retrieve The current power state of a virtual guest.

func (Virtual_Guest) GetPrimaryBackendIpAddress 

func (r Virtual_Guest) GetPrimaryBackendIpAddress() (resp string, err error)

Retrieve A guest's primary private IP address.

func (Virtual_Guest) GetPrimaryBackendNetworkComponent 

func (r Virtual_Guest) GetPrimaryBackendNetworkComponent() (resp datatypes.Virtual_Guest_Network_Component, err error)

Retrieve A guest's primary backend network component.

func (Virtual_Guest) GetPrimaryIpAddress 

func (r Virtual_Guest) GetPrimaryIpAddress() (resp string, err error)

Retrieve The guest's primary public IP address.

func (Virtual_Guest) GetPrimaryNetworkComponent 

func (r Virtual_Guest) GetPrimaryNetworkComponent() (resp datatypes.Virtual_Guest_Network_Component, err error)

Retrieve A guest's primary public network component.

func (Virtual_Guest) GetPrivateNetworkOnlyFlag 

func (r Virtual_Guest) GetPrivateNetworkOnlyFlag() (resp bool, err error)

Retrieve Whether the computing instance only has access to the private network.

func (Virtual_Guest) GetProjectedOverBandwidthAllocationFlag 

func (r Virtual_Guest) GetProjectedOverBandwidthAllocationFlag() (resp int, err error)

Retrieve Whether the bandwidth usage for this computing instance for the current billing cycle is projected to exceed the allocation.

func (Virtual_Guest) GetProjectedPublicBandwidthUsage 

func (r Virtual_Guest) GetProjectedPublicBandwidthUsage() (resp datatypes.Float64, err error)

Retrieve The projected public outbound bandwidth for this computing instance for the current billing cycle.

func (Virtual_Guest) GetProvisionDate 

func (r Virtual_Guest) GetProvisionDate() (resp datatypes.Time, err error)

no documentation yet

func (Virtual_Guest) GetRecentEvents 

func (r Virtual_Guest) GetRecentEvents() (resp []datatypes.Notification_Occurrence_Event, err error)

Retrieve Recent events that impact this computing instance.

func (Virtual_Guest) GetRecentMetricData 

func (r Virtual_Guest) GetRecentMetricData(time *uint) (resp []datatypes.Metric_Tracking_Object, err error)

Recent metric data for a guest

func (Virtual_Guest) GetRegionalGroup 

func (r Virtual_Guest) GetRegionalGroup() (resp datatypes.Location_Group_Regional, err error)

Retrieve The regional group this guest is in.

func (Virtual_Guest) GetRegionalInternetRegistry 

func (r Virtual_Guest) GetRegionalInternetRegistry() (resp datatypes.Network_Regional_Internet_Registry, err error)

Retrieve

func (Virtual_Guest) GetReservedCapacityGroup 

func (r Virtual_Guest) GetReservedCapacityGroup() (resp datatypes.Virtual_ReservedCapacityGroup, err error)

Retrieve The reserved capacity group the guest is associated with.

func (Virtual_Guest) GetReservedCapacityGroupFlag 

func (r Virtual_Guest) GetReservedCapacityGroupFlag() (resp bool, err error)

Retrieve Flag to indicate whether or not a guest is part of a reserved capacity group.

func (Virtual_Guest) GetReservedCapacityGroupInstance 

func (r Virtual_Guest) GetReservedCapacityGroupInstance() (resp datatypes.Virtual_ReservedCapacityGroup_Instance, err error)

Retrieve The reserved capacity group instance the guest is associated with.

func (Virtual_Guest) GetReverseDomainRecords 

func (r Virtual_Guest) GetReverseDomainRecords() (resp []datatypes.Dns_Domain, err error)

Retrieve the reverse domain records associated with this server.

func (Virtual_Guest) GetSecurityScanRequests 

func (r Virtual_Guest) GetSecurityScanRequests() (resp []datatypes.Network_Security_Scanner_Request, err error)

Retrieve A guest's vulnerability scan requests.

func (Virtual_Guest) GetServerRoom 

func (r Virtual_Guest) GetServerRoom() (resp datatypes.Location, err error)

Retrieve The server room that a guest is located at. There may be more than one server room for every data center.

func (Virtual_Guest) GetSoftwareComponents 

func (r Virtual_Guest) GetSoftwareComponents() (resp []datatypes.Software_Component, err error)

Retrieve A guest's installed software.

func (Virtual_Guest) GetSshKeys 

func (r Virtual_Guest) GetSshKeys() (resp []datatypes.Security_Ssh_Key, err error)

Retrieve SSH keys to be installed on the server during provisioning or an OS reload.

func (Virtual_Guest) GetStatus 

func (r Virtual_Guest) GetStatus() (resp datatypes.Virtual_Guest_Status, err error)

Retrieve A computing instance's status.

func (Virtual_Guest) GetTagReferences 

func (r Virtual_Guest) GetTagReferences() (resp []datatypes.Tag_Reference, err error)

Retrieve

func (Virtual_Guest) GetTransientGuestFlag 

func (r Virtual_Guest) GetTransientGuestFlag() (resp bool, err error)

Retrieve Whether or not a computing instance is a Transient Instance.

func (Virtual_Guest) GetTransientWebhookURI 

func (r Virtual_Guest) GetTransientWebhookURI() (resp datatypes.Virtual_Guest_Attribute, err error)

Retrieve The endpoint used to notify customers their transient guest is terminating.

func (Virtual_Guest) GetType 

func (r Virtual_Guest) GetType() (resp datatypes.Virtual_Guest_Type, err error)

Retrieve The type of this virtual guest.

func (Virtual_Guest) GetUpgradeItemPrices 

func (r Virtual_Guest) GetUpgradeItemPrices(includeDowngradeItemPrices *bool) (resp []datatypes.Product_Item_Price, err error)

Retrieves a list of all upgrades available to a virtual server. Upgradeable items include, but are not limited to, number of cores, amount of RAM, storage configuration, and network port speed.

This method exclude downgrade item prices by default. You can set the "includeDowngradeItemPrices" parameter to true so that it can include downgrade item prices.

func (Virtual_Guest) GetUpgradeRequest 

func (r Virtual_Guest) GetUpgradeRequest() (resp datatypes.Product_Upgrade_Request, err error)

Retrieve A computing instance's associated upgrade request object if any.

func (Virtual_Guest) GetUserData 

func (r Virtual_Guest) GetUserData() (resp []datatypes.Virtual_Guest_Attribute, err error)

Retrieve A base64 encoded string containing custom user data for a Cloud Computing Instance order.

func (Virtual_Guest) GetUsers 

func (r Virtual_Guest) GetUsers() (resp []datatypes.User_Customer, err error)

Retrieve A list of users that have access to this computing instance.

func (Virtual_Guest) GetValidBlockDeviceTemplateGroups 

func (r Virtual_Guest) GetValidBlockDeviceTemplateGroups(visibility *string) (resp []datatypes.Virtual_Guest_Block_Device_Template_Group, err error)

This method will return the list of block device template groups that are valid to the host. For instance, it will validate that the template groups returned are compatible with the size and number of disks on the host.

func (Virtual_Guest) GetVirtualRack 

func (r Virtual_Guest) GetVirtualRack() (resp datatypes.Network_Bandwidth_Version1_Allotment, err error)

Retrieve The name of the bandwidth allotment that a hardware belongs too.

func (Virtual_Guest) GetVirtualRackId 

func (r Virtual_Guest) GetVirtualRackId() (resp int, err error)

Retrieve The id of the bandwidth allotment that a computing instance belongs too.

func (Virtual_Guest) GetVirtualRackName 

func (r Virtual_Guest) GetVirtualRackName() (resp string, err error)

Retrieve The name of the bandwidth allotment that a computing instance belongs too.

func (Virtual_Guest) Id 

func (r Virtual_Guest) Id(id int) Virtual_Guest

func (Virtual_Guest) IsBackendPingable 

func (r Virtual_Guest) IsBackendPingable() (resp bool, err error)

Issues a ping command and returns the success (true) or failure (false) of the ping command.

func (Virtual_Guest) IsCloudInit added in v1.0.2 

func (r Virtual_Guest) IsCloudInit() (resp bool, err error)

Determines if the virtual guest was provisioned from a cloud-init enabled image.

func (Virtual_Guest) IsPingable 

func (r Virtual_Guest) IsPingable() (resp bool, err error)

Issues a ping command and returns the success (true) or failure (false) of the ping command.

func (Virtual_Guest) IsolateInstanceForDestructiveAction 

func (r Virtual_Guest) IsolateInstanceForDestructiveAction() (err error)

Closes the public or private ports to isolate the instance before a destructive action.

func (Virtual_Guest) Limit 

func (r Virtual_Guest) Limit(limit int) Virtual_Guest

func (Virtual_Guest) Mask 

func (r Virtual_Guest) Mask(mask string) Virtual_Guest

func (Virtual_Guest) Migrate 

func (r Virtual_Guest) Migrate() (resp datatypes.Provisioning_Version1_Transaction, err error)

Creates a transaction to migrate a virtual guest to a new host. NOTE: Will only migrate if SoftLayer_Virtual_Guest property pendingMigrationFlag = true

func (Virtual_Guest) MigrateDedicatedHost 

func (r Virtual_Guest) MigrateDedicatedHost(destinationHostId *int) (err error)

Create a transaction to migrate an instance from one dedicated host to another dedicated host

func (Virtual_Guest) MountIsoImage 

func (r Virtual_Guest) MountIsoImage(diskImageId *int) (resp datatypes.Provisioning_Version1_Transaction, err error)

no documentation yet

func (Virtual_Guest) Offset 

func (r Virtual_Guest) Offset(offset int) Virtual_Guest

func (Virtual_Guest) Pause 

func (r Virtual_Guest) Pause() (resp bool, err error)

Pause a virtual guest. This can only be called when the specified VM is in the Running state.

func (Virtual_Guest) PowerCycle 

func (r Virtual_Guest) PowerCycle() (resp bool, err error)

Power cycle a virtual guest

func (Virtual_Guest) PowerOff 

func (r Virtual_Guest) PowerOff() (resp bool, err error)

Power off a virtual guest

func (Virtual_Guest) PowerOffSoft 

func (r Virtual_Guest) PowerOffSoft() (resp bool, err error)

Power off a virtual guest

func (Virtual_Guest) PowerOn 

func (r Virtual_Guest) PowerOn() (resp bool, err error)

Power on a virtual guest

func (Virtual_Guest) RebootDefault 

func (r Virtual_Guest) RebootDefault() (resp bool, err error)

Power cycle a virtual guest

func (Virtual_Guest) RebootHard 

func (r Virtual_Guest) RebootHard() (resp bool, err error)

Power cycle a guest.

func (Virtual_Guest) RebootSoft 

func (r Virtual_Guest) RebootSoft() (resp bool, err error)

Attempt to complete a soft reboot of a guest by shutting down the operating system.

func (Virtual_Guest) ReconfigureConsole added in v1.1.4 

func (r Virtual_Guest) ReconfigureConsole() (err error)

no documentation yet Deprecated: This function has been marked as deprecated.

func (Virtual_Guest) ReloadCurrentOperatingSystemConfiguration 

func (r Virtual_Guest) ReloadCurrentOperatingSystemConfiguration() (resp datatypes.Provisioning_Version1_Transaction, err error)

Create a transaction to perform an OS reload

func (Virtual_Guest) ReloadOperatingSystem 

func (r Virtual_Guest) ReloadOperatingSystem(token *string, config *datatypes.Container_Hardware_Server_Configuration) (resp string, err error)

Reloads current operating system configuration.

This service has a confirmation protocol for proceeding with the reload. To proceed with the reload without confirmation, simply pass in 'FORCE' as the token parameter. To proceed with the reload with confirmation, simply call the service with no parameter. A token string will be returned by this service. The token will remain active for 10 minutes. Use this token as the parameter to confirm that a reload is to be performed for the server.

As a precaution, we strongly recommend backing up all data before reloading the operating system. The reload will format the primary disk and will reconfigure the computing instance to the current specifications on record.

If reloading from an image template, we recommend first getting the list of valid private block device template groups, by calling the getOperatingSystemReloadImages method.

func (Virtual_Guest) RemoveAccessToNetworkStorage 

func (r Virtual_Guest) RemoveAccessToNetworkStorage(networkStorageTemplateObject *datatypes.Network_Storage) (resp bool, err error)

This method is used to remove access to a SoftLayer_Network_Storage volume that supports host- or network-level access control.

func (Virtual_Guest) RemoveAccessToNetworkStorageList 

func (r Virtual_Guest) RemoveAccessToNetworkStorageList(networkStorageTemplateObjects []datatypes.Network_Storage) (resp bool, err error)

This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support host- or network-level access control.

func (Virtual_Guest) RemoveTags 

func (r Virtual_Guest) RemoveTags(tags *string) (resp bool, err error)

no documentation yet

func (Virtual_Guest) Resume 

func (r Virtual_Guest) Resume() (resp bool, err error)

Resume a virtual guest, this can only be called when a VSI is in Suspended state.

func (Virtual_Guest) SendTestReclaimScheduledAlert 

func (r Virtual_Guest) SendTestReclaimScheduledAlert() (err error)

no documentation yet

func (Virtual_Guest) SetPrivateNetworkInterfaceSpeed 

func (r Virtual_Guest) SetPrivateNetworkInterfaceSpeed(newSpeed *int) (resp bool, err error)

Sets the private network interface speed to the new speed. Speed values can only be 0 (Disconnect), 10, 100, or 1000. The new speed must be equal to or less than the max speed of the interface.

It will take less than a minute to update the port speed.

func (Virtual_Guest) SetPublicNetworkInterfaceSpeed 

func (r Virtual_Guest) SetPublicNetworkInterfaceSpeed(newSpeed *int) (resp bool, err error)

Sets the public network interface speed to the new speed. Speed values can only be 0 (Disconnect), 10, 100, or 1000. The new speed must be equal to or less than the max speed of the interface.

It will take less than a minute to update the port speed.

func (Virtual_Guest) SetTags 

func (r Virtual_Guest) SetTags(tags *string) (resp bool, err error)

no documentation yet

func (Virtual_Guest) SetTransientWebhook 

func (r Virtual_Guest) SetTransientWebhook(uri *string, secret *string) (err error)

no documentation yet

func (Virtual_Guest) SetUserMetadata 

func (r Virtual_Guest) SetUserMetadata(metadata []string) (resp bool, err error)

Sets the data that will be written to the configuration drive.

func (Virtual_Guest) ShutdownPrivatePort 

func (r Virtual_Guest) ShutdownPrivatePort() (resp bool, err error)

Shuts down the private network port

func (Virtual_Guest) ShutdownPublicPort 

func (r Virtual_Guest) ShutdownPublicPort() (resp bool, err error)

Shuts down the public network port

func (Virtual_Guest) UnmountIsoImage 

func (r Virtual_Guest) UnmountIsoImage() (resp datatypes.Provisioning_Version1_Transaction, err error)

no documentation yet

func (Virtual_Guest) ValidateImageTemplate 

func (r Virtual_Guest) ValidateImageTemplate(imageTemplateId *int) (resp bool, err error)

Validate an image template for OS Reload

func (Virtual_Guest) VerifyReloadOperatingSystem 

func (r Virtual_Guest) VerifyReloadOperatingSystem(config *datatypes.Container_Hardware_Server_Configuration) (resp bool, err error)

Verify that a virtual server can go through the operating system reload process. It may be useful to call this method before attempting to actually reload the operating system just to verify that the reload will go smoothly. If the server configuration is not setup correctly or there is some other issue, an exception will be thrown indicating the error. If there were no issues, this will just return true.

type Virtual_Guest_Block_Device_Template_Group 

type Virtual_Guest_Block_Device_Template_Group struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetVirtualGuestBlockDeviceTemplateGroupService 

func GetVirtualGuestBlockDeviceTemplateGroupService(sess session.SLSession) Virtual_Guest_Block_Device_Template_Group

GetVirtualGuestBlockDeviceTemplateGroupService returns an instance of the Virtual_Guest_Block_Device_Template_Group SoftLayer service

func (Virtual_Guest_Block_Device_Template_Group) AddByolAttribute 

func (r Virtual_Guest_Block_Device_Template_Group) AddByolAttribute() (resp bool, err error)

This method allows you to mark this image template as customer managed software license (BYOL)

func (Virtual_Guest_Block_Device_Template_Group) AddCloudInitAttribute 

func (r Virtual_Guest_Block_Device_Template_Group) AddCloudInitAttribute() (resp bool, err error)

This method allows you to mark this image template as cloud init

func (Virtual_Guest_Block_Device_Template_Group) AddLocations 

func (r Virtual_Guest_Block_Device_Template_Group) AddLocations(locations []datatypes.Location) (resp bool, err error)

This method will create transaction(s) to add available locations to an archive image template.

func (Virtual_Guest_Block_Device_Template_Group) AddSupportedBootMode 

func (r Virtual_Guest_Block_Device_Template_Group) AddSupportedBootMode(bootMode *string) (resp bool, err error)

This method allows you to mark this image's supported boot modes as 'HVM' or 'PV'.

func (Virtual_Guest_Block_Device_Template_Group) CopyToExternalSource 

func (r Virtual_Guest_Block_Device_Template_Group) CopyToExternalSource(configuration *datatypes.Container_Virtual_Guest_Block_Device_Template_Configuration) (resp bool, err error)

Create a transaction to export/copy a template to an external source.

func (Virtual_Guest_Block_Device_Template_Group) CopyToIcos 

func (r Virtual_Guest_Block_Device_Template_Group) CopyToIcos(configuration *datatypes.Container_Virtual_Guest_Block_Device_Template_Configuration) (resp bool, err error)

Create a transaction to export/copy a template to an ICOS.

func (Virtual_Guest_Block_Device_Template_Group) CreateFromExternalSource 

func (r Virtual_Guest_Block_Device_Template_Group) CreateFromExternalSource(configuration *datatypes.Container_Virtual_Guest_Block_Device_Template_Configuration) (resp datatypes.Virtual_Guest_Block_Device_Template_Group, err error)

Create a transaction to import a disk image from an external source and create a standard image template.

func (Virtual_Guest_Block_Device_Template_Group) CreateFromIcos 

func (r Virtual_Guest_Block_Device_Template_Group) CreateFromIcos(configuration *datatypes.Container_Virtual_Guest_Block_Device_Template_Configuration) (resp datatypes.Virtual_Guest_Block_Device_Template_Group, err error)

Create a process to import a disk image from ICOS and create a standard

func (Virtual_Guest_Block_Device_Template_Group) CreatePublicArchiveTransaction 

func (r Virtual_Guest_Block_Device_Template_Group) CreatePublicArchiveTransaction(groupName *string, summary *string, note *string, locations []datatypes.Location) (resp int, err error)

Create a transaction to copy archived block devices into public repository

func (Virtual_Guest_Block_Device_Template_Group) DeleteByolAttribute 

func (r Virtual_Guest_Block_Device_Template_Group) DeleteByolAttribute() (resp bool, err error)

This method allows you to remove BYOL attribute for a given image template.

func (Virtual_Guest_Block_Device_Template_Group) DeleteCloudInitAttribute 

func (r Virtual_Guest_Block_Device_Template_Group) DeleteCloudInitAttribute() (resp bool, err error)

This method allows you to remove cloud init attribute for a given image template.

func (Virtual_Guest_Block_Device_Template_Group) DeleteObject 

func (r Virtual_Guest_Block_Device_Template_Group) DeleteObject() (resp datatypes.Provisioning_Version1_Transaction, err error)

Deleting a block device template group is different from the deletion of other objects. A block device template group can contain several gigabytes of data in its disk images. This may take some time to delete and requires a transaction to be created. This method creates a transaction that will delete all resources associated with the block device template group.

func (Virtual_Guest_Block_Device_Template_Group) DenySharingAccess 

func (r Virtual_Guest_Block_Device_Template_Group) DenySharingAccess(accountId *int) (resp bool, err error)

This method will deny another SoftLayer customer account's previously given access to provision CloudLayer Computing Instances from an image template group. Template access should only be removed from the parent template group object, not the child.

func (Virtual_Guest_Block_Device_Template_Group) EditObject 

func (r Virtual_Guest_Block_Device_Template_Group) EditObject(templateObject *datatypes.Virtual_Guest_Block_Device_Template_Group) (resp bool, err error)

Edit an image template group's associated name and note. All other properties in the SoftLayer_Virtual_Guest_Block_Device_Template_Group data type are read-only.

func (Virtual_Guest_Block_Device_Template_Group) Filter 

func (r Virtual_Guest_Block_Device_Template_Group) Filter(filter string) Virtual_Guest_Block_Device_Template_Group

func (Virtual_Guest_Block_Device_Template_Group) FindGcImagesByCurrentUser 

func (r Virtual_Guest_Block_Device_Template_Group) FindGcImagesByCurrentUser(dataCenters []string, regions []string) (resp []datatypes.Virtual_Guest_Block_Device_Template_Group, err error)

Find block device template groups containing a GC enabled cloudinit image for the current active user. A sorted collection of groups is returned. The Caller can optionally specify data center or region names to retrieve GC images from only those locations.

func (Virtual_Guest_Block_Device_Template_Group) GetAccount 

func (r Virtual_Guest_Block_Device_Template_Group) GetAccount() (resp datatypes.Account, err error)

Retrieve A block device template group's [[SoftLayer_Account|account]].

func (Virtual_Guest_Block_Device_Template_Group) GetAccountContacts 

func (r Virtual_Guest_Block_Device_Template_Group) GetAccountContacts() (resp []datatypes.Account_Contact, err error)

Retrieve

func (Virtual_Guest_Block_Device_Template_Group) GetAccountReferences 

func (r Virtual_Guest_Block_Device_Template_Group) GetAccountReferences() (resp []datatypes.Virtual_Guest_Block_Device_Template_Group_Accounts, err error)

Retrieve The accounts which may have read-only access to an image template group. Will only be populated for parent template group objects.

func (Virtual_Guest_Block_Device_Template_Group) GetAllAvailableCompatiblePlatformNames 

func (r Virtual_Guest_Block_Device_Template_Group) GetAllAvailableCompatiblePlatformNames() (resp []string, err error)

Get all available compatible platform names that can be added to a template group.

func (Virtual_Guest_Block_Device_Template_Group) GetBlockDevices 

func (r Virtual_Guest_Block_Device_Template_Group) GetBlockDevices() (resp []datatypes.Virtual_Guest_Block_Device_Template, err error)

Retrieve The block devices that are part of an image template group

func (Virtual_Guest_Block_Device_Template_Group) GetBlockDevicesDiskSpaceTotal 

func (r Virtual_Guest_Block_Device_Template_Group) GetBlockDevicesDiskSpaceTotal() (resp datatypes.Float64, err error)

Retrieve The total disk space of all images in a image template group.

func (Virtual_Guest_Block_Device_Template_Group) GetBootMode 

func (r Virtual_Guest_Block_Device_Template_Group) GetBootMode() (resp string, err error)

This method returns the boot mode, if any, set on a given image template.

func (Virtual_Guest_Block_Device_Template_Group) GetByolFlag 

func (r Virtual_Guest_Block_Device_Template_Group) GetByolFlag() (resp bool, err error)

Retrieve A flag indicating that customer is providing the software licenses.

func (Virtual_Guest_Block_Device_Template_Group) GetChildren 

func (r Virtual_Guest_Block_Device_Template_Group) GetChildren() (resp []datatypes.Virtual_Guest_Block_Device_Template_Group, err error)

Retrieve The image template groups that are clones of an image template group.

func (Virtual_Guest_Block_Device_Template_Group) GetCurrentCompatiblePlatformNames 

func (r Virtual_Guest_Block_Device_Template_Group) GetCurrentCompatiblePlatformNames() (resp []string, err error)

Get compatible platform names currently set on the template group.

func (Virtual_Guest_Block_Device_Template_Group) GetDatacenter 

func (r Virtual_Guest_Block_Device_Template_Group) GetDatacenter() (resp datatypes.Location, err error)

Retrieve The location containing this image template group. Will only be populated for child template group objects.

func (Virtual_Guest_Block_Device_Template_Group) GetDatacenters 

func (r Virtual_Guest_Block_Device_Template_Group) GetDatacenters() (resp []datatypes.Location, err error)

Retrieve A collection of locations containing a copy of this image template group. Will only be populated for parent template group objects.

func (Virtual_Guest_Block_Device_Template_Group) GetDefaultBootMode 

func (r Virtual_Guest_Block_Device_Template_Group) GetDefaultBootMode() (resp string, err error)

This method returns the default boot mode set by the software description

func (Virtual_Guest_Block_Device_Template_Group) GetEncryptionAttributes 

func (r Virtual_Guest_Block_Device_Template_Group) GetEncryptionAttributes() (resp []string, err error)

This method returns an array of encryption values, or empty array if none are found

func (Virtual_Guest_Block_Device_Template_Group) GetFirstChild added in v1.0.2 

func (r Virtual_Guest_Block_Device_Template_Group) GetFirstChild() (resp datatypes.Virtual_Guest_Block_Device_Template_Group, err error)

Retrieve The first clone of the image template group

func (Virtual_Guest_Block_Device_Template_Group) GetFlexImageFlag 

func (r Virtual_Guest_Block_Device_Template_Group) GetFlexImageFlag() (resp bool, err error)

Retrieve A flag indicating if this is a flex image.

func (Virtual_Guest_Block_Device_Template_Group) GetGlobalIdentifier 

func (r Virtual_Guest_Block_Device_Template_Group) GetGlobalIdentifier() (resp string, err error)

Retrieve An image template's universally unique identifier.

func (Virtual_Guest_Block_Device_Template_Group) GetImageType 

func (r Virtual_Guest_Block_Device_Template_Group) GetImageType() (resp datatypes.Virtual_Disk_Image_Type, err error)

Retrieve The virtual disk image type of this template. Value will be populated on parent and child, but only supports object filtering on the parent.

func (Virtual_Guest_Block_Device_Template_Group) GetImageTypeKeyName 

func (r Virtual_Guest_Block_Device_Template_Group) GetImageTypeKeyName() (resp string, err error)

Retrieve The virtual disk image type keyname (e.g. SYSTEM, DISK_CAPTURE, ISO, etc) of this template. Value will be populated on parent and child, but only supports object filtering on the parent.

func (Virtual_Guest_Block_Device_Template_Group) GetNextGenFlag 

func (r Virtual_Guest_Block_Device_Template_Group) GetNextGenFlag() (resp bool, err error)

Retrieve A flag indicating if this is a next generation image.

func (Virtual_Guest_Block_Device_Template_Group) GetObject 

func (r Virtual_Guest_Block_Device_Template_Group) GetObject() (resp datatypes.Virtual_Guest_Block_Device_Template_Group, err error)

no documentation yet

func (Virtual_Guest_Block_Device_Template_Group) GetParent 

func (r Virtual_Guest_Block_Device_Template_Group) GetParent() (resp datatypes.Virtual_Guest_Block_Device_Template_Group, err error)

Retrieve The image template group that another image template group was cloned from.

func (Virtual_Guest_Block_Device_Template_Group) GetPublicCustomerOwnedImages 

func (r Virtual_Guest_Block_Device_Template_Group) GetPublicCustomerOwnedImages() (resp []datatypes.Virtual_Guest_Block_Device_Template_Group, err error)

This method gets all public customer owned image templates that the user is allowed to see.

func (Virtual_Guest_Block_Device_Template_Group) GetPublicImages 

func (r Virtual_Guest_Block_Device_Template_Group) GetPublicImages() (resp []datatypes.Virtual_Guest_Block_Device_Template_Group, err error)

This method gets all public image templates that the user is allowed to see.

func (Virtual_Guest_Block_Device_Template_Group) GetRegion added in v1.0.2 

func (r Virtual_Guest_Block_Device_Template_Group) GetRegion() (resp datatypes.Network_Service_Resource, err error)

Retrieve

func (Virtual_Guest_Block_Device_Template_Group) GetRegions added in v1.0.2 

func (r Virtual_Guest_Block_Device_Template_Group) GetRegions() (resp []datatypes.Network_Service_Resource, err error)

Retrieve

func (Virtual_Guest_Block_Device_Template_Group) GetSshKeys 

func (r Virtual_Guest_Block_Device_Template_Group) GetSshKeys() (resp []datatypes.Security_Ssh_Key, err error)

Retrieve The ssh keys to be implemented on the server when provisioned or reloaded from an image template group.

func (Virtual_Guest_Block_Device_Template_Group) GetStatus 

func (r Virtual_Guest_Block_Device_Template_Group) GetStatus() (resp datatypes.Virtual_Guest_Block_Device_Template_Group_Status, err error)

Retrieve A template group's status.

func (Virtual_Guest_Block_Device_Template_Group) GetStorageLocations 

func (r Virtual_Guest_Block_Device_Template_Group) GetStorageLocations() (resp []datatypes.Location, err error)

Returns the image storage locations.

func (Virtual_Guest_Block_Device_Template_Group) GetStorageRepository 

func (r Virtual_Guest_Block_Device_Template_Group) GetStorageRepository() (resp datatypes.Virtual_Storage_Repository, err error)

Retrieve The storage repository that an image template group resides on.

func (Virtual_Guest_Block_Device_Template_Group) GetSupportedBootModes 

func (r Virtual_Guest_Block_Device_Template_Group) GetSupportedBootModes() (resp []string, err error)

This method indicates which boot modes are supported by the image.

func (Virtual_Guest_Block_Device_Template_Group) GetTagReferences 

func (r Virtual_Guest_Block_Device_Template_Group) GetTagReferences() (resp []datatypes.Tag_Reference, err error)

Retrieve The tags associated with this image template group.

func (Virtual_Guest_Block_Device_Template_Group) GetTemplateDataCenterName 

func (r Virtual_Guest_Block_Device_Template_Group) GetTemplateDataCenterName() (resp string, err error)

This method allows you to grab the first data center that the image(s) reside on so we can pull it from there.

func (Virtual_Guest_Block_Device_Template_Group) GetTransaction 

func (r Virtual_Guest_Block_Device_Template_Group) GetTransaction() (resp datatypes.Provisioning_Version1_Transaction, err error)

Retrieve A transaction that is being performed on a image template group.

func (Virtual_Guest_Block_Device_Template_Group) GetVhdImportSoftwareDescriptions 

func (r Virtual_Guest_Block_Device_Template_Group) GetVhdImportSoftwareDescriptions() (resp []datatypes.Software_Description, err error)

Returns an array of SoftLayer_Software_Description that are supported for VHD imports.

func (Virtual_Guest_Block_Device_Template_Group) Id 

func (r Virtual_Guest_Block_Device_Template_Group) Id(id int) Virtual_Guest_Block_Device_Template_Group

func (Virtual_Guest_Block_Device_Template_Group) IsByol 

func (r Virtual_Guest_Block_Device_Template_Group) IsByol() (resp bool, err error)

This method indicates whether or not this image is a customer supplied license image.

func (Virtual_Guest_Block_Device_Template_Group) IsByolCapableOperatingSystem 

func (r Virtual_Guest_Block_Device_Template_Group) IsByolCapableOperatingSystem() (resp bool, err error)

This method indicates whether or not this image uses an operating system capable of using a customer supplied license image.

func (Virtual_Guest_Block_Device_Template_Group) IsByolOnlyOperatingSystem 

func (r Virtual_Guest_Block_Device_Template_Group) IsByolOnlyOperatingSystem() (resp bool, err error)

This method indicates whether or not this image uses an operating system that requires using a customer supplied license image

func (Virtual_Guest_Block_Device_Template_Group) IsCloudInit 

func (r Virtual_Guest_Block_Device_Template_Group) IsCloudInit() (resp bool, err error)

This method indicates whether or not this image is a cloud-init image.

func (Virtual_Guest_Block_Device_Template_Group) IsCloudInitOnlyOperatingSystem 

func (r Virtual_Guest_Block_Device_Template_Group) IsCloudInitOnlyOperatingSystem() (resp bool, err error)

This method indicates whether or not this image uses an operating system that requires cloud init

func (Virtual_Guest_Block_Device_Template_Group) IsEncrypted 

func (r Virtual_Guest_Block_Device_Template_Group) IsEncrypted() (resp bool, err error)

This method indicates whether this image template contains an encrypted disk image.

func (Virtual_Guest_Block_Device_Template_Group) Limit 

func (r Virtual_Guest_Block_Device_Template_Group) Limit(limit int) Virtual_Guest_Block_Device_Template_Group

func (Virtual_Guest_Block_Device_Template_Group) Mask 

func (r Virtual_Guest_Block_Device_Template_Group) Mask(mask string) Virtual_Guest_Block_Device_Template_Group

func (Virtual_Guest_Block_Device_Template_Group) Offset 

func (r Virtual_Guest_Block_Device_Template_Group) Offset(offset int) Virtual_Guest_Block_Device_Template_Group

func (Virtual_Guest_Block_Device_Template_Group) PermitSharingAccess 

func (r Virtual_Guest_Block_Device_Template_Group) PermitSharingAccess(accountId *int) (resp bool, err error)

This method will permit another SoftLayer customer account access to provision CloudLayer Computing Instances from an image template group. Template access should only be given to the parent template group object, not the child.

func (Virtual_Guest_Block_Device_Template_Group) RemoveCompatiblePlatforms 

func (r Virtual_Guest_Block_Device_Template_Group) RemoveCompatiblePlatforms(platformNames []string) (resp bool, err error)

Removes compatible platforms on the template group.

func (Virtual_Guest_Block_Device_Template_Group) RemoveLocations 

func (r Virtual_Guest_Block_Device_Template_Group) RemoveLocations(locations []datatypes.Location) (resp bool, err error)

This method will create transaction(s) to remove available locations from an archive image template.

func (Virtual_Guest_Block_Device_Template_Group) RemoveSupportedBootMode 

func (r Virtual_Guest_Block_Device_Template_Group) RemoveSupportedBootMode(bootMode *string) (resp bool, err error)

This method allows you to remove a supported boot mode attribute for a given image template.

func (Virtual_Guest_Block_Device_Template_Group) SetAvailableLocations 

func (r Virtual_Guest_Block_Device_Template_Group) SetAvailableLocations(locations []datatypes.Location) (resp bool, err error)

Create transaction(s) to set the archived block device available locations

func (Virtual_Guest_Block_Device_Template_Group) SetBootMode 

func (r Virtual_Guest_Block_Device_Template_Group) SetBootMode(newBootMode *string) (resp bool, err error)

This method allows you to specify the boot mode for a given image template.

func (Virtual_Guest_Block_Device_Template_Group) SetCompatiblePlatforms 

func (r Virtual_Guest_Block_Device_Template_Group) SetCompatiblePlatforms(platformNames []string) (resp bool, err error)

Sets compatible platforms on the template group.

func (Virtual_Guest_Block_Device_Template_Group) SetTags 

func (r Virtual_Guest_Block_Device_Template_Group) SetTags(tags *string) (resp bool, err error)

Set the tags for this template group.

type Virtual_Guest_Boot_Parameter 

type Virtual_Guest_Boot_Parameter struct {
	Session session.SLSession
	Options sl.Options
}

no documentation yet

func GetVirtualGuestBootParameterService 

func GetVirtualGuestBootParameterService(sess session.SLSession) Virtual_Guest_Boot_Parameter

GetVirtualGuestBootParameterService returns an instance of the Virtual_Guest_Boot_Parameter SoftLayer service

func (Virtual_Guest_Boot_Parameter) CreateObject 

func (r Virtual_Guest_Boot_Parameter) CreateObject(templateObject *datatypes.Virtual_Guest_Boot_Parameter) (resp bool, err error)

no documentation yet

func (Virtual_Guest_Boot_Parameter) DeleteObject 

func (r Virtual_Guest_Boot_Parameter) DeleteObject() (resp bool, err error)

no documentation yet

func (Virtual_Guest_Boot_Parameter) EditObject 

func (r Virtual_Guest_Boot_Parameter) EditObject(templateObject *datatypes.Virtual_Guest_Boot_Parameter) (resp bool, err error)

no documentation yet

func (Virtual_Guest_Boot_Parameter) Filter 

func (r Virtual_Guest_Boot_Parameter) Filter(filter string) Virtual_Guest_Boot_Parameter

func (Virtual_Guest_Boot_Parameter) GetGuest 

func (r Virtual_Guest_Boot_Parameter) GetGuest() (resp datatypes.Virtual_Guest, err error)

Retrieve

func (Virtual_Guest_Boot_Parameter) GetGuestBootParameterType 

func (r Virtual_Guest_Boot_Parameter) GetGuestBootParameterType() (resp datatypes.Virtual_Guest_Boot_Parameter_Type, err error)

Retrieve

func (Virtual_Guest_Boot_Parameter) GetObject 

func (r Virtual_Guest_Boot_Parameter) GetObject() (resp datatypes.Virtual_Guest_Boot_Parameter, err error)

no documentation yet

func (Virtual_Guest_Boot_Parameter) Id 

func (r Virtual_Guest_Boot_Parameter) Id(id int) Virtual_Guest_Boot_Parameter

func (Virtual_Guest_Boot_Parameter) Limit 

func (r Virtual_Guest_Boot_Parameter) Limit(limit int) Virtual_Guest_Boot_Parameter

func (Virtual_Guest_Boot_Parameter) Mask 

func (r Virtual_Guest_Boot_Parameter) Mask(mask string) Virtual_Guest_Boot_Parameter

func (Virtual_Guest_Boot_Parameter) Offset 

func (r Virtual_Guest_Boot_Parameter) Offset(offset int) Virtual_Guest_Boot_Parameter

type Virtual_Guest_Boot_Parameter_Type 

type Virtual_Guest_Boot_Parameter_Type struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetVirtualGuestBootParameterTypeService 

func GetVirtualGuestBootParameterTypeService(sess session.SLSession) Virtual_Guest_Boot_Parameter_Type

GetVirtualGuestBootParameterTypeService returns an instance of the Virtual_Guest_Boot_Parameter_Type SoftLayer service

func (Virtual_Guest_Boot_Parameter_Type) Filter 

func (r Virtual_Guest_Boot_Parameter_Type) Filter(filter string) Virtual_Guest_Boot_Parameter_Type

func (Virtual_Guest_Boot_Parameter_Type) GetAllObjects 

func (r Virtual_Guest_Boot_Parameter_Type) GetAllObjects() (resp []datatypes.Virtual_Guest_Boot_Parameter_Type, err error)

no documentation yet

func (Virtual_Guest_Boot_Parameter_Type) GetObject 

func (r Virtual_Guest_Boot_Parameter_Type) GetObject() (resp datatypes.Virtual_Guest_Boot_Parameter_Type, err error)

no documentation yet

func (Virtual_Guest_Boot_Parameter_Type) Id 

func (r Virtual_Guest_Boot_Parameter_Type) Id(id int) Virtual_Guest_Boot_Parameter_Type

func (Virtual_Guest_Boot_Parameter_Type) Limit 

func (r Virtual_Guest_Boot_Parameter_Type) Limit(limit int) Virtual_Guest_Boot_Parameter_Type

func (Virtual_Guest_Boot_Parameter_Type) Mask 

func (r Virtual_Guest_Boot_Parameter_Type) Mask(mask string) Virtual_Guest_Boot_Parameter_Type

func (Virtual_Guest_Boot_Parameter_Type) Offset 

func (r Virtual_Guest_Boot_Parameter_Type) Offset(offset int) Virtual_Guest_Boot_Parameter_Type

type Virtual_Guest_Network_Component 

type Virtual_Guest_Network_Component struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetVirtualGuestNetworkComponentService 

func GetVirtualGuestNetworkComponentService(sess session.SLSession) Virtual_Guest_Network_Component

GetVirtualGuestNetworkComponentService returns an instance of the Virtual_Guest_Network_Component SoftLayer service

func (Virtual_Guest_Network_Component) Disable 

func (r Virtual_Guest_Network_Component) Disable() (resp bool, err error)

Completely restrict all incoming and outgoing bandwidth traffic to a network component

func (Virtual_Guest_Network_Component) Enable 

func (r Virtual_Guest_Network_Component) Enable() (resp bool, err error)

Allow incoming and outgoing bandwidth traffic to a network component

func (Virtual_Guest_Network_Component) Filter 

func (r Virtual_Guest_Network_Component) Filter(filter string) Virtual_Guest_Network_Component

func (Virtual_Guest_Network_Component) GetGuest 

func (r Virtual_Guest_Network_Component) GetGuest() (resp datatypes.Virtual_Guest, err error)

Retrieve The computing instance that this network component exists on.

func (Virtual_Guest_Network_Component) GetHighAvailabilityFirewallFlag 

func (r Virtual_Guest_Network_Component) GetHighAvailabilityFirewallFlag() (resp bool, err error)

Retrieve

func (Virtual_Guest_Network_Component) GetIcpBinding 

func (r Virtual_Guest_Network_Component) GetIcpBinding() (resp datatypes.Virtual_Guest_Network_Component_IcpBinding, err error)

Retrieve

func (Virtual_Guest_Network_Component) GetIpAddressBindings 

func (r Virtual_Guest_Network_Component) GetIpAddressBindings() (resp []datatypes.Virtual_Guest_Network_Component_IpAddress, err error)

Retrieve The records of all IP addresses bound to a computing instance's network component.

func (Virtual_Guest_Network_Component) GetNetworkComponentFirewall 

func (r Virtual_Guest_Network_Component) GetNetworkComponentFirewall() (resp datatypes.Network_Component_Firewall, err error)

Retrieve The upstream network component firewall.

func (Virtual_Guest_Network_Component) GetNetworkVlan 

func (r Virtual_Guest_Network_Component) GetNetworkVlan() (resp datatypes.Network_Vlan, err error)

Retrieve The VLAN that a computing instance network component's subnet is associated with.

func (Virtual_Guest_Network_Component) GetObject 

func (r Virtual_Guest_Network_Component) GetObject() (resp datatypes.Virtual_Guest_Network_Component, err error)

no documentation yet

func (Virtual_Guest_Network_Component) GetPrimaryIpAddress 

func (r Virtual_Guest_Network_Component) GetPrimaryIpAddress() (resp string, err error)

Retrieve A computing instance network component's primary IP address.

func (Virtual_Guest_Network_Component) GetPrimaryIpAddressRecord 

func (r Virtual_Guest_Network_Component) GetPrimaryIpAddressRecord() (resp datatypes.Network_Subnet_IpAddress, err error)

Retrieve

func (Virtual_Guest_Network_Component) GetPrimarySubnet 

func (r Virtual_Guest_Network_Component) GetPrimarySubnet() (resp datatypes.Network_Subnet, err error)

Retrieve A network component's subnet for its primary IP address

func (Virtual_Guest_Network_Component) GetPrimaryVersion6IpAddressRecord 

func (r Virtual_Guest_Network_Component) GetPrimaryVersion6IpAddressRecord() (resp datatypes.Network_Subnet_IpAddress, err error)

Retrieve A network component's primary IPv6 IP address record.

func (Virtual_Guest_Network_Component) GetRouter 

func (r Virtual_Guest_Network_Component) GetRouter() (resp datatypes.Hardware_Router, err error)

Retrieve A network component's routers.

func (Virtual_Guest_Network_Component) GetSecurityGroupBindings 

func (r Virtual_Guest_Network_Component) GetSecurityGroupBindings() (resp []datatypes.Virtual_Network_SecurityGroup_NetworkComponentBinding, err error)

Retrieve The bindings associating security groups to this network component

func (Virtual_Guest_Network_Component) GetSubnets 

func (r Virtual_Guest_Network_Component) GetSubnets() (resp []datatypes.Network_Subnet, err error)

Retrieve A network component's subnets. A subnet is a group of IP addresses

func (Virtual_Guest_Network_Component) Id 

func (r Virtual_Guest_Network_Component) Id(id int) Virtual_Guest_Network_Component

func (Virtual_Guest_Network_Component) IsPingable 

func (r Virtual_Guest_Network_Component) IsPingable() (resp bool, err error)

Issues a ping command and returns the success (true) or failure (false) of the ping command.

func (Virtual_Guest_Network_Component) Limit 

func (r Virtual_Guest_Network_Component) Limit(limit int) Virtual_Guest_Network_Component

func (Virtual_Guest_Network_Component) Mask 

func (r Virtual_Guest_Network_Component) Mask(mask string) Virtual_Guest_Network_Component

func (Virtual_Guest_Network_Component) Offset 

func (r Virtual_Guest_Network_Component) Offset(offset int) Virtual_Guest_Network_Component

func (Virtual_Guest_Network_Component) SecurityGroupsReady 

func (r Virtual_Guest_Network_Component) SecurityGroupsReady() (resp bool, err error)

no documentation yet

type Virtual_Host 

type Virtual_Host struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetVirtualHostService 

func GetVirtualHostService(sess session.SLSession) Virtual_Host

GetVirtualHostService returns an instance of the Virtual_Host SoftLayer service

func (Virtual_Host) Filter 

func (r Virtual_Host) Filter(filter string) Virtual_Host

func (Virtual_Host) GetAccount 

func (r Virtual_Host) GetAccount() (resp datatypes.Account, err error)

Retrieve The account which a virtual host belongs to.

func (Virtual_Host) GetHardware 

func (r Virtual_Host) GetHardware() (resp datatypes.Hardware_Server, err error)

Retrieve The hardware record which a virtual host resides on.

func (Virtual_Host) GetObject 

func (r Virtual_Host) GetObject() (resp datatypes.Virtual_Host, err error)

no documentation yet

func (Virtual_Host) GetPciDevices 

func (r Virtual_Host) GetPciDevices() (resp []datatypes.Virtual_Host_PciDevice, err error)

Retrieve

func (Virtual_Host) Id 

func (r Virtual_Host) Id(id int) Virtual_Host

func (Virtual_Host) Limit 

func (r Virtual_Host) Limit(limit int) Virtual_Host

func (Virtual_Host) Mask 

func (r Virtual_Host) Mask(mask string) Virtual_Host

func (Virtual_Host) Offset 

func (r Virtual_Host) Offset(offset int) Virtual_Host

type Virtual_PlacementGroup 

type Virtual_PlacementGroup struct {
	Session session.SLSession
	Options sl.Options
}

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.

func GetVirtualPlacementGroupService 

func GetVirtualPlacementGroupService(sess session.SLSession) Virtual_PlacementGroup

GetVirtualPlacementGroupService returns an instance of the Virtual_PlacementGroup SoftLayer service

func (Virtual_PlacementGroup) CreateObject 

func (r Virtual_PlacementGroup) CreateObject(templateObject *datatypes.Virtual_PlacementGroup) (resp datatypes.Virtual_PlacementGroup, err error)

Add a placement group to your account for use during VSI provisioning.

func (Virtual_PlacementGroup) DeleteObject 

func (r Virtual_PlacementGroup) DeleteObject() (resp bool, err error)

Delete a placement group from your account.

func (Virtual_PlacementGroup) EditObject 

func (r Virtual_PlacementGroup) EditObject(templateObject *datatypes.Virtual_PlacementGroup) (resp bool, err error)

Update a placement group.

func (Virtual_PlacementGroup) Filter 

func (r Virtual_PlacementGroup) Filter(filter string) Virtual_PlacementGroup

func (Virtual_PlacementGroup) GetAccount 

func (r Virtual_PlacementGroup) GetAccount() (resp datatypes.Account, err error)

Retrieve The account that the placement group is implemented on.

func (Virtual_PlacementGroup) GetAvailableRouters 

func (r Virtual_PlacementGroup) GetAvailableRouters(datacenterId *int) (resp []datatypes.Hardware, err error)

Returns all routers available for use with placement groups. If a datacenter location ID is provided, this method will further restrict the list of routers to ones contained within that datacenter.

func (Virtual_PlacementGroup) GetBackendRouter 

func (r Virtual_PlacementGroup) GetBackendRouter() (resp datatypes.Hardware_Router_Backend, err error)

Retrieve The router the placement group is implemented on.

func (Virtual_PlacementGroup) GetGuests 

func (r Virtual_PlacementGroup) GetGuests() (resp []datatypes.Virtual_Guest, err error)

Retrieve The virtual guests that are members of the placement group.

func (Virtual_PlacementGroup) GetObject 

func (r Virtual_PlacementGroup) GetObject() (resp datatypes.Virtual_PlacementGroup, err error)

no documentation yet

func (Virtual_PlacementGroup) GetRule 

func (r Virtual_PlacementGroup) GetRule() (resp datatypes.Virtual_PlacementGroup_Rule, err error)

Retrieve The placement rule that the placement group is implementing.

func (Virtual_PlacementGroup) Id 

func (r Virtual_PlacementGroup) Id(id int) Virtual_PlacementGroup

func (Virtual_PlacementGroup) Limit 

func (r Virtual_PlacementGroup) Limit(limit int) Virtual_PlacementGroup

func (Virtual_PlacementGroup) Mask 

func (r Virtual_PlacementGroup) Mask(mask string) Virtual_PlacementGroup

func (Virtual_PlacementGroup) Offset 

func (r Virtual_PlacementGroup) Offset(offset int) Virtual_PlacementGroup

type Virtual_PlacementGroup_Rule 

type Virtual_PlacementGroup_Rule struct {
	Session session.SLSession
	Options sl.Options
}

This data type presents the structure of a virtual guest placement group rule.

func GetVirtualPlacementGroupRuleService 

func GetVirtualPlacementGroupRuleService(sess session.SLSession) Virtual_PlacementGroup_Rule

GetVirtualPlacementGroupRuleService returns an instance of the Virtual_PlacementGroup_Rule SoftLayer service

func (Virtual_PlacementGroup_Rule) Filter 

func (r Virtual_PlacementGroup_Rule) Filter(filter string) Virtual_PlacementGroup_Rule

func (Virtual_PlacementGroup_Rule) GetAllObjects 

func (r Virtual_PlacementGroup_Rule) GetAllObjects() (resp []datatypes.Virtual_PlacementGroup_Rule, err error)

Get all placement group rules.

func (Virtual_PlacementGroup_Rule) GetObject 

func (r Virtual_PlacementGroup_Rule) GetObject() (resp datatypes.Virtual_PlacementGroup_Rule, err error)

no documentation yet

func (Virtual_PlacementGroup_Rule) Id 

func (r Virtual_PlacementGroup_Rule) Id(id int) Virtual_PlacementGroup_Rule

func (Virtual_PlacementGroup_Rule) Limit 

func (r Virtual_PlacementGroup_Rule) Limit(limit int) Virtual_PlacementGroup_Rule

func (Virtual_PlacementGroup_Rule) Mask 

func (r Virtual_PlacementGroup_Rule) Mask(mask string) Virtual_PlacementGroup_Rule

func (Virtual_PlacementGroup_Rule) Offset 

func (r Virtual_PlacementGroup_Rule) Offset(offset int) Virtual_PlacementGroup_Rule

type Virtual_ReservedCapacityGroup 

type Virtual_ReservedCapacityGroup struct {
	Session session.SLSession
	Options sl.Options
}

This data type presents the structure for a virtual reserved capacity group.

func GetVirtualReservedCapacityGroupService 

func GetVirtualReservedCapacityGroupService(sess session.SLSession) Virtual_ReservedCapacityGroup

GetVirtualReservedCapacityGroupService returns an instance of the Virtual_ReservedCapacityGroup SoftLayer service

func (Virtual_ReservedCapacityGroup) EditObject 

func (r Virtual_ReservedCapacityGroup) EditObject(templateObject *datatypes.Virtual_ReservedCapacityGroup) (resp bool, err error)

Update a reserved capacity group.

func (Virtual_ReservedCapacityGroup) Filter 

func (r Virtual_ReservedCapacityGroup) Filter(filter string) Virtual_ReservedCapacityGroup

func (Virtual_ReservedCapacityGroup) GetAccount 

func (r Virtual_ReservedCapacityGroup) GetAccount() (resp datatypes.Account, err error)

Retrieve The account that the reserved capacity group is implemented on.

func (Virtual_ReservedCapacityGroup) GetAvailableInstances 

func (r Virtual_ReservedCapacityGroup) GetAvailableInstances() (resp []datatypes.Virtual_ReservedCapacityGroup_Instance, err error)

Retrieve The instances available for guest provisions on this reserved capacity group.

func (Virtual_ReservedCapacityGroup) GetBackendRouter 

func (r Virtual_ReservedCapacityGroup) GetBackendRouter() (resp datatypes.Hardware_Router_Backend, err error)

Retrieve The router the reserved capacity group is implemented on.

func (Virtual_ReservedCapacityGroup) GetInstances 

func (r Virtual_ReservedCapacityGroup) GetInstances() (resp []datatypes.Virtual_ReservedCapacityGroup_Instance, err error)

Retrieve The guest instances that are members of this reserved capacity group.

func (Virtual_ReservedCapacityGroup) GetInstancesCount 

func (r Virtual_ReservedCapacityGroup) GetInstancesCount() (resp uint, err error)

Retrieve The number of instances that are members of this reserved capacity group.

func (Virtual_ReservedCapacityGroup) GetObject 

func (r Virtual_ReservedCapacityGroup) GetObject() (resp datatypes.Virtual_ReservedCapacityGroup, err error)

no documentation yet

func (Virtual_ReservedCapacityGroup) GetOccupiedInstances 

func (r Virtual_ReservedCapacityGroup) GetOccupiedInstances() (resp []datatypes.Virtual_ReservedCapacityGroup_Instance, err error)

Retrieve The instances already occupied by a guest on this reserved capacity group.

func (Virtual_ReservedCapacityGroup) Id 

func (r Virtual_ReservedCapacityGroup) Id(id int) Virtual_ReservedCapacityGroup

func (Virtual_ReservedCapacityGroup) Limit 

func (r Virtual_ReservedCapacityGroup) Limit(limit int) Virtual_ReservedCapacityGroup

func (Virtual_ReservedCapacityGroup) Mask 

func (r Virtual_ReservedCapacityGroup) Mask(mask string) Virtual_ReservedCapacityGroup

func (Virtual_ReservedCapacityGroup) Offset 

func (r Virtual_ReservedCapacityGroup) Offset(offset int) Virtual_ReservedCapacityGroup

type Virtual_ReservedCapacityGroup_Instance 

type Virtual_ReservedCapacityGroup_Instance struct {
	Session session.SLSession
	Options sl.Options
}

This data type presents the structure for a virtual reserved capacity group instance.

func GetVirtualReservedCapacityGroupInstanceService 

func GetVirtualReservedCapacityGroupInstanceService(sess session.SLSession) Virtual_ReservedCapacityGroup_Instance

GetVirtualReservedCapacityGroupInstanceService returns an instance of the Virtual_ReservedCapacityGroup_Instance SoftLayer service

func (Virtual_ReservedCapacityGroup_Instance) Filter 

func (r Virtual_ReservedCapacityGroup_Instance) Filter(filter string) Virtual_ReservedCapacityGroup_Instance

func (Virtual_ReservedCapacityGroup_Instance) GetAvailableFlag 

func (r Virtual_ReservedCapacityGroup_Instance) GetAvailableFlag() (resp bool, err error)

Retrieve Flag to indecate whether or not the reserved instance is available or not.

func (Virtual_ReservedCapacityGroup_Instance) GetBillingItem 

func (r Virtual_ReservedCapacityGroup_Instance) GetBillingItem() (resp datatypes.Billing_Item, err error)

Retrieve The billing item for the reserved capacity group instance.

func (Virtual_ReservedCapacityGroup_Instance) GetGuest 

func (r Virtual_ReservedCapacityGroup_Instance) GetGuest() (resp datatypes.Virtual_Guest, err error)

Retrieve The virtual guest associated with this reserved capacity group instance.

func (Virtual_ReservedCapacityGroup_Instance) GetObject 

func (r Virtual_ReservedCapacityGroup_Instance) GetObject() (resp datatypes.Virtual_ReservedCapacityGroup_Instance, err error)

no documentation yet

func (Virtual_ReservedCapacityGroup_Instance) GetReservedCapacityGroup 

func (r Virtual_ReservedCapacityGroup_Instance) GetReservedCapacityGroup() (resp datatypes.Virtual_ReservedCapacityGroup, err error)

Retrieve The reserved instances that are members of this reserved capacity group.

func (Virtual_ReservedCapacityGroup_Instance) Id 

func (r Virtual_ReservedCapacityGroup_Instance) Id(id int) Virtual_ReservedCapacityGroup_Instance

func (Virtual_ReservedCapacityGroup_Instance) Limit 

func (r Virtual_ReservedCapacityGroup_Instance) Limit(limit int) Virtual_ReservedCapacityGroup_Instance

func (Virtual_ReservedCapacityGroup_Instance) Mask 

func (r Virtual_ReservedCapacityGroup_Instance) Mask(mask string) Virtual_ReservedCapacityGroup_Instance

func (Virtual_ReservedCapacityGroup_Instance) Offset 

func (r Virtual_ReservedCapacityGroup_Instance) Offset(offset int) Virtual_ReservedCapacityGroup_Instance

type Virtual_Storage_Repository 

type Virtual_Storage_Repository struct {
	Session session.SLSession
	Options sl.Options
}

The SoftLayer_Virtual_Storage_Repository represents a web based storage system that can be accessed through many types of devices, interfaces, and other resources.

func GetVirtualStorageRepositoryService 

func GetVirtualStorageRepositoryService(sess session.SLSession) Virtual_Storage_Repository

GetVirtualStorageRepositoryService returns an instance of the Virtual_Storage_Repository SoftLayer service

func (Virtual_Storage_Repository) Filter 

func (r Virtual_Storage_Repository) Filter(filter string) Virtual_Storage_Repository

func (Virtual_Storage_Repository) GetAccount 

func (r Virtual_Storage_Repository) GetAccount() (resp datatypes.Account, err error)

Retrieve The [[SoftLayer_Account|account]] that a storage repository belongs to.

func (Virtual_Storage_Repository) GetArchiveDiskUsageRatePerGb 

func (r Virtual_Storage_Repository) GetArchiveDiskUsageRatePerGb() (resp datatypes.Float64, err error)

Returns the archive storage disk usage fee rate per gigabyte.

func (Virtual_Storage_Repository) GetAverageDiskUsageMetricDataFromInfluxByDate 

func (r Virtual_Storage_Repository) GetAverageDiskUsageMetricDataFromInfluxByDate(startDateTime *datatypes.Time, endDateTime *datatypes.Time) (resp datatypes.Float64, err error)

Returns the average disk space usage for a storage repository.

func (Virtual_Storage_Repository) GetBillingItem 

func (r Virtual_Storage_Repository) GetBillingItem() (resp datatypes.Billing_Item, err error)

Retrieve The current billing item for a storage repository.

func (Virtual_Storage_Repository) GetDatacenter 

func (r Virtual_Storage_Repository) GetDatacenter() (resp datatypes.Location, err error)

Retrieve The datacenter that a virtual storage repository resides in.

func (Virtual_Storage_Repository) GetDiskImages 

func (r Virtual_Storage_Repository) GetDiskImages() (resp []datatypes.Virtual_Disk_Image, err error)

Retrieve The [[SoftLayer_Virtual_Disk_Image|disk images]] that are in a storage repository. Disk images are the virtual hard drives for a virtual guest.

func (Virtual_Storage_Repository) GetGuests 

func (r Virtual_Storage_Repository) GetGuests() (resp []datatypes.Virtual_Guest, err error)

Retrieve The computing instances that have disk images in a storage repository.

func (Virtual_Storage_Repository) GetMetricTrackingObject 

func (r Virtual_Storage_Repository) GetMetricTrackingObject() (resp datatypes.Metric_Tracking_Object, err error)

Retrieve

func (Virtual_Storage_Repository) GetObject 

func (r Virtual_Storage_Repository) GetObject() (resp datatypes.Virtual_Storage_Repository, err error)

no documentation yet

func (Virtual_Storage_Repository) GetPublicImageBillingItem 

func (r Virtual_Storage_Repository) GetPublicImageBillingItem() (resp datatypes.Billing_Item, err error)

Retrieve The current billing item for a public storage repository.

func (Virtual_Storage_Repository) GetPublicImageDiskUsageRatePerGb 

func (r Virtual_Storage_Repository) GetPublicImageDiskUsageRatePerGb() (resp datatypes.Float64, err error)

Returns the public image storage disk usage fee rate per gigabyte.

func (Virtual_Storage_Repository) GetStorageLocations 

func (r Virtual_Storage_Repository) GetStorageLocations() (resp []datatypes.Location, err error)

Returns the public image storage locations.

func (Virtual_Storage_Repository) GetType 

func (r Virtual_Storage_Repository) GetType() (resp datatypes.Virtual_Storage_Repository_Type, err error)

Retrieve A storage repository's [[SoftLayer_Virtual_Storage_Repository_Type|type]].

func (Virtual_Storage_Repository) Id 

func (r Virtual_Storage_Repository) Id(id int) Virtual_Storage_Repository

func (Virtual_Storage_Repository) Limit 

func (r Virtual_Storage_Repository) Limit(limit int) Virtual_Storage_Repository

func (Virtual_Storage_Repository) Mask 

func (r Virtual_Storage_Repository) Mask(mask string) Virtual_Storage_Repository

func (Virtual_Storage_Repository) Offset 

func (r Virtual_Storage_Repository) Offset(offset int) Virtual_Storage_Repository

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.