Uses of Class
com.softlayer.api.annotation.ApiMethod
-
-
Uses of ApiMethod in com.softlayer.api.service
Methods in com.softlayer.api.service with annotations of type ApiMethod Modifier and Type Method Description AccountAccount.Service. activatePartner(String accountId, String hashCode)BooleanAccount.Service. addAchInformation(Ach achInformation)VoidTicket.Service. addAssignedAgent(Long agentId)
BooleanTicket.Service. addAttachedAdditionalEmails(List<String> emails)Creates new additional emails for assigned user if new emails are provided.HostTicket.Service. addAttachedDedicatedHost(Long dedicatedHostId)Attach the given Dedicated Host to a SoftLayer ticket.FileTicket.Service. addAttachedFile(Attachment fileAttachment)Attach the given file to a SoftLayer ticket.HardwareTicket.Service. addAttachedHardware(Long hardwareId)Attach the given hardware to a SoftLayer ticket.GuestTicket.Service. addAttachedVirtualGuest(Long guestId, Boolean callCommit)Attach the given CloudLayer Computing Instance to a SoftLayer ticket.BooleanTicket.Service. addFinalComments(String finalComments)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.BooleanAccount.Service. addReferralPartnerPaymentOption(Option paymentOption)VoidTicket.Service. addScheduledAlert(String activationTime)VoidTicket.Service. addScheduledAutoClose(String activationTime)List<Update>Ticket.Service. addUpdate(Update templateObject, List<Attachment> attachedFiles)Add an update to a ticket.List<Result>Search.Service. advancedSearch(String searchString)This method allows for searching for SoftLayer resources by simple terms and operators.BooleanHardware.Service. allowAccessToNetworkStorage(Storage networkStorageTemplateObject)This method is used to allow access to a SoftLayer_Network_Storage volume that supports host- or network-level access control.BooleanHardware.Service. allowAccessToNetworkStorageList(List<Storage> networkStorageTemplateObjects)This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support host- or network-level access control.BooleanAccount.Service. areVdrUpdatesBlockedForBilling()This method indicates whether or not Bandwidth Pooling updates are blocked for the account so the billing cycle can run.List<Tag>Tag.Service. autoComplete(String tag)This function is responsible for setting the Tags values.BooleanAccount.Service. cancelPayPalTransaction(String token, String payerId)Cancel the PayPal Payment Request process.GroupHardware.Service. captureImage(Template captureTemplate)Captures an Image of the hard disk on the physical machine, based on the capture template parameter.StringAccount.Service. completePayPalTransaction(String token, String payerId)Complete the PayPal Payment Request process and receive confirmation message.BooleanNetwork.Service. connectPrivateEndpointService()Initiate the automated process to establish connectivity granting the account private back-end network access to the services available through IBM Cloud Service Endpoint.LongAccount.Service. countHourlyInstances()Retrieve the number of hourly services on an account that are active, plus any pending orders with hourly services attached.TicketTicket.Service. createAdministrativeTicket(Ticket templateObject, String contents, Long attachmentId, String rootPassword, String controlPanelPassword, String accessPort, List<Attachment> attachedFiles, String attachmentType)Create an administrative support ticket.TicketTicket.Service. createCancelServerTicket(Long attachmentId, String reason, String content, Boolean cancelAssociatedItems, String attachmentType)A cancel server request creates a ticket to cancel the resource on next bill date.TicketTicket.Service. createCancelServiceTicket(Long attachmentId, String reason, String content, String attachmentType)A cancel service request creates a sales ticket.AccountBrand.Service. createCustomerAccount(Account account, Boolean bypassDuplicateAccountCheck)Create a new customer account record.BrandBrand.Service. createObject(Brand templateObject)
createObject() allows the creation of a new brand.HardwareHardware.Service. createObject(Hardware templateObject)
createObject() enables the creation of servers on an account.TicketTicket.Service. createStandardTicket(Ticket templateObject, String contents, Long attachmentId, String rootPassword, String controlPanelPassword, String accessPort, List<Attachment> attachedFiles, String attachmentType)Create a standard support ticket.TicketTicket.Service. createUpgradeTicket(Long attachmentId, String genericUpgrade, String upgradeMaintenanceWindow, String details, String attachmentType, String title)Create a ticket for the SoftLayer sales team to perform a hardware or service upgrade.CustomerAccount.Service. createUser(Customer templateObject, String password, String vpnPassword, Boolean silentlyCreateFlag)Create a new Customer user record in the SoftLayer customer portal.BooleanHardware.Service. deleteObject()
This method will cancel a server effective immediately.BooleanHardware.Service. deleteSoftwareComponentPasswords(List<Password> softwareComponentPasswords)Delete software component passwords.BooleanHardware.Service. deleteTag(String tagName)Delete an existing tag.BooleanTag.Service. deleteTag(String tagName)Delete a tag for an object.VoidBrand.Service. disableAccount(Long accountId)Disable an account associated with this Brand.VoidAccount.Service. disableEuSupport()Warning: If you remove the EU Supported account flag, you are removing the restriction that limits Processing activities to EU personnel.VoidAccount.Service. disableVpnConfigRequiresVpnManageAttribute()Disables the VPN_CONFIG_REQUIRES_VPN_MANAGE attribute on the account.BooleanNetwork.Service. disconnectPrivateEndpointService()Initiate the automated process to revoke mutual connectivity from the account network and IBM Cloud Service Endpoint network.TicketTicket.Service. edit(Ticket templateObject, String contents, List<Attachment> attachedFiles)Edit a SoftLayer ticket.ResponseAccount.Service. editAccount(Account modifiedAccountInformation)This method will edit the account's information.BooleanHardware.Service. editSoftwareComponentPasswords(List<Password> softwareComponentPasswords)Edit the properties of a software component password such as the username, password, and notes.VoidAccount.Service. enableEuSupport()If you select the EU Supported option, the most common Support issues will be limited to IBM Cloud staff located in the EU.VoidAccount.Service. enableVpnConfigRequiresVpnManageAttribute()Enables the VPN_CONFIG_REQUIRES_VPN_MANAGE attribute on the account.VoidHardware.Service. executeRemoteScript(String uri)Download and run remote script from uri on the hardware.HardwareHardware.Service. findByIpAddress(String ipAddress)The '''findByIpAddress''' method finds hardware using its primary public or private IP address.OrderHardware.Service. generateOrderTemplate(Hardware templateObject)
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]].StringAccount.Service. getAbuseEmail()An email address that is responsible for abuse and legal inquiries on behalf of an account.List<AbuseEmail>Account.Service. getAbuseEmails()Email addresses that are responsible for abuse and legal inquiries on behalf of an account.AccountBrand.Service. getAccount()AccountHardware.Service. getAccount()The account associated with a piece of hardware.AccountTag.Service. getAccount()The account to which the tag is tied.AccountTicket.Service. getAccount()The SoftLayer customer account associated with a ticket.List<JobDetails>Account.Service. getAccountBackupHistory(GregorianCalendar startDate, GregorianCalendar endDate, String backupStatus)This method returns an array of SoftLayer_Container_Network_Storage_Evault_WebCc_JobDetails objects for the given start and end dates.List<Contact>Account.Service. getAccountContacts()The account contacts on an account.List<AccountLicense>Account.Service. getAccountLicenses()The account software licenses owned by an accountList<Link>Account.Service. getAccountLinks()StatusAccount.Service. getAccountStatus()An account's status presented in a more detailed data type.StringAccount.Service. getAccountTraitValue(String keyName)This method pulls an account trait by its key.ItemAccount.Service. getActiveAccountDiscountBillingItem()The billing item associated with an account's monthly discount.List<AccountLicense>Account.Service. getActiveAccountLicenses()The active account software licenses owned by an accountList<Address>Account.Service. getActiveAddresses()The active address(es) that belong to an account.List<Agreement>Account.Service. getActiveAgreements()All active agreements for an accountList<Agreement>Account.Service. getActiveBillingAgreements()All billing agreements for an accountEnrollmentAccount.Service. getActiveCatalystEnrollment()List<Item>Account.Service. getActiveColocationContainers()The account's active top level colocation containers.List<Component>Hardware.Service. getActiveComponents()A piece of hardware's active physical components.EnrollmentAccount.Service. getActiveFlexibleCreditEnrollment()[Deprecated] Please use SoftLayer_Account::activeFlexibleCreditEnrollments.List<Enrollment>Account.Service. getActiveFlexibleCreditEnrollments()List<Incident>Hardware.Service. getActiveNetworkMonitorIncident()A piece of hardware's active network monitoring incidents.List<Subscriber>Account.Service. getActiveNotificationSubscribers()List<Package>Account.Service. getActiveOutletPackages()Deprecated.List<Package>Account.Service. getActivePackages()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.List<Package>Account.Service. getActivePackagesByAttribute(String attributeKeyName)Deprecated.List<Event>Location.Service. getActivePresaleEvents()List<Package>Account.Service. getActivePrivateHostedCloudPackages()Deprecated.List<Quote>Account.Service. getActiveQuotes()An account's non-expired quotes.List<Agreement>Account.Service. getActiveReservedCapacityAgreements()Active reserved capacity agreements for an accountSurveySurvey.Service. getActiveSurveyByType(String type)Provides survey details for the given typeList<VirtualLicense>Account.Service. getActiveVirtualLicenses()The virtual software licenses controlled by an accountList<VirtualIpAddress>Account.Service. getAdcLoadBalancers()An account's associated load balancers.List<Address>Account.Service. getAddresses()All the address(es) that belong to an account.StringAccount.Service. getAffiliateId()An affiliate identifier associated with the customer account.GraphAccount.Service. getAggregatedUptimeGraph(GregorianCalendar startDate, GregorianCalendar endDate)Returns URL uptime data for your accountList<Item>Account.Service. getAllBillingItems()The billing items that will be on an account's next invoice.List<Item>Account.Service. getAllCommissionBillingItems()The billing items that will be on an account's next invoice.List<Notification>Notification.Service. getAllObjects()Use this method to retrieve all active notifications that can be subscribed to.BooleanBrand.Service. getAllowAccountCreationFlag()This flag indicates if creation of accounts is allowed.HostHardware.Service. getAllowedHost()The SoftLayer_Network_Storage_Allowed_Host information to connect this server to Network Storage volumes that require access control lists.List<Storage>Hardware.Service. getAllowedNetworkStorage()The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to.List<Storage>Hardware.Service. getAllowedNetworkStorageReplicas()The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to.BooleanAccount.Service. getAllowIbmIdSilentMigrationFlag()Indicates whether this account is allowed to silently migrate to use IBMid Authentication.List<Account>Brand.Service. getAllOwnedAccounts()All accounts owned by the brand.BooleanAccount.Service. getAllowsBluemixAccountLinkingFlag()Flag indicating if this account can be linked with Bluemix.List<Component>Hardware.Service. getAllPowerComponents()List<Item>Account.Service. getAllRecurringTopLevelBillingItems()The billing items that will be on an account's next invoice.List<Item>Account.Service. getAllRecurringTopLevelBillingItemsUnfiltered()The billing items that will be on an account's next invoice.List<Item>Account.Service. getAllSubnetBillingItems()The billing items that will be on an account's next invoice.List<Type>Tag.Service. getAllTagTypes()Returns all tags of a given object type.List<Group>Ticket.Service. getAllTicketGroups()getAllTicketGroups() retrieves a list of all groups that a ticket may be assigned to.List<Status>Ticket.Service. getAllTicketStatuses()getAllTicketStatuses() retrieves a list of all statuses that a ticket may exist in.List<Subject>Brand.Service. getAllTicketSubjects(Account account)Deprecated.List<Item>Account.Service. getAllTopLevelBillingItems()All billing items of an account.List<Item>Account.Service. getAllTopLevelBillingItemsUnfiltered()The billing items that will be on an account's next invoice.CreditCardAccount.Service. getAlternateCreditCardData()ComponentHardware.Service. getAntivirusSpywareSoftwareComponent()Information regarding an antivirus/spyware software component object.List<Controller>Account.Service. getApplicationDeliveryControllers()An account's associated application delivery controller records.List<Customer>Ticket.Service. getAssignedAgents()CustomerTicket.Service. getAssignedUser()The portal user that a ticket is assigned to.List<AdditionalEmail>Ticket.Service. getAttachedAdditionalEmails()The list of additional emails to notify when a ticket update is made.List<DedicatedHost>Ticket.Service. getAttachedDedicatedHosts()The Dedicated Hosts associated with a ticket.byte[]Ticket.Service. getAttachedFile(Long attachmentId)Retrieve the file attached to a SoftLayer ticket by it's given identifier.List<File>Ticket.Service. getAttachedFiles()The files attached to a ticket.List<Hardware>Ticket.Service. getAttachedHardware()The hardware associated with a ticket.LongTicket.Service. getAttachedHardwareCount()List<Storage>Hardware.Service. getAttachedNetworkStorages(String nasType)This method is retrieve a list of SoftLayer_Network_Storage volumes that are authorized access to this SoftLayer_Hardware.List<Attachment>Ticket.Service. getAttachedResources()List<Tag>Tag.Service. getAttachedTagsForCurrentUser()Get all tags with at least one reference attached to it for the current account.List<Guest>Ticket.Service. getAttachedVirtualGuests()The virtual guests associated with a ticket.AttributeAccount.Service. getAttributeByType(String attributeType)Retrieve a single [[SoftLayer_Account_Attribute]] record by its [[SoftLayer_Account_Attribute_Type|types's]] key name.List<Attribute>Account.Service. getAttributes()The account attribute values for a SoftLayer customer account.List<Attribute>Hardware.Service. getAttributes()Information regarding a piece of hardware's specific attributes.List<Message>Account.Service. getAuxiliaryNotifications()List<Price>Hardware.Service. getAvailableBillingTermChangePrices()Retrieves a list of available term prices to this hardware.List<Storage>Hardware.Service. getAvailableNetworkStorages(String nasType)This method retrieves a list of SoftLayer_Network_Storage volumes that can be authorized to this SoftLayer_Hardware.List<Location>Location.Service. getAvailableObjectStorageDatacenters()Object Storage is only available in select datacenters.List<Vlan>Account.Service. getAvailablePublicNetworkVlans()The public network VLANs assigned to an account.BigDecimalAccount.Service. getAverageArchiveUsageMetricDataByDate(GregorianCalendar startDateTime, GregorianCalendar endDateTime)Returns the average disk space usage for all archive repositories.BigDecimalHardware.Service. getAverageDailyPublicBandwidthUsage()The average daily public bandwidth usage for the current billing cycle.BigDecimalAccount.Service. getAveragePublicUsageMetricDataByDate(GregorianCalendar startDateTime, GregorianCalendar endDateTime)Returns the average disk space usage for all public repositories.BooleanTicket.Service. getAwaitingUserResponseFlag()Ticket is waiting on a response from a customer flag.List<Dependent>Location.Service. getBackboneDependents()BigDecimalHardware.Service. getBackendIncomingBandwidth(GregorianCalendar startDate, GregorianCalendar endDate)The '''getBackendIncomingBandwidth''' method retrieves the amount of incoming private network traffic used between the given start date and end date parameters.List<Component>Hardware.Service. getBackendNetworkComponents()A piece of hardware's back-end or private network components.BigDecimalHardware.Service. getBackendOutgoingBandwidth(GregorianCalendar startDate, GregorianCalendar endDate)The '''getBackendOutgoingBandwidth''' method retrieves the amount of outgoing private network traffic used between the given start date and end date parameters.List<Hardware>Hardware.Service. getBackendRouters()A hardware's backend or private router.BigDecimalAccount.Service. getBalance()The account balance of a SoftLayer customer account.BigDecimalHardware.Service. getBandwidthAllocation()A hardware's allotted bandwidth (measured in GB).DetailHardware.Service. getBandwidthAllotmentDetail()A hardware's allotted detail record.List<Allotment>Account.Service. getBandwidthAllotments()The bandwidth allotments for an account.List<Allotment>Account.Service. getBandwidthAllotmentsOverAllocation()The bandwidth allotments for an account currently over allocation.List<Allotment>Account.Service. getBandwidthAllotmentsProjectedOverAllocation()The bandwidth allotments for an account projected to go over allocation.List<Usage>Account.Service. getBandwidthList(String networkType, String direction, String startDate, String endDate, List<Long> serverIds)List<Hardware>Account.Service. getBareMetalInstances()An account's associated bare metal server objects.List<Certification>Hardware.Service. getBenchmarkCertifications()Information regarding a piece of hardware's benchmark certifications.List<Agreement>Account.Service. getBillingAgreements()All billing agreements for an accountInfoAccount.Service. getBillingInfo()An account's billing information.HardwareHardware.Service. getBillingItem()Information regarding the billing item for a server.BooleanHardware.Service. getBillingItemFlag()A flag indicating that a billing item exists.BooleanHardware.Service. getBlockCancelBecauseDisconnectedFlag()Determines whether the hardware is ineligible for cancellation because it is disconnected.List<Group>Account.Service. getBlockDeviceTemplateGroups()Private template group objects (parent and children) and the shared template group objects (parent only) for an account.BluemixAccount.Service. getBluemixAccountLink()The Bluemix account link associated with this SoftLayer account, if one exists.BooleanAccount.Service. getBluemixLinkedFlag()Returns true if this account is linked to IBM Bluemix, false if not.BooleanLocation.Service. getBnppCompliantFlag()A flag indicating whether or not the datacenter/location is BNPP compliant.BooleanTicket.Service. getBnppSupportedFlag()A ticket's associated BNPP compliant recordBrandAccount.Service. getBrand()BooleanAccount.Service. getBrandAccountFlag()StringAccount.Service. getBrandKeyName()The brand keyName.BooleanHardware.Service. getBusinessContinuanceInsuranceFlag()Status indicating whether or not a piece of hardware has business continuance insurance.PartnerAccount.Service. getBusinessPartner()The Business Partner details for the account.PartnerBrand.Service. getBusinessPartner()Business Partner details for the brand.BooleanBrand.Service. getBusinessPartnerFlag()Flag indicating if the brand is a business partner.RequestTicket.Service. getCancellationRequest()A service cancellation request.BooleanAccount.Service. getCanOrderAdditionalVlansFlag()[DEPRECATED] All accounts may order VLANs.List<Quote>Account.Service. getCarts()An account's active carts.CatalogBrand.Service. getCatalog()The Product Catalog for the BrandList<Enrollment>Account.Service. getCatalystEnrollments()List<Hardware>Hardware.Service. getChildrenHardware()Child hardware.List<Ticket>Account.Service. getClosedTickets()All closed tickets associated with an account.LocaleLocale.Service. getClosestToLanguageTag(String languageTag)StringHardware.Service. getComponentDetailsXML()List<Component>Hardware.Service. getComponents()A piece of hardware's components.List<Contact>Brand.Service. getContactInformation()Retrieve the contact information for the brand such as the corporate or support contact.List<Contact>Brand.Service. getContacts()The contacts for the brand.ComponentHardware.Service. getContinuousDataProtectionSoftwareComponent()A continuous data protection/server backup software component object.ConfigurationHardware.Service. getCreateObjectOptions()
There are many options that may be provided while ordering a server, this method can be used to determine what these options are.OutputsAccount.Service. getCurrentBackupStatisticsGraph(Boolean detailedGraph)Deprecated.BigDecimalHardware.Service. getCurrentBillableBandwidthUsage()The current billable public outbound bandwidth for this hardware for the current billing cycle.List<Item>Hardware.Service. getCurrentBillingDetail()Get the billing detail for this hardware for the current billing period.BigDecimalHardware.Service. getCurrentBillingTotal()Get the total bill amount in US Dollars ($) for this hardware in the current billing period.OutputsAccount.Service. getCurrentTicketStatisticsGraph(Boolean detailedGraph)Deprecated.CustomerAccount.Service. getCurrentUser()Retrieve the user record of the user calling the SoftLayer API.List<CustomerCountry>Brand.Service. getCustomerCountryLocationRestrictions()This references relationship between brands, locations and countries associated with a user's account that are ineligible when ordering products.BigDecimalHardware.Service. getDailyAverage(GregorianCalendar startDate, GregorianCalendar endDate)The '''getDailyAverage''' method calculates the average daily network traffic used by the selected server.LocationHardware.Service. getDatacenter()Information regarding the datacenter in which a piece of hardware resides.StringHardware.Service. getDatacenterName()The name of the datacenter in which a piece of hardware resides.List<Location>Location.Service. getDatacenters()Retrieve all datacenter locations.List<Location>Account.Service. getDatacentersWithSubnetAllocations()Datacenters which contain subnets that the account has access to route.List<Location>Location.Service. getDatacentersWithVirtualImageStoreServiceResourceRecord()LongHardware.Service. getDaysInSparePool()Number of day(s) a server have been in spare pool.List<DedicatedHost>Account.Service. getDedicatedHosts()An account's associated virtual dedicated host objects.List<DedicatedHost>Account.Service. getDedicatedHostsForImageTemplate(Long imageTemplateId)This returns a collection of dedicated hosts that are valid for a given image template.BooleanAccount.Service. getDisablePaymentProcessingFlag()A flag indicating whether payments are processed for this account.List<Data>Account.Service. getDiskUsageMetricDataByDate(GregorianCalendar startDateTime, GregorianCalendar endDateTime)Retrieve disk usage data on a [[SoftLayer_Virtual_Guest|Cloud Computing Instance]] image for the time range you provide from the Metric Tracking Object System and Legacy Data Warehouse.List<Data>Account.Service. getDiskUsageMetricDataFromLegacyByDate(GregorianCalendar startDateTime, GregorianCalendar endDateTime)Retrieve disk usage data on a [[SoftLayer_Virtual_Guest|Cloud Computing Instance]] image for the time range you provide from the Legacy Data Warehouse.List<Data>Account.Service. getDiskUsageMetricDataFromMetricTrackingObjectSystemByDate(GregorianCalendar startDateTime, GregorianCalendar endDateTime)Retrieve disk usage data on a [[SoftLayer_Virtual_Guest|Cloud Computing Instance]] image for the time range you provide from the Metric Tracking Object System.OutputsAccount.Service. getDiskUsageMetricImageByDate(GregorianCalendar startDateTime, GregorianCalendar endDateTime)Deprecated.List<Employee>Account.Service. getDisplaySupportRepresentativeAssignments()The SoftLayer employees that an account is assigned to.BrandBrand.Service. getDistributor()BooleanBrand.Service. getDistributorChildFlag()StringBrand.Service. getDistributorFlag()List<Registration>Account.Service. getDomainRegistrations()List<Domain>Account.Service. getDomains()The DNS domains associated with an account.List<Domain>Account.Service. getDomainsWithoutSecondaryDnsRecords()The DNS domains associated with an account that were not created as a result of a secondary DNS zone transfer.List<Hardware>Hardware.Service. getDownlinkHardware()All hardware that has uplink network connections to a piece of hardware.List<Hardware>Hardware.Service. getDownlinkNetworkHardware()All hardware that has uplink network connections to a piece of hardware.List<Hardware>Hardware.Service. getDownlinkServers()Information regarding all servers attached to a piece of network hardware.List<Guest>Hardware.Service. getDownlinkVirtualGuests()Information regarding all virtual guests attached to a piece of network hardware.List<Hardware>Hardware.Service. getDownstreamHardwareBindings()All hardware downstream from a network device.List<Hardware>Hardware.Service. getDownstreamNetworkHardware()All network hardware downstream from the selected piece of hardware.List<Hardware>Hardware.Service. getDownstreamNetworkHardwareWithIncidents()All network hardware with monitoring warnings or errors that are downstream from the selected piece of hardware.List<Hardware>Hardware.Service. getDownstreamServers()Information regarding all servers attached downstream to a piece of network hardware.List<Guest>Hardware.Service. getDownstreamVirtualGuests()Information regarding all virtual guests attached to a piece of network hardware.List<Component>Hardware.Service. getDriveControllers()The drive controllers contained within a piece of hardware.List<Employee>Ticket.Service. getEmployeeAttachments()BooleanLocation.Service. getEuCompliantFlag()A flag indicating whether or not the datacenter/location is EU compliant.BooleanAccount.Service. getEuSupportedFlag()Boolean flag dictating whether or not this account has the EU Supported flag.BooleanTicket.Service. getEuSupportedFlag()A ticket's associated EU compliant recordLongAccount.Service. getEvaultCapacityGB()The total capacity of Legacy EVault Volumes on an account, in GB.List<Password>Account.Service. getEvaultMasterUsers()An account's master EVault user.List<Storage>Account.Service. getEvaultNetworkStorage()An account's associated EVault storage volumes.List<Storage>Hardware.Service. getEvaultNetworkStorage()Information regarding a piece of hardware's associated EVault network storage service account.byte[]Account.Service. getExecutiveSummaryPdf(String pdfType, String historicalType, String startDate, String endDate)This method will return a PDF of the specified report, with the specified period within the start and end dates.List<Certificate>Account.Service. getExpiredSecurityCertificates()Stored security certificates that are expired (ie.List<Log>Account.Service. getFacilityLogs()Logs of who entered a colocation area which is assigned to this account, or when a user under this account enters a datacenter.BooleanAccount.Service. getFileBlockBetaAccessFlag()FirewallHardware.Service. getFirewallServiceComponent()Information regarding a piece of hardware's firewall services.AttachmentTicket.Service. getFirstAttachedResource()The first physical or virtual server attached to a ticket.UpdateTicket.Service. getFirstUpdate()The first update made to a ticket.PresetHardware.Service. getFixedConfigurationPreset()Defines the fixed components in a fixed configuration bare metal server.List<Enrollment>Account.Service. getFlexibleCreditEnrollments()All of the account's current and former Flexible Credit enrollments.ProgramAccount.Service. getFlexibleCreditProgramInfo(Boolean forNextBillCycle)Deprecated.CollectionAccount.Service. getFlexibleCreditProgramsInfo(Boolean nextBillingCycleFlag)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.StringAccount.Service. getForcePaasAccountLinkDate()Timestamp representing the point in time when an account is required to link with PaaS.BigDecimalHardware.Service. getFrontendIncomingBandwidth(GregorianCalendar startDate, GregorianCalendar endDate)The '''getFrontendIncomingBandwidth''' method retrieves the amount of incoming public network traffic used by a server between the given start and end date parameters.List<Component>Hardware.Service. getFrontendNetworkComponents()A piece of hardware's front-end or public network components.BigDecimalHardware.Service. getFrontendOutgoingBandwidth(GregorianCalendar startDate, GregorianCalendar endDate)The '''getFrontendOutgoingBandwidth''' method retrieves the amount of outgoing public network traffic used by a server between the given start and end date parameters.List<Hardware>Hardware.Service. getFrontendRouters()A hardware's frontend or public router.BooleanTicket.Service. getFsboaSupportedFlag()A ticket's associated FSBOA compliant recordHardwareHardware.Service. getFutureBillingItem()Information regarding the future billing item for a server.StringHardware.Service. getGlobalIdentifier()A hardware's universally unique identifier.List<Global>Account.Service. getGlobalIpRecords()List<Global>Account.Service. getGlobalIpv4Records()List<Global>Account.Service. getGlobalIpv6Records()List<Account>Account.Service. getGlobalLoadBalancerAccounts()[Deprecated] The global load balancer accounts for a softlayer customer account.GroupTicket.Service. getGroup()The SoftLayer department that a ticket is assigned to.List<Group>Location.Service. getGroups()A location can be a member of 1 or more groups.List<Component>Hardware.Service. getHardDrives()The hard drives contained within a piece of hardware.List<Hardware>Account.Service. getHardware()An account's associated hardware objects.List<Hardware>Brand.Service. getHardware()An account's associated hardware objects.ChassisHardware.Service. getHardwareChassis()The chassis that a piece of hardware is housed in.List<Hardware>Location.Service. getHardwareFirewalls()FunctionHardware.Service. getHardwareFunction()A hardware's function.StringHardware.Service. getHardwareFunctionDescription()A hardware's function.List<Hardware>Account.Service. getHardwareOverBandwidthAllocation()An account's associated hardware objects currently over bandwidth allocation.List<Details>Account.Service. getHardwarePools()Return a collection of managed hardware pools.List<Hardware>Account.Service. getHardwareProjectedOverBandwidthAllocation()An account's associated hardware objects projected to go over bandwidth allocation.StateHardware.Service. getHardwareState()A hardware's power/transaction state.StatusHardware.Service. getHardwareStatus()A hardware's status.List<Hardware>Account.Service. getHardwareWithCpanel()All hardware associated with an account that has the cPanel web hosting control panel installed.List<Hardware>Account.Service. getHardwareWithHelm()All hardware associated with an account that has the Helm web hosting control panel installed.List<Hardware>Account.Service. getHardwareWithMcafee()All hardware associated with an account that has McAfee Secure software components.List<Hardware>Account.Service. getHardwareWithMcafeeAntivirusRedhat()All hardware associated with an account that has McAfee Secure AntiVirus for Redhat software components.List<Hardware>Account.Service. getHardwareWithMcafeeAntivirusWindows()All hardware associated with an account that has McAfee Secure AntiVirus for Windows software components.List<Hardware>Account.Service. getHardwareWithMcafeeIntrusionDetectionSystem()All hardware associated with an account that has McAfee Secure Intrusion Detection System software components.List<Hardware>Account.Service. getHardwareWithPlesk()All hardware associated with an account that has the Plesk web hosting control panel installed.List<Hardware>Account.Service. getHardwareWithQuantastor()All hardware associated with an account that has the QuantaStor storage system installed.List<Hardware>Account.Service. getHardwareWithUrchin()All hardware associated with an account that has the Urchin web traffic analytics package installed.List<Hardware>Account.Service. getHardwareWithWindows()All hardware associated with an account that is running a version of the Microsoft Windows operating system.BooleanBrand.Service. getHasAgentAdvancedSupportFlag()BooleanBrand.Service. getHasAgentSupportFlag()BooleanAccount.Service. getHasEvaultBareMetalRestorePluginFlag()Return 1 if one of the account's hardware has the EVault Bare Metal Server Restore Plugin otherwise 0.BooleanAccount.Service. getHasIderaBareMetalRestorePluginFlag()Return 1 if one of the account's hardware has an installation of Idera Server Backup otherwise 0.LongAccount.Service. getHasPendingOrder()The number of orders in a PENDING status for a SoftLayer customer account.BooleanAccount.Service. getHasR1softBareMetalRestorePluginFlag()Return 1 if one of the account's hardware has an installation of R1Soft CDP otherwise 0.BooleanHardware.Service. getHasTrustedPlatformModuleBillingItemFlag()Determine in hardware object has TPM enabled.OutputsAccount.Service. getHistoricalBackupGraph(GregorianCalendar startDate, GregorianCalendar endDate)OutputsAccount.Service. getHistoricalBandwidthGraph(GregorianCalendar startDate, GregorianCalendar endDate)Deprecated.OutputsAccount.Service. getHistoricalTicketGraph(GregorianCalendar startDate, GregorianCalendar endDate)Given the start and end dates, this method will return a pie chart of ticket statistics in the form of SoftLayer_Container_Account_Graph_Outputs object with a base64 PNG string.OutputsAccount.Service. getHistoricalUptimeGraph(GregorianCalendar startDate, GregorianCalendar endDate)The graph image is returned as a base64 PNG string.ComponentHardware.Service. getHostIpsSoftwareComponent()Information regarding a host IPS software component object.List<Data>Hardware.Service. getHourlyBandwidth(String mode, GregorianCalendar day)The '''getHourlyBandwidth''' method retrieves all bandwidth updates hourly for the specified hardware.List<Hardware>Account.Service. getHourlyBareMetalInstances()An account's associated hourly bare metal server objects.BooleanHardware.Service. getHourlyBillingFlag()A server's hourly billing status.List<Item>Account.Service. getHourlyServiceBillingItems()Hourly service billing items that will be on an account's next invoice.List<Guest>Account.Service. getHourlyVirtualGuests()An account's associated hourly virtual guest objects.List<Storage>Account.Service. getHubNetworkStorage()An account's associated Virtual Storage volumes.StringAccount.Service. getIbmCustomerNumber()Unique identifier for a customer used throughout IBM.BooleanAccount.Service. getIbmIdAuthenticationRequiredFlag()Indicates whether this account requires IBMid authentication.StringAccount.Service. getIbmIdMigrationExpirationTimestamp()This key is deprecated and should not be used.BigDecimalHardware.Service. getInboundBandwidthUsage()The sum of all the inbound network traffic data for the last 30 days.BigDecimalHardware.Service. getInboundPublicBandwidthUsage()The total public inbound bandwidth for this hardware for the current billing cycle.SetupAccount.Service. getInProgressExternalAccountSetup()An in progress request to switch billing systems.List<Note>Account.Service. getInternalNotes()List<Item>Ticket.Service. getInvoiceItems()The invoice items associated with a ticket.List<Invoice>Account.Service. getInvoices()An account's associated billing invoices.List<IpAddress>Account.Service. getIpAddresses()BooleanHardware.Service. getIsBillingTermChangeAvailableFlag()Whether or not this hardware object is eligible to change to term billing.BooleanAccount.Service. getIscsiIsolationDisabled()List<Storage>Account.Service. getIscsiNetworkStorage()An account's associated iSCSI storage volumes.LongAccount.Service. getLargestAllowedSubnetCidr(Long numberOfHosts, Long locationId)Computes the number of available public secondary IP addresses, aligned to a subnet size.ActivityTicket.Service. getLastActivity()ItemAccount.Service. getLastCanceledBillingItem()The most recently canceled billing item.ItemAccount.Service. getLastCancelledServerBillingItem()The most recent cancelled server billing item.InterfaceTicket.Service. getLastEditor()List<Ticket>Account.Service. getLastFiveClosedAbuseTickets()The five most recently closed abuse tickets associated with an account.List<Ticket>Account.Service. getLastFiveClosedAccountingTickets()The five most recently closed accounting tickets associated with an account.List<Ticket>Account.Service. getLastFiveClosedOtherTickets()The five most recently closed tickets that do not belong to the abuse, accounting, sales, or support groups associated with an account.List<Ticket>Account.Service. getLastFiveClosedSalesTickets()The five most recently closed sales tickets associated with an account.List<Ticket>Account.Service. getLastFiveClosedSupportTickets()The five most recently closed support tickets associated with an account.List<Ticket>Account.Service. getLastFiveClosedTickets()The five most recently closed tickets associated with an account.TransactionHardware.Service. getLastTransaction()Information regarding the last transaction a server performed.UpdateTicket.Service. getLastUpdate()The last update made to a ticket.GregorianCalendarAccount.Service. getLatestBillDate()An account's most recent billing date.IncidentHardware.Service. getLatestNetworkMonitorIncident()A piece of hardware's latest network monitoring incident.InvoiceAccount.Service. getLatestRecurringInvoice()An account's latest recurring invoice.InvoiceAccount.Service. getLatestRecurringPendingInvoice()An account's latest recurring pending invoice.List<Allotment>Account.Service. getLegacyBandwidthAllotments()The legacy bandwidth allotments for an account.LongAccount.Service. getLegacyIscsiCapacityGB()The total capacity of Legacy iSCSI Volumes on an account, in GB.List<VirtualIpAddress>Account.Service. getLoadBalancers()An account's associated load balancers.LocationHardware.Service. getLocation()Where a piece of hardware is located within SoftLayer's location hierarchy.LocationTicket.Service. getLocation()A ticket's associated location within the SoftLayer location hierarchy.AddressLocation.Service. getLocationAddress()A location's physical address.List<Address>Location.Service. getLocationAddresses()A location's physical addresses.StringHardware.Service. getLocationPathString()MemberLocation.Service. getLocationReservationMember()A location's Dedicated Rack memberStatusLocation.Service. getLocationStatus()The current locations status.LongAccount.Service. getLockboxCapacityGB()The total capacity of Legacy lockbox Volumes on an account, in GB.List<Storage>Account.Service. getLockboxNetworkStorage()An account's associated Lockbox storage volumes.StorageHardware.Service. getLockboxNetworkStorage()Information regarding a lockbox account associated with a server.BooleanHardware.Service. getManagedResourceFlag()A flag indicating that the hardware is a managed resource.List<ManualPayment>Account.Service. getManualPaymentsUnderReview()CustomerAccount.Service. getMasterUser()An account's master user.List<Request>Account.Service. getMediaDataTransferRequests()An account's media transfer service requests.List<Component>Hardware.Service. getMemory()Information regarding a piece of hardware's memory.LongHardware.Service. getMemoryCapacity()The amount of memory a piece of hardware has, measured in gigabytes.StringBrand.Service. getMerchantName()Get the payment processor merchant name.HardwareServerHardware.Service. getMetricTrackingObject()A piece of hardware's metric tracking object.BooleanAccount.Service. getMigratedToIbmCloudPortalFlag()Flag indicating whether this account is restricted to the IBM Cloud portal.List<Component>Hardware.Service. getModules()RobotHardware.Service. getMonitoringRobot()StratumHardware.Service. getMonitoringServiceComponent()Information regarding a piece of hardware's network monitoring services.BooleanHardware.Service. getMonitoringServiceEligibilityFlag()List<Hardware>Account.Service. getMonthlyBareMetalInstances()An account's associated monthly bare metal server objects.List<Guest>Account.Service. getMonthlyVirtualGuests()An account's associated monthly virtual guest objects.ComponentHardware.Service. getMotherboard()Information regarding a piece of hardware's motherboard.List<Storage>Account.Service. getNasNetworkStorage()An account's associated NAS storage volumes.List<String>Account.Service. getNetAppActiveAccountLicenseKeys()This returns a collection of active NetApp software account license keys.List<Component>Hardware.Service. getNetworkCards()Information regarding a piece of hardware's network cards.List<Component>Hardware.Service. getNetworkComponents()Returns a hardware's network components.AttributeLocation.Service. getNetworkConfigurationAttribute()BooleanAccount.Service. getNetworkCreationFlag()[Deprecated] Whether or not this account can define their own networks.MemberHardware.Service. getNetworkGatewayMember()The gateway member if this device is part of a network gateway.BooleanHardware.Service. getNetworkGatewayMemberFlag()Whether or not this device is part of a network gateway.List<Gateway>Account.Service. getNetworkGateways()All network gateway devices on this account.List<Hardware>Account.Service. getNetworkHardware()An account's associated network hardware.StringHardware.Service. getNetworkManagementIpAddress()A piece of hardware's network management IP address.List<Delivery>Account.Service. getNetworkMessageDeliveryAccounts()List<Hardware>Hardware.Service. getNetworkMonitorAttachedDownHardware()All servers with failed monitoring that are attached downstream to a piece of hardware.List<Guest>Hardware.Service. getNetworkMonitorAttachedDownVirtualGuests()Virtual guests that are attached downstream to a hardware that have failed monitoringList<Hardware>Account.Service. getNetworkMonitorDownHardware()Hardware which is currently experiencing a service failure.List<Guest>Account.Service. getNetworkMonitorDownVirtualGuests()Virtual guest which is currently experiencing a service failure.List<Incident>Hardware.Service. getNetworkMonitorIncidents()The status of all of a piece of hardware's network monitoring incidents.List<Hardware>Account.Service. getNetworkMonitorRecoveringHardware()Hardware which is currently recovering from a service failure.List<Guest>Account.Service. getNetworkMonitorRecoveringVirtualGuests()Virtual guest which is currently recovering from a service failure.List<Host>Hardware.Service. getNetworkMonitors()Information regarding a piece of hardware's network monitors.List<Hardware>Account.Service. getNetworkMonitorUpHardware()Hardware which is currently online.List<Guest>Account.Service. getNetworkMonitorUpVirtualGuests()Virtual guest which is currently online.StringHardware.Service. getNetworkStatus()The value of a hardware's network status attribute.AttributeHardware.Service. getNetworkStatusAttribute()The hardware's related network status attribute.List<Storage>Account.Service. getNetworkStorage()An account's associated storage volumes.List<Storage>Hardware.Service. getNetworkStorage()Information regarding a piece of hardware's associated network storage service account.List<Group>Account.Service. getNetworkStorageGroups()An account's Network Storage groups.List<Context>Account.Service. getNetworkTunnelContexts()IPSec network tunnels for an account.List<Vlan>Account.Service. getNetworkVlans()All network VLANs assigned to an account.List<Vlan>Hardware.Service. getNetworkVlans()The network virtual LANs (VLANs) associated with a piece of hardware's network components.SpanAccount.Service. getNetworkVlanSpan()Whether or not an account has automatic private VLAN spanning enabled.BooleanTicket.Service. getNewUpdatesFlag()True if there are new, unread updates to this ticket for the current user, False otherwise.BigDecimalHardware.Service. getNextBillingCycleBandwidthAllocation()A hardware's allotted bandwidth for the next billing cycle (measured in GB).List<Allotment>Account.Service. getNextBillingPublicAllotmentHardwareBandwidthDetails()DEPRECATED - This information can be pulled directly through tapping keys now - DEPRECATED.byte[]Account.Service. getNextInvoiceExcel(GregorianCalendar documentCreateDate)Return an account's next invoice in a Microsoft excel format.BigDecimalAccount.Service. getNextInvoiceIncubatorExemptTotal()The pre-tax total amount exempt from incubator credit for the account's next invoice.byte[]Account.Service. getNextInvoicePdf(GregorianCalendar documentCreateDate)Return an account's next invoice in PDF format.byte[]Account.Service. getNextInvoicePdfDetailed(GregorianCalendar documentCreateDate)Return an account's next invoice detailed portion in PDF format.BigDecimalAccount.Service. getNextInvoiceRecurringAmountEligibleForAccountDiscount()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.List<Item>Account.Service. getNextInvoiceTopLevelBillingItems()The billing items that will be on an account's next invoice.BigDecimalAccount.Service. getNextInvoiceTotalAmount()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.BigDecimalAccount.Service. getNextInvoiceTotalOneTimeAmount()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.BigDecimalAccount.Service. getNextInvoiceTotalOneTimeTaxAmount()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.BigDecimalAccount.Service. getNextInvoiceTotalRecurringAmount()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.BigDecimalAccount.Service. getNextInvoiceTotalRecurringAmountBeforeAccountDiscount()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.BigDecimalAccount.Service. getNextInvoiceTotalRecurringTaxAmount()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.BigDecimalAccount.Service. getNextInvoiceTotalTaxableRecurringAmount()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.List<Count>Account.Service. getNextInvoiceZeroFeeItemCounts()List<Note>Hardware.Service. getNotesHistory()List<Subscriber>Account.Service. getNotificationSubscribers()LongHardware.Service. getNvRamCapacity()The amount of non-volatile memory a piece of hardware has, measured in gigabytes.List<Model>Hardware.Service. getNvRamComponentModels()AccountAccount.Service. getObject()getObject retrieves the SoftLayer_Account object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Account service.BrandBrand.Service. getObject()HardwareHardware.Service. getObject()getObject retrieves the SoftLayer_Hardware object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Hardware service.LocaleLocale.Service. getObject()LocationLocation.Service. getObject()NetworkNetwork.Service. getObject()NotificationNotification.Service. getObject()SurveySurvey.Service. getObject()getObject retrieves the SoftLayer_Survey object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Survey service.TagTag.Service. getObject()TicketTicket.Service. getObject()getObject retrieves the SoftLayer_Ticket object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Ticket service.List<ObjectType>Search.Service. getObjectTypes()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.LongLocation.Service. getOnlineSslVpnUserCount()The total number of users online using SoftLayer's SSL VPN service for a location.List<Ticket>Account.Service. getOpenAbuseTickets()The open abuse tickets associated with an account.List<Ticket>Account.Service. getOpenAccountingTickets()The open accounting tickets associated with an account.List<Ticket>Account.Service. getOpenBillingTickets()The open billing tickets associated with an account.List<Request>Account.Service. getOpenCancellationRequests()An open ticket requesting cancellation of this server, if one exists.List<Ticket>Account.Service. getOpenOtherTickets()The open tickets that do not belong to the abuse, accounting, sales, or support groups associated with an account.List<Invoice>Account.Service. getOpenRecurringInvoices()An account's recurring invoices.List<Ticket>Account.Service. getOpenSalesTickets()The open sales tickets associated with an account.List<Link>Account.Service. getOpenStackAccountLinks()List<Storage>Account.Service. getOpenStackObjectStorage()An account's associated Openstack related Object Storage accounts.List<Ticket>Account.Service. getOpenSupportTickets()The open support tickets associated with an account.List<Ticket>Account.Service. getOpenTickets()All open tickets associated with an account.List<Ticket>Brand.Service. getOpenTickets()List<Ticket>Account.Service. getOpenTicketsWaitingOnCustomer()All open tickets associated with an account last edited by an employee.OperatingSystemHardware.Service. getOperatingSystem()Information regarding a piece of hardware's operating system.StringHardware.Service. getOperatingSystemReferenceCode()A hardware's operating system software description.List<Order>Account.Service. getOrders()An account's associated billing orders excluding upgrades.List<Item>Account.Service. getOrphanBillingItems()The billing items that have no parent billing item.BigDecimalHardware.Service. getOutboundBandwidthUsage()The sum of all the outbound network traffic data for the last 30 days.BigDecimalHardware.Service. getOutboundPublicBandwidthUsage()The total public outbound bandwidth for this hardware for the current billing cycle.List<Account>Brand.Service. getOwnedAccounts()Active accounts owned by the brand.List<Brand>Account.Service. getOwnedBrands()List<Generic>Account.Service. getOwnedHardwareGenericComponentModels()BladeHardware.Service. getParentBay()Blade BayHardwareHardware.Service. getParentHardware()Parent Hardware.StringLocation.Service. getPathString()List<Processor>Account.Service. getPaymentProcessors()List<CreditCard>Account.Service. getPendingCreditCardChangeRequestData()Before being approved for general use, a credit card must be approved by a SoftLayer agent.List<Event>Account.Service. getPendingEvents()InvoiceAccount.Service. getPendingInvoice()An account's latest open (pending) invoice.List<Item>Account.Service. getPendingInvoiceTopLevelItems()A list of top-level invoice items that are on an account's currently pending invoice.BigDecimalAccount.Service. getPendingInvoiceTotalAmount()The total amount of an account's pending invoice, if one exists.BigDecimalAccount.Service. getPendingInvoiceTotalOneTimeAmount()The total one-time charges for an account's pending invoice, if one exists.BigDecimalAccount.Service. getPendingInvoiceTotalOneTimeTaxAmount()The sum of all the taxes related to one time charges for an account's pending invoice, if one exists.BigDecimalAccount.Service. getPendingInvoiceTotalRecurringAmount()The total recurring amount of an account's pending invoice, if one exists.BigDecimalAccount.Service. getPendingInvoiceTotalRecurringTaxAmount()The total amount of the recurring taxes on an account's pending invoice, if one exists.List<Group>Account.Service. getPermissionGroups()An account's permission groups.List<Role>Account.Service. getPermissionRoles()An account's user roles.List<PlacementGroup>Account.Service. getPlacementGroups()An account's associated virtual placement groups.List<Location>Location.Service. getpointOfPresence()Retrieve all point of presence locations.LocationHardware.Service. getPointOfPresenceLocation()Information regarding the Point of Presence (PoP) location in which a piece of hardware resides.List<Image>Account.Service. getPortableStorageVolumes()List<Hook>Account.Service. getPostProvisioningHooks()Customer specified URIs that are downloaded onto a newly provisioned or reloaded server.List<Component>Hardware.Service. getPowerComponents()The power components for a hardware object.List<Component>Hardware.Service. getPowerSupply()Information regarding a piece of hardware's power supply.BooleanAccount.Service. getPptpVpnAllowedFlag()(Deprecated) Boolean flag dictating whether or not this account supports PPTP VPN Access.List<Customer>Account.Service. getPptpVpnUsers()An account's associated portal users with PPTP VPN access.List<Preference>Notification.Service. getPreferences()The preferences related to the notification.BigDecimalAccount.Service. getPreviousRecurringRevenue()The total recurring amount for an accounts previous revenue.List<Group>Location.Service. getPriceGroups()A location can be a member of 1 or more Price Groups.List<Restriction>Account.Service. getPriceRestrictions()The item price that an account is restricted to.StringHardware.Service. getPrimaryBackendIpAddress()The hardware's primary private IP address.ComponentHardware.Service. getPrimaryBackendNetworkComponent()Information regarding the hardware's primary back-end network component.StringHardware.Service. getPrimaryIpAddress()The hardware's primary public IP address.ComponentHardware.Service. getPrimaryNetworkComponent()Information regarding the hardware's primary public network component.List<Ticket>Account.Service. getPriorityOneTickets()All priority one tickets associated with an account.List<Allotment>Account.Service. getPrivateAllotmentHardwareBandwidthDetails()DEPRECATED - This information can be pulled directly through tapping keys now - DEPRECATED.List<Data>Hardware.Service. getPrivateBandwidthData(Long startTime, Long endTime)Retrieve a graph of a server's private network bandwidth usage over the specified timeframe.List<Group>Account.Service. getPrivateBlockDeviceTemplateGroups()Private and shared template group objects (parent only) for an account.List<IpAddress>Account.Service. getPrivateIpAddresses()BooleanHardware.Service. getPrivateNetworkOnlyFlag()Whether the hardware only has access to the private network.List<Vlan>Account.Service. getPrivateNetworkVlans()The private network VLANs assigned to an account.List<Subnet>Account.Service. getPrivateSubnets()All private subnets associated with an account.LongHardware.Service. getProcessorCoreAmount()The total number of processor cores, summed from all processors that are attached to a piece of hardwareLongHardware.Service. getProcessorPhysicalCoreAmount()The total number of physical processor cores, summed from all processors that are attached to a piece of hardwareList<Component>Hardware.Service. getProcessors()Information regarding a piece of hardware's processors.BooleanAccount.Service. getProofOfConceptAccountFlag()Boolean flag indicating whether or not this account is a Proof of Concept account.List<Allotment>Account.Service. getPublicAllotmentHardwareBandwidthDetails()DEPRECATED - This information can be pulled directly through tapping keys now - DEPRECATED.List<Data>Hardware.Service. getPublicBandwidthData(Long startTime, Long endTime)Retrieve a graph of a server's public network bandwidth usage over the specified timeframe.List<IpAddress>Account.Service. getPublicIpAddresses()List<Vlan>Account.Service. getPublicNetworkVlans()The public network VLANs assigned to an account.List<Subnet>Account.Service. getPublicSubnets()All public network subnets associated with an account.List<Question>Survey.Service. getQuestions()The questions for a survey.List<Quote>Account.Service. getQuotes()An account's quotes.LocationHardware.Service. getRack()List<Component>Hardware.Service. getRaidControllers()The RAID controllers contained within a piece of hardware.List<Event>Account.Service. getRecentEvents()List<Event>Hardware.Service. getRecentEvents()Recent events that impact this hardware.List<Reference>Tag.Service. getReferences()References that tie object to the tag.AccountAccount.Service. getReferralPartner()The Referral Partner for this account, if any.List<Commission>Account.Service. getReferralPartnerCommissionForecast()List<Commission>Account.Service. getReferralPartnerCommissionHistory()List<Commission>Account.Service. getReferralPartnerCommissionPending()List<Account>Account.Service. getReferredAccounts()If this is a account is a referral partner, the accounts this referral partner has referredList<Region>Location.Service. getRegions()A location can be a member of 1 or more regions.List<RegulatedWorkload>Account.Service. getRegulatedWorkloads()List<User>Hardware.Service. getRemoteManagementAccounts()User credentials to issue commands and/or interact with the server's remote management card.List<Request>Account.Service. getRemoteManagementCommandRequests()Remote management command requests for an accountComponentHardware.Service. getRemoteManagementComponent()A hardware's associated remote management component.List<Event>Account.Service. getReplicationEvents()The Replication events for all Network Storage volumes on an account.List<Preference>Notification.Service. getRequiredPreferences()The required preferences related to the notification.BooleanAccount.Service. getRequireSilentIBMidUserCreation()Indicates whether newly created users under this account will be associated with IBMid via an email requiring a response, or not.List<Agreement>Account.Service. getReservedCapacityAgreements()All reserved capacity agreements for an accountList<ReservedCapacityGroup>Account.Service. getReservedCapacityGroups()The reserved capacity groups owned by this account.List<Configuration>Hardware.Service. getResourceConfigurations()List<Member>Hardware.Service. getResourceGroupMemberReferences()List<Role>Hardware.Service. getResourceGroupRoles()List<Group>Account.Service. getResourceGroups()An account's associated top-level resource groups.List<Group>Hardware.Service. getResourceGroups()The resource groups in which this hardware is a member.List<Hardware>Account.Service. getRouters()All Routers that an accounts VLANs reside onList<Hardware>Hardware.Service. getRouters()A hardware's routers.List<Data>Account.Service. getRwhoisData()DEPRECATEDSamlAccount.Service. getSamlAuthentication()The SAML configuration for this account.List<Asset>Hardware.Service. getScaleAssets()Collection of scale assets this hardware corresponds to.List<Group>Account.Service. getScaleGroups()All scale groups on this account.List<Transaction>Ticket.Service. getScheduledActions()List<Secondary>Account.Service. getSecondaryDomains()The secondary DNS records for a SoftLayer customer account.List<Certificate>Account.Service. getSecurityCertificates()Stored security certificates (ie.List<SecurityGroup>Account.Service. getSecurityGroups()The security groups belonging to this account.LevelAccount.Service. getSecurityLevel()LevelBrand.Service. getSecurityLevel()List<Request>Account.Service. getSecurityScanRequests()An account's vulnerability scan requests.List<Request>Hardware.Service. getSecurityScanRequests()Information regarding a piece of hardware's vulnerability scan requests.List<SensorReading>Hardware.Service. getSensorData()The '''getSensorData''' method retrieves a server's hardware state via its internal sensors.SensorReadingsWithGraphsHardware.Service. getSensorDataWithGraphs()The '''getSensorDataWithGraphs''' method retrieves the raw data returned from the server's remote management card.InvoiceTicket.Service. getServerAdministrationBillingInvoice()The invoice associated with a ticket.InvoiceTicket.Service. getServerAdministrationRefundInvoice()The refund invoice associated with a ticket.List<SensorSpeed>Hardware.Service. getServerFanSpeedGraphs()The '''getServerFanSpeedGraphs''' method retrieves the server's fan speeds and displays the speeds using tachometer graphs.StringHardware.Service. getServerPowerState()The '''getPowerState''' method retrieves the power state for the selected server.LocationHardware.Service. getServerRoom()Information regarding the server room in which the hardware is located.List<SensorTemperature>Hardware.Service. getServerTemperatureGraphs()The '''getServerTemperatureGraphs''' retrieves the server's temperatures and displays the various temperatures using thermometer graphs.List<Item>Account.Service. getServiceBillingItems()The service billing items that will be on an account's next invoice.ProviderHardware.Service. getServiceProvider()Information regarding the piece of hardware's service provider.ProviderTicket.Service. getServiceProvider()List<Group>Account.Service. getSharedBlockDeviceTemplateGroups()This method returns the [[SoftLayer_Virtual_Guest_Block_Device_Template_Group]] objects that have been shared with this accountList<Shipment>Account.Service. getShipments()Shipments that belong to the customer's account.List<Component>Hardware.Service. getSoftwareComponents()Information regarding a piece of hardware's installed software.HardwareHardware.Service. getSparePoolBillingItem()Information regarding the billing item for a spare pool server.List<Key>Account.Service. getSshKeys()Customer specified SSH keys that can be implemented onto a newly provisioned or reloaded server.List<Key>Hardware.Service. getSshKeys()SSH keys to be installed on the server during provisioning or an OS reload.List<Customer>Account.Service. getSslVpnUsers()An account's associated portal users with SSL VPN access.List<Guest>Account.Service. getStandardPoolVirtualGuests()An account's virtual guest objects that are hosted on a user provisioned hypervisor.List<State>Ticket.Service. getState()StatusSurvey.Service. getStatus()The status of the surveyStatusTicket.Service. getStatus()A ticket's status.List<Group>Hardware.Service. getStorageGroups()List<Component>Hardware.Service. getStorageNetworkComponents()A piece of hardware's private storage network components.SubjectTicket.Service. getSubject()A ticket's subject.List<Detail>Account.Service. getSubnetRegistrationDetails()List<Registration>Account.Service. getSubnetRegistrations()List<Subnet>Account.Service. getSubnets()All network subnets associated with an account.List<Employee>Account.Service. getSupportRepresentatives()The SoftLayer employees that an account is assigned to.List<Item>Account.Service. getSupportSubscriptions()The active support subscriptions for this account.StringAccount.Service. getSupportTier()BooleanAccount.Service. getSuppressInvoicesFlag()A flag indicating to suppress invoices.List<Tag>Tag.Service. getTagByTagName(String tagList)Returns the Tag object with a given name.List<Reference>Hardware.Service. getTagReferences()List<Reference>Ticket.Service. getTagReferences()List<Tag>Account.Service. getTags()ProgramAccount.Service. getTechIncubatorProgramInfo(Boolean forNextBillCycle)This method will return a SoftLayer_Container_Account_Discount_Program object containing the Technology Incubator Program information for this account.List<Acceptance>Account.Service. getThirdPartyPoliciesAcceptanceStatus()Returns multiple [[SoftLayer_Container_Policy_Acceptance]] that represent the acceptance status of the applicable third-party policies for this account.List<Group>Brand.Service. getTicketGroups()List<Ticket>Account.Service. getTickets()An account's associated tickets.List<Ticket>Brand.Service. getTickets()List<Ticket>Account.Service. getTicketsClosedInTheLastThreeDays()Tickets closed within the last 72 hours or last 10 tickets, whichever is less, associated with an account.List<Ticket>Ticket.Service. getTicketsClosedSinceDate(GregorianCalendar closeDate)Retrieve all tickets closed since a given date.List<Ticket>Account.Service. getTicketsClosedToday()Tickets closed today associated with an account.TimezoneLocation.Service. getTimezone()StringBrand.Service. getToken(Long userId)(DEPRECATED) Use [[SoftLayer_User_Customer::getImpersonationToken]] method.LocationHardware.Service. getTopLevelLocation()List<History>Hardware.Service. getTransactionHistory()
This method will query transaction history for a piece of hardware.List<Account>Account.Service. getTranscodeAccounts()An account's associated Transcode account.TypeSurvey.Service. getType()The type of surveyList<Tag>Tag.Service. getUnattachedTagsForCurrentUser()Get all tags with no references attached to it for the current account.BooleanTicket.Service. getUpdateRatingFlag()Whether employees' updates of this ticket could be rated by customerList<Update>Ticket.Service. getUpdates()A ticket's updates.List<Price>Hardware.Service. getUpgradeItemPrices()Retrieve a list of upgradeable items available to this piece of hardware.RequestHardware.Service. getUpgradeRequest()An account's associated upgrade request object, if any.List<Request>Account.Service. getUpgradeRequests()An account's associated upgrade requests.HardwareHardware.Service. getUplinkHardware()The network device connected to a piece of hardware.List<Component>Hardware.Service. getUplinkNetworkComponents()Information regarding the network component that is one level higher than a piece of hardware on the network infrastructure.List<Attribute>Hardware.Service. getUserData()An array containing a single string of custom user data for a hardware order.List<Customer>Account.Service. getUsers()An account's portal users.List<Customer>Brand.Service. getUsers()List<Entry>Account.Service. getValidSecurityCertificateEntries()Retrieve a list of valid (non-expired) security certificates without the sensitive certificate information.List<Certificate>Account.Service. getValidSecurityCertificates()Stored security certificates that are not expired (ie.CrossReferenceLocation.Service. getVdrGroup()A location can be a member of 1 Bandwidth Pooling Group.BooleanAccount.Service. getVdrUpdatesInProgressFlag()Return 0 if vpn updates are currently in progress on this account otherwise 1.List<Location>Location.Service. getViewableDatacenters()Retrieve all datacenter locations.List<Location>Location.Service. getViewablepointOfPresence()Retrieve all viewable network locations.List<Location>Location.Service. getViewablePopsAndDataCenters()Retrieve all viewable pop and datacenter locations.GroupHardware.Service. getVirtualChassis()Information regarding the virtual chassis for a piece of hardware.List<Hardware>Hardware.Service. getVirtualChassisSiblings()Information regarding the virtual chassis siblings for a piece of hardware.List<Allotment>Account.Service. getVirtualDedicatedRacks()The bandwidth pooling for this account.List<Image>Account.Service. getVirtualDiskImages()An account's associated virtual server virtual disk images.List<Guest>Account.Service. getVirtualGuests()An account's associated virtual guest objects.List<Guest>Brand.Service. getVirtualGuests()An account's associated virtual guest objects.List<Guest>Account.Service. getVirtualGuestsOverBandwidthAllocation()An account's associated virtual guest objects currently over bandwidth allocation.List<Guest>Account.Service. getVirtualGuestsProjectedOverBandwidthAllocation()An account's associated virtual guest objects currently over bandwidth allocation.List<Guest>Account.Service. getVirtualGuestsWithCpanel()All virtual guests associated with an account that has the cPanel web hosting control panel installed.List<Guest>Account.Service. getVirtualGuestsWithMcafee()All virtual guests associated with an account that have McAfee Secure software components.List<Guest>Account.Service. getVirtualGuestsWithMcafeeAntivirusRedhat()All virtual guests associated with an account that have McAfee Secure AntiVirus for Redhat software components.List<Guest>Account.Service. getVirtualGuestsWithMcafeeAntivirusWindows()All virtual guests associated with an account that has McAfee Secure AntiVirus for Windows software components.List<Guest>Account.Service. getVirtualGuestsWithMcafeeIntrusionDetectionSystem()All virtual guests associated with an account that has McAfee Secure Intrusion Detection System software components.List<Guest>Account.Service. getVirtualGuestsWithPlesk()All virtual guests associated with an account that has the Plesk web hosting control panel installed.List<Guest>Account.Service. getVirtualGuestsWithQuantastor()All virtual guests associated with an account that have the QuantaStor storage system installed.List<Guest>Account.Service. getVirtualGuestsWithUrchin()All virtual guests associated with an account that has the Urchin web traffic analytics package installed.HostHardware.Service. getVirtualHost()A piece of hardware's virtual host record.ComponentHardware.Service. getVirtualizationPlatform()A piece of hardware's virtualization platform software.List<VirtualLicense>Hardware.Service. getVirtualLicenses()Information regarding a piece of hardware's virtual software licenses.AllotmentAccount.Service. getVirtualPrivateRack()The bandwidth pooling for this account.AllotmentHardware.Service. getVirtualRack()Information regarding the bandwidth allotment to which a piece of hardware belongs.LongHardware.Service. getVirtualRackId()The name of the bandwidth allotment belonging to a piece of hardware.StringHardware.Service. getVirtualRackName()The name of the bandwidth allotment belonging to a piece of hardware.List<Repository>Account.Service. getVirtualStorageArchiveRepositories()An account's associated virtual server archived storage repositories.List<Repository>Account.Service. getVirtualStoragePublicRepositories()An account's associated virtual server public storage repositories.List<String>Account.Service. getVmWareActiveAccountLicenseKeys()This returns a collection of active VMware software account license keys.List<Guest>Account.Service. getVpcVirtualGuests()An account's associated VPC configured virtual guest objects.BooleanAccount.Service. getVpnConfigRequiresVPNManageFlag()List<Status>Account.Service. getWindowsUpdateStatus()Retrieve a list of an account's hardware's Windows Update status.BooleanAccount.Service. hasAttribute(String attributeType)Determine if an account has an [[SoftLayer_Account_Attribute|attribute]] associated with it.LongAccount.Service. hourlyInstanceLimit()This method will return the limit (number) of hourly services the account is allowed to have.LongAccount.Service. hourlyServerLimit()This method will return the limit (number) of hourly bare metal servers the account is allowed to have.HostHardware.Service. importVirtualHost()The '''importVirtualHost''' method attempts to import the host record for the virtualization platform running on a server.BooleanAccount.Service. isActiveVmwareCustomer()BooleanNetwork.Service. isConnectedToPrivateEndpointService()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.BooleanAccount.Service. isEligibleForLocalCurrencyProgram()Returns true if this account is eligible for the local currency program, false otherwise.BooleanAccount.Service. isEligibleToLinkWithPaas()Returns true if this account is eligible to link with PaaS.BooleanBrand.Service. isIbmSlicBrand()Check if the brand is IBM SLIC top level brand or sub brand.BooleanHardware.Service. isPingable()The '''isPingable''' method issues a ping command to the selected server and returns the result of the ping command.BooleanBrand.Service. isPlatformServicesBrand()Check if the alternate billing system of brand is Bluemix.VoidAccount.Service. linkExternalAccount(String externalAccountId, String authorizationToken, String externalServiceProviderKey)This method will link this SoftLayer account with the provided external account.VoidTicket.Service. markAsViewed()Mark a ticket as viewed.StringHardware.Service. ping()Issues a ping command to the server and returns the ping response.BooleanHardware.Service. powerCycle()The '''powerCycle''' method completes a power off and power on of the server successively in one command.BooleanHardware.Service. powerOff()This method will power off the server via the server's remote management card.BooleanHardware.Service. powerOn()The '''powerOn''' method powers on a server via its remote management card.VoidBrand.Service. reactivateAccount(Long accountId)Reactivate an account associated with this Brand.BooleanHardware.Service. rebootDefault()The '''rebootDefault''' method attempts to reboot the server by issuing a soft reboot, or reset, command to the server's remote management card.BooleanHardware.Service. rebootHard()The '''rebootHard''' method reboots the server by issuing a cycle command to the server's remote management card.BooleanHardware.Service. rebootSoft()The '''rebootSoft''' method reboots the server by issuing a reset command to the server's remote management card via soft reboot.BooleanHardware.Service. removeAccessToNetworkStorage(Storage networkStorageTemplateObject)This method is used to remove access to s SoftLayer_Network_Storage volumes that supports host- or network-level access control.BooleanHardware.Service. removeAccessToNetworkStorageList(List<Storage> networkStorageTemplateObjects)This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support host- or network-level access control.BooleanAccount.Service. removeAlternateCreditCard()VoidTicket.Service. removeAssignedAgent(Long agentId)
BooleanTicket.Service. removeAttachedAdditionalEmails(List<String> emails)removeAttachedAdditionalEmails() removes the specified email addresses from a ticket's notification list.BooleanTicket.Service. removeAttachedHardware(Long hardwareId)detach the given hardware from a SoftLayer ticket.BooleanTicket.Service. removeAttachedVirtualGuest(Long guestId)Detach the given CloudLayer Computing Instance from a SoftLayer ticket.VoidTicket.Service. removeScheduledAlert()VoidTicket.Service. removeScheduledAutoClose()BooleanHardware.Service. removeTags(String tags)ChangeRequestAccount.Service. requestCreditCardChange(ChangeRequest request, String vatId, String paymentRoleName, Boolean onlyChangeNicknameFlag)Retrieve the record data associated with the submission of a Credit Card Change Request.ManualPaymentAccount.Service. requestManualPayment(ManualPayment request)Retrieve the record data associated with the submission of a Manual Payment Request.ManualPaymentAccount.Service. requestManualPaymentUsingCreditCardOnFile(String amount, Boolean payWithAlternateCardFlag, String note)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.List<Result>Search.Service. search(String searchString)This method allows for searching for SoftLayer resources by simple phrase.BooleanAccount.Service. setAbuseEmails(List<String> emails)Set this account's abuse emails.LongAccount.Service. setManagedPoolQuantity(String poolKeyName, String backendRouter, Long quantity)Set the total number of servers that are to be maintained in the given pool.BooleanHardware.Service. setTags(String tags)BooleanTag.Service. setTags(String tags, String keyName, Long resourceTableId)Tag an object by passing in one or more tags separated by a comma.BooleanTicket.Service. setTags(String tags)BooleanAccount.Service. setVlanSpan(Boolean enabled)Set the flag that enables or disables automatic private network VLAN spanning for a SoftLayer customer account.BooleanTicket.Service. surveyEligible()Deprecated.BooleanAccount.Service. swapCreditCards()VoidAccount.Service. syncCurrentUserPopulationWithPaas()BooleanSurvey.Service. takeSurvey(List<Response> responses)Response to a SoftLayer survey's questions.BooleanTicket.Service. updateAttachedAdditionalEmails(List<String> emails)Creates new additional emails for assigned user if new emails are provided.BooleanHardware.Service. updateIpmiPassword(String password)This method will update the root IPMI password on this SoftLayer_Hardware.BooleanAccount.Service. updateVpnUsersForResource(Long objectId, String objectType)Deprecated.List<String>Account.Service. validate(Account account)This method will validate the following account fields.BooleanAccount.Service. validateManualPaymentAmount(String amount)This method checks global and account specific requirements and returns true if the dollar amount entered is acceptable for this account and false otherwise.VoidBrand.Service. verifyCanDisableAccount(Long accountId)Verify that an account may be disabled by a Brand Agent.VoidBrand.Service. verifyCanReactivateAccount(Long accountId)Verify that an account may be reactivated by a Brand Agent. -
Uses of ApiMethod in com.softlayer.api.service.account
Methods in com.softlayer.api.service.account with annotations of type ApiMethod Modifier and Type Method Description VoidProofOfConcept.Service. approveReview(Long requestId, String accessToken)Allows a verified reviewer to approve a requestContactContact.Service. createComplianceReportRequestorContact(Contact requestorTemplate)<AddressAddress.Service. createObject(Address templateObject)Create a new address record.AffiliationAffiliation.Service. createObject(Affiliation templateObject)Create a new affiliation to associate with an existing account.ContactContact.Service. createObject(Contact templateObject)This method creates an account contact.NoteNote.Service. createObject(Note templateObject)BooleanAffiliation.Service. deleteObject()deleteObject permanently removes an account affiliationBooleanContact.Service. deleteObject()deleteObject permanently removes an account contactBooleanNote.Service. deleteObject()VoidProofOfConcept.Service. denyReview(Long requestId, String accessToken, String reason)Allows verified reviewer to deny a requestBooleanAddress.Service. editObject(Address templateObject)Edit the properties of an address record by passing in a modified instance of a SoftLayer_Account_Address object.BooleanAffiliation.Service. editObject(Affiliation templateObject)Edit an affiliation that is associated to an existing account.BooleanContact.Service. editObject(Contact templateObject)This method allows you to modify an account contact.BooleanMedia.Service. editObject(Media templateObject)Edit the properties of a media record by passing in a modified instance of a SoftLayer_Account_Media object.BooleanNote.Service. editObject(Note templateObject)BooleanPassword.Service. editObject(Password templateObject)The password and/or notes may be modified.BooleanShipment.Service. editObject(Shipment templateObject)Edit the properties of a shipment record by passing in a modified instance of a SoftLayer_Account_Shipment object.AccountAddress.Service. getAccount()The account to which this address belongs.AccountAffiliation.Service. getAccount()The account that an affiliation belongs to.AccountAgreement.Service. getAccount()AccountContact.Service. getAccount()AccountMasterServiceAgreement.Service. getAccount()AccountMedia.Service. getAccount()The account to which the media belongs.AccountNote.Service. getAccount()AccountPassword.Service. getAccount()AccountShipment.Service. getAccount()The account to which the shipment belongs.List<Affiliation>Affiliation.Service. getAccountAffiliationsByAffiliateId(String affiliateId)Get account affiliation information associated with affiliate id.TypeAgreement.Service. getAgreementType()The type of agreement.List<Type>Contact.Service. getAllContactTypes()This method will return an array of SoftLayer_Account_Contact_Type objects which can be used when creating or editing an account contact.List<Courier>Shipment.Service. getAllCouriers()Retrieve a list of available shipping couriers.List<Courier>Shipment.Service. getAllCouriersByType(String courierTypeKeyName)Retrieve a list of available shipping couriers.List<Address>Address.Service. getAllDataCenters()Retrieve a list of SoftLayer datacenter addresses.List<Type>Media.Service. getAllMediaTypes()Retrieve a list supported media types for SoftLayer's Data Transfer Service.List<Status>Shipment.Service. getAllShipmentStatuses()Retrieve a a list of shipment statuses.List<Type>Shipment.Service. getAllShipmentTypes()Retrieve a a list of shipment types.List<MasterServiceAgreement>Agreement.Service. getAttachedBillingAgreementFiles()The files attached to an agreement.StringProofOfConcept.Service. getAuthenticationUrl(String targetPage)Returns URL used to authenticate reviewersList<Item>Agreement.Service. getBillingItems()The billing items associated with an agreement.CourierShipment.Service. getCourier()The courier handling the shipment.EmployeeShipment.Service. getCreateEmployee()The employee who created the shipment.CustomerAddress.Service. getCreateUser()The customer user who created this address.CustomerMedia.Service. getCreateUser()The customer user who created the media object.CustomerShipment.Service. getCreateUser()The customer user who created the shipment.CurrencyShipment.Service. getCurrency()CustomerNote.Service. getCustomer()LocationMedia.Service. getDatacenter()The datacenter where the media resides.AddressShipment.Service. getDestinationAddress()The address at which the shipment is received.EntityMasterServiceAgreement.Service. getFile()Gets a File Entity container with the user's account's current MSA PDF.LocationAddress.Service. getLocation()The location of this address.DataShipment.Service. getMasterTrackingData()The one master tracking data for the shipment.EmployeeAddress.Service. getModifyEmployee()The employee who last modified this address.EmployeeMedia.Service. getModifyEmployee()The employee who last modified the media.EmployeeShipment.Service. getModifyEmployee()The employee who last modified the shipment.CustomerAddress.Service. getModifyUser()The customer user who last modified this address.CustomerMedia.Service. getModifyUser()The customer user who last modified the media.CustomerShipment.Service. getModifyUser()The customer user who last modified the shipment.List<Address>Address.Service. getNetworkAddress(String name)Retrieve a list of SoftLayer datacenter addresses.List<History>Note.Service. getNoteHistory()AddressAddress.Service. getObject()AffiliationAffiliation.Service. getObject()AgreementAgreement.Service. getObject()ContactContact.Service. getObject()MasterServiceAgreementMasterServiceAgreement.Service. getObject()MediaMedia.Service. getObject()NoteNote.Service. getObject()PasswordPassword.Service. getObject()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.ShipmentShipment.Service. getObject()AddressShipment.Service. getOriginationAddress()The address from which the shipment is sent.RequestMedia.Service. getRequest()The request to which the media belongs.List<Summary>ProofOfConcept.Service. getRequestsPendingIntegratedOfferingTeamReview(String accessToken)Retrieves a list of requests that are pending review in the specified regionsList<Summary>ProofOfConcept.Service. getRequestsPendingOverThresholdReview(String accessToken)Retrieves a list of requests that are pending over threshold reviewStringProofOfConcept.Service. getReviewerAccessToken(String unverifiedAuthenticationCode)Exchanges a code for a token during reviewer validation.StringProofOfConcept.Service. getReviewerEmailFromAccessToken(String accessToken)Finds a reviewer's email using the access tokenList<Item>Shipment.Service. getShipmentItems()The items in the shipment.StatusAgreement.Service. getStatus()The status of the agreement.StatusShipment.Service. getStatus()The status of the shipment.ReviewProofOfConcept.Service. getSubmittedRequest(Long requestId)Allows authorized IBMer to pull all the details of a single proof of concept account request.List<Summary>ProofOfConcept.Service. getSubmittedRequests(String email, String sortOrder)Allows authorized IBMer to retrieve a list summarizing all previously submitted proof of concept requests.StringProofOfConcept.Service. getSupportEmailAddress()Gets email address users can use to ask for help/supportList<Item>Agreement.Service. getTopLevelBillingItems()The top level billing item associated with an agreement.LongProofOfConcept.Service. getTotalRequestsPendingIntegratedOfferingTeamReview(String accessToken)LongProofOfConcept.Service. getTotalRequestsPendingOverThresholdReviewCount()List<Data>Shipment.Service. getTrackingData()All tracking data for the shipment and packages.TypeAddress.Service. getType()An account address' type.TypeContact.Service. getType()TypeMedia.Service. getType()The media's type.TypePassword.Service. getType()The service that an account/password combination is tied to.TypeShipment.Service. getType()The type of shipment (e.g.AddressShipment.Service. getViaAddress()The address at which the shipment is received.StorageMedia.Service. getVolume()A guest's associated EVault network storage service account.BooleanProofOfConcept.Service. isCurrentReviewer(Long requestId, String accessToken)Determines if the user is one of the reviewers currently able to actBooleanProofOfConcept.Service. isIntegratedOfferingTeamReviewer(String emailAddress)Indicates whether or not a reviewer belongs to the integrated offering teamBooleanProofOfConcept.Service. isOverThresholdReviewer(String emailAddress)Indicates whether or not a reviewer belongs to the threshold team.LongMedia.Service. removeMediaFromList(Media mediaTemplate)Remove a media from a SoftLayer account's list of media.SummaryProofOfConcept.Service. requestAccountTeamFundedAccount(AccountFunded request)Allows authorized IBMer's to apply for a proof of concept account using account team funding.SummaryProofOfConcept.Service. requestGlobalFundedAccount(GlobalFunded request)Allows authorized IBMer's to apply for a proof of concept account using global funding.VoidProofOfConcept.Service. verifyReviewer(Long requestId, String reviewerEmailAddress)Verifies that a potential reviewer is an approved internal IBM employee -
Uses of ApiMethod in com.softlayer.api.service.account.address
Methods in com.softlayer.api.service.account.address with annotations of type ApiMethod Modifier and Type Method Description TypeType.Service. getObject() -
Uses of ApiMethod in com.softlayer.api.service.account.authentication
Methods in com.softlayer.api.service.account.authentication with annotations of type ApiMethod Modifier and Type Method Description SamlSaml.Service. createObject(Saml templateObject)BooleanSaml.Service. deleteObject()BooleanSaml.Service. editObject(Saml templateObject)Edit the object by passing in a modified instance of the objectAccountAttribute.Service. getAccount()The SoftLayer customer account.AccountSaml.Service. getAccount()The account associated with this saml configuration.List<Attribute>Saml.Service. getAttributes()The saml attribute values for a SoftLayer customer account.SamlAttribute.Service. getAuthenticationRecord()The SoftLayer account authentication that has an attribute.StringSaml.Service. getMetadata()This method will return the service provider metadata in XML format.AttributeAttribute.Service. getObject()SamlSaml.Service. getObject()TypeAttribute.Service. getType()The type of attribute assigned to a SoftLayer account authentication. -
Uses of ApiMethod in com.softlayer.api.service.account.authentication.attribute
Methods in com.softlayer.api.service.account.authentication.attribute with annotations of type ApiMethod Modifier and Type Method Description List<Type>Type.Service. getAllObjects()TypeType.Service. getObject() -
Uses of ApiMethod in com.softlayer.api.service.account.business
Methods in com.softlayer.api.service.account.business with annotations of type ApiMethod Modifier and Type Method Description AccountPartner.Service. getAccount()Account associated with the business partner dataChannelPartner.Service. getChannel()Channel indicator used to categorize business partner revenue.PartnerPartner.Service. getObject()SegmentPartner.Service. getSegment()Segment indicator used to categorize business partner revenue. -
Uses of ApiMethod in com.softlayer.api.service.account.external
Methods in com.softlayer.api.service.account.external with annotations of type ApiMethod Modifier and Type Method Description ProvisioningHoldLiftedSetup.Service. finalizeExternalBillingForAccount(Long accountId)Calling this method signals that the account with the provided account id is ready to be billed by the external billing system.SetupSetup.Service. getObject()TransactionSetup.Service. getVerifyCardTransaction()The transaction information related to verifying the customer credit card. -
Uses of ApiMethod in com.softlayer.api.service.account.historical
Methods in com.softlayer.api.service.account.historical with annotations of type ApiMethod Modifier and Type Method Description GraphReport.Service. getAccountHostUptimeGraphData(String startDate, String endDate, Long accountId)SummaryReport.Service. getAccountHostUptimeSummary(String startDateTime, String endDateTime, Long accountId)Deprecated.GraphReport.Service. getAccountUrlUptimeGraphData(String startDate, String endDate, Long accountId)SummaryReport.Service. getAccountUrlUptimeSummary(String startDateTime, String endDateTime, Long accountId)Deprecated.DetailReport.Service. getHostUptimeDetail(Long configurationValueId, String startDateTime, String endDateTime)Deprecated.GraphReport.Service. getHostUptimeGraphData(Long configurationValueId, String startDate, String endDate)DetailReport.Service. getUrlUptimeDetail(Long configurationValueId, String startDateTime, String endDateTime)Deprecated.GraphReport.Service. getUrlUptimeGraphData(Long configurationValueId, String startDate, String endDate) -
Uses of ApiMethod in com.softlayer.api.service.account.internal
Methods in com.softlayer.api.service.account.internal with annotations of type ApiMethod Modifier and Type Method Description List<String>Ibm.Service. getAccountTypes()Validates request and, if the request is approved, returns a list of allowed uses for an automatically created IBMer IaaS account.StringIbm.Service. getAuthorizationUrl(Long requestId)Gets the URL used to perform manager validation.List<String>Ibm.Service. getBmsCountryList()StringIbm.Service. getEmployeeAccessToken(String unverifiedAuthenticationCode)Exchanges a code for a token during manager validation.RequestIbm.Service. getManagerPreview(Long requestId, String accessToken)After validating the requesting user through the access token, generates a container with the relevant request information and returns it.BooleanIbm.Service. hasExistingRequest(String employeeUid, String managerUid)Checks for an existing request which would block an IBMer from submitting a new request.VoidIbm.Service. managerApprove(Long requestId, String accessToken)Applies manager approval to a pending internal IBM account request.VoidIbm.Service. managerDeny(Long requestId, String accessToken)Denies a pending request and prevents additional requests from the same applicant for as long as the manager remains the same.VoidIbm.Service. requestAccount(Request requestContainer)Validates request and kicks off the approval process. -
Uses of ApiMethod in com.softlayer.api.service.account.link
Methods in com.softlayer.api.service.account.link with annotations of type ApiMethod Modifier and Type Method Description DomainCreationDetailsOpenStack.Service. createOSDomain(LinkRequest request)ProjectCreationDetailsOpenStack.Service. createOSProject(LinkRequest request)BooleanOpenStack.Service. deleteObject()deleteObject permanently removes an account link and all of it's associated keystone data (including users for the associated project).BooleanOpenStack.Service. deleteOSDomain(String domainId)BooleanOpenStack.Service. deleteOSProject(String projectId)BluemixBluemix.Service. getObject()OpenStackOpenStack.Service. getObject()ProjectDetailsOpenStack.Service. getOSProject(String projectId)StringBluemix.Service. getSupportTierType()List<ProjectDetails>OpenStack.Service. listOSProjects() -
Uses of ApiMethod in com.softlayer.api.service.account.lockdown
Methods in com.softlayer.api.service.account.lockdown with annotations of type ApiMethod Modifier and Type Method Description VoidRequest.Service. cancelRequest()Will cancel a lockdown request scheduled in the future.LongRequest.Service. disableLockedAccount(String disableDate)Takes the original lockdown request ID, and an optional disable date.LongRequest.Service. disconnectCompute(Long accountId, String disconnectDate)Takes an account ID and an optional disconnect date.List<Request>Request.Service. getAccountHistory(Long accountId)Provides a history of an account's lockdown requests and their status.RequestRequest.Service. getObject()LongRequest.Service. reconnectCompute(String reconnectDate)Takes the original disconnected lockdown event ID, and an optional reconnect date. -
Uses of ApiMethod in com.softlayer.api.service.account.media.data.transfer
Methods in com.softlayer.api.service.account.media.data.transfer with annotations of type ApiMethod Modifier and Type Method Description BooleanRequest.Service. editObject(Request templateObject)Edit the properties of a data transfer request record by passing in a modified instance of a SoftLayer_Account_Media_Data_Transfer_Request object.AccountRequest.Service. getAccount()The account to which the request belongs.List<Ticket>Request.Service. getActiveTickets()The active tickets that are attached to the data transfer request.List<Status>Request.Service. getAllRequestStatuses()Retrieves a list of all the possible statuses to which a request may be set.ItemRequest.Service. getBillingItem()The billing item for the original request.CustomerRequest.Service. getCreateUser()The customer user who created the request.MediaRequest.Service. getMedia()The media of the request.EmployeeRequest.Service. getModifyEmployee()The employee who last modified the request.CustomerRequest.Service. getModifyUser()The customer user who last modified the request.RequestRequest.Service. getObject()List<Shipment>Request.Service. getShipments()The shipments of the request.StatusRequest.Service. getStatus()The status of the request.List<Ticket>Request.Service. getTickets()All tickets that are attached to the data transfer request. -
Uses of ApiMethod in com.softlayer.api.service.account.partner.referral
Methods in com.softlayer.api.service.account.partner.referral with annotations of type ApiMethod Modifier and Type Method Description ProspectProspect.Service. createProspect(Prospect templateObject, Boolean commit)Create a new Referral Partner ProspectProspectProspect.Service. getObject()List<Question>Prospect.Service. getSurveyQuestions()Retrieves Questions for a Referral Partner Survey -
Uses of ApiMethod in com.softlayer.api.service.account.personaldata
Methods in com.softlayer.api.service.account.personaldata with annotations of type ApiMethod Modifier and Type Method Description VoidRemoveRequestReview.Service. approveRequest(Long requestId, String accessToken)Approve a personal information removal request.AccountRemoveRequestReview.Service. getAccount()RemoveRequestReviewRemoveRequestReview.Service. getApprovedFlag()StringRemoveRequestReview.Service. getAuthorizationUrl()Gets the redirect URL for GDPR removal review.RemoveRequestReviewRemoveRequestReview.Service. getObject()List<PersonalInformation>RemoveRequestReview.Service. getPendingRequests(String accessToken)Gets information removal requests to review.StringRemoveRequestReview.Service. getReviewerAccessToken(String code)Retrieves an access token.StringRemoveRequestReview.Service. getReviewerEmailFromAccessToken(String accessToken)Finds a reviewer's email using the access tokenLongRemoveRequestReview.Service. getTotalPendingRequests() -
Uses of ApiMethod in com.softlayer.api.service.account.proofofconcept
Methods in com.softlayer.api.service.account.proofofconcept with annotations of type ApiMethod Modifier and Type Method Description List<Approver>Approver.Service. getAllObjects()Retrieves a list of reviewersApproverApprover.Service. getObject()RoleApprover.Service. getRole()TypeApprover.Service. getType() -
Uses of ApiMethod in com.softlayer.api.service.account.proofofconcept.approver
Methods in com.softlayer.api.service.account.proofofconcept.approver with annotations of type ApiMethod Modifier and Type Method Description List<Approver>Type.Service. getApprovers()RoleRole.Service. getObject()TypeType.Service. getObject() -
Uses of ApiMethod in com.softlayer.api.service.account.proofofconcept.campaign
Methods in com.softlayer.api.service.account.proofofconcept.campaign with annotations of type ApiMethod Modifier and Type Method Description List<Code>Code.Service. getAllObjects()This method will retrieve all SoftLayer_Account_ProofOfConcept_Campaign_Code objects.CodeCode.Service. getObject() -
Uses of ApiMethod in com.softlayer.api.service.account.proofofconcept.funding
Methods in com.softlayer.api.service.account.proofofconcept.funding with annotations of type ApiMethod Modifier and Type Method Description List<Type>Type.Service. getAllObjects()List<Approver>Type.Service. getApprovers()List<Type>Type.Service. getApproverTypes()TypeType.Service. getObject() -
Uses of ApiMethod in com.softlayer.api.service.account.regional.registry
Methods in com.softlayer.api.service.account.regional.registry with annotations of type ApiMethod Modifier and Type Method Description DetailDetail.Service. createObject(Detail templateObject)This method will create a new SoftLayer_Account_Regional_Registry_Detail object.BooleanDetail.Service. deleteObject()This method will delete an existing SoftLayer_Account_Regional_Registry_Detail object.BooleanDetail.Service. editObject(Detail templateObject)This method will edit an existing SoftLayer_Account_Regional_Registry_Detail object.AccountDetail.Service. getAccount()The account that this detail object belongs to.List<Details>Detail.Service. getDetails()References to the [[SoftLayer_Network_Subnet_Registration|registration objects]] that consume this detail object.TypeDetail.Service. getDetailType()The associated type of this detail object.DetailDetail.Service. getObject()List<Property>Detail.Service. getProperties()The individual properties that define this detail object's values.HandleDetail.Service. getRegionalInternetRegistryHandle()The associated RWhois handle of this detail object.TransactionDetailsDetail.Service. updateReferencedRegistrations()This method will create a bulk transaction to update any registrations that reference this detail object.List<Message>Detail.Service. validatePersonForAllRegistrars()Validates this person detail against all supported external registrars (APNIC/ARIN/RIPE). -
Uses of ApiMethod in com.softlayer.api.service.account.regional.registry.detail
Methods in com.softlayer.api.service.account.regional.registry.detail with annotations of type ApiMethod Modifier and Type Method Description PropertyProperty.Service. createObject(Property templateObject)This method will create a new SoftLayer_Account_Regional_Registry_Detail_Property object.List<Property>Property.Service. createObjects(List<Property> templateObjects)Edit multiple [[SoftLayer_Account_Regional_Registry_Detail_Property]] objects.BooleanProperty.Service. deleteObject()This method will delete an existing SoftLayer_Account_Regional_Registry_Detail_Property object.BooleanProperty.Service. editObject(Property templateObject)This method will edit an existing SoftLayer_Account_Regional_Registry_Detail_Property object.BooleanProperty.Service. editObjects(List<Property> templateObjects)Edit multiple [[SoftLayer_Account_Regional_Registry_Detail_Property]] objects.List<Type>Type.Service. getAllObjects()DetailProperty.Service. getDetail()The [[SoftLayer_Account_Regional_Registry_Detail]] object this property belongs toPropertyProperty.Service. getObject()TypeType.Service. getObject()TypeProperty.Service. getPropertyType()The [[SoftLayer_Account_Regional_Registry_Detail_Property_Type]] object this property belongs to -
Uses of ApiMethod in com.softlayer.api.service.account.regional.registry.detail.property
Methods in com.softlayer.api.service.account.regional.registry.detail.property with annotations of type ApiMethod Modifier and Type Method Description List<Type>Type.Service. getAllObjects()TypeType.Service. getObject() -
Uses of ApiMethod in com.softlayer.api.service.account.reports
Methods in com.softlayer.api.service.account.reports with annotations of type ApiMethod Modifier and Type Method Description RequestRequest.Service. createRequest(Contact recipientContact, String reason, String reportType, Contact requestorContact)AccountRequest.Service. getAccount()ContactRequest.Service. getAccountContact()A request's corresponding external contact, if one exists.RequestRequest.Service. getAllObjects()RequestRequest.Service. getObject()TypeRequest.Service. getReportType()Type of the report customer is requesting for.RequestRequest.Service. getRequestByRequestKey(String requestKey)ContactRequest.Service. getRequestorContact()A request's corresponding requestor contact, if one exists.TicketRequest.Service. getTicket()CustomerRequest.Service. getUser()The customer user that initiated a report request.BooleanRequest.Service. sendReportEmail(Request request)BooleanRequest.Service. updateTicketOnDecline(Request request) -
Uses of ApiMethod in com.softlayer.api.service.account.shipment
Methods in com.softlayer.api.service.account.shipment with annotations of type ApiMethod Modifier and Type Method Description BooleanItem.Service. editObject(Item templateObject)Edit the properties of a shipment record by passing in a modified instance of a SoftLayer_Account_Shipment_Item object.ItemItem.Service. getObject()StatusStatus.Service. getObject()TypeType.Service. getObject()ShipmentItem.Service. getShipment()The shipment to which this item belongs.TypeItem.Service. getShipmentItemType()The type of this shipment item. -
Uses of ApiMethod in com.softlayer.api.service.account.shipment.item
Methods in com.softlayer.api.service.account.shipment.item with annotations of type ApiMethod Modifier and Type Method Description TypeType.Service. getObject() -
Uses of ApiMethod in com.softlayer.api.service.account.shipment.resource
Methods in com.softlayer.api.service.account.shipment.resource with annotations of type ApiMethod Modifier and Type Method Description TypeType.Service. getObject() -
Uses of ApiMethod in com.softlayer.api.service.account.shipment.tracking
Methods in com.softlayer.api.service.account.shipment.tracking with annotations of type ApiMethod Modifier and Type Method Description DataData.Service. createObject(Data templateObject)Create a new shipment tracking data.List<Data>Data.Service. createObjects(List<Data> templateObjects)Create a new shipment tracking data.BooleanData.Service. deleteObject()deleteObject permanently removes a shipment tracking datum (number)BooleanData.Service. editObject(Data templateObject)Edit the properties of a tracking data record by passing in a modified instance of a SoftLayer_Account_Shipment_Tracking_Data object.EmployeeData.Service. getCreateEmployee()The employee who created the tracking datum.CustomerData.Service. getCreateUser()The customer user who created the tracking datum.EmployeeData.Service. getModifyEmployee()The employee who last modified the tracking datum.CustomerData.Service. getModifyUser()The customer user who last modified the tracking datum.DataData.Service. getObject()ShipmentData.Service. getShipment()The shipment of the tracking datum. -
Uses of ApiMethod in com.softlayer.api.service.auxiliary.marketing
Methods in com.softlayer.api.service.auxiliary.marketing with annotations of type ApiMethod Modifier and Type Method Description List<Event>Event.Service. getMarketingEvents()This method will return a collection of SoftLayer_Auxiliary_Marketing_Event objects ordered in ascending order by start date.EventEvent.Service. getObject() -
Uses of ApiMethod in com.softlayer.api.service.auxiliary.network
Methods in com.softlayer.api.service.auxiliary.network with annotations of type ApiMethod Modifier and Type Method Description List<Reading>Status.Service. getNetworkStatus(String target)Return the current network status of and latency information for a given target from numerous points around the world. -
Uses of ApiMethod in com.softlayer.api.service.auxiliary.notification
Methods in com.softlayer.api.service.auxiliary.notification with annotations of type ApiMethod Modifier and Type Method Description List<Emergency>Emergency.Service. getAllObjects()Retrieve an array of SoftLayer_Auxiliary_Notification_Emergency data types, which contain all notification events regardless of status.List<Emergency>Emergency.Service. getCurrentNotifications()Retrieve an array of SoftLayer_Auxiliary_Notification_Emergency data types, which contain all current notification events.EmergencyEmergency.Service. getObject()getObject retrieves the SoftLayer_Auxiliary_Notification_Emergency object, it can be used to check for current notifications being broadcast by SoftLayer.SignatureEmergency.Service. getSignature()The signature of the SoftLayer employee department associated with this notification.StatusEmergency.Service. getStatus()The status of this notification. -
Uses of ApiMethod in com.softlayer.api.service.auxiliary.press
Methods in com.softlayer.api.service.auxiliary.press with annotations of type ApiMethod Modifier and Type Method Description List<Release>Release.Service. getAbout()List<Release>Release.Service. getAllObjects()Retrieve an array of SoftLayer_Auxiliary_Press_Release data types, which contain all press releases.List<Release>Release.Service. getContacts()List<Release>Release.Service. getMediaPartners()ReleaseRelease.Service. getObject()getObject retrieves the SoftLayer_Auxiliary_Press_Release object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Auxiliary_Press_Release service.ContentRelease.Service. getPressReleaseContent()List<Release>Release.Service. getRenderedPressRelease()Retrieve an array of SoftLayer_Auxiliary_Press_Release data types, which contain all press releases.List<Release>Release.Service. getRenderedPressReleases(String resultLimit, String year)Retrieve an array of SoftLayer_Auxiliary_Press_Release data types, which contain all press releases for a given year and or result limit.List<Release>Release.Service. getWebsiteHighlightPressReleases()Retrieve an array of SoftLayer_Auxiliary_Press_Release data types, which have the website highlight flag set. -
Uses of ApiMethod in com.softlayer.api.service.auxiliary.press.release
Methods in com.softlayer.api.service.auxiliary.press.release with annotations of type ApiMethod Modifier and Type Method Description AboutAbout.Service. getObject()getObject retrieves the SoftLayer_Auxiliary_Press_Release_About object whose about id number corresponds to the ID number of the init parameter passed to the SoftLayer_Auxiliary_Press_Release service.ContactContact.Service. getObject()getObject retrieves the SoftLayer_Auxiliary_Press_Release_Contact object whose contact id number corresponds to the ID number of the init parameter passed to the SoftLayer_Auxiliary_Press_Release service.ContentContent.Service. getObject()getObject retrieves the SoftLayer_Auxiliary_Press_Release_Content object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Auxiliary_Press_Release service. -
Uses of ApiMethod in com.softlayer.api.service.auxiliary.press.release.about.press
Methods in com.softlayer.api.service.auxiliary.press.release.about.press with annotations of type ApiMethod Modifier and Type Method Description List<About>Release.Service. getAboutParagraphs()ReleaseRelease.Service. getObject()getObject retrieves the SoftLayer_Auxiliary_Press_Release_About_Press_Release object whose contact id number corresponds to the ID number of the init parameter passed to the SoftLayer_Auxiliary_Press_Release service.List<Release>Release.Service. getPressReleases() -
Uses of ApiMethod in com.softlayer.api.service.auxiliary.press.release.contact.press
Methods in com.softlayer.api.service.auxiliary.press.release.contact.press with annotations of type ApiMethod Modifier and Type Method Description List<Contact>Release.Service. getContacts()ReleaseRelease.Service. getObject()getObject retrieves the SoftLayer_Auxiliary_Press_Release_Contact object whose contact id number corresponds to the ID number of the init parameter passed to the SoftLayer_Auxiliary_Press_Release service.List<Release>Release.Service. getPressReleases() -
Uses of ApiMethod in com.softlayer.api.service.auxiliary.press.release.media
Methods in com.softlayer.api.service.auxiliary.press.release.media with annotations of type ApiMethod Modifier and Type Method Description PartnerPartner.Service. getObject()getObject retrieves the SoftLayer_Auxiliary_Press_Release_Contact object whose contact id number corresponds to the ID number of the init parameter passed to the SoftLayer_Auxiliary_Press_Release service. -
Uses of ApiMethod in com.softlayer.api.service.auxiliary.press.release.media.partner.press
Methods in com.softlayer.api.service.auxiliary.press.release.media.partner.press with annotations of type ApiMethod Modifier and Type Method Description List<Partner>Release.Service. getMediaPartners()ReleaseRelease.Service. getObject()getObject retrieves the SoftLayer_Auxiliary_Press_Release_Media_Partner_Press_Release object whose media partner id number corresponds to the ID number of the init parameter passed to the SoftLayer_Auxiliary_Press_Release service.List<Release>Release.Service. getPressReleases() -
Uses of ApiMethod in com.softlayer.api.service.auxiliary.shipping.courier
Methods in com.softlayer.api.service.auxiliary.shipping.courier with annotations of type ApiMethod Modifier and Type Method Description List<Courier>Type.Service. getCourier()TypeType.Service. getObject()TypeType.Service. getTypeByKeyName(String keyName) -
Uses of ApiMethod in com.softlayer.api.service.billing
Methods in com.softlayer.api.service.billing with annotations of type ApiMethod Modifier and Type Method Description BooleanOrder.Service. approveModifiedOrder()When an order has been modified, the customer will need to approve the changes.BooleanItem.Service. cancelItem(Boolean cancelImmediately, Boolean cancelAssociatedBillingItems, String reason, String customerNote)Cancel the resource or service for a billing Item.BooleanItem.Service. cancelService()Cancel the resource or service (excluding bare metal servers) for a billing Item.BooleanItem.Service. cancelServiceOnAnniversaryDate()Cancel the resource or service for a billing ItemVoidInvoice.Service. emailInvoices(Email options)Create a transaction to email PDF and/or Excel invoice links to the requesting user's email address.AccountInfo.Service. getAccount()The SoftLayer customer account associated with this billing information.AccountInvoice.Service. getAccount()The account that an invoice belongs to.AccountItem.Service. getAccount()The account that a billing item belongs to.AccountOrder.Service. getAccount()The [[SoftLayer_Account|account]] to which an order belongs.List<Ach>Info.Service. getAchInformation()AgreementItem.Service. getActiveAgreement()AgreementItem.Service. getActiveAgreementFlag()A flag indicating that the billing item is under an active agreement.List<Item>Item.Service. getActiveAssociatedChildren()A billing item's active associated child billing items.List<Item>Item.Service. getActiveAssociatedGuestDiskBillingItems()List<Item>Item.Service. getActiveBundledItems()A Billing Item's active bundled billing items.ItemItem.Service. getActiveCancellationItem()A service cancellation request item that corresponds to the billing item.List<Item>Item.Service. getActiveChildren()A Billing Item's active child billing items.BooleanItem.Service. getActiveFlag()List<Item>Item.Service. getActiveSparePoolAssociatedGuestDiskBillingItems()List<Item>Item.Service. getActiveSparePoolBundledItems()A Billing Item's spare pool bundled billing items.List<Currency>Currency.Service. getAllObjects()List<Order>Order.Service. getAllObjects()This will get all billing orders for your account.BigDecimalInvoice.Service. getAmount()This is the amount of this invoice.ItemItem.Service. getAssociatedBillingItem()A billing item's associated parent.List<History>Item.Service. getAssociatedBillingItemHistory()A history of billing items which a billing item has been associated with.List<Item>Item.Service. getAssociatedChildren()A Billing Item's associated child billing items.List<Item>Item.Service. getAssociatedParent()A billing item's associated parent billing item.List<Vlan>Item.Service. getAvailableMatchingVlans()AllocationItem.Service. getBandwidthAllocation()The bandwidth allocation for a billing item.List<Item>Item.Service. getBillableChildren()A billing item's recurring child items that have once been billed and are scheduled to be billed in the future.BrandOrder.Service. getBrand()BrandInvoice.Service. getBrandAtInvoiceCreation()List<Item>Item.Service. getBundledItems()A Billing Item's bundled billing items.List<Bundles>Item.Service. getBundleItems()(DEPRECATED) Do not use.List<Item>Item.Service. getCanceledChildren()A Billing Item's active child billing items.ReasonItem.Service. getCancellationReason()The billing item's cancellation reason.List<Request>Item.Service. getCancellationRequests()This will return any cancellation requests that are associated with this billing item.CartOrder.Service. getCart()A cart is similar to a quote, except that it can be continually modified by the customer and does not have locked-in prices.CategoryItem.Service. getCategory()The item category to which the billing item's item belongs.List<Item>Item.Service. getChildren()A Billing Item's child billing items'List<Item>Item.Service. getChildrenWithActiveAgreement()A Billing Item's active child billing items.List<Item>Order.Service. getCoreRestrictedItems()The [[SoftLayer_Billing_Order_Item (type)|order items]] that are core restrictedList<Transaction>Order.Service. getCreditCardTransactions()All credit card transactions associated with this order.CurrencyInfo.Service. getCurrency()Currency to be used by this customer account.CycleInfo.Service. getCurrentBillingCycle()Information related to an account's current and previous billing cycles.ExchangeRateCurrency.Service. getCurrentExchangeRate()The current exchange rateBooleanInvoice.Service. getDetailedPdfGeneratedFlag()A flag that will reflect whether the detailed version of the pdf has been generated.List<Item>Item.Service. getDowngradeItems()For product items which have a downgrade path defined, this will return those product items.byte[]Invoice.Service. getExcel()Retrieve a Microsoft Excel spreadsheet of a SoftLayer invoice.ExchangeRateOrder.Service. getExchangeRate()List<Item>Item.Service. getFilteredNextInvoiceChildren()A Billing Item's associated child billing items, excluding some items with a $0.00 recurring fee.BooleanItem.Service. getHourlyFlag()A flag that will reflect whether this billing item is billed on an hourly basis or not.InvoiceOrder.Service. getInitialInvoice()ItemItem.Service. getInvoiceItem()Invoice items associated with this billing itemList<Item>Item.Service. getInvoiceItems()All invoice items associated with the billing itemList<Item>Invoice.Service. getInvoiceTopLevelItems()A list of top-level invoice items that are on the currently pending invoice.BigDecimalInvoice.Service. getInvoiceTotalAmount()The total amount of this invoice.BigDecimalInvoice.Service. getInvoiceTotalOneTimeAmount()The total one-time charges for this invoice.BigDecimalInvoice.Service. getInvoiceTotalOneTimeTaxAmount()A sum of all the taxes related to one time charges for this invoice.BigDecimalInvoice.Service. getInvoiceTotalPreTaxAmount()The total amount of this invoice.BigDecimalInvoice.Service. getInvoiceTotalRecurringAmount()The total Recurring amount of this invoice.BigDecimalInvoice.Service. getInvoiceTotalRecurringTaxAmount()The total amount of the recurring taxes on this invoice.ItemItem.Service. getItem()The entry in the SoftLayer product catalog that a billing item is based upon.PackageItem.Service. getItemPackage()The package under which this billing item was sold.List<Item>Invoice.Service. getItems()The items that belong to this invoice.List<Item>Order.Service. getItems()The SoftLayer_Billing_Order_items included in an order.GregorianCalendarInfo.Service. getLastBillDate()The date on which an account was last billed.ExchangeRateInvoice.Service. getLocalCurrencyExchangeRate()Exchange rate used for billing this invoice.LocationItem.Service. getLocation()The location of the billing item.GregorianCalendarInfo.Service. getNextBillDate()The date on which an account will be billed next.List<Item>Item.Service. getNextInvoiceChildren()A Billing Item's child billing items and associated items'BigDecimalItem.Service. getNextInvoiceTotalOneTimeAmount()A Billing Item's total, including any child billing items if they exist.'BigDecimalItem.Service. getNextInvoiceTotalOneTimeTaxAmount()A Billing Item's total, including any child billing items if they exist.'BigDecimalItem.Service. getNextInvoiceTotalRecurringAmount()A Billing Item's total, including any child billing items and associated billing items if they exist.'BigDecimalItem.Service. getNextInvoiceTotalRecurringTaxAmount()This is deprecated and will always be zero.List<Item>Item.Service. getNonZeroNextInvoiceChildren()A Billing Item's associated child billing items, excluding ALL items with a $0.00 recurring fee.CurrencyCurrency.Service. getObject()InfoInfo.Service. getObject()getObject retrieves the SoftLayer_Billing_Info object whose data corresponds to the account to which your portal user is tied.InvoiceInvoice.Service. getObject()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.ItemItem.Service. getObject()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.OrderOrder.Service. getObject()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.GregorianCalendarOrder.Service. getOrderApprovalDate()ItemItem.Service. getOrderItem()A billing item's original order item.BigDecimalOrder.Service. getOrderNonServerMonthlyAmount()An order's non-server items total monthly fee.BigDecimalOrder.Service. getOrderServerMonthlyAmount()An order's server items total monthly fee.List<Status>Order.Service. getOrderStatuses()Get a list of [[SoftLayer_Container_Billing_Order_Status]] objects.List<Item>Order.Service. getOrderTopLevelItems()An order's top level items.BigDecimalOrder.Service. getOrderTotalAmount()This amount represents the order's initial charge including set up fee and taxes.BigDecimalOrder.Service. getOrderTotalOneTime()An order's total one time amount summing all the set up fees, the labor fees and the one time fees.BigDecimalOrder.Service. getOrderTotalOneTimeAmount()An order's total one time amount.BigDecimalOrder.Service. getOrderTotalOneTimeTaxAmount()An order's total one time tax amount.BigDecimalOrder.Service. getOrderTotalRecurring()An order's total recurring amount.BigDecimalOrder.Service. getOrderTotalRecurringAmount()An order's total recurring amount.BigDecimalOrder.Service. getOrderTotalRecurringTaxAmount()The total tax amount of the recurring fees, if the SoftLayer_Account tied to a SoftLayer_Billing_Order is a taxable account.BigDecimalOrder.Service. getOrderTotalSetupAmount()An order's total setup fee.TypeOrder.Service. getOrderType()The type of an order.LocationItem.Service. getOriginalLocation()The original physical location for this billing item--may differ from current.ItemItem.Service. getParent()A billing item's parent item.GuestItem.Service. getParentVirtualGuestBillingItem()A billing item's parent item.BigDecimalInvoice.Service. getPayment()This is the total payment made on this invoice.List<Payment>Invoice.Service. getPayments()The payments for the invoice.List<Transaction>Order.Service. getPaypalTransactions()All PayPal transactions associated with this order.byte[]Invoice.Service. getPdf()Retrieve a PDF record of a SoftLayer invoice.byte[]Order.Service. getPdf()Retrieve a PDF record of a SoftLayer quote.byte[]Invoice.Service. getPdfDetailed()Retrieve a PDF record of a SoftLayer detailed invoice summary.StringInvoice.Service. getPdfDetailedFilename()StringInvoice.Service. getPdfFilename()StringOrder.Service. getPdfFilename()Retrieve the default filename of an order PDF.LongInvoice.Service. getPdfFileSize()Retrieve the size of a PDF record of a SoftLayer invoice.BooleanItem.Service. getPendingCancellationFlag()This flag indicates whether a billing item is scheduled to be canceled or not.ItemItem.Service. getPendingOrderItem()The new order item that will replace this billing item.byte[]Invoice.Service. getPreliminaryExcel()Retrieve a Microsoft Excel record of a SoftLayer invoice.byte[]Invoice.Service. getPreliminaryPdf()Retrieve a PDF record of a SoftLayer invoice.byte[]Invoice.Service. getPreliminaryPdfDetailed()Retrieve a PDF record of the detailed version of a SoftLayer invoice.EventOrder.Service. getPresaleEvent()StringCurrency.Service. getPrice(BigDecimal price, Format formatOptions)TransactionItem.Service. getProvisionTransaction()Provisioning transaction for this billing itemQuoteOrder.Service. getQuote()The quote of an order.OrderOrder.Service. getRecalculatedOrderContainer(String message, Boolean ignoreDiscountsFlag)Generate an [[SoftLayer_Container_Product_Order|order container]] from a billing order.ReceiptOrder.Service. getReceipt()Generate a [[SoftLayer_Container_Product_Order_Receipt]] object with all the order information.AccountOrder.Service. getReferralPartner()The Referral Partner who referred this order.StringInvoice.Service. getSellerRegistration()This is the seller's tax registration.List<Item>Item.Service. getServiceBillingItemsByCategory(String categoryCode, Boolean includeZeroRecurringFee)This service returns billing items of a specified category code.DescriptionItem.Service. getSoftwareDescription()A friendly description of software componentInfoInvoice.Service. getTaxInfo()This is the tax information that applies to tax auditing.List<Info>Invoice.Service. getTaxInfoHistory()This is the set of tax information for any tax calculation for this invoice.StringInvoice.Service. getTaxMessage()This is a message explaining the tax treatment for this invoice.TypeInvoice.Service. getTaxType()This is the strategy used to calculate tax on this invoice.ItemItem.Service. getUpgradeItem()Billing items whose product item has an upgrade path defined in our system will return the next product item in the upgrade path.List<Item>Item.Service. getUpgradeItems()Billing items whose product item has an upgrade path defined in our system will return all the product items in the upgrade path.BooleanOrder.Service. getUpgradeRequestFlag()This flag indicates an order is an upgrade.CustomerOrder.Service. getUserRecord()The SoftLayer_User_Customer object tied to an order.StringInvoice.Service. getXlsFilename()List<Count>Invoice.Service. getZeroFeeItemCounts()BooleanOrder.Service. isPendingEditApproval()When an order has been modified, it will contain a status indicating so.BooleanItem.Service. removeAssociationId()Remove the association from a billing item.BooleanItem.Service. setAssociationId(Long associatedId)Set an associated billing item to an orphan billing item.BooleanItem.Service. voidCancelService()Void a previously made cancellation for a service -
Uses of ApiMethod in com.softlayer.api.service.billing.currency
Methods in com.softlayer.api.service.billing.currency with annotations of type ApiMethod Modifier and Type Method Description List<ExchangeRate>ExchangeRate.Service. getAllCurrencyExchangeRates(String stringDate)List<Country>Country.Service. getCountriesWithListOfEligibleCurrencies()List<Currency>ExchangeRate.Service. getCurrencies()ExchangeRateExchangeRate.Service. getExchangeRate(String to, String from, GregorianCalendar effectiveDate)CurrencyExchangeRate.Service. getFundingCurrency()CurrencyExchangeRate.Service. getLocalCurrency()CountryCountry.Service. getObject()ExchangeRateExchangeRate.Service. getObject()StringExchangeRate.Service. getPrice(BigDecimal price, Format formatOptions) -
Uses of ApiMethod in com.softlayer.api.service.billing.invoice
Methods in com.softlayer.api.service.billing.invoice with annotations of type ApiMethod Modifier and Type Method Description List<Item>Item.Service. getAssociatedChildren()An Invoice Item's associated child invoice items.ItemItem.Service. getAssociatedInvoiceItem()An Invoice Item's associated invoice item.ItemItem.Service. getBillingItem()An Invoice Item's billing item, from which this item was generated.CategoryItem.Service. getCategory()This invoice item's "item category".List<Item>Item.Service. getChildren()An Invoice Item's child invoice items.byte[]Next.Service. getExcel(GregorianCalendar documentCreateDate)Return an account's next invoice in a Microsoft excel format.List<Item>Item.Service. getFilteredAssociatedChildren()An Invoice Item's associated child invoice items, excluding some items with a $0.00 recurring fee.BooleanItem.Service. getHourlyFlag()Indicating whether this invoice item is billed on an hourly basis.InvoiceItem.Service. getInvoice()The invoice to which this item belongs.LocationItem.Service. getLocation()An invoice item's location, if one exists.'List<Item>Item.Service. getNonZeroAssociatedChildren()An Invoice Item's associated child invoice items, excluding ALL items with a $0.00 recurring fee.ItemItem.Service. getObject()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.ItemItem.Service. getParent()Every item tied to a server should have a parent invoice item which is the server line item.byte[]Next.Service. getPdf(GregorianCalendar documentCreateDate)Return an account's next invoice in PDF format.byte[]Next.Service. getPdfDetailed(GregorianCalendar documentCreateDate)Return an account's next invoice detailed portion in PDF format.ItemItem.Service. getProduct()The entry in the product catalog that a invoice item is based upon.StringItem.Service. getTopLevelProductGroupName()A string representing the name of parent level product group of an invoice item.BigDecimalItem.Service. getTotalOneTimeAmount()An invoice Item's total, including any child invoice items if they exist.BigDecimalItem.Service. getTotalOneTimeTaxAmount()An invoice Item's total, including any child invoice items if they exist.BigDecimalItem.Service. getTotalRecurringAmount()An invoice Item's total, including any child invoice items if they exist.BigDecimalItem.Service. getTotalRecurringTaxAmount()A Billing Item's total, including any child billing items if they exist.'BooleanItem.Service. getUsageChargeFlag()Indicating whether this invoice item is for the usage charge. -
Uses of ApiMethod in com.softlayer.api.service.billing.invoice.tax
Methods in com.softlayer.api.service.billing.invoice.tax with annotations of type ApiMethod Modifier and Type Method Description List<Status>Status.Service. getAllObjects()List<Type>Type.Service. getAllObjects()StatusStatus.Service. getObject()TypeType.Service. getObject() -
Uses of ApiMethod in com.softlayer.api.service.billing.item.cancellation
Methods in com.softlayer.api.service.billing.item.cancellation with annotations of type ApiMethod Modifier and Type Method Description RequestRequest.Service. createObject(Request templateObject)This method creates a service cancellation request.AccountRequest.Service. getAccount()The SoftLayer account that a service cancellation request belongs to.List<Reason>Reason.Service. getAllCancellationReasons()getAllCancellationReasons() retrieves a list of all cancellation reasons that a server/service may be assigned to.List<Request>Request.Service. getAllCancellationRequests()This method returns all service cancellation requests.CategoryReason.Service. getBillingCancellationReasonCategory()An billing cancellation reason category.List<Item>Reason.Service. getBillingItems()The corresponding billing items having the specific cancellation reason.GregorianCalendarRequest.Service. getCancellationCutoffDate(Long accountId, String categoryCode)Services can be canceled 2 or 3 days prior to your next bill date.List<Item>Request.Service. getItems()A collection of service cancellation items.ReasonReason.Service. getObject()RequestRequest.Service. getObject()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.StatusRequest.Service. getStatus()The status of a service cancellation request.TicketRequest.Service. getTicket()The ticket that is associated with the service cancellation request.StringReason.Service. getTranslatedReason()CustomerRequest.Service. getUser()The user that initiated a service cancellation request.BooleanRequest.Service. removeCancellationItem(Long itemId)This method removes a cancellation item from a cancellation request that is in "Pending" or "Approved" status.BooleanRequest.Service. requestVoid(Boolean closeRelatedTicketFlag)This method voids a service cancellation request in "Pending" or "Approved" status.BooleanRequest.Service. validateBillingItemForCancellation(Long billingItemId)This method examined if a billing item is eligible for cancellation. -
Uses of ApiMethod in com.softlayer.api.service.billing.item.cancellation.reason
Methods in com.softlayer.api.service.billing.item.cancellation.reason with annotations of type ApiMethod Modifier and Type Method Description List<Category>Category.Service. getAllCancellationReasonCategories()getAllCancellationReasonCategories() retrieves a list of all cancellation reason categoriesList<Reason>Category.Service. getBillingCancellationReasons()The corresponding billing cancellation reasons having the specific billing cancellation reason category.CategoryCategory.Service. getObject() -
Uses of ApiMethod in com.softlayer.api.service.billing.item.virtual
Methods in com.softlayer.api.service.billing.item.virtual with annotations of type ApiMethod Modifier and Type Method Description DedicatedHostDedicatedHost.Service. getObjectForDedicatedHost()DedicatedHostDedicatedHost.Service. getResource()The resource for a virtual dedicated host billing item. -
Uses of ApiMethod in com.softlayer.api.service.billing.order
Methods in com.softlayer.api.service.billing.order with annotations of type ApiMethod Modifier and Type Method Description QuoteQuote.Service. claim(String quoteKey, Long quoteId)This method is used to transfer an anonymous quote to the active user and associated account.LongCart.Service. createCart(Order orderData)When creating a new cart, the order data is sent through SoftLayer_Product_Order::verifyOrder to make sure that the cart contains valid data.BooleanCart.Service. deleteCart()If a cart is no longer needed, it can be deleted using this service.QuoteQuote.Service. deleteQuote()Account master users and sub-users in the SoftLayer customer portal can delete the quote of an order.AccountQuote.Service. getAccount()A quote's corresponding account.ItemItem.Service. getBillingItem()The SoftLayer_Billing_Item tied to the order item.List<Item>Item.Service. getBundledItems()The other items included with an ordered item.CartCart.Service. getCartByCartKey(String cartKey)Retrieve a valid cart record of a SoftLayer order.CategoryItem.Service. getCategory()The item category tied to an order item.List<Item>Item.Service. getChildren()The child order items for an order item.BooleanQuote.Service. getDoNotContactFlag()Indicates whether the owner of the quote chosen to no longer be contacted.StringItem.Service. getGlobalIdentifier()A hardware's universally unique identifier.GenericItem.Service. getHardwareGenericComponent()The component type tied to an order item.ItemItem.Service. getItem()The SoftLayer_Product_Item tied to an order item.List<Answer>Item.Service. getItemCategoryAnswers()This is an item's category answers.PackageItem.Service. getItemPackage()The SoftLayer_Product_Package an order item is a part of.PriceItem.Service. getItemPrice()The SoftLayer_Product_Item_Price tied to an order item.LocationItem.Service. getLocation()The location of an ordered item.List<Item>Item.Service. getNextOrderChildren()ItemItem.Service. getObject()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.QuoteQuote.Service. getObject()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.CartCart.Service. getObjectForCart()ItemItem.Service. getOldBillingItem()This is only populated when an upgrade order is placed.OrderItem.Service. getOrder()The order to which this item belongs.OrderQuote.Service. getOrder()This order contains the records for which products were selected for this quote.GregorianCalendarItem.Service. getOrderApprovalDate()List<Order>Quote.Service. getOrdersFromQuote()These are all the orders that were created from this quote.ItemItem.Service. getParent()The parent order item ID for an item.byte[]Quote.Service. getPdf()Retrieve a PDF record of a SoftLayer quoted order.byte[]Cart.Service. getPdfForCart()Retrieve a PDF copy of the cart.PresetItem.Service. getPreset()The SoftLayer_Product_Package_Preset related to this order item.PromotionItem.Service. getPromoCode()QuoteQuote.Service. getQuoteByQuoteKey(String quoteKey)This method will return a [[SoftLayer_Billing_Order_Quote]] that is identified by the quote key specified.OrderCart.Service. getRecalculatedOrderContainer(Order orderData, Boolean orderBeingPlacedFlag)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.OrderQuote.Service. getRecalculatedOrderContainer(Order userOrderData, Boolean orderBeingPlacedFlag)Generate an [[SoftLayer_Container_Product_Order|order container]] from the previously-created quote.LongItem.Service. getRedundantPowerSupplyCount()A count of power supplies contained within this SoftLayer_Billing_OrderDescriptionItem.Service. getSoftwareDescription()For ordered items that are software items, a full description of that software can be found with this property.List<Order>Item.Service. getStorageGroups()The drive storage groups that are attached to this billing order item.BigDecimalItem.Service. getTotalRecurringAmount()The recurring fee of an ordered item.ItemItem.Service. getUpgradeItem()The next SoftLayer_Product_Item in the upgrade path for this order item.ReceiptQuote.Service. placeOrder(Order orderData)Use this method for placing server orders and additional services orders.OrderQuote.Service. placeQuote(Order orderData)Use this method for placing server quotes and additional services quotes.QuoteQuote.Service. saveQuote()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.LongCart.Service. updateCart(Order orderData)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.OrderQuote.Service. verifyOrder(Order orderData)Use this method for placing server orders and additional services orders.VoidQuote.Service. withdrawGdprAcceptance()Withdraws the users acceptance of the GDPR terms. -
Uses of ApiMethod in com.softlayer.api.service.bluepages
Methods in com.softlayer.api.service.bluepages with annotations of type ApiMethod Modifier and Type Method Description EmployeeProfileSearch.Service. findBluePagesProfile(String emailAddress)Given an IBM email address, searches BluePages and returns the employee's details. -
Uses of ApiMethod in com.softlayer.api.service.brand.business
Methods in com.softlayer.api.service.brand.business with annotations of type ApiMethod Modifier and Type Method Description BrandPartner.Service. getBrand()Brand associated with the business partner dataChannelPartner.Service. getChannel()Channel indicator used to categorize business partner revenue.PartnerPartner.Service. getObject()SegmentPartner.Service. getSegment()Segment indicator used to categorize business partner revenue. -
Uses of ApiMethod in com.softlayer.api.service.brand.restriction.location
Methods in com.softlayer.api.service.brand.restriction.location with annotations of type ApiMethod Modifier and Type Method Description List<CustomerCountry>CustomerCountry.Service. getAllObjects()BrandCustomerCountry.Service. getBrand()This references the brand that has a brand-location-country restriction setup.LocationCustomerCountry.Service. getLocation()This references the datacenter that has a brand-location-country restriction setup.CustomerCountryCustomerCountry.Service. getObject() -
Uses of ApiMethod in com.softlayer.api.service.business.partner
Methods in com.softlayer.api.service.business.partner with annotations of type ApiMethod Modifier and Type Method Description ChannelChannel.Service. getObject()SegmentSegment.Service. getObject() -
Uses of ApiMethod in com.softlayer.api.service.catalyst
Methods in com.softlayer.api.service.catalyst with annotations of type ApiMethod Modifier and Type Method Description AccountEnrollment.Service. getAccount()AffiliateEnrollment.Service. getAffiliate()List<Affiliate>Enrollment.Service. getAffiliates()TypeEnrollment.Service. getCompanyType()List<Type>Enrollment.Service. getCompanyTypes()List<AnswerOption>Enrollment.Service. getEnrollmentRequestAnnualRevenueOptions()List<AnswerOption>Enrollment.Service. getEnrollmentRequestUserCountOptions()List<AnswerOption>Enrollment.Service. getEnrollmentRequestYearsInOperationOptions()BooleanEnrollment.Service. getIsActiveFlag()EnrollmentEnrollment.Service. getObject()EmployeeEnrollment.Service. getRepresentative()VoidEnrollment.Service. requestManualEnrollment(ManualEnrollmentRequest request)AccountEnrollment.Service. requestSelfEnrollment(Request enrollmentRequest) -
Uses of ApiMethod in com.softlayer.api.service.catalyst.company
Methods in com.softlayer.api.service.catalyst.company with annotations of type ApiMethod Modifier and Type Method Description List<Type>Type.Service. getAllObjects()<<TypeType.Service. getObject() -
Uses of ApiMethod in com.softlayer.api.service.compliance.report
Methods in com.softlayer.api.service.compliance.report with annotations of type ApiMethod Modifier and Type Method Description List<Type>Type.Service. getAllObjects()TypeType.Service. getObject() -
Uses of ApiMethod in com.softlayer.api.service.configuration
Methods in com.softlayer.api.service.configuration with annotations of type ApiMethod Modifier and Type Method Description TemplateTemplate.Service. copyTemplate(Template templateObject)Copy a configuration template and returns a newly created template copyBooleanTemplate.Service. deleteObject()Deletes a customer configuration template.BooleanTemplate.Service. editObject(Template templateObject)Edit the object by passing in a modified instance of the object.AccountTemplate.Service. getAccount()List<Template>Template.Service. getAllObjects()Retrieves all available configuration templatesList<Section>Template.Service. getConfigurationSections()List<Value>Template.Service. getDefaultValues()List<Definition>Template.Service. getDefinitions()ItemTemplate.Service. getItem()ReferenceTemplate.Service. getLinkedSectionReferences()TemplateTemplate.Service. getObject()TemplateTemplate.Service. getParent()CustomerTemplate.Service. getUser()BooleanTemplate.Service. updateDefaultValues(List<Value> configurationValues)Updates default configuration values. -
Uses of ApiMethod in com.softlayer.api.service.configuration.storage.group.array
Methods in com.softlayer.api.service.configuration.storage.group.array with annotations of type ApiMethod Modifier and Type Method Description List<Type>Type.Service. getAllObjects()List<Model>Type.Service. getHardwareComponentModels()TypeType.Service. getObject() -
Uses of ApiMethod in com.softlayer.api.service.configuration.template
Methods in com.softlayer.api.service.configuration.template with annotations of type ApiMethod Modifier and Type Method Description List<Definition>Section.Service. getDefinitions()BooleanSection.Service. getDisallowedDeletionFlag()TemplateSection.Service. getLinkedTemplate()ReferenceSection.Service. getLinkedTemplateReference()SectionSection.Service. getObject()TypeType.Service. getObject()List<Profile>Section.Service. getProfiles()TypeSection.Service. getSectionType()StringSection.Service. getSectionTypeName()List<Section>Section.Service. getSubSections()TemplateSection.Service. getTemplate()BooleanSection.Service. hasSubSections()Returns true if the object has sub-sections -
Uses of ApiMethod in com.softlayer.api.service.configuration.template.section
Methods in com.softlayer.api.service.configuration.template.section with annotations of type ApiMethod Modifier and Type Method Description List<Attribute>Definition.Service. getAttributes()SectionProfile.Service. getConfigurationSection()ValueDefinition.Service. getDefaultValue()GroupDefinition.Service. getGroup()BooleanDefinition.Service. getMonitoringDataFlag()DefinitionDefinition.Service. getObject()ProfileProfile.Service. getObject()ReferenceReference.Service. getObject()TypeType.Service. getObject()SectionDefinition.Service. getSection()SectionReference.Service. getSection()TemplateReference.Service. getTemplate()TypeDefinition.Service. getValueType() -
Uses of ApiMethod in com.softlayer.api.service.configuration.template.section.definition
Methods in com.softlayer.api.service.configuration.template.section.definition with annotations of type ApiMethod Modifier and Type Method Description List<Group>Group.Service. getAllGroups()Get all configuration definition group objects.DefinitionValue.Service. getDefinition()GroupGroup.Service. getObject()TypeType.Service. getObject()ValueValue.Service. getObject()GroupGroup.Service. getParent()TemplateValue.Service. getTemplate() -
Uses of ApiMethod in com.softlayer.api.service.dns
Methods in com.softlayer.api.service.dns with annotations of type ApiMethod Modifier and Type Method Description BooleanSecondary.Service. convertToPrimary()A secondary DNS record may be converted to a primary DNS record.AaaaTypeDomain.Service. createAaaaRecord(String host, String data, Long ttl)Create an AAAA record on a SoftLayer domain.ATypeDomain.Service. createARecord(String host, String data, Long ttl)Create an A record on a SoftLayer domain.CnameTypeDomain.Service. createCnameRecord(String host, String data, Long ttl)Create a CNAME record on a SoftLayer domain.MxTypeDomain.Service. createMxRecord(String host, String data, Long ttl, Long mxPriority)Create an MX record on a SoftLayer domain.NsTypeDomain.Service. createNsRecord(String host, String data, Long ttl)Create an NS record on a SoftLayer domain.DomainDomain.Service. createObject(Domain templateObject)Create a new domain on the SoftLayer name servers.SecondarySecondary.Service. createObject(Secondary templateObject)Create a secondary DNS record.List<Domain>Domain.Service. createObjects(List<Domain> templateObjects)Create multiple domains on the SoftLayer name servers.List<Secondary>Secondary.Service. createObjects(List<Secondary> templateObjects)Create multiple secondary DNS records.ResourceRecordDomain.Service. createPtrRecord(String ipAddress, String ptrRecord, Long ttl)setPtrRecordForIpAddress() sets a single reverse DNS record for a single IP address and returns the newly created or edited [[SoftLayer_Dns_Domain_ResourceRecord]] record.SpfTypeDomain.Service. createSpfRecord(String host, String data, Long ttl)Create an SPF record on a SoftLayer domain.TxtTypeDomain.Service. createTxtRecord(String host, String data, Long ttl)Create a TXT record on a SoftLayer domain.BooleanDomain.Service. deleteObject()deleteObject permanently removes a domain and all of it's associated resource records from the softlayer name servers.BooleanSecondary.Service. deleteObject()Delete a secondary DNS Record.BooleanSecondary.Service. editObject(Secondary templateObject)Edit the properties of a secondary DNS record by passing in a modified instance of a SoftLayer_Dns_Secondary object.AccountDomain.Service. getAccount()The SoftLayer customer account that owns a domain.AccountSecondary.Service. getAccount()The SoftLayer account that owns a secondary DNS record.List<Domain>Domain.Service. getByDomainName(String name)Search for [[SoftLayer_Dns_Domain]] records by domain name.List<Secondary>Secondary.Service. getByDomainName(String name)Search for [[SoftLayer_Dns_Secondary]] records by domain name.DomainSecondary.Service. getDomain()The domain record created by zone transfer from a secondary DNS record.List<Message>Secondary.Service. getErrorMessages()The error messages created during secondary DNS record transfer.BooleanDomain.Service. getManagedResourceFlag()A flag indicating that the dns domain record is a managed resource.DomainDomain.Service. getObject()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.SecondarySecondary.Service. getObject()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.List<ResourceRecord>Domain.Service. getResourceRecords()The individual records contained within a domain record.SecondaryDomain.Service. getSecondary()The secondary DNS record that defines this domain as being managed through zone transfers.SoaTypeDomain.Service. getSoaResourceRecord()The start of authority (SOA) record contains authoritative and propagation details for a DNS zone.StatusSecondary.Service. getStatus()The current status of the secondary DNS zone.StringDomain.Service. getZoneFileContents()Return a SoftLayer hosted domain and resource records' data formatted as zone file.BooleanSecondary.Service. transferNow()Force a secondary DNS zone transfer by setting it's status "Transfer Now". -
Uses of ApiMethod in com.softlayer.api.service.dns.domain
Methods in com.softlayer.api.service.dns.domain with annotations of type ApiMethod Modifier and Type Method Description BooleanRegistration.Service. addNameserversToDomain(List<String> nameservers)The addNameserversToDomain method adds nameservers to a domain for a domain that already has nameservers assigned to it.ResourceRecordResourceRecord.Service. createObject(ResourceRecord templateObject)createObject creates a new domain resource record.List<ResourceRecord>ResourceRecord.Service. createObjects(List<ResourceRecord> templateObjects)Create multiple resource records on a domain.BooleanResourceRecord.Service. deleteObject()Delete a domain's resource record.BooleanResourceRecord.Service. deleteObjects(List<ResourceRecord> templateObjects)Remove multiple resource records from a domain.BooleanRegistration.Service. deleteRegisteredNameserver(String nameserver)The deleteRegisteredNameserver method deletes a nameserver that was registered, provided it is not currently serving a domainBooleanResourceRecord.Service. editObject(ResourceRecord templateObject)editObject edits an existing domain resource record.BooleanResourceRecord.Service. editObjects(List<ResourceRecord> templateObjects)Edit multiple resource records on a domain.AccountRegistration.Service. getAccount()The SoftLayer customer account that the domain is registered to.StringRegistration.Service. getAuthenticationCode()The getAuthenticationCode method retrieves the authentication code for the domain.DomainResourceRecord.Service. getDomain()The domain that a resource record belongs to.InformationRegistration.Service. getDomainInformation()The getDomainInformation method retrieves all the information for a domain.List<Nameserver>Registration.Service. getDomainNameservers()The getDomainNameservers method retrieve nameservers information for domain.StatusRegistration.Service. getDomainRegistrationStatus()The domain registration status.List<ExtendedAttribute>Registration.Service. getExtendedAttributes(String domainName)The getExtendedAttributes method determines if a country code top level domain requires extended attributes.RegistrationRegistration.Service. getObject()getObject retrieves the SoftLayer_Dns_Domain_Registration object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Dns_Domain_Registration service.ResourceRecordResourceRecord.Service. getObject()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.NameserverRegistration.Service. getRegisteredNameserver()The getRegisteredNameserver method retrieves registered nameservers.StatusRegistration.Service. getRegistrantVerificationStatus()The registrant verification status.StatusDetailRegistration.Service. getRegistrantVerificationStatusDetail()When a domain is registered or transferred, or when the registrant contact information is changed, the registrant must reply to an email requesting them to confirm that the submitted contact information is correct.ProviderRegistration.Service. getServiceProvider()InformationRegistration.Service. getTransferInformation(String domainName)The getTransferInformation method checks to see if the domain can be transferred and also can be used to check the status of the last transfer request.BooleanRegistration.Service. lockDomain()The lockDomain method locks a domain to prevent unauthorized, unwanted or accidental changes to the domain name.List<Lookup>Registration.Service. lookupDomain(String domainName)The lookupDomain method checks whether a specified domain name is available for registration in TLD's, and suggests other similar domain names, and checks whether they are available as well.BooleanRegistration.Service. modifyContact(Contact contact)The modifyContact method modifies contact information (admin, billing, owner, technical) for a domain.BooleanRegistration.Service. modifyRegisteredNameserver(String oldNameserver, String newNameserver, String ipAddress)The modifyRegisteredNameserver method modifies a nameserver that was registered.BooleanRegistration.Service. registerNameserver(String nameserver, String ipAddress)The registerNameserver method creates a nameserver for the domain.BooleanRegistration.Service. removeNameserversFromDomain(List<String> nameservers)The removeNameserversFromDomain method removes nameservers from a domain for a domain that already has nameservers assigned to it.BooleanRegistration.Service. sendAuthenticationCode()The sendAuthenticationCode method sends the authentication code to the administrative contact for the domain.BooleanRegistration.Service. sendRegistrantVerificationEmail()When a domain is registered or transferred, or when the registrant contact information is changed, the registrant must reply to an email requesting them to confirm that the submitted contact information is correct.BooleanRegistration.Service. sendTransferApprovalEmail()The sendTransferApprovalEmail method resends a transfer approval email message for a transfer that is in 'pending owner approval' state, to the admin contact listed for the domain at the time that the transfer request was submittedBooleanRegistration.Service. setAuthenticationCode(String authenticationCode)The setAuthenticationCode method sets the authentication code for the domain.BooleanRegistration.Service. unlockDomain()The unlockDomain method unlocks a domain -
Uses of ApiMethod in com.softlayer.api.service.dns.domain.registration
Methods in com.softlayer.api.service.dns.domain.registration with annotations of type ApiMethod Modifier and Type Method Description List<Status>Status.Service. getAllObjects()StatusStatus.Service. getObject() -
Uses of ApiMethod in com.softlayer.api.service.dns.domain.registration.registrant.verification
Methods in com.softlayer.api.service.dns.domain.registration.registrant.verification with annotations of type ApiMethod Modifier and Type Method Description List<Status>Status.Service. getAllObjects()StatusStatus.Service. getObject() -
Uses of ApiMethod in com.softlayer.api.service.dns.domain.resourcerecord
Methods in com.softlayer.api.service.dns.domain.resourcerecord with annotations of type ApiMethod Modifier and Type Method Description MxTypeMxType.Service. createObject(MxType templateObject)createObject creates a new MX record.SrvTypeSrvType.Service. createObject(SrvType templateObject)createObject creates a new SRV record.List<ResourceRecord>MxType.Service. createObjectsForMxType(List<ResourceRecord> templateObjects)Create multiple MX records on a domain.List<ResourceRecord>SrvType.Service. createObjectsForSrvType(List<ResourceRecord> templateObjects)Create multiple SRV records on a domain.BooleanMxType.Service. deleteObjectForMxType()Delete a domain's MX record.BooleanSrvType.Service. deleteObjectForSrvType()Delete a domain's SRV record.BooleanMxType.Service. deleteObjectsForMxType(List<MxType> templateObjects)Remove multiple MX records from a domain.BooleanSrvType.Service. deleteObjectsForSrvType(List<SrvType> templateObjects)Remove multiple SRV records from a domain.BooleanMxType.Service. editObject(MxType templateObject)editObject edits an existing MX resource record.BooleanSrvType.Service. editObject(SrvType templateObject)editObject edits an existing SRV resource record.BooleanMxType.Service. editObjectsForMxType(List<MxType> templateObjects)Edit multiple MX records on a domain.BooleanSrvType.Service. editObjectsForSrvType(List<SrvType> templateObjects)Edit multiple SRV records on a domain.MxTypeMxType.Service. getObjectForMxType()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.SrvTypeSrvType.Service. getObjectForSrvType()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. -
Uses of ApiMethod in com.softlayer.api.service.email
Methods in com.softlayer.api.service.email with annotations of type ApiMethod Modifier and Type Method Description BooleanSubscription.Service. disable()BooleanSubscription.Service. enable()List<Subscription>Subscription.Service. getAllObjects()BooleanSubscription.Service. getEnabled()SubscriptionSubscription.Service. getObject() -
Uses of ApiMethod in com.softlayer.api.service.email.subscription
Methods in com.softlayer.api.service.email.subscription with annotations of type ApiMethod Modifier and Type Method Description List<Group>Group.Service. getAllObjects()GroupGroup.Service. getObject()List<Subscription>Group.Service. getSubscriptions()All email subscriptions associated with this group. -
Uses of ApiMethod in com.softlayer.api.service.event
Methods in com.softlayer.api.service.event with annotations of type ApiMethod Modifier and Type Method Description List<String>Log.Service. getAllEventNames(String objectName)This all indexed event names.List<String>Log.Service. getAllEventObjectNames()This all indexed event object names.List<Log>Log.Service. getAllObjects()List<String>Log.Service. getAllUserTypes()CustomerLog.Service. getUser() -
Uses of ApiMethod in com.softlayer.api.service.flexiblecredit
Methods in com.softlayer.api.service.flexiblecredit with annotations of type ApiMethod Modifier and Type Method Description List<Affiliate>Program.Service. getAffiliatesAvailableForSelfEnrollmentByVerificationType(String verificationTypeKeyName)List<Type>Program.Service. getCompanyTypes()ProgramProgram.Service. getObject()AccountProgram.Service. selfEnrollNewAccount(Account accountTemplate) -
Uses of ApiMethod in com.softlayer.api.service.hardware
Methods in com.softlayer.api.service.hardware with annotations of type ApiMethod Modifier and Type Method Description BooleanServer.Service. activatePrivatePort()Activate a server's private network interface to the maximum available speed.BooleanServer.Service. activatePublicPort()Activate a server's public network interface to the maximum available speed.BooleanServer.Service. bootToRescueLayer(String noOsBootEnvironment)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.BooleanServer.Service. createFirmwareReflashTransaction(Long ipmi, Long raidController, Long bios)You can launch firmware reflash by selecting from your server list.BooleanServer.Service. createFirmwareUpdateTransaction(Long ipmi, Long raidController, Long bios, Long harddrive)You can launch firmware updates by selecting from your server list.BooleanServer.Service. createHyperThreadingUpdateTransaction(Long disableHyperthreading)You can launch hyper-threading update by selecting from your server list.SecurityModuleSecurityModule.Service. createObject(SecurityModule templateObject)
createObject() enables the creation of servers on an account.SecurityModule750SecurityModule750.Service. createObject(SecurityModule750 templateObject)
createObject() enables the creation of servers on an account.ServerServer.Service. createObject(Server templateObject)
createObject() enables the creation of servers on an account.BooleanServer.Service. createPostSoftwareInstallTransaction(List<String> installCodes, Boolean returnBoolean)BooleanServer.Service. editObject(Server templateObject)Edit a server's propertiesItemServer.Service. getActiveNetworkFirewallBillingItem()The billing item for a server's attached network firewall.List<Ticket>Server.Service. getActiveTickets()TransactionServer.Service. getActiveTransaction()Transaction currently running for server.List<Transaction>Server.Service. getActiveTransactions()Any active transaction(s) that are currently running for the server (example: os reload).List<Stratum>Server.Service. getAvailableMonitoring()An object that stores the maximum level for the monitoring query types and response types.BigDecimalServer.Service. getAverageDailyBandwidthUsage()The average daily total bandwidth usage for the current billing cycle.BigDecimalServer.Service. getAverageDailyPrivateBandwidthUsage()The average daily private bandwidth usage for the current billing cycle.List<Data>Server.Service. getBackendBandwidthUsage(GregorianCalendar startDate, GregorianCalendar endDate)Use this method to return an array of private bandwidth utilization records between a given date range.List<Detail>Server.Service. getBackendBandwidthUse(GregorianCalendar startDate, GregorianCalendar endDate)Deprecated.List<Data>Server.Service. getBandwidthForDateRange(GregorianCalendar startDate, GregorianCalendar endDate)Retrieve a collection of bandwidth data from an individual public or private network tracking object.GraphOutputsServer.Service. getBandwidthImage(String networkType, String snapshotRange, Boolean draw, GregorianCalendar dateSpecified, GregorianCalendar dateSpecifiedEnd)Use this method when needing a bandwidth image for a single server.List<Usage>Server.Service. getBillingCycleBandwidthUsage()The raw bandwidth usage data for the current billing cycle.UsageServer.Service. getBillingCyclePrivateBandwidthUsage()The raw private bandwidth usage data for the current billing cycle.UsageServer.Service. getBillingCyclePublicBandwidthUsage()The raw public bandwidth usage data for the current billing cycle.BooleanServer.Service. getBiosPasswordNullFlag()Determine if BIOS password should be left as null.List<String>Server.Service. getBootModeOptions()Retrieve the valid boot modes for this serverList<Subnet>Router.Service. getBoundSubnets()Associated subnets for a router object.CaptureEnabledServer.Service. getCaptureEnabledFlag()Determine if the server is able to be image captured.BooleanServer.Service. getContainsSolidStateDrivesFlag()ControlPanelServer.Service. getControlPanel()A server's control panel.BigDecimalServer.Service. getCost()The total cost of a server, measured in US Dollars ($USD).SummaryServer.Service. getCurrentBandwidthSummary()An object that provides commonly used bandwidth summary components for the current billing cycle.byte[]Server.Service. getCurrentBenchmarkCertificationResultFile()Attempt to retrieve the file associated with the current benchmark certification result, if such a file exists.GraphServer.Service. getCustomBandwidthDataByDate(Graph graphData)Retrieve bandwidth graph by date.BooleanServer.Service. getCustomerInstalledOperatingSystemFlag()Indicates if a server has a Customer Installed OSBooleanServer.Service. getCustomerOwnedFlag()Indicates if a server is a customer owned device.List<Subnet>Server.Service. getFirewallProtectableSubnets()Get the subnets associated with this server that are protectable by a network component firewall.List<Data>Server.Service. getFrontendBandwidthUsage(GregorianCalendar startDate, GregorianCalendar endDate)Use this method to return an array of public bandwidth utilization records between a given date range.List<Detail>Server.Service. getFrontendBandwidthUse(GregorianCalendar startDate, GregorianCalendar endDate)Deprecated.ServerServer.Service. getHardwareByIpAddress(String ipAddress)Retrieve a server by searching for the primary IP address.HardwareBlade.Service. getHardwareChild()HardwareBlade.Service. getHardwareParent()BooleanServer.Service. getHasSingleRootVirtualizationBillingItemFlag()Determine if hardware has Single Root IO VIrtualization (SR-IOV) billing item.BigDecimalServer.Service. getInboundPrivateBandwidthUsage()The total private inbound bandwidth for this hardware for the current billing cycle.BooleanServer.Service. getIsCloudReadyNodeCertified()Determine if hardware object has the IBM_CLOUD_READY_NODE_CERTIFIED attribute.BooleanServer.Service. getIsIpmiDisabled()Determine if remote management has been disabled due to port speed.BooleanServer.Service. getIsVirtualPrivateCloudNode()Determine if hardware object is a Virtual Private Cloud node.List<Item>Server.Service. getItemPricesFromSoftwareDescriptions(List<Description> softwareDescriptions, Boolean includeTranslationsFlag, Boolean returnAllPricesFlag)Return a collection of SoftLayer_Item_Price objects from a collection of SoftLayer_Software_DescriptionTransactionServer.Service. getLastOperatingSystemReload()The last transaction that a server's operating system was loaded.BooleanRouter.Service. getLocalDiskStorageCapabilityFlag()A flag indicating that a VLAN on the router can be assigned to a host that has local disk functionality.List<Group>Server.Service. getLogicalVolumeStorageGroups()Returns a list of logical volumes on the physical machine.ComponentServer.Service. getManagementNetworkComponent()Retrieve the remote management network component attached with this server.LongServer.Service. getMetricTrackingObjectId()The metric tracking object id for this server.List<Hardware>Server.Service. getMonitoringUserNotification()The monitoring notification objects for this hardware.List<IpAddress>Server.Service. getNetworkComponentFirewallProtectableIpAddresses()Get the IP addresses associated with this server that are protectable by a network component firewall.BladeBlade.Service. getObject()RouterRouter.Service. getObjectForRouter()SecurityModuleSecurityModule.Service. getObjectForSecurityModule()SecurityModule750SecurityModule750.Service. getObjectForSecurityModule750()ServerServer.Service. getObjectForServer()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.TicketServer.Service. getOpenCancellationTicket()An open ticket requesting cancellation of this server, if one exists.BigDecimalServer.Service. getOutboundPrivateBandwidthUsage()The total private outbound bandwidth for this hardware for the current billing cycle.LongServer.Service. getOverBandwidthAllocationFlag()Whether the bandwidth usage for this hardware for the current billing cycle exceeds the allocation.List<Partition>Server.Service. getPartitions()List<PmInfo>Server.Service. getPMInfo()Retrieve a server's hardware state via its internal sensors.LongServer.Service. getPrimaryDriveSize()SummaryServer.Service. getPrivateBandwidthDataSummary()Retrieve a brief summary of a server's private network bandwidth usage.byte[]Server.Service. getPrivateBandwidthGraphImage(String startTime, String endTime)Retrieve a graph of a server's private network bandwidth usage over the specified time frame.StringServer.Service. getPrivateIpAddress()A server's primary private IP address.ComponentServer.Service. getPrivateNetworkComponent()Retrieve the private network component attached with this server.VlanServer.Service. getPrivateVlan()Retrieve the backend VLAN for the primary IP address of the serverVlanServer.Service. getPrivateVlanByIpAddress(String ipAddress)
*** DEPRECATED ***
Retrieve a backend network VLAN by searching for an IP addressLongServer.Service. getProjectedOverBandwidthAllocationFlag()Whether the bandwidth usage for this hardware for the current billing cycle is projected to exceed the allocation.BigDecimalServer.Service. getProjectedPublicBandwidthUsage()The projected public outbound bandwidth for this hardware for the current billing cycle.GregorianCalendarServer.Service. getProvisionDate()SummaryServer.Service. getPublicBandwidthDataSummary()Retrieve a brief summary of a server's public network bandwidth usage.byte[]Server.Service. getPublicBandwidthGraphImage(GregorianCalendar startTime, GregorianCalendar endTime)Retrieve a graph of a server's public network bandwidth usage over the specified time frame.LongServer.Service. getPublicBandwidthTotal(Long startTime, Long endTime)Retrieve the total number of bytes used by a server over a specified time period via the data warehouse tracking objects for this hardware.ComponentServer.Service. getPublicNetworkComponent()Retrieve a SoftLayer server's public network component.VlanServer.Service. getPublicVlan()Retrieve the frontend VLAN for the primary IP address of the serverVlanServer.Service. getPublicVlanByHostname(String hostname)Retrieve the frontend network Vlan by searching the hostname of a serverBooleanServer.Service. getReadyNodeFlag()Determine if hardware object is vSan Ready Node.List<Request>Server.Service. getRecentRemoteManagementCommands()The last five commands issued to the server's remote management card.RegistryServer.Service. getRegionalInternetRegistry()RemoteManagementServer.Service. getRemoteManagement()A server's remote management card.List<User>Server.Service. getRemoteManagementUsers()User(s) who have access to issue commands and/or interact with the server's remote management card.List<Domain>Server.Service. getReverseDomainRecords()Retrieve the reverse domain records associated with this server.BooleanRouter.Service. getSanStorageCapabilityFlag()A flag indicating that a VLAN on the router can be assigned to a host that has SAN disk functionality.List<SensorReading>Server.Service. getSensorDataForServer()Retrieve a server's hardware state via its internal sensors.SensorReadingsWithGraphsServer.Service. getSensorDataWithGraphsForServer()Retrieves the raw data returned from the server's remote management card.DetailsServer.Service. getServerDetails()Retrieve a server's hardware components, software, and network components.List<SensorSpeed>Server.Service. getServerFanSpeedGraphsForServer()Retrieve the server's fan speeds and displays them using tachometer graphs.StringServer.Service. getServerPowerStateForServer()Retrieves the power state for the server.List<SensorTemperature>Server.Service. getServerTemperatureGraphsForServer()Retrieve the server's temperature and displays them using thermometer graphs.BooleanServer.Service. getSoftwareGuardExtensionEnabled()Determine if hardware object has Software Guard Extension (SGX) enabled.RemoteManagementServer.Service. getStatisticsRemoteManagement()A server's remote management card used for statistics.BooleanServer.Service. getUefiBootFlag()Whether to use UEFI boot instead of BIOS.List<Customer>Server.Service. getUsers()A list of users that have access to this computing instance.List<Group>Server.Service. getValidBlockDeviceTemplateGroups(String visibility)This method will return the list of block device template groups that are valid to the host.List<Guest>Server.Service. getVirtualGuests()A hardware server's virtual servers.List<UpdateItem>Server.Service. getWindowsUpdateAvailableUpdates()Retrieve a list of Windows updates available for a server from the local SoftLayer Windows Server Update Services (WSUS) server.List<UpdateItem>Server.Service. getWindowsUpdateInstalledUpdates()Retrieve a list of Windows updates installed on a server as reported by the local SoftLayer Windows Server Update Services (WSUS) server.StatusServer.Service. getWindowsUpdateStatus()This method returns an update status record for this server.BooleanServer.Service. initiateIderaBareMetalRestore()Idera Bare Metal Server Restore is a backup agent designed specifically for making full system restores made with Idera Server Backup.BooleanServer.Service. initiateR1SoftBareMetalRestore()R1Soft Bare Metal Server Restore is an R1Soft disk agent designed specifically for making full system restores made with R1Soft CDP Server backup.BooleanServer.Service. isBackendPingable()Issues a ping command and returns the success (true) or failure (false) of the ping command.BooleanServer.Service. isPingableForServer()Issues a ping command and returns the success (true) or failure (false) of the ping command.BooleanServer.Service. isWindowsServer()Determine if the server runs any version of the Microsoft Windows operating systems.List<Request>Server.Service. massFirmwareReflash(List<Long> hardwareIds, Boolean ipmi, Boolean raidController, Boolean bios)You can launch firmware reflashes by selecting from your server list.List<Request>Server.Service. massFirmwareUpdate(List<Long> hardwareIds, Boolean ipmi, Boolean raidController, Boolean bios, Boolean harddrive)You can launch firmware updates by selecting from your server list.List<Request>Server.Service. massHyperThreadingUpdate(List<Long> hardwareIds, Boolean disableHyperthreading)You can launch hyper-threading update by selecting from your server list.StringServer.Service. massReloadOperatingSystem(List<String> hardwareIds, String token, Configuration config)Reloads current or customer specified operating system configuration.List<Request>Server.Service. massSparePool(List<String> hardwareIds, String action, Boolean newOrder)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.StringServer.Service. pingForServer()Issues a ping command to the server and returns the ping response.VoidServer.Service. populateServerRam(String ramSerialString)BooleanServer.Service. powerCycleForServer()Power off then power on the server via powerstrip.BooleanServer.Service. powerOffForServer()This method will power off the server via the server's remote management card.BooleanServer.Service. powerOnForServer()Power on server via its remote management card.BooleanServer.Service. rebootDefaultForServer()Attempts to reboot the server by issuing a reset (soft reboot) command to the server's remote management card.BooleanServer.Service. rebootHardForServer()Reboot the server by issuing a cycle command to the server's remote management card.BooleanServer.Service. rebootSoftForServer()Reboot the server by issuing a reset command to the server's remote management card.StringServer.Service. reloadCurrentOperatingSystemConfiguration(String token)Reloads current operating system configuration.StringServer.Service. reloadOperatingSystem(String token, Configuration config)Reloads current or customer specified operating system configuration.BooleanServer.Service. runPassmarkCertificationBenchmark()You can launch a new Passmark hardware test by selecting from your server list.BooleanServer.Service. setOperatingSystemPassword(String newPassword)Changes the password that we have stored in our database for a servers' Operating SystemBooleanServer.Service. setPrivateNetworkInterfaceSpeed(Long newSpeed, String redundancy)Set the private network interface speed and redundancy configuration.BooleanServer.Service. setPublicNetworkInterfaceSpeed(Long newSpeed, String redundancy)Set the public network interface speed and redundancy configuration.List<Attribute>Server.Service. setUserMetadata(List<String> metadata)Sets the data that will be written to the configuration drive.BooleanServer.Service. shutdownPrivatePort()Disconnect a server's private network interface.BooleanServer.Service. shutdownPublicPort()Disconnect a server's public network interface.BooleanServer.Service. sparePool(String action, Boolean newOrder)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.BooleanServer.Service. testRaidAlertService()Test the RAID Alert service by sending the service a request to store a test email for this server.BooleanServer.Service. toggleManagementInterface(Boolean enabled)Attempt to toggle the IPMI interface.BooleanServer.Service. updateIpmiPassword(String password)This method will update the root IPMI password on this SoftLayer_Hardware.BooleanServer.Service. validatePartitionsForOperatingSystem(Description operatingSystem, List<Partition> partitions)Validates a collection of partitions for an operating system -
Uses of ApiMethod in com.softlayer.api.service.hardware.benchmark
Methods in com.softlayer.api.service.hardware.benchmark with annotations of type ApiMethod Modifier and Type Method Description AccountCertification.Service. getAccount()Information regarding a benchmark certification result's associated SoftLayer customer account.HardwareCertification.Service. getHardware()Information regarding the piece of hardware on which a benchmark certification test was performed.CertificationCertification.Service. getObject()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.byte[]Certification.Service. getResultFile()Attempt to retrieve the file associated with a benchmark certification result, if such a file exists. -
Uses of ApiMethod in com.softlayer.api.service.hardware.component
Methods in com.softlayer.api.service.hardware.component with annotations of type ApiMethod Modifier and Type Method Description TypeModel.Service. getArchitectureType()List<Attribute>Model.Service. getAttributes()List<Type>Model.Service. getCompatibleArrayTypes()List<Model>Model.Service. getCompatibleChildComponentModels()All the component models that are compatible with a hardware component model.List<Model>Model.Service. getCompatibleParentComponentModels()All the component models that a hardware component model is compatible with.LongModel.Service. getFirmwareQuantity()List<Firmware>Model.Service. getFirmwares()List<Result>Locator.Service. getGenericComponentModelAvailability(List<Long> genericComponentModelIds)List<Component>Model.Service. getHardwareComponents()A hardware component model's physical components in inventory.GenericModel.Service. getHardwareGenericComponentModel()The non-vendor specific generic component model for a hardware component model.AttributeModel.Service. getInfinibandCompatibleAttribute()BooleanModel.Service. getIsFlexSkuCompatible()BooleanModel.Service. getIsInfinibandCompatible()ModelModel.Service. getObject()getObject retrieves the SoftLayer_Hardware_Component_Model object.List<Result>Locator.Service. getPackageItemsAvailability(Long packageId)TimeModel.Service. getRebootTime()A motherboard's average reboot time.List<Result>Locator.Service. getServerPackageAvailability()StringModel.Service. getType()A hardware component model's type.List<Type>Model.Service. getValidAttributeTypes()The types of attributes that are allowed for a given hardware component model. -
Uses of ApiMethod in com.softlayer.api.service.hardware.component.partition
Methods in com.softlayer.api.service.hardware.component.partition with annotations of type ApiMethod Modifier and Type Method Description AccountTemplate.Service. getAccount()A partition template's associated [[SoftLayer_Account|Account]].List<OperatingSystem>OperatingSystem.Service. getAllObjects()OperatingSystemOperatingSystem.Service. getByDescription(String description)The '''getByDescription''' method retrieves all possible partition templates based on the description (required parameter) entered when calling the method.List<Partition>Template.Service. getData()An individual partition for a partition template.StringTemplate.Service. getExpireDate()OperatingSystemOperatingSystem.Service. getObject()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.sTemplateTemplate.Service. getObject()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.OperatingSystemTemplate.Service. getPartitionOperatingSystem()A partition template's associated [[SoftLayer_Hardware_Component_Partition_OperatingSystem|Operating System]].List<Partition>Template.Service. getPartitionTemplatePartition()An individual partition for a partition template.List<Template>OperatingSystem.Service. getPartitionTemplates()Information regarding an operating system's [[SoftLayer_Hardware_Component_Partition_Template|Partition Templates]]. -
Uses of ApiMethod in com.softlayer.api.service.integratedofferingteam
Methods in com.softlayer.api.service.integratedofferingteam with annotations of type ApiMethod Modifier and Type Method Description List<Region>Region.Service. getAllObjects()Returns a list of all Integrated Offering Team regions.List<Lead>Region.Service. getRegionLeads()Returns a list of all Integrated Offering Team region leads. -
Uses of ApiMethod in com.softlayer.api.service.layout
Methods in com.softlayer.api.service.layout with annotations of type ApiMethod Modifier and Type Method Description BooleanProfile.Service. createObject(Profile templateObject)This method creates a new layout profile object.BooleanProfile.Service. deleteObject()This method deletes an existing layout profile and associated custom preferencesBooleanProfile.Service. editObject(Profile templateObject)This method edits an existing layout profile object by passing in a modified instance of the object.List<Container>Container.Service. getAllObjects()Use this method to retrieve all active layout containers that can be customized.List<Container>Profile.Service. getLayoutContainers()TypeContainer.Service. getLayoutContainerType()The type of the layout container objectList<Preference>Item.Service. getLayoutItemPreferences()The layout preferences assigned to this layout itemList<Item>Container.Service. getLayoutItems()The layout items assigned to this layout containerTypeItem.Service. getLayoutItemType()The type of the layout item objectList<Preference>Profile.Service. getLayoutPreferences()ContainerContainer.Service. getObject()ItemItem.Service. getObject()ProfileProfile.Service. getObject()PreferenceProfile.Service. modifyPreference(Preference templateObject)This method modifies an existing associated [[SoftLayer_Layout_Profile_Preference]] object.List<Preference>Profile.Service. modifyPreferences(List<Preference> layoutPreferenceObjects)Using this method, multiple [[SoftLayer_Layout_Profile_Preference]] objects may be updated at once. -
Uses of ApiMethod in com.softlayer.api.service.layout.profile
Methods in com.softlayer.api.service.layout.profile with annotations of type ApiMethod Modifier and Type Method Description BooleanContainers.Service. createObject(Containers templateObject)BooleanContainers.Service. editObject(Containers templateObject)ContainerPreference.Service. getLayoutContainer()ContainerContainers.Service. getLayoutContainerType()The container to be containedItemPreference.Service. getLayoutItem()PreferencePreference.Service. getLayoutPreference()ProfileContainers.Service. getLayoutProfile()The profile containing this containerProfilePreference.Service. getLayoutProfile()ContainersContainers.Service. getObject()PreferencePreference.Service. getObject()CustomerCustomer.Service. getObjectForCustomer()CustomerCustomer.Service. getUserRecord() -
Uses of ApiMethod in com.softlayer.api.service.locale
Methods in com.softlayer.api.service.locale with annotations of type ApiMethod Modifier and Type Method Description List<Timezone>Timezone.Service. getAllObjects()Retrieve all timezone objects.List<VatCountryCodeAndFormat>Country.Service. getAllVatCountryCodesAndVatIdRegexes()This method is to get the collection of VAT country codes and VAT ID Regexes.List<Country>Country.Service. getAvailableCountries()Use this method to retrieve a list of countries and locale information available to the current user.List<Country>Country.Service. getCountries()Use this method to retrieve a list of countries and locale information such as country code and state/provinces.List<CountryCode>Country.Service. getCountriesAndStates(Boolean usFirstFlag)This method will return a collection of [[SoftLayer_Container_Collection_Locale_CountryCode]] objects.CountryCountry.Service. getObject()TimezoneTimezone.Service. getObject()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.List<String>Country.Service. getPostalCodeRequiredCountryCodes()This method will return an array of country codes that require postal codeList<StateProvince>Country.Service. getStates()States that belong to this country.List<String>Country.Service. getVatCountries()This method will return an array of ISO 3166 Alpha-2 country codes that use a Value-Added Tax (VAT) ID.List<String>Country.Service. getVatRequiredCountryCodes()This method will return an array of ISO 3166 Alpha-2 country codes that use a Value-Added Tax (VAT) ID.BooleanCountry.Service. isEuropeanUnionCountry(String iso2CountryCode)Returns true if the country code is in the European Union (EU), false otherwise. -
Uses of ApiMethod in com.softlayer.api.service.location
Methods in com.softlayer.api.service.location with annotations of type ApiMethod Modifier and Type Method Description AccountReservation.Service. getAccount()The account that a billing item belongs to.List<Reservation>Reservation.Service. getAccountReservations()List<Event>Datacenter.Service. getActiveItemPresaleEvents()List<Group>Group.Service. getAllObjects()AllotmentReservation.Service. getAllotment()The bandwidth allotment that the reservation belongs to.List<Hardware>Datacenter.Service. getBackendHardwareRouters()ItemReservation.Service. getBillingItem()The bandwidth allotment that the reservation belongs to.List<Subnet>Datacenter.Service. getBoundSubnets()Subnets which are directly bound to one or more routers in a given datacenter, and currently allow routing.List<CustomerCountry>Datacenter.Service. getBrandCountryRestrictions()This references relationship between brands, locations and countries associated with a user's account that are ineligible when ordering products.List<Hardware>Datacenter.Service. getFrontendHardwareRouters()List<Hardware>Datacenter.Service. getHardwareRouters()LocationReservation.Service. getLocation()The datacenter location that the reservation belongs to.TypeGroup.Service. getLocationGroupType()The type for this location group.RackReservation.Service. getLocationReservationRack()Rack information for the reservationList<Location>Group.Service. getLocations()The locations in a group.GroupGroup.Service. getObject()ReservationReservation.Service. getObject()DatacenterDatacenter.Service. getObjectForDatacenter()List<Event>Datacenter.Service. getPresaleEvents()RegionalDatacenter.Service. getRegionalGroup()The regional group this datacenter belongs to.RegistryDatacenter.Service. getRegionalInternetRegistry()List<Subnet>Datacenter.Service. getRoutableBoundSubnets()Retrieve all subnets that are eligible to be routed; those which the account has permission to associate with a vlan.byte[]Datacenter.Service. getStatisticsGraphImage()Retrieve a graph of a SoftLayer datacenter's last 48 hours of network activity. -
Uses of ApiMethod in com.softlayer.api.service.location.group
Methods in com.softlayer.api.service.location.group with annotations of type ApiMethod Modifier and Type Method Description List<Group>Pricing.Service. getAllObjectsForPricing()List<Group>Regional.Service. getAllObjectsForRegional()List<Location>Regional.Service. getDatacenters()The datacenters in a group.PricingPricing.Service. getObjectForPricing()RegionalRegional.Service. getObjectForRegional()DatacenterRegional.Service. getPreferredDatacenter()The preferred datacenters of a group.List<Price>Pricing.Service. getPrices()The prices that this pricing location group limits. -
Uses of ApiMethod in com.softlayer.api.service.location.reservation
Methods in com.softlayer.api.service.location.reservation with annotations of type ApiMethod Modifier and Type Method Description AllotmentRack.Service. getAllotment()The bandwidth allotment that the reservation belongs to.List<Member>Rack.Service. getChildren()Members of the rack.LocationRack.Service. getLocation()ReservationRack.Service. getLocationReservation()RackRack.Service. getObject() -
Uses of ApiMethod in com.softlayer.api.service.location.reservation.rack
Methods in com.softlayer.api.service.location.reservation.rack with annotations of type ApiMethod Modifier and Type Method Description LocationMember.Service. getLocation()Location relation for the rack memberRackMember.Service. getLocationReservationRack()MemberMember.Service. getObject() -
Uses of ApiMethod in com.softlayer.api.service.marketplace
Methods in com.softlayer.api.service.marketplace with annotations of type ApiMethod Modifier and Type Method Description List<Partner>Partner.Service. getAllObjects()List<Partner>Partner.Service. getAllPublishedPartners(String searchTerm)List<Attachment>Partner.Service. getAttachments()List<Partner>Partner.Service. getFeaturedPartners(Boolean non)FilePartner.Service. getFile(String name)AttachmentPartner.Service. getLogoMedium()AttachmentPartner.Service. getLogoMediumTemp()AttachmentPartner.Service. getLogoSmall()AttachmentPartner.Service. getLogoSmallTemp()PartnerPartner.Service. getObject()PartnerPartner.Service. getPartnerByUrlIdentifier(String urlIdentifier) -
Uses of ApiMethod in com.softlayer.api.service.metric.tracking
Methods in com.softlayer.api.service.metric.tracking with annotations of type ApiMethod Modifier and Type Method Description GraphOutputsObject.Service. getBackboneBandwidthGraph(String graphTitle)[DEPRECATED] Retrieve a PNG image of the last 24 hours of bandwidth usage of one of SoftLayer's network backbones.List<Data>Object.Service. getBandwidthData(GregorianCalendar startDateTime, GregorianCalendar endDateTime, String type, Long rollupSeconds)Retrieve a collection of raw bandwidth data from an individual public or private network tracking object.GraphOutputsObject.Service. getBandwidthGraph(GregorianCalendar startDateTime, GregorianCalendar endDateTime, String graphType, Long fontSize, Long graphWidth, Long graphHeight, Boolean doNotShowTimeZone)Retrieve a PNG image of a bandwidth graph representing the bandwidth usage over time recorded by SofTLayer's bandwidth pollers.LongObject.Service. getBandwidthTotal(GregorianCalendar startDateTime, GregorianCalendar endDateTime, String direction, String type)Retrieve the total amount of bandwidth recorded by a tracking object within the given date range.GraphObject.Service. getCustomGraphData(Graph graphContainer)Returns a graph container instance that is populated with metric data for the tracking object.List<Details>Object.Service. getDetailsForDateRange(GregorianCalendar startDate, GregorianCalendar endDate, List<String> graphType)Retrieve a collection of detailed metric data over a date range.GraphOutputsObject.Service. getGraph(GregorianCalendar startDateTime, GregorianCalendar endDateTime, List<String> graphType)Retrieve a PNG image of a metric in graph form.List<Type>Object.Service. getMetricDataTypes()Returns a collection of metric data types that can be retrieved for a metric tracking object.ObjectObject.Service. getObject()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.SummaryObject.Service. getSummary(String graphType)Retrieve a metric summary.List<Data>Object.Service. getSummaryData(GregorianCalendar startDateTime, GregorianCalendar endDateTime, List<Type> validTypes, Long summaryPeriod)Returns summarized metric data for the date range, metric type and summary period provided.TypeObject.Service. getType()The type of data that a tracking object polls. -
Uses of ApiMethod in com.softlayer.api.service.metric.tracking.object.bandwidth
Methods in com.softlayer.api.service.metric.tracking.object.bandwidth with annotations of type ApiMethod Modifier and Type Method Description SummarySummary.Service. getObject() -
Uses of ApiMethod in com.softlayer.api.service.monitoring
Methods in com.softlayer.api.service.monitoring with annotations of type ApiMethod Modifier and Type Method Description BooleanRobot.Service. checkConnection()Deprecated.RobotRobot.Service. getObject() -
Uses of ApiMethod in com.softlayer.api.service.network
Methods in com.softlayer.api.service.network with annotations of type ApiMethod Modifier and Type Method Description List<Vlan>Component.Service. addNetworkVlanTrunks(List<Vlan> networkVlans)Add VLANs as trunks to a network component.RequestRulesSecurityGroup.Service. addRules(List<Rule> ruleTemplates)Add new rules to a security group by sending in an array of template [[SoftLayer_Network_SecurityGroup_Rule (type)]] objects to be created.BooleanStorage.Service. allowAccessFromHardware(Hardware hardwareObjectTemplate)This method is used to modify the access control list for this Storage volume.BooleanStorage.Service. allowAccessFromHardwareList(List<Hardware> hardwareObjectTemplates)HostStorage.Service. allowAccessFromHost(String typeClassName, Long hostId)This method is used to modify the access control list for this Storage volume.List<Host>Storage.Service. allowAccessFromHostList(List<Host> hostObjectTemplates)This method is used to modify the access control list for this Storage volume.BooleanStorage.Service. allowAccessFromIpAddress(IpAddress ipAddressObjectTemplate)This method is used to modify the access control list for this Storage volume.BooleanStorage.Service. allowAccessFromIpAddressList(List<IpAddress> ipAddressObjectTemplates)BooleanStorage.Service. allowAccessFromSubnet(Subnet subnetObjectTemplate)This method is used to modify the access control list for this Storage volume.BooleanStorage.Service. allowAccessFromSubnetList(List<Subnet> subnetObjectTemplates)BooleanStorage.Service. allowAccessFromVirtualGuest(Guest virtualGuestObjectTemplate)This method is used to modify the access control list for this Storage volume.BooleanStorage.Service. allowAccessFromVirtualGuestList(List<Guest> virtualGuestObjectTemplates)This method is used to modify the access control list for this Storage volume.BooleanSubnet.Service. allowAccessToNetworkStorage(Storage networkStorageTemplateObject)This method is used to allow access to a SoftLayer_Network_Storage volume that supports host- or network-level access control.BooleanSubnet.Service. allowAccessToNetworkStorageList(List<Storage> networkStorageTemplateObjects)This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support host- or network-level access control.BooleanStorage.Service. allowAccessToReplicantFromHardware(Hardware hardwareObjectTemplate)This method is used to modify the access control list for this Storage replicant volume.BooleanStorage.Service. allowAccessToReplicantFromHardwareList(List<Hardware> hardwareObjectTemplates)This method is used to modify the access control list for this Storage volume's replica.BooleanStorage.Service. allowAccessToReplicantFromIpAddress(IpAddress ipAddressObjectTemplate)BooleanStorage.Service. allowAccessToReplicantFromIpAddressList(List<IpAddress> ipAddressObjectTemplates)This method is used to modify the access control list for this Storage volume's replica.BooleanStorage.Service. allowAccessToReplicantFromSubnet(Subnet subnetObjectTemplate)This method is used to modify the access control list for this Storage replicant volume.BooleanStorage.Service. allowAccessToReplicantFromSubnetList(List<Subnet> subnetObjectTemplates)This method is used to modify the access control list for this Storage volume's replica.BooleanStorage.Service. allowAccessToReplicantFromVirtualGuest(Guest virtualGuestObjectTemplate)This method is used to modify the access control list for this Storage replicant volume.BooleanStorage.Service. allowAccessToReplicantFromVirtualGuestList(List<Guest> virtualGuestObjectTemplates)This method is used to modify the access control list for this Storage volume's replica.BooleanStorage.Service. assignCredential(String username)This method will assign an existing credential to the current volume.CredentialStorage.Service. assignNewCredential(String type)This method will set up a new credential for the remote storage volume.RequestSecurityGroup.Service. attachNetworkComponents(List<Long> networkComponentIds)Attach virtual guest network components to a security group by creating [[SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding (type)]] objects.VoidGateway.Service. bypassAllVlans()Start the asynchronous process to bypass all VLANs.VoidGateway.Service. bypassVlans(List<Vlan> vlans)Start the asynchronous process to bypass the provided VLANs.BooleanGateway.Service. changeGatewayVersion(Long versionId, Boolean rollbackVersion)Used to create a transaction to upgrade or rollback the vSRX version for Juniper gateway.BooleanStorage.Service. changePassword(String username, String currentPassword, String newPassword)The method will change the password for the given Storage/Virtual Server Storage account.BooleanGateway.Service. checkAccountWhiteList(Long accountId, String category)List<Vlan>Component.Service. clearNetworkVlanTrunks()This method will remove all VLANs trunked to this network component.BooleanSubnet.Service. clearRoute()This interface allows you to remove the route of your Account Owned subnets.LongStorage.Service. collectBandwidth(String type, GregorianCalendar startDate, GregorianCalendar endDate){{CloudLayerOnlyMethod}}
collectBandwidth() Retrieve the bandwidth usage for the current billing cycle.LongStorage.Service. collectBytesUsed(){{CloudLayerOnlyMethod}}
collectBytesUsed() retrieves the number of bytes capacity currently in use on a Storage account.BooleanStorage.Service. convertCloneDependentToIndependent()BooleanStorage.Service. createFolder(String folder)GatewayGateway.Service. createObject(Gateway templateObject)Create and return a new gateway.SecurityGroupSecurityGroup.Service. createObject(SecurityGroup templateObject)Create a new security group.List<SecurityGroup>SecurityGroup.Service. createObjects(List<SecurityGroup> templateObjects)Create new security groups.PropertyStorage.Service. createOrUpdateLunId(Long lunId)The LUN ID only takes effect during the Host Authorization process.ReverseSubnet.Service. createReverseDomainRecords()Create the default PTR records for this subnetStorageStorage.Service. createSnapshot(String notes)BooleanSubnet.Service. createSubnetRouteUpdateTransaction(String newEndPointIpAddress)
***DEPRECATED***
This endpoint is deprecated in favor of the more expressive and capable SoftLayer_Network_Subnet::route, to which this endpoint now proxies.BooleanSubnet.Service. createSwipTransaction()
***DEPRECATED***
This function is used to create a new SoftLayer SWIP transaction to register your RWHOIS data with ARIN.BooleanStorage.Service. deleteAllFiles(){{CloudLayerOnlyMethod}} Delete all files within a Storage account.BooleanStorage.Service. deleteFile(String fileId){{CloudLayerOnlyMethod}} Delete an individual file within a Storage account.BooleanStorage.Service. deleteFiles(List<String> fileIds){{CloudLayerOnlyMethod}} Delete multiple files within a Storage account.BooleanStorage.Service. deleteFolder(String folder)BooleanSecurityGroup.Service. deleteObject()Delete a security group for an account.BooleanStorage.Service. deleteObject()Delete a network storage volume.BooleanSecurityGroup.Service. deleteObjects(List<SecurityGroup> templateObjects)Delete security groups for an account.RequestSecurityGroup.Service. detachNetworkComponents(List<Long> networkComponentIds)Detach virtual guest network components from a security group by deleting its [[SoftLayer_Virtual_Network_SecurityGroup_NetworkComponentBinding (type)]].BooleanStorage.Service. disableSnapshots(String scheduleType)This method is not valid for Legacy iSCSI Storage Volumes.BooleanStorage.Service. disasterRecoveryFailoverToReplicant(Long replicantId)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.EntityStorage.Service. downloadFile(String fileId){{CloudLayerOnlyMethod}} Download a file from a Storage account.BooleanStorage.Service. editCredential(String username, String newPassword)This method will change the password of a credential created using the 'addNewCredential' method.BooleanSubnet.Service. editNote(String note)Edit the note for this subnet.BooleanGateway.Service. editObject(Gateway templateObject)Edit this gateway.BooleanSecurityGroup.Service. editObject(SecurityGroup templateObject)Edit a security group.BooleanStorage.Service. editObject(Storage templateObject)The password and/or notes may be modified for the Storage service except evault passwords and notes.BooleanVlan.Service. editObject(Vlan templateObject)Edit a VLAN's propertiesBooleanSecurityGroup.Service. editObjects(List<SecurityGroup> templateObjects)Edit security groups.RequestRulesSecurityGroup.Service. editRules(List<Rule> ruleTemplates)Edit rules that belong to the security group.BooleanStorage.Service. enableSnapshots(String scheduleType, Long retentionCount, Long minute, Long hour, String dayOfWeek)This method is not valid for Legacy iSCSI Storage Volumes.BooleanStorage.Service. failbackFromReplicant()Failback from a volume replicant.BooleanStorage.Service. failoverToReplicant(Long replicantId)Failover to a volume replicant.List<Subnet>Subnet.Service. findAllSubnetsAndActiveSwipTransactionStatus()
***DEPRECATED***
Retrieve a list of a SoftLayer customer's subnets along with their SWIP transaction statuses.BooleanGateway.Service. forceRebuildvSRXCluster(Long osPriceId)Purpose is to rebuild the target Gateway cluster with the specified OS price id.AccountGateway.Service. getAccount()The account for this gateway.AccountSecurityGroup.Service. getAccount()The account this security group belongs to.AccountStorage.Service. getAccount()The account that a Storage services belongs to.AccountSubnet.Service. getAccount()AccountVlan.Service. getAccount()The SoftLayer customer account associated with a VLAN.PasswordStorage.Service. getAccountPassword()Other usernames and passwords associated with a Storage volume.RequestComponent.Service. getActiveCommand()Reboot/power (rebootDefault, rebootSoft, rebootHard, powerOn, powerOff and powerCycle) command currently executing by the server's remote management card.RegistrationSubnet.Service. getActiveRegistration()If present, the active registration for this subnet.TransactionSubnet.Service. getActiveSwipTransaction()DEPRECATEDTransactionSubnet.Service. getActiveTransaction()DEPRECATEDList<Transaction>Storage.Service. getActiveTransactions()The currently active transactions on a network storage volume.List<Subnet>Vlan.Service. getAdditionalPrimarySubnets()A VLAN's additional primary subnets.StringSubnet.Service. getAddressSpace()Identifier which distinguishes what classification of addresses the subnet represents.List<Backbone>Backbone.Service. getAllBackbones()Retrieve a list of all SoftLayer backbone connections.List<Entity>Storage.Service. getAllFiles(){{CloudLayerOnlyMethod}} Retrieve details such as id, name, size, create date for all files in a Storage account's root directory.List<Entity>Storage.Service. getAllFilesByFilter(Entity filter){{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.List<Pod>Pod.Service. getAllObjects()Filtering is supported for ``datacenterName`` and ``capabilities``.List<SecurityGroup>SecurityGroup.Service. getAllObjects()List<Hardware>Storage.Service. getAllowableHardware(String filterHostname)This method retrieves a list of SoftLayer_Hardware that can be authorized to this SoftLayer_Network_Storage.List<IpAddress>Storage.Service. getAllowableIpAddresses(Long subnetId, String filterIpAddress)This method retrieves a list of SoftLayer_Network_Subnet_IpAddress that can be authorized to this SoftLayer_Network_Storage.List<Subnet>Storage.Service. getAllowableSubnets(String filterNetworkIdentifier)This method retrieves a list of SoftLayer_Network_Subnet that can be authorized to this SoftLayer_Network_Storage.List<Guest>Storage.Service. getAllowableVirtualGuests(String filterHostname)This method retrieves a list of SoftLayer_Virtual_Guest that can be authorized to this SoftLayer_Network_Storage.StringStorage.Service. getAllowDisasterRecoveryFailback()StringStorage.Service. getAllowDisasterRecoveryFailover()List<Hardware>Storage.Service. getAllowedHardware()The SoftLayer_Hardware objects which are allowed access to this storage volume.HostSubnet.Service. getAllowedHost()The SoftLayer_Network_Storage_Allowed_Host information to connect this Subnet to Network Storage supporting access control lists.LongStorage.Service. getAllowedHostsLimit()Retrieves the total number of allowed hosts limit per volume.List<IpAddress>Storage.Service. getAllowedIpAddresses()The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume.List<Storage>Subnet.Service. getAllowedNetworkStorage()The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to.List<Storage>Subnet.Service. getAllowedNetworkStorageReplicas()The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to.List<Long>Gateway.Service. getAllowedOsPriceIds(Long memberId)Used to get a list of OS prices (ids) which are allowed for the Gateway.List<Hardware>Storage.Service. getAllowedReplicationHardware()The SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant.List<IpAddress>Storage.Service. getAllowedReplicationIpAddresses()The SoftLayer_Network_Subnet_IpAddress objects which are allowed access to this storage volume's Replicant.List<Subnet>Storage.Service. getAllowedReplicationSubnets()The SoftLayer_Network_Subnet objects which are allowed access to this storage volume's Replicant.List<Guest>Storage.Service. getAllowedReplicationVirtualGuests()The SoftLayer_Hardware objects which are allowed access to this storage volume's Replicant.List<Subnet>Storage.Service. getAllowedSubnets()The SoftLayer_Network_Subnet objects which are allowed access to this storage volume.List<Guest>Storage.Service. getAllowedVirtualGuests()The SoftLayer_Virtual_Guest objects which are allowed access to this storage volume.GatewayVlan.Service. getAttachedNetworkGateway()The gateway this VLAN is inside of.BooleanVlan.Service. getAttachedNetworkGatewayFlag()Whether or not this VLAN is inside a gateway.VlanVlan.Service. getAttachedNetworkGatewayVlan()The inside VLAN record if this VLAN is inside a network gateway.List<Storage>Subnet.Service. getAttachedNetworkStorages(String nasType)This method is retrieve a list of SoftLayer_Network_Storage volumes that are authorized access to this SoftLayer_Network_Subnet.List<Storage>Subnet.Service. getAvailableNetworkStorages(String nasType)This method retrieves a list of SoftLayer_Network_Storage volumes that can be authorized to this SoftLayer_Network_Subnet.List<Backbone>Backbone.Service. getBackbonesForLocationName(String locationName)Retrieve a list of all SoftLayer backbone connections for a location name.ItemStorage.Service. getBillingItem()The current billing item for a Storage volume.ItemSubnet.Service. getBillingItem()The billing item for a subnet.ItemVlan.Service. getBillingItem()The billing item for a network vlan.CategoryStorage.Service. getBillingItemCategory()List<Subnet>Subnet.Service. getBoundDescendants()BooleanSubnet.Service. getBoundRouterFlag()Whether or not this subnet is associated with a router.List<Hardware>Subnet.Service. getBoundRouters()StringStorage.Service. getBytesUsed()The amount of space used by the volume, in bytes.List<Storage>Storage.Service. getByUsername(String username, String type)Retrieve network storage accounts by username and storage account type.List<String>Vlan.Service. getCancelFailureReasons()Get a set of reasons why this VLAN may not be cancelled.List<String>Pod.Service. getCapabilities()Provides the list of capabilities a Pod fulfills.StringGateway.Service. getCapacity()Returns the Gbps capacity of the gateway object
List<ContentDeliveryUrl>Storage.Service. getCdnUrls()List<Subnet>Subnet.Service. getChildren()ResourceStorage.Service. getClusterResource()InterfaceComponent.Service. getComponentInterface()[DEPRECATED] A hardware switch's interface to the bandwidth pod.StringStorage.Service. getCreationScheduleId()The schedule id which was executed to create a snapshot.List<Credential>Storage.Service. getCredentials()GraphComponent.Service. getCustomBandwidthDataByDate(Graph graphData)Retrieve bandwidth graph by date.ScheduleStorage.Service. getDailySchedule()The Daily Schedule which is associated with this network storage volume.DatacenterSubnet.Service. getDatacenter()The data center this subnet may be routed within.LongVlan.Service. getDedicatedFirewallFlag()A flag indicating that a network vlan is on a Hardware Firewall (Dedicated).StringStorage.Service. getDependentDuplicate()Whether or not a network storage volume is a dependent duplicate.List<Storage>Storage.Service. getDependentDuplicates()The network storage volumes configured to be dependent duplicates of a volume.List<Subnet>Subnet.Service. getDescendants()StringSubnet.Service. getDisplayLabel()ComponentComponent.Service. getDownlinkComponent()The network component linking this object to a child deviceModeComponent.Service. getDuplexMode()The duplex mode of a network component.IpAddressSubnet.Service. getEndPointIpAddress()A static routed ip addressList<Event>Storage.Service. getEvents()The events which have taken place on a network storage volume.RouterVlan.Service. getExtensionRouter()The extension router that a VLAN is associated with.StringStorage.Service. getFailbackNotAllowed()Determines whether the volume is allowed to failbackStringStorage.Service. getFailoverNotAllowed()Determines whether the volume is allowed to failoverList<Location>Storage.Service. getFileBlockEncryptedLocations()
EntityStorage.Service. getFileByIdentifier(String identifier){{CloudLayerOnlyMethod}} Retrieve details such as id, name, size, create date of a file within a Storage account.LongStorage.Service. getFileCount(){{CloudLayerOnlyMethod}} Retrieve the file number of files in a Virtual Server Storage account's root directory.List<Entity>Storage.Service. getFileList(String folder, String path)StringStorage.Service. getFileNetworkMountAddress()Retrieves the NFS Network Mount Address Name for a given File Storage Volume.LongStorage.Service. getFilePendingDeleteCount(){{CloudLayerOnlyMethod}} Retrieve the number of files pending deletion in a Storage account's recycle bin.List<Entity>Storage.Service. getFilesPendingDelete(){{CloudLayerOnlyMethod}} Retrieve a list of files that are pending deletion in a Storage account's recycle bin.List<Firewall>Vlan.Service. getFirewallGuestNetworkComponents()A firewalled Vlan's network components.List<Interface>Vlan.Service. getFirewallInterfaces()A firewalled vlan's inbound/outbound interfaces.List<Firewall>Vlan.Service. getFirewallNetworkComponents()A firewalled Vlan's network components.List<IpAddress>Vlan.Service. getFirewallProtectableIpAddresses()Get the IP addresses associated with this server that are protectable by a network component firewall.List<Subnet>Vlan.Service. getFirewallProtectableSubnets()Get the subnets associated with this server that are protectable by a network component firewall.List<Rule>Vlan.Service. getFirewallRules()The currently running rule set of a firewalled VLAN.List<Folder>Storage.Service. getFolderList()GlobalSubnet.Service. getGlobalIpRecord()GraphOutputsStorage.Service. getGraph(GregorianCalendar startDate, GregorianCalendar endDate, String type){{CloudLayerOnlyMethod}}
getGraph() retrieves a Storage account's usage and returns a PNG graph image, title, and the minimum and maximum dates included in the graphed date range.byte[]Backbone.Service. getGraphImage()[DEPRECATED] Retrieve a graph of a SoftLayer backbone's last 24 hours of activity.List<Component>Vlan.Service. getGuestNetworkComponents()The networking components that are connected to a VLAN.HardwareComponent.Service. getHardware()The hardware that a network component resides in.HardwareStorage.Service. getHardware()When applicable, the hardware associated with a Storage service.List<Hardware>Subnet.Service. getHardware()The hardware using IP addresses on this subnet.List<Hardware>Vlan.Service. getHardware()All of the hardware that exists on a VLAN.BooleanStorage.Service. getHasEncryptionAtRest()StringBackbone.Service. getHealth()A backbone's status.BooleanComponent.Service. getHighAvailabilityFirewallFlag()BooleanVlan.Service. getHighAvailabilityFirewallFlag()ScheduleStorage.Service. getHourlySchedule()The Hourly Schedule which is associated with this network storage volume.List<Vlan>Gateway.Service. getInsideVlans()All VLANs trunked to this gateway.ScheduleStorage.Service. getIntervalSchedule()The Interval Schedule which is associated with this network storage volume.StringStorage.Service. getIops()The maximum number of IOPs selected for this volume.List<IpAddress>Component.Service. getIpAddressBindings()The records of all IP addresses bound to a network component.List<IpAddress>Component.Service. getIpAddresses()List<IpAddress>Subnet.Service. getIpAddresses()All the ip addresses associated with a subnet.List<IpAddress>Monitor.Service. getIpAddressesByHardware(Hardware hardware, String partialIpAddress)This will return an arrayObject of objects containing the ipaddresses.List<IpAddress>Monitor.Service. getIpAddressesByVirtualGuest(Guest guest, String partialIpAddress)This will return an arrayObject of objects containing the ipaddresses.List<Storage>Storage.Service. getIscsiLuns()Relationship between a container volume and iSCSI LUNs.List<String>Storage.Service. getIscsiTargetIpAddresses()Returns the target IP addresses of an iSCSI volume.BooleanStorage.Service. getIsDependentDuplicateProvisionCompleted()Determines whether dependent volume provision is completed on background.BooleanStorage.Service. getIsInDedicatedServiceResource()StringStorage.Service. getIsMagneticStorage()BooleanStorage.Service. getIsReadyForSnapshot()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.BooleanStorage.Service. getIsReadyToMount()Determines whether a volume is ready to have Hosts authorized to access it.RequestComponent.Service. getLastCommand()Last reboot/power (rebootDefault, rebootSoft, rebootHard, powerOn, powerOff and powerCycle) command issued to the server's remote management card.List<Limit>SecurityGroup.Service. getLimits()List the current security group limitsBooleanVlan.Service. getLocalDiskStorageCapabilityFlag()A flag indicating that a vlan can be assigned to a host that has local disk functionality.LocationBackbone.Service. getLocation()Which of the SoftLayer datacenters a backbone is connected to.StringStorage.Service. getLunId()The ID of the LUN volume.List<Storage>Storage.Service. getManualSnapshots()The manually-created snapshots associated with this SoftLayer_Network_Storage volume.StringGateway.Service. getManufacturer(Boolean checkSameOs, Boolean checkOsReloadMember)Returns manufacturer name for a given gateway object.LongStorage.Service. getMaximumExpansionSize()BooleanGateway.Service. getMemberGatewayImagesMatch()Returns true if no mismatch is found, gateway is not Juniper vSRX or SA gateway
List<Member>Gateway.Service. getMembers()The members for this gateway.ObjectComponent.Service. getMetricTrackingObject()The metric tracking object for this network component.ObjectStorage.Service. getMetricTrackingObject()A network storage volume's metric tracking object.StringStorage.Service. getMountableFlag()Whether or not a network storage volume may be mounted.StringStorage.Service. getMountPath()Retrieves the NFS Network Mount Path for a given File Storage Volume.StringStorage.Service. getMoveAndSplitStatus()The current status of split or move operation as a part of volume duplication.NetworkVlan.Service. getNetwork()The network in which this VLAN resides.ComponentBackbone.Service. getNetworkComponent()A backbone's primary network component.List<NetworkComponentBinding>SecurityGroup.Service. getNetworkComponentBindings()The network component bindings for this security group.FirewallComponent.Service. getNetworkComponentFirewall()The upstream network component firewall.FirewallSubnet.Service. getNetworkComponentFirewall()The upstream network component firewall.GroupComponent.Service. getNetworkComponentGroup()A network component's associated group.List<Component>Vlan.Service. getNetworkComponents()The networking components that are connected to a VLAN.List<Component>Vlan.Service. getNetworkComponentsTrunkable()The viable trunking targets of this VLAN.List<Trunk>Vlan.Service. getNetworkComponentTrunks()The network components that are connected to this VLAN through a trunk.NetworkConnectionInformationStorage.Service. getNetworkConnectionDetails()FirewallGateway.Service. getNetworkFirewall()The firewall associated with this gateway, if any.BooleanGateway.Service. getNetworkFirewallFlag()Whether or not there is a firewall associated with this gateway.List<Hardware>Component.Service. getNetworkHardware()All network devices in SoftLayer's network hierarchy that this device is connected to.StringStorage.Service. getNetworkMountAddress()StringStorage.Service. getNetworkMountPath()List<Address>Subnet.Service. getNetworkProtectionAddresses()StringVlan.Service. getNetworkSpace()Identifier to denote whether a VLAN is used for public or private connectivity.List<Context>Subnet.Service. getNetworkTunnelContexts()IPSec network tunnels that have access to a private subnet.VlanComponent.Service. getNetworkVlan()The VLAN that a network component's subnet is associated with.VlanSubnet.Service. getNetworkVlan()The VLAN object that a subnet is associated with.FirewallVlan.Service. getNetworkVlanFirewall()The Hardware Firewall (Dedicated) for a network vlan.List<Trunk>Component.Service. getNetworkVlanTrunks()The VLANs that are trunked to this network component.List<Subscriber>Storage.Service. getNotificationSubscribers()The subscribers that will be notified for usage amount warnings and overages.BackboneBackbone.Service. getObject()Retrieve an individual SoftLayer_Network_Backbone record.ComponentComponent.Service. getObject()GatewayGateway.Service. getObject()PodPod.Service. getObject()Set the initialization parameter to the ``name`` of the Pod to retrieve.SecurityGroupSecurityGroup.Service. getObject()StorageStorage.Service. getObject()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.SubnetSubnet.Service. getObject()getObject retrieves the SoftLayer_Network_Subnet object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Network_Subnet service.VlanVlan.Service. getObject()getObject retrieves the SoftLayer_Network_Vlan object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Network_Vlan service.List<Storage>Storage.Service. getObjectsByCredential(Credential credentialObject)Retrieve network storage accounts by SoftLayer_Network_Storage_Credential object.List<ConnectionInformation>Storage.Service. getObjectStorageConnectionInformation()List<OrderBinding>SecurityGroup.Service. getOrderBindings()The order bindings for this security groupStringStorage.Service. getOriginalSnapshotName()The name of the snapshot that this volume was duplicated from.StringStorage.Service. getOriginalVolumeName()The name of the volume that this volume was duplicated from.StringStorage.Service. getOriginalVolumeSize()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.TypeStorage.Service. getOsType()A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type.StringStorage.Service. getOsTypeId()A volume's configured SoftLayer_Network_Storage_Iscsi_OS_Type ID.List<Partnership>Storage.Service. getParentPartnerships()The volumes or snapshots partnered with a network storage volume in a parental role.StorageStorage.Service. getParentVolume()The parent volume of a volume in a complex storage relationship.List<Partnership>Storage.Service. getPartnerships()The volumes or snapshots partnered with a network storage volume.List<Group>Storage.Service. getPermissionsGroups()All permissions group(s) this volume is in.StringSubnet.Service. getPodName()The pod in which this subnet resides.StatisticComponent.Service. getPortStatistics()Deprecated.List<Vlan>Gateway.Service. getPossibleInsideVlans()Get all VLANs that can become inside VLANs on this gateway.IpAddressComponent.Service. getPrimaryIpAddressRecord()The primary IPv4 Address record for a network component.RouterVlan.Service. getPrimaryRouter()The primary router that a VLAN is associated with.SubnetComponent.Service. getPrimarySubnet()The subnet of the primary IP address assigned to this network component.SubnetVlan.Service. getPrimarySubnet()A VLAN's primary subnet.List<Subnet>Vlan.Service. getPrimarySubnets()SubnetVlan.Service. getPrimarySubnetVersion6()A VLAN's primary IPv6 subnet.IpAddressComponent.Service. getPrimaryVersion6IpAddressRecord()The primary IPv6 Address record for a network component.IpAddressGateway.Service. getPrivateIpAddress()The private gateway IP address.List<Gateway>Vlan.Service. getPrivateNetworkGateways()The gateways this VLAN is the private VLAN of.VlanGateway.Service. getPrivateVlan()The private VLAN for accessing this gateway.VlanVlan.Service. getPrivateVlan()Retrieve a VLAN's associated private network VLAN.VlanVlan.Service. getPrivateVlanByIpAddress(String ipAddress)
*** DEPRECATED ***
Retrieve the private network VLAN associated with an IP address.List<Property>Storage.Service. getProperties()The properties used to provide additional details about a network storage volume.List<IpAddress>Subnet.Service. getProtectedIpAddresses()List<IpAddress>Vlan.Service. getProtectedIpAddresses()StringStorage.Service. getProvisionedIops()The number of IOPs provisioned for this volume.IpAddressGateway.Service. getPublicIpAddress()The public gateway IP address.IpAddressGateway.Service. getPublicIpv6Address()The public gateway IPv6 address.List<Gateway>Vlan.Service. getPublicNetworkGateways()The gateways this VLAN is the public VLAN of.VlanGateway.Service. getPublicVlan()The public VLAN for accessing this gateway.VlanVlan.Service. getPublicVlanByFqdn(String fqdn)Retrieve the VLAN that belongs to a server's public network interface, as described by a server's fully-qualified domain name.List<Request>Component.Service. getRecentCommands()The last five reboot/power (rebootDefault, rebootSoft, rebootHard, powerOn, powerOff and powerCycle) commands issued to the server's remote management card.EntityStorage.Service. getRecycleBinFileByIdentifier(String fileId){{CloudLayerOnlyMethod}} Retrieve the details of a file that is pending deletion in a Storage account's a recycle bin.BooleanComponent.Service. getRedundancyCapableFlag()Indicates whether the network component is participating in a group of two or more components capable of being operationally redundant, if enabled.BooleanComponent.Service. getRedundancyEnabledFlag()Indicates whether the network component is participating in a group of two or more components which is actively providing link redundancy.RegistrySubnet.Service. getRegionalInternetRegistry()List<Registration>Subnet.Service. getRegistrations()All registrations that have been created for this subnet.LongStorage.Service. getRemainingAllowedHosts()Retrieves the remaining number of allowed hosts per volume.LongStorage.Service. getRemainingAllowedHostsForReplicant()Retrieves the remaining number of allowed hosts for a volume's replicant.List<User>Component.Service. getRemoteManagementUsers()User(s) credentials to issue commands and/or interact with the server's remote management card.List<Storage>Storage.Service. getReplicatingLuns()The iSCSI LUN volumes being replicated by this network storage volume.StorageStorage.Service. getReplicatingVolume()The network storage volume being replicated by a volume.List<Event>Storage.Service. getReplicationEvents()The volume replication events.List<Storage>Storage.Service. getReplicationPartners()The network storage volumes configured to be replicants of a volume.ScheduleStorage.Service. getReplicationSchedule()The Replication Schedule associated with a network storage volume.StringStorage.Service. getReplicationStatus()The current replication status of a network storage volume.StringStorage.Service. getReplicationTimestamp()DomainSubnet.Service. getReverseDomain()The reverse DNS domain associated with this subnet.List<Domain>Subnet.Service. getReverseDomainRecords()Retrieve all reverse DNS records associated with a subnet.List<Domain>Vlan.Service. getReverseDomainRecords()Retrieve all reverse DNS records associated with the subnets assigned to a VLAN.StringSubnet.Service. getRoleKeyName()An identifier of the role the subnet is within.StringSubnet.Service. getRoleName()The name of the role the subnet is within.StringGateway.Service. getRollbackSupport()Returns the following statuses SUPPORTED - rollback is supported and perform automatically UNSUPPORTED - rollback is not supported MANUAL - rollback can be performed but
List<IpAddress>Subnet.Service. getRoutableEndpointIpAddresses()Returns IP addresses which may be used as routing endpoints for a given subnet.HardwareComponent.Service. getRouter()A network component's routers.StringSubnet.Service. getRoutingTypeKeyName()The identifier for the type of route then subnet is currently configured for.StringSubnet.Service. getRoutingTypeName()The name for the type of route then subnet is currently configured for.List<Rule>SecurityGroup.Service. getRules()The rules for this security group.BooleanVlan.Service. getSanStorageCapabilityFlag()A flag indicating that a vlan can be assigned to a host that has SAN disk functionality.List<Vlan>Vlan.Service. getScaleVlans()Collection of scale VLANs this VLAN applies to.List<Schedule>Storage.Service. getSchedules()The schedules which are associated with a network storage volume.HardwareVlan.Service. getSecondaryRouter()The secondary router that a VLAN is associated with.List<Subnet>Vlan.Service. getSecondarySubnets()The subnets that exist as secondary interfaces on a VLANResourceStorage.Service. getServiceResource()The network resource a Storage service is connected to.StringStorage.Service. getServiceResourceBackendIpAddress()The IP address of a Storage resource.StringStorage.Service. getServiceResourceName()The name of a Storage's network resource.StringStorage.Service. getSnapshotCapacityGb()A volume's configured snapshot space size.StringStorage.Service. getSnapshotCreationTimestamp()The creation timestamp of the snapshot on the storage platform.StringStorage.Service. getSnapshotDeletionThresholdPercentage()The percentage of used snapshot space after which to delete automated snapshots.StringStorage.Service. getSnapshotNotificationStatus()Whether or not a network storage volume may be mounted.List<Storage>Storage.Service. getSnapshots()The snapshots associated with this SoftLayer_Network_Storage volume.List<Storage>Storage.Service. getSnapshotsForVolume()Retrieves a list of snapshots for this SoftLayer_Network_Storage volume.StringStorage.Service. getSnapshotSizeBytes()The snapshot size in bytes.StringStorage.Service. getSnapshotSpaceAvailable()A volume's available snapshot reservation space.StringStorage.Service. getStaasVersion()StatusGateway.Service. getStatus()The current status of the gateway.List<Group>Storage.Service. getStorageGroups()The network storage groups this volume is attached to.List<NetworkConnectionInformation>Storage.Service. getStorageGroupsNetworkConnectionDetails()BooleanComponent.Service. getStorageNetworkFlag()Whether a network component's primary ip address is from a storage network subnet or not.StringStorage.Service. getStorageTierLevel()TypeStorage.Service. getStorageType()A description of the Storage object.SubnetSubnet.Service. getSubnetForIpAddress(String ipAddress)Retrieve the subnet associated with an IP address.List<Subnet>Component.Service. getSubnets()A network component's subnets.List<Subnet>Vlan.Service. getSubnets()All of the subnets that exist as VLAN interfaces.List<Location>SecurityGroup.Service. getSupportedDataCenters()List the data centers that currently support the use of security groups.List<Transaction>Subnet.Service. getSwipTransaction()DEPRECATEDList<Reference>Subnet.Service. getTagReferences()References to all tags for this subnet.List<Reference>Vlan.Service. getTagReferences()References to all tags for this VLAN.List<String>Storage.Service. getTargetIpAddresses()StringStorage.Service. getTotalBytesUsed()The amount of space used by the volume.LongVlan.Service. getTotalPrimaryIpAddressCount()The number of primary IP addresses in a VLAN.LongStorage.Service. getTotalScheduleSnapshotRetentionCount()The total snapshot retention count of all schedules on this network storage volume.TypeVlan.Service. getType()The type of this VLAN.List<Subnet>Subnet.Service. getUnboundDescendants()List<Price>Gateway.Service. getUpgradeItemPrices()Retrieve a list of upgradable items available for network gateways.ComponentComponent.Service. getUplinkComponent()The network component linking this object to parentModeComponent.Service. getUplinkDuplexMode()The duplex mode of the uplink network component linking to this objectNotificationStorage.Service. getUsageNotification()The usage notification for SL Storage services.LongSubnet.Service. getUtilizedIpAddressCount()Provides the total number of utilized IP addresses on this subnet.List<Location>Storage.Service. getValidReplicationTargetDatacenterLocations()StringStorage.Service. getVendorName()The type of network storage service.GuestStorage.Service. getVirtualGuest()When applicable, the virtual guest associated with a Storage service.List<Guest>Subnet.Service. getVirtualGuests()The Virtual Servers using IP addresses on this subnet.List<Guest>Vlan.Service. getVirtualGuests()All of the Virtual Servers that are connected to a VLAN.VlanVlan.Service. getVlanForIpAddress(String ipAddress)Retrieve the VLAN associated with an IP address via the IP's associated subnet.List<VolumeCountLimitContainer>Storage.Service. getVolumeCountLimits()Retrieves an array of volume count limits per location and globally.VolumeDuplicateParametersStorage.Service. getVolumeDuplicateParameters()This method returns the parameters for cloning a volumeList<History>Storage.Service. getVolumeHistory()The username and password history for a Storage service.StringStorage.Service. getVolumeStatus()The current status of a network storage volume.PasswordStorage.Service. getWebccAccount()The account username and password for the EVault webCC interface.ScheduleStorage.Service. getWeeklySchedule()The Weekly Schedule which is associated with this network storage volume.BooleanStorage.Service. immediateFailoverToReplicant(Long replicantId)Immediate Failover to a volume replicant.StringStorage.Service. initiateOriginVolumeReclaim()StringStorage.Service. initiateVolumeCutover()BooleanGateway.Service. isAccountWhiteListed(String category)BooleanStorage.Service. isBlockingOperationInProgress(List<String> exemptStatusKeyNames)BooleanStorage.Service. isDuplicateReadyForSnapshot()This method returns a boolean indicating whether the clone volume is ready for snapshot.BooleanStorage.Service. isDuplicateReadyToMount()This method returns a boolean indicating whether the clone volume is ready to mount.BooleanGateway.Service. isLicenseServerAllowed(String licenseKeyName)BooleanGateway.Service. isRollbackAllowed()Returns true if rollback is allowed.BooleanStorage.Service. isVolumeActive()List<String>Pod.Service. listCapabilities()A capability is simply a string literal that denotes the availability of a feature.BooleanGateway.Service. rebuildvSRXHACluster()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.BooleanStorage.Service. refreshDependentDuplicate(Long snapshotId)BooleanStorage.Service. refreshDuplicate(Long snapshotId)BooleanGateway.Service. refreshGatewayLicense()Used to refresh the license for the Juniper Gateway, requires License readiness check has passed.BooleanStorage.Service. removeAccessFromHardware(Hardware hardwareObjectTemplate)This method is used to modify the access control list for this Storage volume.BooleanStorage.Service. removeAccessFromHardwareList(List<Hardware> hardwareObjectTemplates)This method is used to modify the access control list for this Storage volume.HostStorage.Service. removeAccessFromHost(String typeClassName, Long hostId)This method is used to modify the access control list for this Storage volume.List<Host>Storage.Service. removeAccessFromHostList(List<Host> hostObjectTemplates)This method is used to modify the access control list for this Storage volume.BooleanStorage.Service. removeAccessFromIpAddress(IpAddress ipAddressObjectTemplate)This method is used to modify the access control list for this Storage volume.BooleanStorage.Service. removeAccessFromIpAddressList(List<IpAddress> ipAddressObjectTemplates)BooleanStorage.Service. removeAccessFromSubnet(Subnet subnetObjectTemplate)BooleanStorage.Service. removeAccessFromSubnetList(List<Subnet> subnetObjectTemplates)BooleanStorage.Service. removeAccessFromVirtualGuest(Guest virtualGuestObjectTemplate)This method is used to modify the access control list for this Storage volume.BooleanStorage.Service. removeAccessFromVirtualGuestList(List<Guest> virtualGuestObjectTemplates)This method is used to modify the access control list for this Storage volume.BooleanSubnet.Service. removeAccessToNetworkStorageList(List<Storage> networkStorageTemplateObjects)This method is used to remove access to multiple SoftLayer_Network_Storage volumesBooleanStorage.Service. removeAccessToReplicantFromHardwareList(List<Hardware> hardwareObjectTemplates)This method is used to modify the access control list for this Storage volume's replica.BooleanStorage.Service. removeAccessToReplicantFromIpAddressList(List<IpAddress> ipAddressObjectTemplates)This method is used to modify the access control list for this Storage volume's replica.BooleanStorage.Service. removeAccessToReplicantFromSubnet(Subnet subnetObjectTemplate)BooleanStorage.Service. removeAccessToReplicantFromSubnetList(List<Subnet> subnetObjectTemplates)This method is used to modify the access control list for this Storage volume's replica.BooleanStorage.Service. removeAccessToReplicantFromVirtualGuestList(List<Guest> virtualGuestObjectTemplates)This method is used to modify the access control list for this Storage volume's replica.BooleanStorage.Service. removeCredential(String username)This method will remove a credential from the current volume.List<Vlan>Component.Service. removeNetworkVlanTrunks(List<Vlan> networkVlans)Remove one or more VLANs currently attached to the uplinkComponent of this networkComponent.RequestRulesSecurityGroup.Service. removeRules(List<Long> ruleIds)Remove rules from a security group.EntityStorage.Service. restoreFile(String fileId){{CloudLayerOnlyMethod}} Restore an individual file so that it may be used as it was before it was deleted.BooleanStorage.Service. restoreFromSnapshot(Long snapshotId)Restore the volume from a snapshot that was previously taken.BooleanSubnet.Service. route(String type, String identifier)This interface allows you to change the route of your Account Owned subnets.BooleanStorage.Service. sendPasswordReminderEmail(String username)The method will retrieve the password for the StorageLayer or Virtual Server Storage Account and email the password.BooleanGateway.Service. setGatewayPassword(String password)Returns true if password change is successful, false if not successful
BooleanStorage.Service. setMountable(Boolean mountable)Enable or disable the mounting of a Storage volume.VoidStorage.Service. setSnapshotAllocation(Long capacityGb)VoidStorage.Service. setSnapshotNotification(Boolean notificationFlag)Function to enable/disable snapshot warning notification.BooleanSubnet.Service. setTags(String tags)Tag a subnet by passing in one or more tags separated by a comma.BooleanVlan.Service. setTags(String tags)Tag a VLAN by passing in one or more tags separated by a comma.VoidGateway.Service. unbypassAllVlans()Start the asynchronous process to unbypass all VLANs.VoidGateway.Service. unbypassVlans(List<Vlan> vlans)Start the asynchronous process to unbypass the provided VLANs.VoidVlan.Service. updateFirewallIntraVlanCommunication(Boolean enabled)The '''getSensorData''' method updates a VLAN's firewall to allow or disallow intra-VLAN communication.VlanVlan.Service. upgrade()Convert the VLAN this operation is executed against to a paid resource.BooleanStorage.Service. upgradeVolumeCapacity(Long itemId)Upgrade the Storage volume to one of the upgradable packages (for example from 10 Gigs of EVault storage to 100 Gigs of EVault storage).EntityStorage.Service. uploadFile(Entity file){{CloudLayerOnlyMethod}} Upload a file to a Storage account's root directory. -
Uses of ApiMethod in com.softlayer.api.service.network.application.delivery
Methods in com.softlayer.api.service.network.application.delivery with annotations of type ApiMethod Modifier and Type Method Description BooleanController.Service. createLiveLoadBalancer(VirtualIpAddress loadBalancer)Create or add to an application delivery controller based load balancer service.BooleanController.Service. deleteLiveLoadBalancer(VirtualIpAddress loadBalancer)Remove a virtual IP address from an application delivery controller based load balancer.BooleanController.Service. deleteLiveLoadBalancerService(LoadBalancerService service)Remove an entire load balancer service, including all virtual IP addresses, from and application delivery controller based load balancer.BooleanController.Service. editObject(Controller templateObject)Edit an applications delivery controller record.AccountController.Service. getAccount()The SoftLayer customer account that owns an application delivery controller record.BigDecimalController.Service. getAverageDailyPublicBandwidthUsage()The average daily public bandwidth usage for the current billing cycle.List<Data>Controller.Service. getBandwidthDataByDate(GregorianCalendar startDateTime, GregorianCalendar endDateTime, String networkType)GraphOutputsController.Service. getBandwidthImageByDate(GregorianCalendar startDateTime, GregorianCalendar endDateTime, String networkType)Use this method when needing a bandwidth image for a single application delivery controller.ControllerController.Service. getBillingItem()The billing item for a Application Delivery Controller.List<History>Controller.Service. getConfigurationHistory()Previous configurations for an Application Delivery Controller.GraphController.Service. getCustomBandwidthDataByDate(Graph graphData)Retrieve bandwidth graph by date.LocationController.Service. getDatacenter()The datacenter that the application delivery controller resides in.StringController.Service. getDescription()A brief description of an application delivery controller record.GregorianCalendarController.Service. getLicenseExpirationDate()The date in which the license for this application delivery controller will expire.byte[]Controller.Service. getLiveLoadBalancerServiceGraphImage(LoadBalancerService service, String graphType, String metric)Get the graph image for an application delivery controller service based on the supplied graph type and metric.List<VirtualIpAddress>Controller.Service. getLoadBalancers()The virtual IP address records that belong to an application delivery controller based load balancer.BooleanController.Service. getManagedResourceFlag()A flag indicating that this Application Delivery Controller is a managed resource.StringController.Service. getManagementIpAddress()An application delivery controller's management ip address.VlanController.Service. getNetworkVlan()The network VLAN that an application delivery controller resides on.List<Vlan>Controller.Service. getNetworkVlans()The network VLANs that an application delivery controller resides on.ControllerController.Service. getObject()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.BigDecimalController.Service. getOutboundPublicBandwidthUsage()The total public outbound bandwidth for the current billing cycle.PasswordController.Service. getPassword()The password used to connect to an application delivery controller's management interface when it is operating in advanced view mode.StringController.Service. getPrimaryIpAddress()An application delivery controller's primary public IP address.BigDecimalController.Service. getProjectedPublicBandwidthUsage()The projected public outbound bandwidth for the current billing cycle.List<Subnet>Controller.Service. getSubnets()A network application controller's subnets.List<Reference>Controller.Service. getTagReferences()TypeController.Service. getType()List<VirtualIpAddress>Controller.Service. getVirtualIpAddresses()BooleanController.Service. restoreBaseConfiguration()Restore an application delivery controller's base configuration state.BooleanController.Service. restoreConfiguration(Long configurationHistoryId)Restore an application delivery controller's configuration state.HistoryController.Service. saveCurrentConfiguration(String notes)Save an application delivery controller's configuration state.BooleanController.Service. updateLiveLoadBalancer(VirtualIpAddress loadBalancer)Update the the virtual IP address interface within an application delivery controller based load balancer identified by the ''name'' property in the loadBalancer parameter.TransactionController.Service. updateNetScalerLicense()Update the NetScaler VPX License. -
Uses of ApiMethod in com.softlayer.api.service.network.application.delivery.controller.configuration
Methods in com.softlayer.api.service.network.application.delivery.controller.configuration with annotations of type ApiMethod Modifier and Type Method Description BooleanHistory.Service. deleteObject()deleteObject permanently removes a configuration history recordControllerHistory.Service. getController()The application delivery controller that a configuration history record belongs to.HistoryHistory.Service. getObject() -
Uses of ApiMethod in com.softlayer.api.service.network.application.delivery.controller.loadbalancer
Methods in com.softlayer.api.service.network.application.delivery.controller.loadbalancer with annotations of type ApiMethod Modifier and Type Method Description BooleanLoadBalancerService.Service. deleteObject()BooleanVirtualServer.Service. deleteObject()BooleanVirtualIpAddress.Service. editObject(VirtualIpAddress templateObject)Like any other API object, the load balancers can have their exposed properties edited by passing in a modified version of the object.AccountVirtualIpAddress.Service. getAccount()ControllerVirtualIpAddress.Service. getApplicationDeliveryController()A virtual IP address's associated application delivery controller.List<Controller>VirtualIpAddress.Service. getApplicationDeliveryControllers()A virtual IP address's associated application delivery controllers.List<SecureTransportCipher>VirtualIpAddress.Service. getAvailableSecureTransportCiphers()Yields a list of the SSL/TLS encryption ciphers that are currently supported on this virtual IP address instance.List<SecureTransportProtocol>VirtualIpAddress.Service. getAvailableSecureTransportProtocols()Yields a list of the secure communication protocols that are currently supported on this virtual IP address instance.ItemVirtualIpAddress.Service. getBillingItem()The current billing item for the load balancer virtual IP.LoadBalancerVirtualIpAddress.Service. getDedicatedBillingItem()The current billing item for the load balancing device housing the virtual IP.byte[]LoadBalancerService.Service. getGraphImage(String graphType, String metric)Get the graph image for a load balancer service based on the supplied graph type and metric.List<CrossReference>LoadBalancerService.Service. getGroupReferences()List<Group>LoadBalancerService.Service. getGroups()CheckLoadBalancerService.Service. getHealthCheck()List<Check>LoadBalancerService.Service. getHealthChecks()BooleanVirtualIpAddress.Service. getHighAvailabilityFlag()Denotes whether the virtual IP is configured within a high availability cluster.IpAddressLoadBalancerService.Service. getIpAddress()IpAddressVirtualIpAddress.Service. getIpAddress()List<Hardware>VirtualIpAddress.Service. getLoadBalancerHardware()BooleanVirtualIpAddress.Service. getManagedResourceFlag()A flag indicating that the load balancer is a managed resource.LoadBalancerServiceLoadBalancerService.Service. getObject()VirtualIpAddressVirtualIpAddress.Service. getObject()VirtualServerVirtualServer.Service. getObject()MethodVirtualServer.Service. getRoutingMethod()List<LoadBalancer>VirtualServer.Service. getScaleLoadBalancers()Collection of scale load balancers this virtual server applies to.List<SecureTransportCipher>VirtualIpAddress.Service. getSecureTransportCiphers()The list of security ciphers enabled for this virtual IP addressList<SecureTransportProtocol>VirtualIpAddress.Service. getSecureTransportProtocols()The list of secure transport protocols enabled for this virtual IP addressCertificateVirtualIpAddress.Service. getSecurityCertificate()The SSL certificate currently associated with the VIP.EntryVirtualIpAddress.Service. getSecurityCertificateEntry()The SSL certificate currently associated with the VIP.GroupLoadBalancerService.Service. getServiceGroup()List<Group>VirtualServer.Service. getServiceGroups()VirtualIpAddressVirtualServer.Service. getVirtualIpAddress()List<VirtualServer>VirtualIpAddress.Service. getVirtualServers()BooleanVirtualIpAddress.Service. startSsl()Start SSL acceleration on all SSL virtual services (those with a type of HTTPS).BooleanVirtualServer.Service. startSsl()Deprecated.BooleanVirtualIpAddress.Service. stopSsl()Stop SSL acceleration on all SSL virtual services (those with a type of HTTPS).BooleanVirtualServer.Service. stopSsl()Deprecated.BooleanLoadBalancerService.Service. toggleStatus()BooleanVirtualIpAddress.Service. upgradeConnectionLimit()Upgrades the connection limit on the Virtual IP to Address to the next, higher connection limit of the same product. -
Uses of ApiMethod in com.softlayer.api.service.network.application.delivery.controller.loadbalancer.health
Methods in com.softlayer.api.service.network.application.delivery.controller.loadbalancer.health with annotations of type ApiMethod Modifier and Type Method Description List<Attribute>Check.Service. getAttributes()CheckAttribute.Service. getHealthCheck()AttributeAttribute.Service. getObject()CheckCheck.Service. getObject()List<LoadBalancer>Check.Service. getScaleLoadBalancers()Collection of scale load balancers that use this health check.List<LoadBalancerService>Check.Service. getServices()TypeAttribute.Service. getType()TypeCheck.Service. getType() -
Uses of ApiMethod in com.softlayer.api.service.network.application.delivery.controller.loadbalancer.health.attribute
Methods in com.softlayer.api.service.network.application.delivery.controller.loadbalancer.health.attribute with annotations of type ApiMethod Modifier and Type Method Description List<Type>Type.Service. getAllObjects()TypeType.Service. getObject() -
Uses of ApiMethod in com.softlayer.api.service.network.application.delivery.controller.loadbalancer.health.check
Methods in com.softlayer.api.service.network.application.delivery.controller.loadbalancer.health.check with annotations of type ApiMethod Modifier and Type Method Description List<Type>Type.Service. getAllObjects()TypeType.Service. getObject() -
Uses of ApiMethod in com.softlayer.api.service.network.application.delivery.controller.loadbalancer.routing
Methods in com.softlayer.api.service.network.application.delivery.controller.loadbalancer.routing with annotations of type ApiMethod Modifier and Type Method Description List<Method>Method.Service. getAllObjects()List<Type>Type.Service. getAllObjects()MethodMethod.Service. getObject()TypeType.Service. getObject() -
Uses of ApiMethod in com.softlayer.api.service.network.application.delivery.controller.loadbalancer.service
Methods in com.softlayer.api.service.network.application.delivery.controller.loadbalancer.service with annotations of type ApiMethod Modifier and Type Method Description byte[]Group.Service. getGraphImage(String graphType, String metric)Get the graph image for a load balancer service group based on the supplied graph type and metric.GroupGroup.Service. getObject()MethodGroup.Service. getRoutingMethod()TypeGroup.Service. getRoutingType()List<CrossReference>Group.Service. getServiceReferences()List<LoadBalancerService>Group.Service. getServices()VirtualServerGroup.Service. getVirtualServer()List<VirtualServer>Group.Service. getVirtualServers()BooleanGroup.Service. kickAllConnections() -
Uses of ApiMethod in com.softlayer.api.service.network.backbone.location
Methods in com.softlayer.api.service.network.backbone.location with annotations of type ApiMethod Modifier and Type Method Description List<Dependent>Dependent.Service. getAllObjects()LocationDependent.Service. getDependentLocation()DependentDependent.Service. getObject()LocationDependent.Service. getSourceDependentsByName(String locationName)LocationDependent.Service. getSourceLocation() -
Uses of ApiMethod in com.softlayer.api.service.network.bandwidth.version1
Methods in com.softlayer.api.service.network.bandwidth.version1 with annotations of type ApiMethod Modifier and Type Method Description AllotmentAllotment.Service. createObject(Allotment templateObject)Create a allotment for servers to pool bandwidth and avoid overages in billing if they use more than there allocated bandwidth.BooleanAllotment.Service. editObject(Allotment templateObject)Edit a bandwidth allotment's local properties.AccountAllotment.Service. getAccount()The account associated with this virtual rack.List<Detail>Allotment.Service. getActiveDetails()The bandwidth allotment detail records associated with this virtual rack.List<Controller>Allotment.Service. getApplicationDeliveryControllers()The Application Delivery Controller contained within a virtual rack.BigDecimalAllotment.Service. getAverageDailyPublicBandwidthUsage()The average daily public bandwidth usage for the current billing cycle.List<Usage>Allotment.Service. getBackendBandwidthByHour(GregorianCalendar date)Deprecated.List<Detail>Allotment.Service. getBackendBandwidthUse(GregorianCalendar startDate, GregorianCalendar endDate)This method recurses through all servers on a Bandwidth Pool between the given start and end dates to retrieve public bandwidth data.TypeAllotment.Service. getBandwidthAllotmentType()The bandwidth allotment type of this virtual rack.List<Data>Allotment.Service. getBandwidthForDateRange(GregorianCalendar startDate, GregorianCalendar endDate)Retrieve a collection of bandwidth data from an individual public or private network tracking object.GraphOutputsAllotment.Service. getBandwidthImage(String networkType, String snapshotRange, Boolean draw, GregorianCalendar dateSpecified, GregorianCalendar dateSpecifiedEnd)This method recurses through all servers on a Bandwidth Pool for a given snapshot range, gathers the necessary parameters, and then calls the bandwidth graphing server.List<Hardware>Allotment.Service. getBareMetalInstances()The bare metal server instances contained within a virtual rack.List<Usage>Allotment.Service. getBillingCycleBandwidthUsage()A virtual rack's raw bandwidth usage data for an account's current billing cycle.UsageAllotment.Service. getBillingCyclePrivateBandwidthUsage()A virtual rack's raw private network bandwidth usage data for an account's current billing cycle.UsageAllotment.Service. getBillingCyclePublicBandwidthUsage()A virtual rack's raw public network bandwidth usage data for an account's current billing cycle.LongAllotment.Service. getBillingCyclePublicUsageTotal()The total public bandwidth used in this virtual rack for an account's current billing cycle.ItemAllotment.Service. getBillingItem()A virtual rack's billing item.SummaryAllotment.Service. getCurrentBandwidthSummary()An object that provides commonly used bandwidth summary components for the current billing cycle.GraphAllotment.Service. getCustomBandwidthDataByDate(Graph graphData)Retrieve bandwidth graph by date.List<Detail>Allotment.Service. getDetails()The bandwidth allotment detail records associated with this virtual rack.List<Usage>Allotment.Service. getFrontendBandwidthByHour(GregorianCalendar date)Deprecated.List<Detail>Allotment.Service. getFrontendBandwidthUse(GregorianCalendar startDate, GregorianCalendar endDate)This method recurses through all servers on a Bandwidth Pool between the given start and end dates to retrieve private bandwidth data.List<Hardware>Allotment.Service. getHardware()The hardware contained within a virtual rack.BigDecimalAllotment.Service. getInboundPublicBandwidthUsage()The total public inbound bandwidth used in this virtual rack for an account's current billing cycle.GroupAllotment.Service. getLocationGroup()The location group associated with this virtual rack.List<Hardware>Allotment.Service. getManagedBareMetalInstances()The managed bare metal server instances contained within a virtual rack.List<Hardware>Allotment.Service. getManagedHardware()The managed hardware contained within a virtual rack.List<Guest>Allotment.Service. getManagedVirtualGuests()The managed Virtual Server contained within a virtual rack.VirtualDedicatedRackAllotment.Service. getMetricTrackingObject()A virtual rack's metric tracking object.LongAllotment.Service. getMetricTrackingObjectId()The metric tracking object id for this allotment.AllotmentAllotment.Service. getObject()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.BigDecimalAllotment.Service. getOutboundPublicBandwidthUsage()The total public outbound bandwidth used in this virtual rack for an account's current billing cycle.LongAllotment.Service. getOverBandwidthAllocationFlag()Whether the bandwidth usage for this bandwidth pool for the current billing cycle exceeds the allocation.List<Hardware>Allotment.Service. getPrivateNetworkOnlyHardware()The private network only hardware contained within a virtual rack.LongAllotment.Service. getProjectedOverBandwidthAllocationFlag()Whether the bandwidth usage for this bandwidth pool for the current billing cycle is projected to exceed the allocation.BigDecimalAllotment.Service. getProjectedPublicBandwidthUsage()The projected public outbound bandwidth for this virtual server for the current billing cycle.ProviderAllotment.Service. getServiceProvider()LongAllotment.Service. getTotalBandwidthAllocated()The combined allocated bandwidth for all servers in a virtual rack.BigDecimalAllotment.Service. getVdrMemberRecurringFee()Gets the monthly recurring fee of a pooled server.List<Guest>Allotment.Service. getVirtualGuests()The Virtual Server contained within a virtual rack.BooleanAllotment.Service. reassignServers(List<Hardware> templateObjects, Long newAllotmentId)This method will reassign a collection of SoftLayer hardware to a bandwidth allotment Bandwidth Pool.BooleanAllotment.Service. requestVdrCancellation()This will remove a bandwidth pooling from a customer's allotments by cancelling the billing item.BooleanAllotment.Service. requestVdrContentUpdates(List<Hardware> hardwareToAdd, List<Hardware> hardwareToRemove, List<Guest> cloudsToAdd, List<Guest> cloudsToRemove, Long optionalAllotmentId, List<Controller> adcToAdd, List<Controller> adcToRemove)This will move servers into a bandwidth pool, removing them from their previous bandwidth pool and optionally remove the bandwidth pool on completion.BooleanAllotment.Service. setVdrContent(List<Hardware> hardware, List<Hardware> bareMetalServers, List<Guest> virtualServerInstance, List<Controller> adc, Long optionalAllotmentId)This will update the bandwidth pool to the servers provided.BooleanAllotment.Service. unassignServers(List<Hardware> templateObjects)This method will reassign a collection of SoftLayer hardware to the virtual private rackBooleanAllotment.Service. voidPendingServerMove(Long id, String type)This method will void a pending server removal from this bandwidth pooling.BooleanAllotment.Service. voidPendingVdrCancellation()This method will void a pending cancellation on a bandwidth pool. -
Uses of ApiMethod in com.softlayer.api.service.network.cdnmarketplace
Methods in com.softlayer.api.service.network.cdnmarketplace with annotations of type ApiMethod Modifier and Type Method Description AccountAccount.Service. getAccount()SoftLayer account to which the CDN account belongs.ItemAccount.Service. getBillingItem()An associated parent billing item which is active.List<Metrics>Metrics.Service. getCustomerInvoicingMetrics(String vendorName, Long startDate, Long endDate, String frequency)List<Metrics>Metrics.Service. getCustomerRealTimeMetrics(String vendorName, Long startTime, Long endTime, Long timeInterval)List<Metrics>Metrics.Service. getCustomerUsageMetrics(String vendorName, Long startDate, Long endDate, String frequency)List<Metrics>Metrics.Service. getMappingBandwidthByRegionMetrics(String mappingUniqueId, Long startDate, Long endDate, String frequency)List<Metrics>Metrics.Service. getMappingBandwidthMetrics(String mappingUniqueId, Long startDate, Long endDate, String frequency)List<Metrics>Metrics.Service. getMappingHitsByTypeMetrics(String mappingUniqueId, Long startDate, Long endDate, String frequency)List<Metrics>Metrics.Service. getMappingHitsMetrics(String mappingUniqueId, Long startDate, Long endDate, String frequency)List<Metrics>Metrics.Service. getMappingIntegratedMetrics(String mappingUniqueId, Long startTime, Long endTime, String frequency)List<Metrics>Metrics.Service. getMappingRealTimeMetrics(String mappingUniqueId, Long startTime, Long endTime, Long timeInterval)List<Metrics>Metrics.Service. getMappingUsageMetrics(String mappingUniqueId, Long startDate, Long endDate, String frequency)AccountAccount.Service. getObject()VendorVendor.Service. getObject()List<Vendor>Vendor.Service. listVendors()BooleanAccount.Service. verifyCdnAccountExists(String vendorName) -
Uses of ApiMethod in com.softlayer.api.service.network.cdnmarketplace.configuration
Methods in com.softlayer.api.service.network.cdnmarketplace.configuration with annotations of type ApiMethod Modifier and Type Method Description List<Mapping>Mapping.Service. createDomainMapping(Input input)List<Mapping>Mapping.Service. deleteDomainMapping(String uniqueId)MappingMapping.Service. getObject()List<Mapping>Mapping.Service. listDomainMappingByUniqueId(String uniqueId)List<Mapping>Mapping.Service. listDomainMappings()List<Mapping>Mapping.Service. retryHttpsActionRequest(String uniqueId)List<Mapping>Mapping.Service. startDomainMapping(String uniqueId)List<Mapping>Mapping.Service. stopDomainMapping(String uniqueId)List<Mapping>Mapping.Service. updateDomainMapping(Input input)BooleanMapping.Service. verifyCname(String cname)Verifies the CNAME is Unique in the domain.List<Mapping>Mapping.Service. verifyDomainMapping(Long uniqueId)Verifies the status of the domain mapping by calling the rest api; will update the status, cname, and vendorCName if necessary and will return the updated values. -
Uses of ApiMethod in com.softlayer.api.service.network.cdnmarketplace.configuration.behavior
-
Uses of ApiMethod in com.softlayer.api.service.network.cdnmarketplace.configuration.cache
Methods in com.softlayer.api.service.network.cdnmarketplace.configuration.cache with annotations of type ApiMethod Modifier and Type Method Description List<Purge>Purge.Service. createPurge(String uniqueId, String path)PurgeGroupPurgeGroup.Service. createPurgeGroup(String uniqueId, String groupName, List<String> paths, Long option)StringTimeToLive.Service. createTimeToLive(String uniqueId, String pathName, String ttl)StringTimeToLive.Service. deleteTimeToLive(String uniqueId, String pathName)PurgePurge.Service. getObject()PurgeGroupPurgeGroup.Service. getObject()PurgeHistoryPurgeHistory.Service. getObject()TimeToLiveTimeToLive.Service. getObject()PurgeGroupPurgeGroup.Service. getPurgeGroupByGroupId(String uniqueId, String groupUniqueId)LongPurgeGroup.Service. getPurgeGroupQuota()List<Purge>Purge.Service. getPurgeHistoryPerMapping(String uniqueId, Long saved)List<Purge>Purge.Service. getPurgeStatus(String uniqueId, String path)List<PurgeGroup>PurgeGroup.Service. listFavoriteGroup(String uniqueId)List<PurgeGroupHistory>PurgeHistory.Service. listPurgeGroupHistory(String uniqueId)List<TimeToLive>TimeToLive.Service. listTimeToLive(String uniqueId)List<PurgeGroup>PurgeGroup.Service. listUnfavoriteGroup(String uniqueId)List<PurgeGroupHistory>PurgeGroup.Service. purgeByGroupIds(String uniqueId, List<String> groupUniqueIds)PurgeGroupPurgeGroup.Service. removePurgeGroupFromFavorite(String uniqueId, String groupUniqueId)List<Purge>Purge.Service. saveOrUnsavePurgePath(String uniqueId, String path, Long saveOrUnsave)PurgeGroupPurgeGroup.Service. savePurgeGroupAsFavorite(String uniqueId, String groupUniqueId)StringTimeToLive.Service. updateTimeToLive(String uniqueId, String oldPath, String newPath, String oldTtl, String newTtl) -
Uses of ApiMethod in com.softlayer.api.service.network.cdnmarketplace.configuration.mapping
Methods in com.softlayer.api.service.network.cdnmarketplace.configuration.mapping with annotations of type ApiMethod Modifier and Type Method Description List<Path>Path.Service. createOriginPath(Input input)StringPath.Service. deleteOriginPath(String uniqueId, String path)PathPath.Service. getObject()List<Path>Path.Service. listOriginPath(String uniqueId)List<Path>Path.Service. updateOriginPath(Input input) -
Uses of ApiMethod in com.softlayer.api.service.network.component
Methods in com.softlayer.api.service.network.component with annotations of type ApiMethod Modifier and Type Method Description List<Subnet>Firewall.Service. getApplyServerRuleSubnets()The additional subnets linked to this network component firewall, that inherit rules from the host that the context slot is attached to.ItemFirewall.Service. getBillingItem()The billing item for a Hardware Firewall (Dedicated).ComponentFirewall.Service. getGuestNetworkComponent()The network component of the guest virtual server that this network component firewall belongs to.ComponentFirewall.Service. getNetworkComponent()The network component of the switch interface that this network component firewall belongs to.List<Request>Firewall.Service. getNetworkFirewallUpdateRequest()The update requests made for this firewall.FirewallFirewall.Service. getObject()getObject returns a SoftLayer_Network_Firewall_Module_Context_Interface_AccessControlList_Network_Component object.List<Rule>Firewall.Service. getRules()The currently running rule set of this network component firewall.List<Subnet>Firewall.Service. getSubnets()The additional subnets linked to this network component firewall.BooleanFirewall.Service. hasActiveTransactions()Check for active transactions for the shared Firewall. -
Uses of ApiMethod in com.softlayer.api.service.network.customer
Methods in com.softlayer.api.service.network.customer with annotations of type ApiMethod Modifier and Type Method Description SubnetSubnet.Service. createObject(Subnet templateObject)For IPSec network tunnels, customers can create their local subnets using this method.List<IpAddress>Subnet.Service. getIpAddresses()All ip addresses associated with a subnet.SubnetSubnet.Service. getObject()getObject retrieves the SoftLayer_Network_Customer_Subnet object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Network_Customer_Subnet service. -
Uses of ApiMethod in com.softlayer.api.service.network.directlink
Methods in com.softlayer.api.service.network.directlink with annotations of type ApiMethod Modifier and Type Method Description List<Location>Location.Service. getAllObjects()Return all existing Direct Link location.LocationLocation.Service. getLocation()The location of Direct Link facility.LocationLocation.Service. getObject()ProviderProvider.Service. getObject()ServiceTypeServiceType.Service. getObject()ProviderLocation.Service. getProvider()The Id of Direct Link provider.ServiceTypeLocation.Service. getServiceType()The Id of Direct Link service type. -
Uses of ApiMethod in com.softlayer.api.service.network.firewall
Methods in com.softlayer.api.service.network.firewall with annotations of type ApiMethod Modifier and Type Method Description List<Template>Template.Service. getAllObjects()Get all available firewall template objects.List<Request>AccessControlList.Service. getNetworkFirewallUpdateRequests()The update requests made for this firewall.VlanAccessControlList.Service. getNetworkVlan()AccessControlListAccessControlList.Service. getObject()getObject returns a SoftLayer_Network_Firewall_AccessControlList object.TemplateTemplate.Service. getObject()getObject returns a SoftLayer_Network_Firewall_Template object.InterfaceInterface.Service. getObjectForInterface()getObject returns a SoftLayer_Network_Firewall_Interface object.List<Rule>AccessControlList.Service. getRules()The currently running rule set of this context access control list firewall.List<Rule>Template.Service. getRules()The rule set that belongs to this firewall rules template. -
Uses of ApiMethod in com.softlayer.api.service.network.firewall.module.context
Methods in com.softlayer.api.service.network.firewall.module.context with annotations of type ApiMethod Modifier and Type Method Description List<AccessControlList>Interface.Service. getFirewallContextAccessControlLists()VlanInterface.Service. getNetworkVlan()InterfaceInterface.Service. getObject() -
Uses of ApiMethod in com.softlayer.api.service.network.firewall.update
Methods in com.softlayer.api.service.network.firewall.update with annotations of type ApiMethod Modifier and Type Method Description RequestRequest.Service. createObject(Request templateObject)Create a new firewall update request.InterfaceRequest.Service. getAuthorizingUser()The user that authorized this firewall update request.AttributeRequest.Service. getFirewallUpdateRequestRuleAttributes()Get the possible attribute values for a firewall update request rule.GuestRequest.Service. getGuest()The downstream virtual server that the rule set will be applied to.HardwareRequest.Service. getHardware()The downstream server that the rule set will be applied to.FirewallRequest.Service. getNetworkComponentFirewall()The network component firewall that the rule set will be applied to.RequestRequest.Service. getObject()''getObject'' returns a SoftLayer_Network_Firewall_Update_Request object.List<Rule>Request.Service. getRules()The group of rules contained within the update request.BooleanRequest.Service. updateRuleNote(Rule fwRule, String note) -
Uses of ApiMethod in com.softlayer.api.service.network.firewall.update.request
Methods in com.softlayer.api.service.network.firewall.update.request with annotations of type ApiMethod Modifier and Type Method Description RuleRule.Service. createObject(Rule templateObject)Create a new firewall update request.RequestRule.Service. getFirewallUpdateRequest()The update request that this rule belongs to.RuleRule.Service. getObject()getObject returns a SoftLayer_Network_Firewall_Update_Request_Rule object.VoidRule.Service. validateRule(Rule rule, Long applyToComponentId, Long applyToAclId)Validate the supplied firewall request rule against the object it will apply to. -
Uses of ApiMethod in com.softlayer.api.service.network.gateway
Methods in com.softlayer.api.service.network.gateway with annotations of type ApiMethod Modifier and Type Method Description VoidVlan.Service. bypass()Start the asynchronous process to bypass/unroute the VLAN from this gateway.MemberMember.Service. createObject(Member templateObject)Create a new hardware member on the gateway.VlanVlan.Service. createObject(Vlan templateObject)Create a new VLAN attachment.List<Member>Member.Service. createObjects(List<Member> templateObjects)Create multiple new hardware members on the gateway.List<Vlan>Vlan.Service. createObjects(List<Vlan> templateObjects)Create multiple new VLAN attachments.VoidVlan.Service. deleteObject()Start the asynchronous process to detach this VLANs from the gateway.BooleanVlan.Service. deleteObjects(List<Vlan> templateObjects)Detach several VLANs.List<VersionUpgrade>VersionUpgrade.Service. getAllByUpgradePkgUrlId(Long upgradePkgUrlId)List<VersionUpgrade>VersionUpgrade.Service. getAllUpgradesByGatewayId(Long gatewayId)AttributeMember.Service. getAttributes()The attributes for this member.HardwareMember.Service. getHardware()The device for this member.GatewayMember.Service. getNetworkGateway()The gateway this member belongs to.GatewayVlan.Service. getNetworkGateway()The gateway this VLAN is attached to.VlanVlan.Service. getNetworkVlan()The network VLAN record.MemberMember.Service. getObject()PrecheckPrecheck.Service. getObject()StatusStatus.Service. getObject()VersionUpgradeVersionUpgrade.Service. getObject()VlanVlan.Service. getObject()List<Precheck>Precheck.Service. getPrecheckStatus(Long gatewayId, Boolean getRollbackPrecheck)Get the precheck status for all Juniper Gateway Action categories which require a readiness check before executing.List<Prices>VersionUpgrade.Service. getVsrxOrdersAllowedOS(Long accountId, Boolean validate)Used to get a list per package of prices ids for allowed vSRX OS-es for new orders.BooleanPrecheck.Service. licenseManagementPrecheck(Long gatewayId)Used to create a License Management Network Gateway Precheck transaction.BooleanPrecheck.Service. osReloadPrecheck(Long gatewayId)Create an OS Reload Network Gateway Precheck transaction.VoidVlan.Service. unbypass()Start the asynchronous process to route the VLAN to this gateway.BooleanPrecheck.Service. upgradePrecheck(Long gatewayId)Create a Upgrade Network Gateway Precheck transaction.BooleanVersionUpgrade.Service. validateVersionChange(Long gatewayId, Long versionUpgradeId) -
Uses of ApiMethod in com.softlayer.api.service.network.gateway.member
Methods in com.softlayer.api.service.network.gateway.member with annotations of type ApiMethod Modifier and Type Method Description MemberAttribute.Service. getGatewayMember()The gateway member has these attributes.AttributeAttribute.Service. getObject()KeyAttribute.Service. getSshKey() -
Uses of ApiMethod in com.softlayer.api.service.network.interconnect
Methods in com.softlayer.api.service.network.interconnect with annotations of type ApiMethod Modifier and Type Method Description BooleanTenant.Service. allowDeleteConnection(String serviceKey)StringTenant.Service. createConnection(Tenant templateObject)BooleanTenant.Service. deleteConnection(Tenant receivedObject)StringTenant.Service. editConnection(Tenant receivedObject)StringTenant.Service. getAllConnections()List<Tenant>Tenant.Service. getAllObjects()List<String>Tenant.Service. getAllPortLabelsWithCurrentUsage(Long directLinkLocationId)StringTenant.Service. getBgpIpRange()InterconnectTenant.Service. getBillingItem()The active billing item for a network interconnect.StringTenant.Service. getConnection(String serviceKey, String provider)StringTenant.Service. getDatacenterName()StringTenant.Service. getDirectLinkSpeeds(String offeringType)List<String>Tenant.Service. getNetworkZones()TenantTenant.Service. getObject()StringTenant.Service. getPortLabel()StringTenant.Service. getPorts(String provider)ServiceTypeTenant.Service. getServiceType()StringTenant.Service. getVendorName()StringTenant.Service. getZoneName()BooleanTenant.Service. isAdnAccount()BooleanTenant.Service. rejectApprovalRequests(String serviceKey)BooleanTenant.Service. updateConnectionStatus(Long tenantId) -
Uses of ApiMethod in com.softlayer.api.service.network.lbaas
Methods in com.softlayer.api.service.network.lbaas with annotations of type ApiMethod Modifier and Type Method Description LoadBalancerL7Policy.Service. addL7Policies(String listenerUuid, List<PolicyRule> policiesRules)This function creates multiple policies with rules for the given listener.LoadBalancerL7Member.Service. addL7PoolMembers(String l7PoolUuid, List<L7Member> memberInstances)Add server instances as members to a L7pool and return the LoadBalancer Object with listeners, pools and members populatedLoadBalancerL7Rule.Service. addL7Rules(String policyUuid, List<L7Rule> rules)This function creates and adds multiple Rules to a given L7 policy with all the details provided for rulesLoadBalancerMember.Service. addLoadBalancerMembers(String loadBalancerUuid, List<LoadBalancerServerInstanceInfo> serverInstances)Add server instances as members to load balancer and return it with listeners, pools and members populatedBooleanLoadBalancer.Service. cancelLoadBalancer(String uuid)Cancel a load balancer with the given uuid.LoadBalancerL7Pool.Service. createL7Pool(String loadBalancerUuid, L7Pool l7Pool, List<L7Member> l7Members, L7HealthMonitor l7HealthMonitor, L7SessionAffinity l7SessionAffinity)Create a backend to be used for L7 load balancing.LoadBalancerL7Member.Service. deleteL7PoolMembers(String l7PoolUuid, List<String> memberUuids)Delete given members from load balancer and return load balancer object with listeners, pools and members populatedLoadBalancerL7Rule.Service. deleteL7Rules(String policyUuid, List<String> ruleUuids)This function deletes multiple rules aassociated with the same policy.LoadBalancerMember.Service. deleteLoadBalancerMembers(String loadBalancerUuid, List<String> memberUuids)Delete given members from load balancer and return load balancer object with listeners, pools and members populatedLoadBalancerListener.Service. deleteLoadBalancerProtocols(String loadBalancerUuid, List<String> listenerUuids)Delete load balancers front- and backend protocols and return load balancer object with listeners (frontend), pools (backend), server instances (members) and datacenter populated.LoadBalancerL7Policy.Service. deleteObject()Deletes a l7 policy instance and the rules associated with the policyLoadBalancerL7Pool.Service. deleteObject()Deletes an existing L7 pool along with L7 members, L7 health monitor, and L7 session affinity.LoadBalancerL7Policy.Service. editObject(L7Policy templateObject)Edit a l7 policy instance's propertiesLoadBalancerLoadBalancer.Service. enableOrDisableDataLogs(String uuid, Boolean enabled)When enabled, data log would be forwarded to logging service.List<LoadBalancer>LoadBalancer.Service. getAllObjects()Return all existing load balancersList<SSLCipher>SSLCipher.Service. getAllObjects()Returns all supported cipher listLocationLoadBalancer.Service. getDatacenter()Datacenter, where load balancer is located.PoolListener.Service. getDefaultPool()List<HealthMonitor>LoadBalancer.Service. getHealthMonitors()Health monitors for the backend members.L7HealthMonitorL7Pool.Service. getL7HealthMonitor()List<L7Member>L7Pool.Service. getL7Members()List<L7Policy>L7Pool.Service. getL7Policies()List<L7Policy>Listener.Service. getL7Policies()List<L7PoolMembersHealth>L7Pool.Service. getL7PoolMemberHealth(String loadBalancerUuid)Returns the health of all L7 pool's members which are created under load balancer.List<L7Pool>LoadBalancer.Service. getL7Pools()L7Pools for load balancer.List<L7Rule>L7Policy.Service. getL7Rules()L7SessionAffinityL7Pool.Service. getL7SessionAffinity()List<Listener>LoadBalancer.Service. getListeners()Listeners assigned to load balancer.List<LoadBalancerMonitoringMetricDataPoint>LoadBalancer.Service. getListenerTimeSeriesData(String loadBalancerUuid, String metricName, String timeRange, String listenerUuid)Return listener time series datapoints.LoadBalancerLoadBalancer.Service. getLoadBalancer(String uuid)Get the load balancer object with given uuid.List<PoolMembersHealth>LoadBalancer.Service. getLoadBalancerMemberHealth(String uuid)Return load balancer members healthLoadBalancerStatisticsLoadBalancer.Service. getLoadBalancerStatistics(String uuid)Return load balancers statistics such as total number of current sessions and total number of accumulated connections.List<Member>LoadBalancer.Service. getMembers()Members assigned to load balancer.HealthMonitorHealthMonitor.Service. getObject()L7MemberL7Member.Service. getObject()L7PolicyL7Policy.Service. getObject()L7PoolL7Pool.Service. getObject()L7RuleL7Rule.Service. getObject()ListenerListener.Service. getObject()LoadBalancerLoadBalancer.Service. getObject()MemberMember.Service. getObject()SSLCipherSSLCipher.Service. getObject()List<SSLCipher>LoadBalancer.Service. getSslCiphers()list of preferred custom ciphers configured for the load balancer.LoadBalancerLoadBalancer.Service. serviceLoadBalancer(String data)LoadBalancerL7Pool.Service. updateL7Pool(String l7PoolUuid, L7Pool l7Pool, L7HealthMonitor l7HealthMonitor, L7SessionAffinity l7SessionAffinity)Updates an existing L7 pool, L7 health monitor and L7 session affinity.LoadBalancerL7Member.Service. updateL7PoolMembers(String l7PoolUuid, List<L7Member> members)Update L7 members weight and port.LoadBalancerL7Rule.Service. updateL7Rules(String policyUuid, List<L7Rule> rules)This function updates multiple Rules to a given policy with all the details for rules.LoadBalancerLoadBalancer.Service. updateLoadBalancer(String uuid, String newDescription)Update load balancer's description, and return the load balancer object containing all listeners, pools, members and datacenter.LoadBalancerHealthMonitor.Service. updateLoadBalancerHealthMonitors(String loadBalancerUuid, List<LoadBalancerHealthMonitorConfiguration> healthMonitorConfigurations)Update load balancers health monitor and return load balancer object with listeners (frontend), pools (backend), health monitor server instances (members) and datacenter populatedLoadBalancerMember.Service. updateLoadBalancerMembers(String loadBalancerUuid, List<Member> members)Update members weight and return load balancer object with listeners, pools and members populatedLoadBalancerListener.Service. updateLoadBalancerProtocols(String loadBalancerUuid, List<LoadBalancerProtocolConfiguration> protocolConfigurations)Update (create) load balancers front- and backend protocols and return load balancer object with listeners (frontend), pools (backend), server instances (members) and datacenter populated.LoadBalancerLoadBalancer.Service. updateSslCiphers(String loadBalancerUuid, List<Long> cipherList)Updates the load balancer with the new cipher list. -
Uses of ApiMethod in com.softlayer.api.service.network.loadbalancer
Methods in com.softlayer.api.service.network.loadbalancer with annotations of type ApiMethod Modifier and Type Method Description BooleanLoadBalancerService.Service. deleteObject()Calling deleteObject on a particular server will remove it from the load balancer.BooleanVirtualIpAddress.Service. disable()Disable a Virtual IP Address, removing it from load balancer rotation and denying all connections to that IP address.BooleanVirtualIpAddress.Service. editObject(VirtualIpAddress templateObject)Like any other API object, the load balancers can have their exposed properties edited by passing in a modified version of the object.BooleanVirtualIpAddress.Service. enable()Enable a disabled Virtual IP Address, allowing connections back to the IP address.AccountVirtualIpAddress.Service. getAccount()The account that owns this load balancer.ItemVirtualIpAddress.Service. getBillingItem()The current billing item for the Load Balancer.LongVirtualIpAddress.Service. getCustomerManagedFlag()If false, this VIP and associated services may be edited via the portal or the API.byte[]LoadBalancerService.Service. getGraphImage(String graphType, String metric)Get the graph image for a load balancer service based on the supplied graph type and metric.BooleanVirtualIpAddress.Service. getManagedResourceFlag()A flag indicating that the load balancer is a managed resource.LoadBalancerServiceLoadBalancerService.Service. getObject()getObject retrieves the SoftLayer_Network_LoadBalancer_Service object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Network_LoadBalancer_Service service.VirtualIpAddressVirtualIpAddress.Service. getObject()getObject retrieves the SoftLayer_Network_LoadBalancer_VirtualIpAddress object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Network_LoadBalancer_VirtualIpAddress service.List<LoadBalancerService>VirtualIpAddress.Service. getServices()the services on this load balancer.List<StatusEntry>LoadBalancerService.Service. getStatus()Returns an array of SoftLayer_Container_Network_LoadBalancer_StatusEntry objects.VirtualIpAddressLoadBalancerService.Service. getVip()The load balancer that this service belongs to.BooleanVirtualIpAddress.Service. kickAllConnections()Quickly remove all active external connections to a Virtual IP Address.BooleanLoadBalancerService.Service. resetPeakConnections()Calling resetPeakConnections will set the peakConnections variable to zero on this particular object.BooleanVirtualIpAddress.Service. upgradeConnectionLimit()Upgrades the connection limit on the VirtualIp and changes the billing item on your account to reflect the change. -
Uses of ApiMethod in com.softlayer.api.service.network.loadbalancer.global
Methods in com.softlayer.api.service.network.loadbalancer.global with annotations of type ApiMethod Modifier and Type Method Description BooleanAccount.Service. addNsRecord()The global load balancer service has been deprecated and is no longer available.BooleanHost.Service. deleteObject()The global load balancer service has been deprecated and is no longer available.BooleanAccount.Service. editObject(Account templateObject)The global load balancer service has been deprecated and is no longer available.AccountAccount.Service. getAccount()Your SoftLayer customer account.ItemAccount.Service. getBillingItem()The current billing item for a Global Load Balancer account.List<Host>Account.Service. getHosts()The hosts in the load balancing pool for a global load balancer account.AccountHost.Service. getLoadBalancerAccount()The global load balancer account a host belongs to.TypeAccount.Service. getLoadBalanceType()The load balance method of a global load balancer accountBooleanAccount.Service. getManagedResourceFlag()A flag indicating that the global load balancer is a managed resource.AccountAccount.Service. getObject()The global load balancer service has been deprecated and is no longer available.HostHost.Service. getObject()The global load balancer service has been deprecated and is no longer available.BooleanAccount.Service. removeNsRecord()The global load balancer service has been deprecated and is no longer available. -
Uses of ApiMethod in com.softlayer.api.service.network.media.transcode
Methods in com.softlayer.api.service.network.media.transcode with annotations of type ApiMethod Modifier and Type Method Description JobJob.Service. createObject(Job templateObject)With this method, you can create a transcode job.BooleanAccount.Service. createTranscodeAccount()With this method, you can create a transcode account.BooleanAccount.Service. createTranscodeJob(Job newJob)'''Note'''.AccountAccount.Service. getAccount()The SoftLayer account informationList<Listing>Account.Service. getDirectoryInformation(String directoryName, String extensionFilter)This method returns a collection of SoftLayer_Container_Network_Ftp_Directory objects.InformationAccount.Service. getFileDetail(String source)This method returns detailed information of a media file that resides in the Transcode FTP server.DataAccount.Service. getFtpAttributes()This method returns your Transcode FTP login credentials to the transcode.service.softlayer.com server.List<History>Job.Service. getHistory()AccountAccount.Service. getObject()getObject method retrieves the SoftLayer_Network_Media_Transcode_Account object whose ID number corresponds to the ID number of the initial parameter passed to the SoftLayer_Network_Media_Transcode_Account service.JobJob.Service. getObject()List<Element>Account.Service. getPresetDetail(String guid)This method returns an array of [[SoftLayer_Container_Network_Media_Transcode_Preset_Element|preset element]] objects.List<Preset>Account.Service. getPresets()A transcode preset is a configuration that defines a certain media output.AccountJob.Service. getTranscodeAccount()The transcode service accountList<Job>Account.Service. getTranscodeJobs()Transcode jobsStatusJob.Service. getTranscodeStatus()The status information of a transcode jobStringJob.Service. getTranscodeStatusName()The status of a transcode jobCustomerJob.Service. getUser()The SoftLayer user that created the transcode job -
Uses of ApiMethod in com.softlayer.api.service.network.media.transcode.job
Methods in com.softlayer.api.service.network.media.transcode.job with annotations of type ApiMethod Modifier and Type Method Description List<Status>Status.Service. getAllStatuses()This method returns all transcode job statuses.StatusStatus.Service. getObject() -
Uses of ApiMethod in com.softlayer.api.service.network.message
Methods in com.softlayer.api.service.network.message with annotations of type ApiMethod Modifier and Type Method Description BooleanDelivery.Service. editObject(Delivery templateObject)AccountDelivery.Service. getAccount()The SoftLayer customer account that a network message delivery account belongs to.ItemDelivery.Service. getBillingItem()The billing item for a network message delivery account.DeliveryDelivery.Service. getObject()TypeDelivery.Service. getType()The message delivery type of a network message delivery account.VendorDelivery.Service. getVendor()The vendor for a network message delivery account. -
Uses of ApiMethod in com.softlayer.api.service.network.message.delivery.email
Methods in com.softlayer.api.service.network.message.delivery.email with annotations of type ApiMethod Modifier and Type Method Description BooleanSendgrid.Service. addUnsubscribeEmailAddress(String emailAddress)BooleanSendgrid.Service. deleteEmailListEntries(String list, List<String> entries)BooleanSendgrid.Service. disableSmtpAccess()BooleanSendgrid.Service. enableSmtpAccess()OverviewSendgrid.Service. getAccountOverview()List<String>Sendgrid.Service. getCategoryList()StringSendgrid.Service. getEmailAddress()The contact e-mail address used by SendGrid.List<Entry>Sendgrid.Service. getEmailList(String list)SendgridSendgrid.Service. getObjectForSendgrid()StringSendgrid.Service. getSmtpAccess()A flag that determines if a SendGrid e-mail delivery account has access to send mail through the SendGrid SMTP server.List<Statistics>Sendgrid.Service. getStatistics(Options options)GraphSendgrid.Service. getStatisticsGraph(Options options)StringSendgrid.Service. getVendorPortalUrl()BooleanSendgrid.Service. sendEmail(Email emailContainer)BooleanSendgrid.Service. updateEmailAddress(String emailAddress) -
Uses of ApiMethod in com.softlayer.api.service.network.monitor.version1.query
Methods in com.softlayer.api.service.network.monitor.version1.query with annotations of type ApiMethod Modifier and Type Method Description HostHost.Service. createObject(Host templateObject)Passing in an unsaved instances of a Query_Host object into this function will create the object and return the results to the user.List<Host>Host.Service. createObjects(List<Host> templateObjects)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.BooleanHost.Service. deleteObject()Like any other API object, the monitoring objects can be deleted by passing an instance of them into this function.BooleanHost.Service. deleteObjects(List<Host> templateObjects)Like any other API object, the monitoring objects can be deleted by passing an instance of them into this function.BooleanHost.Service. editObject(Host templateObject)Like any other API object, the monitoring objects can have their exposed properties edited by passing in a modified version of the object.BooleanHost.Service. editObjects(List<Host> templateObjects)Like any other API object, the monitoring objects can have their exposed properties edited by passing in a modified version of the object.List<Host>Host.Service. findByHardwareId(Long hardwareId)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.HardwareHost.Service. getHardware()The hardware that is being monitored by this monitoring instanceResultHost.Service. getLastResult()The most recent result for this particular monitoring instance.HostHost.Service. getObject()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.TypeHost.Service. getQueryType()The type of monitoring query that is executed when this hardware is monitored.ResponseTypeHost.Service. getResponseAction()The action taken when a monitor fails. -
Uses of ApiMethod in com.softlayer.api.service.network.monitor.version1.query.host
Methods in com.softlayer.api.service.network.monitor.version1.query.host with annotations of type ApiMethod Modifier and Type Method Description List<Type>Stratum.Service. getAllQueryTypes()Calling this function returns all possible query type objects.List<ResponseType>Stratum.Service. getAllResponseTypes()Calling this function returns all possible response type objects.HardwareStratum.Service. getHardware()The hardware object that these monitoring permissions applies to.StratumStratum.Service. getObject()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. -
Uses of ApiMethod in com.softlayer.api.service.network.security.scanner
Methods in com.softlayer.api.service.network.security.scanner with annotations of type ApiMethod Modifier and Type Method Description RequestRequest.Service. createObject(Request templateObject)Create a new vulnerability scan request.AccountRequest.Service. getAccount()The account associated with a security scan request.GuestRequest.Service. getGuest()The virtual guest a security scan is run against.HardwareRequest.Service. getHardware()The hardware a security scan is run against.RequestRequest.Service. getObject()getObject retrieves the SoftLayer_Network_Security_Scanner_Request object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Network_Security_Scanner_Request service.StringRequest.Service. getReport()Get the vulnerability report for a scan request, formatted as HTML string.BooleanRequest.Service. getRequestorOwnedFlag()Flag whether the requestor owns the hardware the scan was run on.StatusRequest.Service. getStatus()A security scan request's status. -
Uses of ApiMethod in com.softlayer.api.service.network.service.vpn
Methods in com.softlayer.api.service.network.service.vpn with annotations of type ApiMethod Modifier and Type Method Description BooleanOverrides.Service. createObjects(List<Overrides> templateObjects)Create Softlayer portal user VPN overrides.BooleanOverrides.Service. deleteObject()Use this method to delete a single SoftLayer portal VPN user subnet override.BooleanOverrides.Service. deleteObjects(List<Overrides> templateObjects)Use this method to delete a collection of SoftLayer portal VPN user subnet overrides.OverridesOverrides.Service. getObject()SubnetOverrides.Service. getSubnet()Subnet components accessible by a SoftLayer VPN portal user.CustomerOverrides.Service. getUser()SoftLayer VPN portal user. -
Uses of ApiMethod in com.softlayer.api.service.network.storage
Methods in com.softlayer.api.service.network.storage with annotations of type ApiMethod Modifier and Type Method Description BooleanGroup.Service. addAllowedHost(Host allowedHost)Use this method to attach a SoftLayer_Network_Storage_Allowed_Host object to this group.BooleanIscsi.Service. allowAccessFromHardware(Hardware hardwareObjectTemplate)This method is used to modify the access control list for this Storage volume.BooleanIscsi.Service. allowAccessFromIpAddress(IpAddress ipAddressObjectTemplate)BooleanIscsi.Service. allowAccessFromVirtualGuest(Guest virtualGuestObjectTemplate)This method is used to modify the access control list for this Storage volume.BooleanIscsi.Service. allowAccessToReplicantFromHardwareListForIscsi(List<Hardware> hardwareObjectTemplates)This method is used to modify the access control list for this Storage replica volume.BooleanIscsi.Service. allowAccessToReplicantFromIpAddressListForIscsi(List<IpAddress> ipAddressObjectTemplates)This method is used to modify the access control list for this Storage volume.BooleanIscsi.Service. allowAccessToReplicantFromVirtualGuestListForIscsi(List<Guest> virtualGuestObjectTemplates)This method is used to modify the access control list for this Storage volume.BooleanGroup.Service. attachToVolume(Storage volume)Use this method to attach a SoftLayer_Network_Storage volume to this group.BooleanGroup.Service. createObject(Group templateObject)ScheduleSchedule.Service. createObject(Schedule templateObject)Create a nas volume schedulePropertyIscsi.Service. createOrUpdateLunId(Long lunId)The LUN ID only takes effect during the Host Authorization process.BooleanGroup.Service. deleteObject()BooleanSchedule.Service. deleteObject()Delete a network storage schedule.BooleanGroup.Service. editObject(Group templateObject)BooleanSchedule.Service. editObject(Schedule templateObject)Edit a nas volume scheduleAccountDedicatedCluster.Service. getAccount()AccountGroup.Service. getAccount()The SoftLayer_Account which owns this group.List<Group>Group.Service. getAllObjects()Use this method to retrieve all network storage groups.List<Host>Group.Service. getAllowedHosts()The allowed hosts list for this group.List<Storage>Group.Service. getAttachedVolumes()The network storage volumes this group is attached to.StringSchedule.Service. getDay()The hour parameter of this schedule.StringSchedule.Service. getDayOfMonth()The day of the month parameter of this schedule.StringSchedule.Service. getDayOfWeek()The day of the week parameter of this schedule.List<Long>DedicatedCluster.Service. getDedicatedClusterList()List<Event>Schedule.Service. getEvents()Events which have been created as the result of a schedule execution.TypeGroup.Service. getGroupType()The type which defines this group.StringSchedule.Service. getHour()The hour parameter of this schedule.LongIscsi.Service. getMaximumExpansionSizeForIscsi()StringSchedule.Service. getMinute()The minute parameter of this schedule.StringSchedule.Service. getMonthOfYear()The month of the year parameter of this schedule.NetworkConnectionInformationGroup.Service. getNetworkConnectionDetails()Use this method to retrieve network connection information for SoftLayer_Network_Storage_Allowed_Host objects within this group.DedicatedClusterDedicatedCluster.Service. getObject()GroupGroup.Service. getObject()ScheduleSchedule.Service. getObject()IscsiIscsi.Service. getObjectForIscsi()TypeGroup.Service. getOsType()The OS Type this group is configured for.PartnershipSchedule.Service. getPartnership()The associated partnership for a schedule.List<Property>Schedule.Service. getProperties()Properties used for configuration of a schedule.List<Storage>Schedule.Service. getReplicaSnapshots()Replica snapshots which have been created as the result of this schedule's execution.StringSchedule.Service. getRetentionCount()The number of snapshots this schedule is configured to retain.StringSchedule.Service. getSecond()The minute parameter of this schedule.ResourceDedicatedCluster.Service. getServiceResource()ResourceGroup.Service. getServiceResource()The network resource this group is created on.List<Storage>Schedule.Service. getSnapshots()Snapshots which have been created as the result of this schedule's execution.List<Storage>Iscsi.Service. getSnapshotsForVolumeForIscsi()Retrieves a list of snapshots for this SoftLayer_Network_Storage volume.TypeSchedule.Service. getType()The type provides a standardized definition for a schedule.StorageSchedule.Service. getVolume()The associated volume for a schedule.BooleanIscsi.Service. removeAccessFromHardware(Hardware hardwareObjectTemplate)This method is used to modify the access control list for this Storage volume.BooleanIscsi.Service. removeAccessFromIpAddress(IpAddress ipAddressObjectTemplate)BooleanIscsi.Service. removeAccessFromVirtualGuest(Guest virtualGuestObjectTemplate)This method is used to modify the access control list for this Storage volume.BooleanIscsi.Service. removeAccessToReplicantFromHardwareListForIscsi(List<Hardware> hardwareObjectTemplates)This method is used to modify the access control list for this Storage replica volume.BooleanIscsi.Service. removeAccessToReplicantFromIpAddressListForIscsi(List<IpAddress> ipAddressObjectTemplates)This method is used to modify the access control list for this Storage replica volume.BooleanIscsi.Service. removeAccessToReplicantFromVirtualGuestListForIscsi(List<Guest> virtualGuestObjectTemplates)This method is used to modify the access control list for this Storage replica volume.BooleanGroup.Service. removeAllowedHost(Host allowedHost)Use this method to remove a SoftLayer_Network_Storage_Allowed_Host object from this group.BooleanGroup.Service. removeFromVolume(Storage volume)Use this method to remove a SoftLayer_Network_Storage volume from this group. -
Uses of ApiMethod in com.softlayer.api.service.network.storage.allowed
Methods in com.softlayer.api.service.network.storage.allowed with annotations of type ApiMethod Modifier and Type Method Description List<Long>Host.Service. assignSubnetsToAcl(List<Long> subnetIds)BooleanHost.Service. editObject(Host templateObject)List<Host>Host.Service. getAllObjects()List<Group>Host.Service. getAssignedGroups()The SoftLayer_Network_Storage_Group objects this SoftLayer_Network_Storage_Allowed_Host is present in.List<Storage>Host.Service. getAssignedIscsiVolumes()The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access.List<Storage>Host.Service. getAssignedNfsVolumes()The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access.List<Storage>Host.Service. getAssignedReplicationVolumes()The SoftLayer_Network_Storage primary volumes whose replicas are allowed access.List<Storage>Host.Service. getAssignedVolumes()The SoftLayer_Network_Storage volumes to which this SoftLayer_Network_Storage_Allowed_Host is allowed access.CredentialHost.Service. getCredential()The SoftLayer_Network_Storage_Credential this allowed host uses.HostHost.Service. getObject()StringHost.Service. getSourceSubnet()Connections to a target with a source IP in this subnet prefix are allowed.List<Subnet>Host.Service. getSubnetsInAcl()The SoftLayer_Network_Subnet records assigned to the ACL for this allowed host.List<Long>Host.Service. removeSubnetsFromAcl(List<Long> subnetIds)BooleanHost.Service. setCredentialPassword(String password)Use this method to modify the credential password for a SoftLayer_Network_Storage_Allowed_Host object. -
Uses of ApiMethod in com.softlayer.api.service.network.storage.allowed.host
Methods in com.softlayer.api.service.network.storage.allowed.host with annotations of type ApiMethod Modifier and Type Method Description AccountHardware.Service. getAccount()The SoftLayer_Account object which this SoftLayer_Network_Storage_Allowed_Host belongs to.AccountIpAddress.Service. getAccount()The SoftLayer_Account object which this SoftLayer_Network_Storage_Allowed_Host belongs to.AccountSubnet.Service. getAccount()The SoftLayer_Account object which this SoftLayer_Network_Storage_Allowed_Host belongs to.AccountVirtualGuest.Service. getAccount()The SoftLayer_Account object which this SoftLayer_Network_Storage_Allowed_Host belongs to.HardwareHardware.Service. getObjectForHardware()IpAddressIpAddress.Service. getObjectForIpAddress()SubnetSubnet.Service. getObjectForSubnet()VirtualGuestVirtualGuest.Service. getObjectForVirtualGuest()HardwareHardware.Service. getResource()The SoftLayer_Hardware object which this SoftLayer_Network_Storage_Allowed_Host is referencing.IpAddressIpAddress.Service. getResource()The SoftLayer_Network_Subnet_IpAddress object which this SoftLayer_Network_Storage_Allowed_Host is referencing.SubnetSubnet.Service. getResource()The SoftLayer_Network_Subnet object which this SoftLayer_Network_Storage_Allowed_Host is referencing.GuestVirtualGuest.Service. getResource()The SoftLayer_Virtual_Guest object which this SoftLayer_Network_Storage_Allowed_Host is referencing. -
Uses of ApiMethod in com.softlayer.api.service.network.storage.backup
Methods in com.softlayer.api.service.network.storage.backup with annotations of type ApiMethod Modifier and Type Method Description BooleanEvault.Service. deleteTasks(List<Long> tasks)This method can be used to help maintain the storage space on a vault.List<Hardware>Evault.Service. getHardwareWithEvaultFirst(String option, Boolean exactMatch, String criteria, String mode)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.EvaultEvault.Service. getObjectForEvault()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.DetailsEvault.Service. getWebCCAuthenticationDetails()BooleanEvault.Service. initiateBareMetalRestore()Evault Bare Metal Restore is a special version of Rescue Kernel designed specifically for making full system restores made with Evault's BMR backup.BooleanEvault.Service. initiateBareMetalRestoreForServer(Long hardwareId)This method operates the same as the initiateBareMetalRestore() method. -
Uses of ApiMethod in com.softlayer.api.service.network.storage.group
Methods in com.softlayer.api.service.network.storage.group with annotations of type ApiMethod Modifier and Type Method Description BooleanIscsi.Service. addAllowedHost(Host allowedHost)Use this method to attach a SoftLayer_Network_Storage_Allowed_Host object to this group.BooleanNfs.Service. addAllowedHost(Host allowedHost)Use this method to attach a SoftLayer_Network_Storage_Allowed_Host object to this group.BooleanIscsi.Service. attachToVolume(Storage volume)Use this method to attach a SoftLayer_Network_Storage volume to this group.BooleanNfs.Service. attachToVolume(Storage volume)Use this method to attach a SoftLayer_Network_Storage volume to this group.List<Type>Type.Service. getAllObjects()Use this method to retrieve all storage group types available.TypeType.Service. getObject()IscsiIscsi.Service. getObjectForIscsi()NfsNfs.Service. getObjectForNfs()BooleanIscsi.Service. removeAllowedHost(Host allowedHost)Use this method to remove a SoftLayer_Network_Storage_Allowed_Host object from this group.BooleanNfs.Service. removeAllowedHost(Host allowedHost)Use this method to remove a SoftLayer_Network_Storage_Allowed_Host object from this group.BooleanIscsi.Service. removeFromVolume(Storage volume)Use this method to remove a SoftLayer_Network_Storage volume from this group.BooleanNfs.Service. removeFromVolume(Storage volume)Use this method to remove a SoftLayer_Network_Storage volume from this group. -
Uses of ApiMethod in com.softlayer.api.service.network.storage.hub.cleversafe
Methods in com.softlayer.api.service.network.storage.hub.cleversafe with annotations of type ApiMethod Modifier and Type Method Description List<Credential>Account.Service. credentialCreate()Create credentials for an IBM Cloud Object Storage AccountBooleanAccount.Service. credentialDelete(Credential credential)Delete a credentialAccountAccount.Service. getAccount()SoftLayer account to which an IBM Cloud Object Storage account belongs to.List<Account>Account.Service. getAllObjects()ItemAccount.Service. getBillingItem()An associated parent billing item which is active.List<Bucket>Account.Service. getBuckets()Get bucketsItemAccount.Service. getCancelledBillingItem()An associated parent billing item which has been cancelled.LongAccount.Service. getCapacityUsage()Returns the capacity usage for an IBM Cloud Object Storage account.List<String>Account.Service. getCloudObjectStorageMetrics(String start, String end, String storageLocation, String storageClass, String metrics)Makes a request to Cloud Object Storage metricsAPI service and when successful, returns an associative array with two elements:
if 200:
[, ]
if not 200:
[, ]
{ "start": "", "errors": [], "end": " ", "resource_type": "account", "warnings": [], "resources": [{"metrics" : [{"name": "retrieval", "value": " "}]}] }
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.LongAccount.Service. getCredentialLimit()Returns credential limits for this IBM Cloud Object Storage account.List<Credential>Account.Service. getCredentials()Credentials used for generating an AWS signature.List<Endpoint>Account.Service. getEndpoints(Long accountId)Returns a collection of endpoint URLs available to this IBM Cloud Object Storage account.List<Endpoint>Account.Service. getEndpointsWithRefetch(Long accountId, Boolean refetch)Returns a collection of endpoint URLs available to this IBM Cloud Object Storage account.ObjectAccount.Service. getMetricTrackingObject()Provides an interface to various metrics relating to the usage of an IBM Cloud Object Storage account.AccountAccount.Service. getObject()StringAccount.Service. getUuid()Unique identifier for an IBM Cloud Object Storage account. -
Uses of ApiMethod in com.softlayer.api.service.network.storage.hub.swift
Methods in com.softlayer.api.service.network.storage.hub.swift with annotations of type ApiMethod Modifier and Type Method Description List<Folder>Share.Service. getContainerList()This method returns a collection of container objects.FileShare.Service. getFile(String fileName, String container)This method returns a file object given the file's full name.List<Entity>Share.Service. getFileList(String container, String path)This method returns a collection of the file objects within a container and the given path.List<Data>Metrics.Service. getMetricData(GregorianCalendar startDateTime, GregorianCalendar endDateTime, String metricKey, String location)List<Data>Metrics.Service. getSummaryData(GregorianCalendar startDateTime, GregorianCalendar endDateTime, List<Type> validTypes, Long summaryPeriod) -
Uses of ApiMethod in com.softlayer.api.service.network.storage.iscsi.os
Methods in com.softlayer.api.service.network.storage.iscsi.os with annotations of type ApiMethod Modifier and Type Method Description List<Type>Type.Service. getAllObjects()Use this method to retrieve all iSCSI OS Types.TypeType.Service. getObject() -
Uses of ApiMethod in com.softlayer.api.service.network.storage.massdatamigration
Methods in com.softlayer.api.service.network.storage.massdatamigration with annotations of type ApiMethod Modifier and Type Method Description AccountRequest.Service. getAccount()The account to which the request belongs.List<Ticket>Request.Service. getActiveTickets()The active tickets that are attached to the MDMS request.AddressRequest.Service. getAddress()The customer address where the device is shipped to.List<Request>Request.Service. getAllObjects()List<Status>Request.Service. getAllRequestStatuses()Retrieves a list of all the possible statuses to which a request may be set.ItemRequest.Service. getBillingItem()An associated parent billing item which is active.EmployeeRequest.Service. getCreateEmployee()The employee user who created the request.CustomerRequest.Service. getCreateUser()The customer user who created the request.DeviceConfigurationRequest.Service. getDeviceConfiguration()The device configurations.StringRequest.Service. getDeviceModel()The model of device assigned to this request.List<KeyContact>Request.Service. getKeyContacts()The key contacts for this requests.EmployeeRequest.Service. getModifyEmployee()The employee who last modified the request.CustomerRequest.Service. getModifyUser()The customer user who last modified the request.RequestRequest.Service. getObject()List<Request>Request.Service. getPendingRequests()Returns placeholder MDMS requests for any MDMS order pending approval.List<Shipment>Request.Service. getShipments()The shipments of the request.StatusRequest.Service. getStatus()The status of the request.TicketRequest.Service. getTicket()Ticket that is attached to this mass data migration request.List<Ticket>Request.Service. getTickets()All tickets that are attached to the mass data migration request. -
Uses of ApiMethod in com.softlayer.api.service.network.storage.massdatamigration.crossregion.country
Methods in com.softlayer.api.service.network.storage.massdatamigration.crossregion.country with annotations of type ApiMethod Modifier and Type Method Description List<Xref>Xref.Service. getAllObjects()CountryXref.Service. getCountry()SoftLayer_Locale_Country Id.GroupXref.Service. getLocationGroup()Location Group ID of CleverSafe cross region.XrefXref.Service. getObject()List<Xref>Xref.Service. getValidCountriesForRegion(String locationGroupName)Returns countries assigned to the region having pricing info set. -
Uses of ApiMethod in com.softlayer.api.service.network.storage.massdatamigration.request
Methods in com.softlayer.api.service.network.storage.massdatamigration.request with annotations of type ApiMethod Modifier and Type Method Description AccountKeyContact.Service. getAccount()The request this key contact belongs to.KeyContactKeyContact.Service. getObject()StatusStatus.Service. getObject()RequestKeyContact.Service. getRequest()The request this key contact belongs to. -
Uses of ApiMethod in com.softlayer.api.service.network.storage.schedule.property
Methods in com.softlayer.api.service.network.storage.schedule.property with annotations of type ApiMethod Modifier and Type Method Description List<Type>Type.Service. getAllObjects()Use this method to retrieve all network storage schedule property types.TypeType.Service. getObject() -
Uses of ApiMethod in com.softlayer.api.service.network.subnet
Methods in com.softlayer.api.service.network.subnet with annotations of type ApiMethod Modifier and Type Method Description BooleanIpAddress.Service. allowAccessToNetworkStorage(Storage networkStorageTemplateObject)This method is used to allow access to a SoftLayer_Network_Storage volume that supports host- or network-level access control.BooleanIpAddress.Service. allowAccessToNetworkStorageList(List<Storage> networkStorageTemplateObjects)This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support host- or network-level access control.BooleanRegistration.Service. clearRegistration()This method will initiate the removal of a subnet registration.RegistrationRegistration.Service. createObject(Registration templateObject)Create registration with a global registrar to associate an assigned subnet with the provided contact details.List<Registration>Registration.Service. createObjects(List<Registration> templateObjects)Create registrations with respective registrars to associate multiple assigned subnets with the provided contact details.BooleanIpAddress.Service. editObject(IpAddress templateObject)Edit a subnet IP address.BooleanRegistration.Service. editObject(Registration templateObject)This method will edit an existing SoftLayer_Network_Subnet_Registration object.BooleanIpAddress.Service. editObjects(List<IpAddress> templateObjects)This function is used to edit multiple objects at the same time.BooleanRegistration.Service. editRegistrationAttachedDetails(Details personObjectSkeleton, Details networkObjectSkeleton)This method modifies a single registration by modifying the current [[SoftLayer_Network_Subnet_Registration_Details]] objects that are linked to that registration.IpAddressIpAddress.Service. findByIpv4Address(String ipAddress)Search for an IP address record by IPv4 address.AccountRegistration.Service. getAccount()The account that this registration belongs to.HostIpAddress.Service. getAllowedHost()The SoftLayer_Network_Storage_Allowed_Host information to connect this IP Address to Network Storage supporting access control lists.List<Storage>IpAddress.Service. getAllowedNetworkStorage()The SoftLayer_Network_Storage objects that this SoftLayer_Hardware has access to.List<Storage>IpAddress.Service. getAllowedNetworkStorageReplicas()The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Hardware has access to.ControllerIpAddress.Service. getApplicationDeliveryController()The application delivery controller using this address.List<Storage>IpAddress.Service. getAttachedNetworkStorages(String nasType)This method is retrieve a list of SoftLayer_Network_Storage volumes that are authorized access to this SoftLayer_Network_Subnet_IpAddress.List<Storage>IpAddress.Service. getAvailableNetworkStorages(String nasType)This method retrieves a list of SoftLayer_Network_Storage volumes that can be authorized to this SoftLayer_Network_Subnet_IpAddress.IpAddressIpAddress.Service. getByIpAddress(String ipAddress)Search for an IP address record by IP address.List<Translation>IpAddress.Service. getContextTunnelTranslations()An IPSec network tunnel's address translations.List<Details>Registration.Service. getDetailReferences()The cross-reference records that tie the [[SoftLayer_Account_Regional_Registry_Detail]] objects to the registration object.List<Subnet>IpAddress.Service. getEndpointSubnets()All the subnets routed to an IP address.List<Event>Registration.Service. getEvents()The related registration events.ComponentIpAddress.Service. getGuestNetworkComponent()A network component that is statically routed to an IP address.IpAddressIpAddress.Service. getGuestNetworkComponentBinding()A network component that is statically routed to an IP address.HardwareIpAddress.Service. getHardware()A server that this IP address is routed to.ComponentIpAddress.Service. getNetworkComponent()A network component that is statically routed to an IP address.DetailRegistration.Service. getNetworkDetail()The "network" detail object.IpAddressIpAddress.Service. getObject()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.RegistrationRegistration.Service. getObject()DetailRegistration.Service. getPersonDetail()The "person" detail object.GatewayIpAddress.Service. getPrivateNetworkGateway()The network gateway appliance using this address as the private IP address.List<Address>IpAddress.Service. getProtectionAddress()GatewayIpAddress.Service. getPublicNetworkGateway()The network gateway appliance using this address as the public IP address.RegistryRegistration.Service. getRegionalInternetRegistry()The related Regional Internet Registry.HandleRegistration.Service. getRegionalInternetRegistryHandle()The RIR handle that this registration object belongs to.ComponentIpAddress.Service. getRemoteManagementNetworkComponent()An IPMI-based management network component of the IP address.StatusRegistration.Service. getStatus()The status of this registration.SubnetIpAddress.Service. getSubnet()An IP address' associated subnet.SubnetRegistration.Service. getSubnet()The subnet that this registration pertains to.List<Syslog>IpAddress.Service. getSyslogEventsOneDay()All events for this IP address stored in the datacenter syslogs from the last 24 hoursList<Syslog>IpAddress.Service. getSyslogEventsSevenDays()All events for this IP address stored in the datacenter syslogs from the last 7 daysList<Syslog>IpAddress.Service. getTopTenSyslogEventsByDestinationPortOneDay()Top Ten network datacenter syslog events, grouped by destination port, for the last 24 hoursList<Syslog>IpAddress.Service. getTopTenSyslogEventsByDestinationPortSevenDays()Top Ten network datacenter syslog events, grouped by destination port, for the last 7 daysList<Syslog>IpAddress.Service. getTopTenSyslogEventsByProtocolsOneDay()Top Ten network datacenter syslog events, grouped by source port, for the last 24 hoursList<Syslog>IpAddress.Service. getTopTenSyslogEventsByProtocolsSevenDays()Top Ten network datacenter syslog events, grouped by source port, for the last 7 daysList<Syslog>IpAddress.Service. getTopTenSyslogEventsBySourceIpOneDay()Top Ten network datacenter syslog events, grouped by source ip address, for the last 24 hoursList<Syslog>IpAddress.Service. getTopTenSyslogEventsBySourceIpSevenDays()Top Ten network datacenter syslog events, grouped by source ip address, for the last 7 daysList<Syslog>IpAddress.Service. getTopTenSyslogEventsBySourcePortOneDay()Top Ten network datacenter syslog events, grouped by source port, for the last 24 hoursList<Syslog>IpAddress.Service. getTopTenSyslogEventsBySourcePortSevenDays()Top Ten network datacenter syslog events, grouped by source port, for the last 7 daysGuestIpAddress.Service. getVirtualGuest()A virtual guest that this IP address is routed to.List<VirtualLicense>IpAddress.Service. getVirtualLicenses()Virtual licenses allocated for an IP Address.BooleanIpAddress.Service. removeAccessToNetworkStorageList(List<Storage> networkStorageTemplateObjects)This method is used to remove access to multiple SoftLayer_Network_Storage volumes -
Uses of ApiMethod in com.softlayer.api.service.network.subnet.ipaddress
Methods in com.softlayer.api.service.network.subnet.ipaddress with annotations of type ApiMethod Modifier and Type Method Description AccountGlobal.Service. getAccount()TransactionGlobal.Service. getActiveTransaction()DEPRECATEDGlobalGlobal.Service. getBillingItem()The billing item for this Global IP.IpAddressGlobal.Service. getDestinationIpAddress()IpAddressGlobal.Service. getIpAddress()GlobalGlobal.Service. getObject()BooleanGlobal.Service. route(String newEndPointIpAddress)
***DEPRECATED***
This endpoint is deprecated in favor of the more expressive and capable SoftLayer_Network_Subnet::route, to which this endpoint now proxies.BooleanGlobal.Service. unroute()
***DEPRECATED***
This endpoint is deprecated in favor of SoftLayer_Network_Subnet::clearRoute, to which this endpoint now proxies. -
Uses of ApiMethod in com.softlayer.api.service.network.subnet.registration
Methods in com.softlayer.api.service.network.subnet.registration with annotations of type ApiMethod Modifier and Type Method Description DetailsDetails.Service. createObject(Details templateObject)This method will create a new SoftLayer_Network_Subnet_Registration_Details object.BooleanDetails.Service. deleteObject()This method will delete an existing SoftLayer_Account_Regional_Registry_Detail object.List<Status>Status.Service. getAllObjects()DetailDetails.Service. getDetail()The related [[SoftLayer_Account_Regional_Registry_Detail|detail object]].DetailsDetails.Service. getObject()StatusStatus.Service. getObject()RegistrationDetails.Service. getRegistration()The related [[SoftLayer_Network_Subnet_Registration|registration object]]. -
Uses of ApiMethod in com.softlayer.api.service.network.subnet.rwhois
Methods in com.softlayer.api.service.network.subnet.rwhois with annotations of type ApiMethod Modifier and Type Method Description BooleanData.Service. editObject(Data templateObject)Edit the RWHOIS record by passing in a modified version of the record object.AccountData.Service. getAccount()The SoftLayer customer account associated with this reverse WHOIS data.DataData.Service. getObject()getObject retrieves the SoftLayer_Network_Subnet_Rwhois_Data object whose ID corresponds to the ID number of the init parameter passed to the SoftLayer_Network_Subnet_Rwhois_Data service. -
Uses of ApiMethod in com.softlayer.api.service.network.subnet.swip
Methods in com.softlayer.api.service.network.subnet.swip with annotations of type ApiMethod Modifier and Type Method Description List<Transaction>Transaction.Service. findMyTransactions()
**DEPRECATED**
This function will return an array of SoftLayer_Network_Subnet_Swip_Transaction objects, one for each SWIP that is currently in transaction with ARIN.AccountTransaction.Service. getAccount()The Account whose RWHOIS data was used to SWIP this subnetTransactionTransaction.Service. getObject()
**DEPRECATED**
getObject retrieves the SoftLayer_Network_Subnet_Swip_Transaction object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Network_Subnet_Swip_transaction service.SubnetTransaction.Service. getSubnet()The subnet that this SWIP transaction was created for.LongTransaction.Service. removeAllSubnetSwips()
**DEPRECATED**
This method finds all subnets attached to your account that are in OK status and starts "DELETE" transactions with ARIN, allowing you to remove your SWIP registration information.BooleanTransaction.Service. removeSwipData()
**DEPRECATED**
This function, when called on an instantiated SWIP transaction, will allow you to start a "DELETE" transaction with ARIN, allowing you to remove your SWIP registration information.BooleanTransaction.Service. resendSwipData()
**DEPRECATED**
This function will allow you to update ARIN's registration data for a subnet to your current RWHOIS data.LongTransaction.Service. swipAllSubnets()
**DEPRECATED**
swipAllSubnets finds all subnets attached to your account and attempts to create a SWIP transaction for all subnets that do not already have a SWIP transaction in progress.LongTransaction.Service. updateAllSubnetSwips()
**DEPRECATED**
This method finds all subnets attached to your account that are in "OK" status and updates their data with ARIN. -
Uses of ApiMethod in com.softlayer.api.service.network.tunnel.module
Methods in com.softlayer.api.service.network.tunnel.module with annotations of type ApiMethod Modifier and Type Method Description BooleanContext.Service. addCustomerSubnetToNetworkTunnel(Long subnetId)Associates a remote subnet to the network tunnel.BooleanContext.Service. addPrivateSubnetToNetworkTunnel(Long subnetId)Associates a private subnet to the network tunnel.BooleanContext.Service. addServiceSubnetToNetworkTunnel(Long subnetId)Associates a service subnet to the network tunnel.BooleanContext.Service. applyConfigurationsToDevice()An asynchronous task will be created to apply the IPSec network tunnel's configuration to network devices.TranslationContext.Service. createAddressTranslation(Translation translation)Create an address translation for a network tunnel.List<Translation>Context.Service. createAddressTranslations(List<Translation> translations)This has the same functionality as the SoftLayer_Network_Tunnel_Module_Context::createAddressTranslation.BooleanContext.Service. deleteAddressTranslation(Long translationId)Remove an existing address translation from a network tunnel.EntityContext.Service. downloadAddressTranslationConfigurations()Provides all of the address translation configurations for an IPSec VPN tunnel in a text fileEntityContext.Service. downloadParameterConfigurations()Provides all of the configurations for an IPSec VPN network tunnel in a text fileTranslationContext.Service. editAddressTranslation(Translation translation)Edit name, source (SoftLayer IP) ip address and/or destination (Customer IP) ip address for an existing address translation for a network tunnel.List<Translation>Context.Service. editAddressTranslations(List<Translation> translations)Edit name, source (SoftLayer IP) ip address and/or destination (Customer IP) ip address for existing address translations for a network tunnel.BooleanContext.Service. editObject(Context templateObject)Negotiation parameters for both phases one and two are editable.AccountContext.Service. getAccount()The account that a network tunnel belongs to.TransactionContext.Service. getActiveTransaction()DEPRECATEDStringContext.Service. getAddressTranslationConfigurations()The address translations will be returned.List<Translation>Context.Service. getAddressTranslations()A network tunnel's address translations.List<Subnet>Context.Service. getAllAvailableServiceSubnets()Subnets that provide access to SoftLayer services such as the management portal and the SoftLayer API.StringContext.Service. getAuthenticationDefault()The default authentication type used for both phases of the negotiation process.List<String>Context.Service. getAuthenticationOptions()Authentication options available for both phases of the negotiation process.ItemContext.Service. getBillingItem()The current billing item for network tunnel.List<Subnet>Context.Service. getCustomerSubnets()Remote subnets that are allowed access through a network tunnel.LocationContext.Service. getDatacenter()The datacenter location for one end of the network tunnel that allows access to account's private subnets.LongContext.Service. getDiffieHellmanGroupDefault()The default Diffie-Hellman group used for both phases of the negotiation process.List<Long>Context.Service. getDiffieHellmanGroupOptions()The Diffie-Hellman group options used for both phases of the negotiation process.StringContext.Service. getEncryptionDefault()The default encryption type used for both phases of the negotiation process.List<String>Context.Service. getEncryptionOptions()Encryption options available for both phases of the negotiation process.List<Subnet>Context.Service. getInternalSubnets()Private subnets that can be accessed through the network tunnel.List<Long>Context.Service. getKeylifeLimits()The keylife limits.ContextContext.Service. getObject()getObject retrieves the SoftLayer_Network_Tunnel_Module_Context object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Network_Tunnel_Module_Context service.StringContext.Service. getParameterConfigurationsForCustomerView()All of the IPSec VPN tunnel's configurations will be returned.StringContext.Service. getPhaseOneKeylifeDefault()The default phase 1 keylife used if a value is not provided.StringContext.Service. getPhaseTwoKeylifeDefault()The default phase 2 keylife used if a value is not provided.List<Subnet>Context.Service. getServiceSubnets()Service subnets that can be access through the network tunnel.List<Subnet>Context.Service. getStaticRouteSubnets()Subnets used for a network tunnel's address translations.List<Transaction>Context.Service. getTransactionHistory()DEPRECATEDBooleanContext.Service. removeCustomerSubnetFromNetworkTunnel(Long subnetId)Disassociate a customer subnet (remote) from a network tunnel.BooleanContext.Service. removePrivateSubnetFromNetworkTunnel(Long subnetId)Disassociate a private subnet from a network tunnel.BooleanContext.Service. removeServiceSubnetFromNetworkTunnel(Long subnetId)Disassociate a service subnet from a network tunnel. -
Uses of ApiMethod in com.softlayer.api.service.network.vlan
Methods in com.softlayer.api.service.network.vlan with annotations of type ApiMethod Modifier and Type Method Description VoidFirewall.Service. approveBypassRequest()Approve a request from technical support to bypass the firewall.LongFirewall.Service. getAccountId()BigDecimalFirewall.Service. getBandwidthAllocation()A firewall's allotted bandwidth (measured in GB).List<Usage>Firewall.Service. getBillingCycleBandwidthUsage()The raw bandwidth usage data for the current billing cycle.UsageFirewall.Service. getBillingCyclePrivateBandwidthUsage()The raw private bandwidth usage data for the current billing cycle.UsageFirewall.Service. getBillingCyclePublicBandwidthUsage()The raw public bandwidth usage data for the current billing cycle.ItemFirewall.Service. getBillingItem()The billing item for a Hardware Firewall (Dedicated).StringFirewall.Service. getBypassRequestStatus()Administrative bypass request status.LocationFirewall.Service. getDatacenter()The datacenter that the firewall resides in.StringFirewall.Service. getFirewallFirmwareVersion()Retrieve the firewall device firmware version from database.StringFirewall.Service. getFirewallType()The firewall device type.StringFirewall.Service. getFullyQualifiedDomainName()A name reflecting the hostname and domain of the firewall.PasswordFirewall.Service. getManagementCredentials()The credentials to log in to a firewall device.ObjectFirewall.Service. getMetricTrackingObject()A firewall's metric tracking object.LongFirewall.Service. getMetricTrackingObjectId()The metric tracking object ID for this firewall.List<Request>Firewall.Service. getNetworkFirewallUpdateRequests()The update requests made for this firewall.GatewayFirewall.Service. getNetworkGateway()The gateway associated with this firewall, if any.VlanFirewall.Service. getNetworkVlan()The VLAN object that a firewall is associated with and protecting.List<Vlan>Firewall.Service. getNetworkVlans()The VLAN objects that a firewall is associated with and protecting.FirewallFirewall.Service. getObject()getObject returns a SoftLayer_Network_Vlan_Firewall object.TypeType.Service. getObject()List<Rule>Firewall.Service. getRules()The currently running rule set of this network component firewall.List<Reference>Firewall.Service. getTagReferences()RequestFirewall.Service. getUpgradeRequest()A firewall's associated upgrade request object, if any.BooleanFirewall.Service. hasActiveTransactions()Check for active transactions for the Firewall.BooleanFirewall.Service. isAccountAllowed()Checks if the account is allowed to use some features of FSA1G and Hardware firewall (Dedicated)BooleanFirewall.Service. isHighAvailabilityUpgradeAvailable()Whether this firewall qualifies for High Availability upgrade.VoidFirewall.Service. rejectBypassRequest()Reject a request from technical support to bypass the firewall.TransactionFirewall.Service. restoreDefaults()This will completely reset the firewall to factory settings.BooleanFirewall.Service. setTags(String tags)This method will associate a comma separated list of tags with this object.TransactionFirewall.Service. updateRouteBypass(Boolean bypass)Enable or disable route bypass for this context. -
Uses of ApiMethod in com.softlayer.api.service.notification
Methods in com.softlayer.api.service.notification with annotations of type ApiMethod Modifier and Type Method Description BooleanMobile.Service. createSubscriberForMobileDevice(String keyName, Long resourceTableId, Long userRecordId)Create a new subscriber for a given resource.MobileMobile.Service. getObjectForMobile() -
Uses of ApiMethod in com.softlayer.api.service.notification.occurrence
Methods in com.softlayer.api.service.notification.occurrence with annotations of type ApiMethod Modifier and Type Method Description BooleanUser.Service. acknowledge()BooleanEvent.Service. acknowledgeNotification()<<<< EOTBooleanEvent.Service. getAcknowledgedFlag()Indicates whether or not this event has been acknowledged by the user.List<Event>Event.Service. getAllObjects()List<User>User.Service. getAllObjects()byte[]Event.Service. getAttachedFile(Long attachmentId)Retrieve the contents of the file attached to a SoftLayer event by it's given identifier.List<Attachment>Event.Service. getAttachments()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.UpdateEvent.Service. getFirstUpdate()The first update for this event.LongEvent.Service. getImpactedAccountCount()This method will return the number of impacted owned accounts associated with this event for the current user.List<Account>Event.Service. getImpactedAccounts()A collection of accounts impacted by this event.LongEvent.Service. getImpactedDeviceCount()This method will return the number of impacted devices associated with this event for the current user.LongUser.Service. getImpactedDeviceCount()List<Resource>Event.Service. getImpactedDevices()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.List<Resource>Event.Service. getImpactedResources()A collection of resources impacted by this event.List<Resource>User.Service. getImpactedResources()A collection of resources impacted by the associated event.List<User>Event.Service. getImpactedUsers()A collection of users impacted by this event.UpdateEvent.Service. getLastUpdate()The last update for this event.EventUser.Service. getNotificationOccurrenceEvent()The associated event.TypeEvent.Service. getNotificationOccurrenceEventType()The type of event such as planned or unplanned maintenance.EventEvent.Service. getObject()UserUser.Service. getObject()CodeEvent.Service. getStatusCode()List<Update>Event.Service. getUpdates()All updates for this event.CustomerUser.Service. getUser()The impacted user. -
Uses of ApiMethod in com.softlayer.api.service.notification.user
Methods in com.softlayer.api.service.notification.user with annotations of type ApiMethod Modifier and Type Method Description BooleanSubscriber.Service. createObject(Subscriber templateObject)Use the method to create a new subscription for a notification.BooleanSubscriber.Service. editObject(Subscriber templateObject)The subscriber's subscription status can be "turned off" or "turned on" if the subscription is not required.List<Method>Subscriber.Service. getDeliveryMethods()The delivery methods used to send the subscribed notification.NotificationSubscriber.Service. getNotification()Notification subscribed to.SubscriberSubscriber.Service. getObject()List<Preference>Subscriber.Service. getPreferences()Associated subscriber preferences used for the notification subscription.List<Preference>Subscriber.Service. getPreferencesDetails()Preference details such as description, minimum and maximum limits, default value and unit of measure.ResourceSubscriber.Service. getResourceRecord()The subscriber id to resource id mapping.CustomerSubscriber.Service. getUserRecord()User record for the subscription. -
Uses of ApiMethod in com.softlayer.api.service.notification.user.subscriber
Methods in com.softlayer.api.service.notification.user.subscriber with annotations of type ApiMethod Modifier and Type Method Description BooleanMobile.Service. clearSnoozeTimer()BooleanPreference.Service. createObject(Preference templateObject)Use the method to create a new notification preference for a subscriberBooleanPreference.Service. editObjects(List<Preference> templateObjects)PreferencePreference.Service. getDefaultPreference()Details such name, keyname, minimum and maximum values for the preference.SubscriberPreference.Service. getNotificationUserSubscriber()Details of the subscriber tied to the preference.PreferencePreference.Service. getObject()BillingBilling.Service. getObjectForBilling()MobileMobile.Service. getObjectForMobile()BooleanMobile.Service. setSnoozeTimer(Long start, Long end) -
Uses of ApiMethod in com.softlayer.api.service.product
Methods in com.softlayer.api.service.product with annotations of type ApiMethod Modifier and Type Method Description BooleanOrder.Service. checkItemAvailability(List<Price> itemPrices, Long accountId, List<String> availabilityTypeKeyNames)BooleanOrder.Service. checkItemAvailabilityForImageTemplate(Long imageTemplateId, Long accountId, Long packageId, List<String> availabilityTypeKeyNames)BooleanOrder.Service. checkItemConflicts(List<Price> itemPrices)Check order items for conflictsPromotionPromotion.Service. findByPromoCode(String code)Retrieves a promotion using its code.List<Preset>Package.Service. getAccountRestrictedActivePresets()The preset configurations available only for the authenticated account and this package.List<Category>Package.Service. getAccountRestrictedCategories()The results from this call are similar to [[SoftLayer_Product_Package/getCategories|getCategories]], but these ONLY include account-restricted prices.BooleanPackage.Service. getAccountRestrictedPricesFlag()The flag to indicate if there are any restricted prices in a package for the currently-active account.List<Item>Package.Service. getActiveItems()Return a list of Items in the package with their active prices.List<Package>Package.Service. getActivePackagesByAttribute(String attributeKeyName)Deprecated.List<Preset>Package.Service. getActivePresets()The available preset configurations for this package.List<Package>Package.Service. getActivePrivateHostedCloudPackages()Deprecated.List<Item>Package.Service. getActiveRamItems()A collection of valid RAM items available for purchase in this package.List<Item>Package.Service. getActiveServerItems()A collection of valid server items available for purchase in this package.List<Item>Package.Service. getActiveSoftwareItems()A collection of valid software items available for purchase in this package.List<Price>Package.Service. getActiveUsagePrices()A collection of [[SoftLayer_Product_Item_Price]] objects for pay-as-you-go usage.List<Price>Package.Service. getActiveUsageRatePrices(Long locationId, String categoryCode)This method returns a collection of active usage rate [[SoftLayer_Product_Item_Price]] objects for the current package and specified datacenter.BooleanPackage.Service. getAdditionalServiceFlag()This flag indicates that the package is an additional service.List<Package>Package.Service. getAllObjects()This method pulls all the active packages.List<Attribute>Package.Service. getAttributes()List<Locations>Package.Service. getAvailableLocations()A collection of valid locations for this package.List<Package>Package.Service. getAvailablePackagesForImageTemplate(Group imageTemplate)LongPackage.Service. getAvailableStorageUnits()The maximum number of available disk storage units associated with the servers in a package.List<Category>Package.Service. getCategories()This is a collection of categories ([[SoftLayer_Product_Item_Category]]) associated with a package which can be used for ordering.List<Item>Package.Service. getCdnItems()List<Item>Package.Service. getCloudStorageItems(Long provider)List<Configuration>Package.Service. getConfiguration()The item categories associated with a package, including information detailing which item categories are required as part of a SoftLayer product order.StringPackage.Service. getDefaultBootCategoryCode()The default boot category code for the package.List<Item>Package.Service. getDefaultRamItems()A collection of valid RAM items available for purchase in this package.StringPackage.Service. getDeploymentNodeType()The node type for a package in a solution deployment.List<Package>Package.Service. getDeploymentPackages()The packages that are allowed in a multi-server solution.List<Package>Package.Service. getDeployments()The package that represents a multi-server solution.StringPackage.Service. getDeploymentType()The solution deployment type.BooleanPackage.Service. getDisallowCustomDiskPartitions()This flag indicates the package does not allow custom disk partitions.ReceiptOrder.Service. getExternalPaymentAuthorizationReceipt(String token, String payerId)This method simply returns a receipt for a previously finalized payment authorization from PayPal.StepPackage.Service. getFirstOrderStep()The Softlayer order step is optionally step-based.BooleanPackage.Service. getGatewayApplianceFlag()Whether the package is a specialized network gateway appliance package.BooleanPackage.Service. getGpuFlag()This flag indicates that the package supports GPUs.BooleanPackage.Service. getHourlyBillingAvailableFlag()Determines whether the package contains prices that can be ordered hourly.BooleanPackage.Service. getHourlyOnlyOrders()Packages with this flag do not allow monthly orders.List<Type>Package.Service. getItemAvailabilityTypes()Returns a collection of SoftLayer_Product_Item_Attribute_Type objects.List<Conflict>Package.Service. getItemConflicts()The item-item conflicts associated with a package.List<Conflict>Package.Service. getItemLocationConflicts()The item-location conflicts associated with a package.List<Prices>Package.Service. getItemPriceReferences()cross reference for item pricesList<Price>Package.Service. getItemPrices()A collection of SoftLayer_Product_Item_Prices that are valid for this package.List<Price>Package.Service. getItemPricesFromSoftwareDescriptions(List<Description> softwareDescriptions, Boolean includeTranslationsFlag, Boolean returnAllPricesFlag)Return a collection of SoftLayer_Item_Price objects from a collection of SoftLayer_Software_DescriptionList<Item>Package.Service. getItems()A collection of valid items available for purchase in this package.List<Item>Package.Service. getItemsFromImageTemplate(Group imageTemplate)Return a collection of [[SoftLayer_Product_Item]] objects from a [[SoftLayer_Virtual_Guest_Block_Device_Template_Group]] objectList<Location>Package.Service. getLocations()A collection of valid locations for this package.PricePackage.Service. getLowestServerPrice()The lowest server [[SoftLayer_Product_Item_Price]] related to this package.LongPackage.Service. getMaximumPortSpeed()The maximum available network speed associated with the package.List<Item>Package.Service. getMessageQueueItems()LongPackage.Service. getMinimumPortSpeed()The minimum available network speed associated with the package.BooleanPackage.Service. getMongoDbEngineeredFlag()This flag indicates that this is a MongoDB engineered package.List<Network>Order.Service. getNetworks(Long locationId, Long packageId, Long accountId)Deprecated.BooleanPackage.Service. getNonEuCompliantFlag()Whether the package is not in compliance with EU support.BooleanPackage.Service. getNoUpgradesFlag()Services ordered from this package cannot have upgrades or downgrades performed.PackagePackage.Service. getObject()PromotionPromotion.Service. getObject()List<Datacenter>Package.Service. getObjectStorageDatacenters()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.List<LocationGroup>Package.Service. getObjectStorageLocationGroups()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.List<Premium>Package.Service. getOrderPremiums()The premium price modifiers associated with the [[SoftLayer_Product_Item_Price]] and [[SoftLayer_Location]] objects in a package.BooleanPackage.Service. getPopLocationAvailabilityFlag()This flag indicates if the package may be available in PoP locations in addition to Datacenters.BooleanPackage.Service. getPreconfiguredFlag()This flag indicates the package is pre-configured.BooleanPackage.Service. getPresetConfigurationRequiredFlag()Whether the package requires the user to define a preset configuration.BooleanPackage.Service. getPreventVlanSelectionFlag()Whether the package prevents the user from specifying a Vlan.BooleanPackage.Service. getPrivateHostedCloudPackageFlag()This flag indicates the package is for a private hosted cloud deployment.StringPackage.Service. getPrivateHostedCloudPackageType()The server role of the private hosted cloud deployment.BooleanPackage.Service. getPrivateNetworkOnlyFlag()Whether the package only has access to the private network.BooleanPackage.Service. getQuantaStorPackageFlag()Whether the package is a specialized mass storage QuantaStor package.BooleanPackage.Service. getRaidDiskRestrictionFlag()This flag indicates the package does not allow different disks with RAID.BooleanPackage.Service. getRedundantPowerFlag()This flag determines if the package contains a redundant power supply product.List<Region>Package.Service. getRegions()The regional locations that a package is available in.OrderOrder.Service. getResellerOrder(Order orderContainer)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.TemplatePackage.Service. getResourceGroupTemplate()The resource group template that describes a multi-server solution.List<Category>Package.Service. getStandardCategories()This call is similar to [[SoftLayer_Product_Package/getCategories|getCategories]], except that it does not include account-restricted pricing.CacheOrder.Service. getTaxCalculationResult(String orderHash)Sometimes taxes cannot be calculated immediately, so we start the calculations and let them run in the background.StringPackage.Service. getTopLevelItemCategoryCode()The top level category code for this service offering.TypePackage.Service. getType()The type of service offering.VlansOrder.Service. getVlans(Long locationId, Long packageId, String selectedItems, List<Long> vlanIds, List<Long> subnetIds, Long accountId, Order orderContainer, Boolean hardwareFirewallOrderedFlag)Return collections of public and private VLANs that are available during ordering.ReceiptOrder.Service. placeOrder(Order orderData, Boolean saveAsQuote)
Use this method to place bare metal server, virtual server and additional service orders with SoftLayer.ReceiptOrder.Service. placeQuote(Order orderData)Use this method for placing server quotes and additional services quotes.OrderOrder.Service. processExternalPaymentAuthorization(String token, String payerId)This method simply finalizes an authorization from PayPal.List<Item>Order.Service. requiredItems(List<Price> itemPrices)Get list of items that are required with the item prices providedOrderOrder.Service. verifyOrder(Order orderData)This service is used to verify that an order meets all the necessary requirements to purchase a server, virtual server or service from SoftLayer. -
Uses of ApiMethod in com.softlayer.api.service.product.item
Methods in com.softlayer.api.service.product.item with annotations of type ApiMethod Modifier and Type Method Description List<Restriction>Price.Service. getAccountRestrictions()The account that the item price is restricted to.List<Item>Category.Service. getAdditionalProductsForCategory()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.List<Attribute>Price.Service. getAttributes()List<Category>Category.Service. getBandwidthCategories()BooleanPrice.Service. getBareMetalReservedCapacityFlag()Signifies pricing that is only available on a bare metal reserved capacity order.BooleanPrice.Service. getBigDataOsJournalDiskFlag()Whether the price is for Big Data OS/Journal disks only.List<Item>Category.Service. getBillingItems()The billing items associated with an account that share a category code with an item category's category code.List<Bundles>Price.Service. getBundleReferences()cross reference for bundlesStringPrice.Service. getCapacityRestrictionMaximum()The maximum capacity value for which this price is suitable.StringPrice.Service. getCapacityRestrictionMinimum()The minimum capacity value for which this price is suitable.StringPrice.Service. getCapacityRestrictionType()The type of capacity restriction by which this price must abide.List<Category>Price.Service. getCategories()All categories which this item is a member.List<Category>Category.Service. getComputingCategories(Boolean resetCache)This method returns a collection of computing categories.List<Category>Category.Service. getCustomUsageRatesCategories(Boolean resetCache)BooleanPrice.Service. getDedicatedHostInstanceFlag()Signifies pricing that is only available on a dedicated host virtual server order.BooleanPrice.Service. getDefinedSoftwareLicenseFlag()Whether this price defines a software license for its product item.StringPrice.Service. getEligibilityStrategy()Eligibility strategy to assess if a customer can order using this price.List<Category>Category.Service. getExternalResourceCategories()GroupCategory.Service. getGroup()This invoice item's "item category group".List<Group>Category.Service. getGroups()A collection of service offering category groups.ItemPrice.Service. getItem()The product item a price is tied to.CategoryCategory.Service. getObject()Each product item price must be tied to a category for it to be sold.PricePrice.Service. getObject()List<Category>Category.Service. getObjectStorageCategories(Boolean resetCache)List<Type>Category.Service. getOrderOptions()Any unique options associated with an item category.List<Premium>Price.Service. getOrderPremiums()List<Configuration>Category.Service. getPackageConfigurations()A list of configuration available in this category.'List<Prices>Price.Service. getPackageReferences()cross reference for packagesList<Package>Price.Service. getPackages()A price's packages under which this item is sold.List<Configuration>Category.Service. getPresetConfigurations()A list of preset configurations this category is used in.'List<Configuration>Price.Service. getPresetConfigurations()A list of preset configurations this price is used in.'StringPrice.Service. getPriceType()The type keyname of this price which can be STANDARD, TIERED, or TERM.PricingPrice.Service. getPricingLocationGroup()The pricing location group that this price is applicable for.List<Xref>Category.Service. getQuestionReferences()The question references that are associated with an item category.List<Question>Category.Service. getQuestions()The questions that are associated with an item category.LongPrice.Service. getRequiredCoreCount()The number of server cores required to order this item.BooleanPrice.Service. getReservedCapacityInstanceFlag()Signifies pricing that is only available on a reserved capacity virtual server order.List<Category>Category.Service. getSoftwareCategories()List<Category>Category.Service. getSubnetCategories()This method returns a list of subnet categories.List<Category>Category.Service. getTopLevelCategories(Boolean resetCache)This method returns a collection of computing categories.List<Price>Price.Service. getUsageRatePrices(Location location, List<Item> items)Returns a collection of rate-based [[SoftLayer_Product_Item_Price]] objects associated with the [[SoftLayer_Product_Item]] objects and the [[SoftLayer_Location]] specified.List<Category>Category.Service. getValidCancelableServiceItemCategories()This method returns service product categories that can be canceled via API.List<Category>Category.Service. getVlanCategories() -
Uses of ApiMethod in com.softlayer.api.service.product.item.category
Methods in com.softlayer.api.service.product.item.category with annotations of type ApiMethod Modifier and Type Method Description GroupGroup.Service. getObject()Each product item category must be tied to a category group. -
Uses of ApiMethod in com.softlayer.api.service.product.item.policy
Methods in com.softlayer.api.service.product.item.policy with annotations of type ApiMethod Modifier and Type Method Description BooleanAssignment.Service. acceptFromTicket(Long ticketId)Register the acceptance of the associated policy to product assignment, and link the created record to a Ticket.AssignmentAssignment.Service. getObject()byte[]Assignment.Service. getPolicyDocumentContents()Retrieve the binary contents of the associated PDF policy document.StringAssignment.Service. getPolicyName()The name of the assigned policy.ItemAssignment.Service. getProduct()The [[SoftLayer_Product_Item]] for this policy assignment. -
Uses of ApiMethod in com.softlayer.api.service.product.item.price
Methods in com.softlayer.api.service.product.item.price with annotations of type ApiMethod Modifier and Type Method Description PricePremium.Service. getItemPrice()LocationPremium.Service. getLocation()PremiumPremium.Service. getObject()PackagePremium.Service. getPremiumPackage() -
Uses of ApiMethod in com.softlayer.api.service.product.pkg
Methods in com.softlayer.api.service.product.pkg with annotations of type ApiMethod Modifier and Type Method Description List<Preset>Preset.Service. getAllObjects()This method returns all the active package presets.List<Server>Server.Service. getAllObjects()This method will grab all the package servers.List<Type>Type.Service. getAllObjects()This method will return all of the available package types.LongPreset.Service. getAvailableStorageUnits()BooleanPreset.Service. getBareMetalReservedFlag()When true this preset is for ordering a Bare Metal Reserved server.CatalogServer.Service. getCatalog()List<Category>Preset.Service. getCategories()The item categories that are included in this package preset configuration.GroupPreset.Service. getComputeGroup()The compute family this configuration belongs to.List<Configuration>Preset.Service. getConfiguration()The preset configuration (category and price).BooleanPreset.Service. getDisallowedComputeGroupUpgradeFlag()When true this preset is only allowed to upgrade/downgrade to other presets in the same compute family.BooleanPreset.Service. getFixedConfigurationFlag()A package preset with this flag set will not allow the price's defined in the preset configuration to be overriden during order placement.ItemServer.Service. getItem()PriceServer.Service. getItemPrice()List<Location>Preset.Service. getLocations()The locations this preset configuration is available in.PricePreset.Service. getLowestPresetServerPrice()The lowest server prices related to this package preset.PresetPreset.Service. getObject()ServerServer.Service. getObject()TypeType.Service. getObject()List<Configuration>Preset.Service. getPackageConfiguration()The item categories associated with a package preset, including information detailing which item categories are required as part of a SoftLayer product order.List<Package>Type.Service. getPackages()All the packages associated with the given package type.PresetServer.Service. getPreset()PackagePreset.Service. getPresetPackage()The package this preset belongs to.List<Price>Preset.Service. getPrices()The item prices that are included in this package preset configuration.PackageServer.Service. getServerPackage()List<Group>Preset.Service. getStorageGroupTemplateArrays()Describes how all disks in this preset will be configured.BigDecimalPreset.Service. getTotalMinimumHourlyFee()The starting hourly price for this configuration.BigDecimalPreset.Service. getTotalMinimumRecurringFee()The starting monthly price for this configuration. -
Uses of ApiMethod in com.softlayer.api.service.product.pkg.server
Methods in com.softlayer.api.service.product.pkg.server with annotations of type ApiMethod Modifier and Type Method Description List<Option>Option.Service. getAllOptions()This method will grab all the package server options.OptionOption.Service. getObject()List<Option>Option.Service. getOptions(String type)This method will grab all the package server options for the specified type. -
Uses of ApiMethod in com.softlayer.api.service.product.upgrade
Methods in com.softlayer.api.service.product.upgrade with annotations of type ApiMethod Modifier and Type Method Description BooleanRequest.Service. approveChanges()When a change is made to an upgrade by Sales, this method will approve the changes that were made.AccountRequest.Service. getAccount()The account that an order belongs toBooleanRequest.Service. getCompletedFlag()Indicates that the upgrade request has completed or has been cancelled.InvoiceRequest.Service. getInvoice()This is the invoice associated with the upgrade request.RequestRequest.Service. getObject()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.OrderRequest.Service. getOrder()An order record associated to the upgrade requestHardwareRequest.Service. getServer()A server object associated with the upgrade request if any.StatusRequest.Service. getStatus()The current status of the upgrade request.TicketRequest.Service. getTicket()The ticket that is used to coordinate the upgrade process.CustomerRequest.Service. getUser()The user that placed the order.GuestRequest.Service. getVirtualGuest()A virtual server object associated with the upgrade request if any.BooleanRequest.Service. updateMaintenanceWindow(GregorianCalendar maintenanceStartTime, Long maintenanceWindowId)In case an upgrade cannot be performed, the maintenance window needs to be updated to a future date. -
Uses of ApiMethod in com.softlayer.api.service.provisioning
Methods in com.softlayer.api.service.provisioning with annotations of type ApiMethod Modifier and Type Method Description HookHook.Service. createObject(Hook templateObject)BooleanHook.Service. deleteObject()BooleanHook.Service. editObject(Hook templateObject)AccountHook.Service. getAccount()TypeHook.Service. getHookType()HookHook.Service. getObject() -
Uses of ApiMethod in com.softlayer.api.service.provisioning.hook
Methods in com.softlayer.api.service.provisioning.hook with annotations of type ApiMethod Modifier and Type Method Description List<Type>Type.Service. getAllHookTypes()TypeType.Service. getObject() -
Uses of ApiMethod in com.softlayer.api.service.provisioning.maintenance
Methods in com.softlayer.api.service.provisioning.maintenance with annotations of type ApiMethod Modifier and Type Method Description BooleanWindow.Service. addCustomerUpgradeWindow(Window customerUpgradeWindow)getMaintenceWindowForTicket() returns a booleanSlotsTicket.Service. getAvailableSlots()List<Category>Classification.Service. getItemCategories()ClassificationTicket.Service. getMaintenanceClass()List<Classification>Classification.Service. getMaintenanceClassification(Long maintenanceClassificationId)Retrieve an array of SoftLayer_Provisioning_Maintenance_Classification data types, which contain all maintenance classifications.List<Classification>Window.Service. getMaintenanceClassifications()getMaintenanceClassifications() returns an object of maintenance classificationsList<Category>Classification.Service. getMaintenanceClassificationsByItemCategory()Retrieve an array of SoftLayer_Provisioning_Maintenance_Classification data types, which contain all maintenance classifications.WindowWindow.Service. getMaintenanceStartEndTime(Long ticketId)getMaintenanceStartEndTime() returns a specific maintenance windowList<Window>Window.Service. getMaintenanceWindowForTicket(Long maintenanceWindowId)getMaintenceWindowForTicket() returns a specific maintenance windowList<Window>Window.Service. getMaintenanceWindows(GregorianCalendar beginDate, GregorianCalendar endDate, Long locationId, Long slotsNeeded)This method returns a list of available maintenance windowsList<Ticket>Window.Service. getMaintenanceWindowTicketsByTicketId(Long ticketId)getMaintenanceWindowTicketsByTicketId() returns a list maintenance window ticket records by ticket idList<Window>Window.Service. getMaintenceWindows(GregorianCalendar beginDate, GregorianCalendar endDate, Long locationId, Long slotsNeeded)(DEPRECATED) Use [[SoftLayer_Provisioning_Maintenance_Window::getMaintenanceWindows|getMaintenanceWindows]] method.ClassificationClassification.Service. getObject()SlotsSlots.Service. getObject()TicketTicket.Service. getObject()TicketTicket.Service. getTicket()BooleanWindow.Service. updateCustomerUpgradeWindow(GregorianCalendar maintenanceStartTime, Long newMaintenanceWindowId, Long ticketId)getMaintenceWindowForTicket() returns a boolean -
Uses of ApiMethod in com.softlayer.api.service.provisioning.maintenance.classification.item
Methods in com.softlayer.api.service.provisioning.maintenance.classification.item with annotations of type ApiMethod Modifier and Type Method Description ClassificationCategory.Service. getMaintenanceClassification()CategoryCategory.Service. getObject() -
Uses of ApiMethod in com.softlayer.api.service.provisioning.version1.transaction
Methods in com.softlayer.api.service.provisioning.version1.transaction with annotations of type ApiMethod Modifier and Type Method Description List<Group>Group.Service. getAllObjects()GroupGroup.Service. getObject()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. -
Uses of ApiMethod in com.softlayer.api.service.resource
Methods in com.softlayer.api.service.resource with annotations of type ApiMethod Modifier and Type Method Description BooleanGroup.Service. editObject(Group templateObject)LongMetadata.Service. getAccountId()The getAccountId retrieves the ID for the account on which the resource is located.List<Group>Group.Service. getAncestorGroups()A resource group's associated group ancestors.List<Attribute>Group.Service. getAttributes()A resource group's associated attributes.List<String>Metadata.Service. getBackendMacAddresses()The getBackendMacAddresses method retrieves a list of backend MAC addresses for the resourceStringMetadata.Service. getDatacenter()The getDatacenter method retrieves the name of the datacenter in which the resource is located.LongMetadata.Service. getDatacenterId()The getDatacenterId retrieves the ID for the datacenter in which the resource is located.StringMetadata.Service. getDomain()The getDomain method retrieves the hostname for the resource.List<String>Metadata.Service. getFrontendMacAddresses()The getFrontendMacAddresses method retrieves a list of frontend MAC addresses for the resourceStringMetadata.Service. getFullyQualifiedDomainName()The getFullyQualifiedDomainName method provides the user with a combined return which includes the hostname and domain for the resource.StringMetadata.Service. getGlobalIdentifier()The getId getGlobalIdentifier retrieves the globalIdentifier for the resourceList<Member>Group.Service. getHardwareMembers()A resource group's associated hardware members.StringMetadata.Service. getHostname()The getHostname method retrieves the hostname for the resource.LongMetadata.Service. getId()The getId method retrieves the ID for the resourceList<Member>Group.Service. getMembers()A resource group's associated members.GroupGroup.Service. getObject()StringMetadata.Service. getPrimaryBackendIpAddress()The getPrimaryBackendIpAddress method retrieves the primary backend IP address for the resourceStringMetadata.Service. getPrimaryIpAddress()The getPrimaryIpAddress method retrieves the primary IP address for the resource.StringMetadata.Service. getProvisionState()The getProvisionState method retrieves the provision state of the resource.GroupGroup.Service. getRootResourceGroup()A resource group's associated root resource group.StringMetadata.Service. getRouter(String macAddress)The getRouter method will return the router associated with a network component.StringMetadata.Service. getServiceResource(String serviceName, Long index)The getServiceResource method retrieves a specific service resource associated with the resource.List<ServiceResource>Metadata.Service. getServiceResources()The getServiceResources method retrieves all service resources associated with the resource.List<Member>Group.Service. getSubnetMembers()A resource group's associated subnet members.List<String>Metadata.Service. getTags()The getTags method retrieves all tags associated with the resource.TemplateGroup.Service. getTemplate()A resource group's associated template.StringMetadata.Service. getUserMetadata()The getUserMetadata method retrieves metadata completed by users who interact with the resource.List<Long>Metadata.Service. getVlanIds(String macAddress)The getVlanIds method returns a list of VLAN IDs for the network component matching the provided MAC address associated with the resource.List<Member>Group.Service. getVlanMembers()A resource group's associated VLAN members.List<Long>Metadata.Service. getVlans(String macAddress)The getVlans method returns a list of VLAN numbers for the network component matching the provided MAC address associated with the resource.BooleanConfiguration.Service. setOsPasswordFromEncrypted(String encryptedPassword)The setOsPasswordFromEncrypted method is used to set the operating system password from a key/pair encrypted password signed by SoftLayer. -
Uses of ApiMethod in com.softlayer.api.service.resource.group
Methods in com.softlayer.api.service.resource.group with annotations of type ApiMethod Modifier and Type Method Description List<Template>Template.Service. getAllObjects()List<Template>Template.Service. getChildren()List<Member>Template.Service. getMembers()TemplateTemplate.Service. getObject()PackageTemplate.Service. getTemplatePackage() -
Uses of ApiMethod in com.softlayer.api.service.sales.presale
Methods in com.softlayer.api.service.sales.presale with annotations of type ApiMethod Modifier and Type Method Description BooleanEvent.Service. getActiveFlag()A flag to indicate that the presale event is currently active.List<Event>Event.Service. getAllObjects()BooleanEvent.Service. getExpiredFlag()A flag to indicate that the presale event is expired.ItemEvent.Service. getItem()The [[SoftLayer_Product_Item]] associated with the presale event.LocationEvent.Service. getLocation()The [[SoftLayer_Location]] associated with the presale event.EventEvent.Service. getObject()'''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.List<Order>Event.Service. getOrders()The orders ([[SoftLayer_Billing_Order]]) associated with this presale event that were created for the customer's account. -
Uses of ApiMethod in com.softlayer.api.service.scale
Methods in com.softlayer.api.service.scale with annotations of type ApiMethod Modifier and Type Method Description GroupGroup.Service. createObject(Group templateObject)Create a scale group.LoadBalancerLoadBalancer.Service. createObject(LoadBalancer templateObject)Create a load balancer for a scale group.PolicyPolicy.Service. createObject(Policy templateObject)BooleanAsset.Service. deleteObject()BooleanGroup.Service. deleteObject()Delete this group.BooleanLoadBalancer.Service. deleteObject()Delete this load balancer configuration.BooleanMember.Service. deleteObject()BooleanPolicy.Service. deleteObject()BooleanGroup.Service. editObject(Group templateObject)Edit this group.BooleanLoadBalancer.Service. editObject(LoadBalancer templateObject)Edit this load balancer configuration.BooleanPolicy.Service. editObject(Policy templateObject)BooleanGroup.Service. forceDeleteObject()AccountGroup.Service. getAccount()The account for this scaling group.List<Action>Policy.Service. getActions()The actions to perform upon any trigger hit.LongLoadBalancer.Service. getAllocationPercent()The percentage of connections allocated to this virtual server.LongGroup.Service. getAvailableHourlyInstanceLimit()This returns the number of hourly instances an account can add from this point.List<Group>Group.Service. getAvailableRegionalGroups()CheckLoadBalancer.Service. getHealthCheck()The health check for this configuration.List<LoadBalancer>Group.Service. getLoadBalancers()Collection of load balancers for this auto scale group.List<Log>Group.Service. getLogs()Collection of log entries for this group.List<Vlan>Group.Service. getNetworkVlans()Collection of VLANs for this auto scale group.AssetAsset.Service. getObject()GroupGroup.Service. getObject()LoadBalancerLoadBalancer.Service. getObject()MemberMember.Service. getObject()PolicyPolicy.Service. getObject()List<OneTime>Policy.Service. getOneTimeTriggers()The one-time triggers to check for this group.List<Policy>Group.Service. getPolicies()Collection of policies for this group.RegionalGroup.Service. getRegionalGroup()The regional group for this scale group.List<Repeating>Policy.Service. getRepeatingTriggers()The repeating triggers to check for this group.List<ResourceUse>Policy.Service. getResourceUseTriggers()The resource-use triggers to check for this group.MethodLoadBalancer.Service. getRoutingMethod()The routing method.TypeLoadBalancer.Service. getRoutingType()The routing type.List<Scale>Policy.Service. getScaleActions()The scale actions to perform upon any trigger hit.GroupAsset.Service. getScaleGroup()The group this asset belongs to.GroupLoadBalancer.Service. getScaleGroup()The group this load balancer configuration is for.GroupMember.Service. getScaleGroup()The group this member belongs to.GroupPolicy.Service. getScaleGroup()The group this policy is on.StatusGroup.Service. getStatus()The status for this scale group.PolicyGroup.Service. getTerminationPolicy()The termination policy for this scaling group.List<Trigger>Policy.Service. getTriggers()The triggers to check for this group.List<Guest>Group.Service. getVirtualGuestAssets()Collection of guests that have been pinned to this group.List<Guest>Group.Service. getVirtualGuestMembers()Collection of guests that have been scaled with the group.LongLoadBalancer.Service. getVirtualIpAddressId()The ID of the virtual IP address.VirtualServerLoadBalancer.Service. getVirtualServer()The virtual server for this configuration.LongLoadBalancer.Service. getVirtualServerPort()The port on the virtual server.VoidGroup.Service. resume()Resume this group.List<Member>Group.Service. scale(Long delta)Scale this group up or down by the amount given.List<Member>Group.Service. scaleTo(Long number)Scale this group up or down to the number given.VoidGroup.Service. suspend()Suspend this group.List<Member>Policy.Service. trigger()Manually trigger the actions on this policy. -
Uses of ApiMethod in com.softlayer.api.service.scale.asset
Methods in com.softlayer.api.service.scale.asset with annotations of type ApiMethod Modifier and Type Method Description HardwareHardware.Service. createObject(Hardware templateObject)HardwareHardware.Service. getHardware()The hardware for this asset.LongHardware.Service. getHardwareId()The identifier of the hardware for this asset.HardwareHardware.Service. getObjectForHardware() -
Uses of ApiMethod in com.softlayer.api.service.scale.asset.virtual
Methods in com.softlayer.api.service.scale.asset.virtual with annotations of type ApiMethod Modifier and Type Method Description GuestGuest.Service. createObject(Guest templateObject)GuestGuest.Service. getObjectForGuest()GuestGuest.Service. getVirtualGuest()The guest for this asset.LongGuest.Service. getVirtualGuestId()The identifier of the guest for this asset. -
Uses of ApiMethod in com.softlayer.api.service.scale.group
Methods in com.softlayer.api.service.scale.group with annotations of type ApiMethod Modifier and Type Method Description List<Status>Status.Service. getAllObjects()StatusStatus.Service. getObject() -
Uses of ApiMethod in com.softlayer.api.service.scale.member.virtual
Methods in com.softlayer.api.service.scale.member.virtual with annotations of type ApiMethod Modifier and Type Method Description BooleanGuest.Service. deleteObjectForGuest()Delete this group member.GuestGuest.Service. getObjectForGuest()GuestGuest.Service. getVirtualGuest()The guest for this member.LongGuest.Service. getVirtualGuestId()The identifier of the guest for this member. -
Uses of ApiMethod in com.softlayer.api.service.scale.network
Methods in com.softlayer.api.service.scale.network with annotations of type ApiMethod Modifier and Type Method Description VlanVlan.Service. createObject(Vlan templateObject)BooleanVlan.Service. deleteObject()VlanVlan.Service. getNetworkVlan()The network VLAN to scale with.VlanVlan.Service. getObject()GroupVlan.Service. getScaleGroup()The group this network VLAN is for. -
Uses of ApiMethod in com.softlayer.api.service.scale.policy
Methods in com.softlayer.api.service.scale.policy with annotations of type ApiMethod Modifier and Type Method Description TriggerTrigger.Service. createObject(Trigger templateObject)BooleanAction.Service. deleteObject()BooleanTrigger.Service. deleteObject()BooleanAction.Service. editObject(Action templateObject)BooleanTrigger.Service. editObject(Trigger templateObject)ActionAction.Service. getObject()TriggerTrigger.Service. getObject()PolicyAction.Service. getScalePolicy()The policy this action is on.PolicyTrigger.Service. getScalePolicy()The policy this trigger is on.TypeAction.Service. getType()The type of action.TypeTrigger.Service. getType()The type of trigger. -
Uses of ApiMethod in com.softlayer.api.service.scale.policy.action
Methods in com.softlayer.api.service.scale.policy.action with annotations of type ApiMethod Modifier and Type Method Description ScaleScale.Service. createObject(Scale templateObject)List<Type>Type.Service. getAllObjects()TypeType.Service. getObject()ScaleScale.Service. getObjectForScale() -
Uses of ApiMethod in com.softlayer.api.service.scale.policy.trigger
Methods in com.softlayer.api.service.scale.policy.trigger with annotations of type ApiMethod Modifier and Type Method Description OneTimeOneTime.Service. createObject(OneTime templateObject)RepeatingRepeating.Service. createObject(Repeating templateObject)ResourceUseResourceUse.Service. createObject(ResourceUse templateObject)List<Type>Type.Service. getAllObjects()TypeType.Service. getObject()OneTimeOneTime.Service. getObjectForOneTime()RepeatingRepeating.Service. getObjectForRepeating()ResourceUseResourceUse.Service. getObjectForResourceUse()List<Watch>ResourceUse.Service. getWatches()The resource watches for this trigger.VoidRepeating.Service. validateCronExpression(String expression) -
Uses of ApiMethod in com.softlayer.api.service.scale.policy.trigger.resourceuse
Methods in com.softlayer.api.service.scale.policy.trigger.resourceuse with annotations of type ApiMethod Modifier and Type Method Description WatchWatch.Service. createObject(Watch templateObject)BooleanWatch.Service. deleteObject()BooleanWatch.Service. editObject(Watch templateObject)List<String>Watch.Service. getAllPossibleAlgorithms()List<String>Watch.Service. getAllPossibleMetrics()List<String>Watch.Service. getAllPossibleOperators()WatchWatch.Service. getObject()ResourceUseWatch.Service. getScalePolicyTrigger()The trigger this watch is on. -
Uses of ApiMethod in com.softlayer.api.service.scale.termination
Methods in com.softlayer.api.service.scale.termination with annotations of type ApiMethod Modifier and Type Method Description List<Policy>Policy.Service. getAllObjects()PolicyPolicy.Service. getObject() -
Uses of ApiMethod in com.softlayer.api.service.security
Methods in com.softlayer.api.service.security with annotations of type ApiMethod Modifier and Type Method Description CertificateCertificate.Service. createObject(Certificate templateObject)Add a certificate to your account for your records, or for use with various services.BooleanCertificate.Service. deleteObject()Remove a certificate from your account.BooleanCertificate.Service. editObject(Certificate templateObject)Update a certificate.List<Certificate>Certificate.Service. findByCommonName(String commonName)Locate certificates by their common name, traditionally a domain name.LongCertificate.Service. getAssociatedServiceCount()The number of services currently associated with the certificate.List<Listener>Certificate.Service. getLbaasListeners()Cloud Load Balancer [LBaaS] listeners currently associated with the certificate.List<VirtualIpAddress>Certificate.Service. getLoadBalancerVirtualIpAddresses()The load balancers virtual IP addresses currently associated with the certificate.CertificateCertificate.Service. getObject()StringCertificate.Service. getPemFormat()Retrieve the certificate in PEM (Privacy Enhanced Mail) format, which is a string containing all base64 encoded (DER) certificates delimited by -----BEGIN/END *----- clauses. -
Uses of ApiMethod in com.softlayer.api.service.security.certificate
Methods in com.softlayer.api.service.security.certificate with annotations of type ApiMethod Modifier and Type Method Description BooleanRequest.Service. cancelSslOrder()Cancels a pending SSL certificate order at the Certificate AuthorityAccountRequest.Service. getAccount()The account to which a SSL certificate request belongs.List<String>Request.Service. getAdministratorEmailDomains(String commonName)Gets the email domains that can be used to validate a certificate to a domain.List<String>Request.Service. getAdministratorEmailPrefixes()Gets the email accounts that can be used to validate a certificate to a domain.RequestRequest.Service. getObject()OrderRequest.Service. getOrder()The order contains the information related to a SSL certificate request.ItemRequest.Service. getOrderItem()The associated order item for this SSL certificate request.CertificateRequest.Service. getPreviousOrderData()Returns previous SSL certificate order data.List<Request>Request.Service. getSslCertificateRequests(Long accountId)Returns all the SSL certificate requests.StatusRequest.Service. getStatus()The status of a SSL certificate request.BooleanRequest.Service. resendEmail(String emailType)A Certificate Authority sends out various emails to your domain administrator or your technical contact.BooleanRequest.Service. validateCsr(String csr, Long validityMonths, Long itemId, String serverType)Allows you to validate a Certificate Signing Request (CSR) required for an SSL certificate with the certificate authority (CA). -
Uses of ApiMethod in com.softlayer.api.service.security.certificate.request
Methods in com.softlayer.api.service.security.certificate.request with annotations of type ApiMethod Modifier and Type Method Description List<ServerType>ServerType.Service. getAllObjects()Returns all SSL certificate server types, which are passed in on a [[SoftLayer_Container_Product_Order_Security_Certificate|certificate order]].ServerTypeServerType.Service. getObject()StatusStatus.Service. getObject()List<Status>Status.Service. getSslRequestStatuses()Returns all SSL certificate request status objects -
Uses of ApiMethod in com.softlayer.api.service.security.ssh
Methods in com.softlayer.api.service.security.ssh with annotations of type ApiMethod Modifier and Type Method Description KeyKey.Service. createObject(Key templateObject)Add a ssh key to your account for use during server provisioning and os reloads.BooleanKey.Service. deleteObject()Remove a ssh key from your account.BooleanKey.Service. editObject(Key templateObject)Update a ssh key.AccountKey.Service. getAccount()List<Group>Key.Service. getBlockDeviceTemplateGroups()The image template groups that are linked to an SSH key.KeyKey.Service. getObject()List<Password>Key.Service. getSoftwarePasswords()The OS root users that are linked to an SSH key. -
Uses of ApiMethod in com.softlayer.api.service.software
Methods in com.softlayer.api.service.software with annotations of type ApiMethod Modifier and Type Method Description AccountAccountLicense.Service. getAccount()The customer account this Account License belongs to.AccountVirtualLicense.Service. getAccount()The customer account this Virtual License belongs to.List<AccountLicense>AccountLicense.Service. getAllObjects()List<Description>Description.Service. getAllObjects()List<Attribute>Description.Service. getAttributes()LongComponent.Service. getAverageInstallationDuration()The average amount of time that a software component takes to install.LongDescription.Service. getAverageInstallationDuration()The average amount of time that a software description takes to install.ItemAccountLicense.Service. getBillingItem()The billing item for a software account license.ItemComponent.Service. getBillingItem()The billing item for a software component.ItemVirtualLicense.Service. getBillingItem()The billing item for a software virtual license.List<Description>Description.Service. getCompatibleSoftwareDescriptions()A list of the software descriptions that are compatible with this software description.List<Description>Description.Service. getCustomerOwnedLicenseDescriptions()List<Feature>Description.Service. getFeatures()The feature attributes of a software description.HardwareComponent.Service. getHardware()The hardware this Software Component is installed upon.ServerVirtualLicense.Service. getHostHardware()The hardware record to which the software virtual license is assigned.IpAddressVirtualLicense.Service. getIpAddressRecord()The IP Address record associated with a virtual license.List<Description>Description.Service. getLatestVersion()The latest version of a software description.StringComponent.Service. getLicenseFile()Attempt to retrieve the file associated with a software component.byte[]VirtualLicense.Service. getLicenseFile()Attempt to retrieve the file associated with a virtual license, if such a file exists.AccountLicenseAccountLicense.Service. getObject()ComponentComponent.Service. getObject()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.DescriptionDescription.Service. getObject()VirtualLicenseVirtualLicense.Service. getObject()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.List<History>Component.Service. getPasswordHistory()History Records for Software Passwords.List<Password>Component.Service. getPasswords()Username/Password pairs used for access to this Software Installation.List<Item>Description.Service. getProductItems()The various product items to which this software description is linked.GroupDescription.Service. getProvisionTransactionGroup()This details the provisioning transaction group for this software.GroupDescription.Service. getReloadTransactionGroup()The transaction group that a software description belongs to.StringDescription.Service. getRequiredUser()The default user created for a given a software description.DescriptionAccountLicense.Service. getSoftwareDescription()The SoftLayer_Software_Description that this account license is for.DescriptionComponent.Service. getSoftwareDescription()The Software Description of this Software Component.DescriptionVirtualLicense.Service. getSoftwareDescription()The SoftLayer_Software_Description that this virtual license is for.LicenseComponent.Service. getSoftwareLicense()The License this Software Component uses.List<License>Description.Service. getSoftwareLicenses()Software Licenses that govern this Software Description.SubnetVirtualLicense.Service. getSubnet()The subnet this Virtual License's IP address belongs to.DescriptionDescription.Service. getUpgradeSoftwareDescription()A suggestion for an upgrade path from this Software DescriptionDescriptionDescription.Service. getUpgradeSwDesc()A suggestion for an upgrade path from this Software Description (Deprecated - Use upgradeSoftwareDescription)List<Type>Description.Service. getValidFilesystemTypes()StringComponent.Service. getVendorSetUpConfiguration()GuestComponent.Service. getVirtualGuest()The virtual guest this software component is installed upon. -
Uses of ApiMethod in com.softlayer.api.service.software.component
Methods in com.softlayer.api.service.software.component with annotations of type ApiMethod Modifier and Type Method Description PasswordPassword.Service. createObject(Password templateObject)Create a password for a software component.BooleanPassword.Service. createObjects(List<Password> templateObjects)Create more than one password for a software component.BooleanPassword.Service. deleteObject()Delete a password from a software component.BooleanPassword.Service. deleteObjects(List<Password> templateObjects)Delete more than one passwords from a software component.BooleanPassword.Service. editObject(Password templateObject)Edit the properties of a software component password such as the username, password, port, and notes.BooleanPassword.Service. editObjects(List<Password> templateObjects)Edit more than one password from a software component.List<Policy>HostIps.Service. getCurrentHostIpsPolicies()Get the current Host IPS policies.PasswordPassword.Service. getObject()AntivirusSpywareAntivirusSpyware.Service. getObjectForAntivirusSpyware()HostIpsHostIps.Service. getObjectForHostIps()ComponentPassword.Service. getSoftware()The SoftLayer_Software_Component instance that this username/password pair is valid for.List<Key>Password.Service. getSshKeys()SSH keys to be installed on the server during provisioning or an OS reload.BooleanAntivirusSpyware.Service. updateAntivirusSpywarePolicy(String newPolicy, Boolean enforce)Update an anti-virus/spyware policy.BooleanHostIps.Service. updateHipsPolicies(String newIpsMode, String newIpsProtection, String newFirewallMode, String newFirewallRuleset, String newApplicationMode, String newApplicationRuleset, String newEnforcementPolicy)Update the Host IPS policies. -
Uses of ApiMethod in com.softlayer.api.service.ticket
Methods in com.softlayer.api.service.ticket with annotations of type ApiMethod Modifier and Type Method Description List<Subject>Subject.Service. getAllObjects()Retrieve all possible ticket subjects.CategorySubject.Service. getCategory()List<Subject>Subject.Service. getChildren()A child subjectGroupSubject.Service. getGroup()SubjectSubject.Service. getObject()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.SubjectSubject.Service. getParent()A parent subjectVoidSurvey.Service. getPreference()Deprecated.List<Priority>Priority.Service. getPriorities()List<QuestionAnswer>Subject.Service. getTopFiveKnowledgeLayerQuestions()SoftLayer maintains relationships between the generic subjects for standard administration and the top five commonly asked questions about these subjects.VoidSurvey.Service. optIn()Deprecated.VoidSurvey.Service. optOut()Deprecated. -
Uses of ApiMethod in com.softlayer.api.service.ticket.attachment
Methods in com.softlayer.api.service.ticket.attachment with annotations of type ApiMethod Modifier and Type Method Description List<String>File.Service. getExtensionWhitelist()FileFile.Service. getObject()TicketFile.Service. getTicket()UpdateFile.Service. getUpdate()The ticket that a file is attached to. -
Uses of ApiMethod in com.softlayer.api.service.ticket.attachment.file
Methods in com.softlayer.api.service.ticket.attachment.file with annotations of type ApiMethod Modifier and Type Method Description ServiceNowServiceNow.Service. getObjectForServiceNow() -
Uses of ApiMethod in com.softlayer.api.service.ticket.subject
Methods in com.softlayer.api.service.ticket.subject with annotations of type ApiMethod Modifier and Type Method Description List<Category>Category.Service. getAllObjects()Retrieve all ticket subject categories.CategoryCategory.Service. getObject()List<Subject>Category.Service. getSubjects() -
Uses of ApiMethod in com.softlayer.api.service.ticket.update
Methods in com.softlayer.api.service.ticket.update with annotations of type ApiMethod Modifier and Type Method Description BooleanEmployee.Service. addResponseRating(Long responseRating, Long responseIndex)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.EmployeeEmployee.Service. getObject()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. -
Uses of ApiMethod in com.softlayer.api.service.user
Methods in com.softlayer.api.service.user with annotations of type ApiMethod Modifier and Type Method Description VoidCustomer.Service. acknowledgeSupportPolicy()StringCustomer.Service. addApiAuthenticationKey()Create a user's API authentication key, allowing that user access to query the SoftLayer API.BooleanCustomer.Service. addBulkDedicatedHostAccess(List<Long> dedicatedHostIds)Grants the user access to one or more dedicated host devices.BooleanCustomer.Service. addBulkHardwareAccess(List<Long> hardwareIds)Add multiple hardware to a portal user's hardware access list.BooleanCustomer.Service. addBulkPortalPermission(List<Permission> permissions)Add multiple permissions to a portal user's permission set.VoidCustomer.Service. addBulkRoles(List<Role> roles)BooleanCustomer.Service. addBulkVirtualGuestAccess(List<Long> virtualGuestIds)Add multiple CloudLayer Computing Instances to a portal user's access list.BooleanCustomer.Service. addDedicatedHostAccess(Long dedicatedHostId)Grants the user access to a single dedicated host device.BindingCustomer.Service. addExternalBinding(Binding externalBinding)BooleanCustomer.Service. addHardwareAccess(Long hardwareId)Add hardware to a portal user's hardware access list.BooleanCustomer.Service. addNotificationSubscriber(String notificationKeyName)Create a notification subscription record for the user.BooleanCustomer.Service. addPortalPermission(Permission permission)Add a permission to a portal user's permission set.VoidCustomer.Service. addRole(Role role)BooleanCustomer.Service. addVirtualGuestAccess(Long virtualGuestId)Add a CloudLayer Computing Instance to a portal user's access list.CustomerCustomer.Service. assignNewParentId(Long parentId, Boolean cascadePermissionsFlag)This method can be used in place of [[SoftLayer_User_Customer::editObject]] to change the parent user of this user.List<Preference>Customer.Service. changePreference(String preferenceTypeKeyName, String value)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.TokenCustomer.Service. checkExternalAuthenticationStatus(Binding authenticationContainer)This service checks the result of a previously requested external authentication.BooleanCustomer.Service. checkPhoneFactorAuthenticationForPasswordSet(PasswordSet passwordSet, Binding authenticationContainer)Add a description here
BooleanCustomer.Service. createNotificationSubscriber(String keyName, Long resourceTableId)Create a new subscriber for a given resource.CustomerCustomer.Service. createObject(Customer templateObject, String password, String vpnPassword)Create a new user in the SoftLayer customer portal.BooleanCustomer.Service. createSubscriberDeliveryMethods(String notificationKeyName, List<String> deliveryMethodKeyNames)Create delivery methods for a notification that the user is subscribed to.BooleanCustomer.Service. deactivateNotificationSubscriber(String keyName, Long resourceTableId)Create a new subscriber for a given resource.BooleanCustomer.Service. editObject(Customer templateObject)Account master users and sub-users who have the User Manage permission in the SoftLayer customer portal can update other user's information.BooleanCustomer.Service. editObjects(List<Customer> templateObjects)Account master users and sub-users who have the User Manage permission in the SoftLayer customer portal can update other user's information.List<Profile>Customer.Service. findUserPreference(String profileName, String containerKeyname, String preferenceKeyname)AccountCustomer.Service. getAccount()The customer account that a user belongs to.List<Action>Customer.Service. getActions()List<Vendor>Customer.Service. getActiveExternalAuthenticationVendors()The getActiveExternalAuthenticationVendors method will return a list of available external vendors that a SoftLayer user can authenticate against.List<AdditionalEmail>Customer.Service. getAdditionalEmails()A portal user's additional email addresses.StringCustomer.Service. getAgentImpersonationToken()List<Long>Customer.Service. getAllowedDedicatedHostIds()List<Long>Customer.Service. getAllowedHardwareIds()List<Long>Customer.Service. getAllowedVirtualGuestIds()List<ApiAuthentication>Customer.Service. getApiAuthenticationKeys()A portal user's API Authentication keys.TokenCustomer.Service. getAuthenticationToken(Token token)List<Customer>Customer.Service. getChildUsers()A portal user's child users.List<Ticket>Customer.Service. getClosedTickets()An user's associated closed tickets.List<DedicatedHost>Customer.Service. getDedicatedHosts()The dedicated hosts to which the user has been granted access.AccountCustomer.Service. getDefaultAccount(String providerType)This method is not applicable to legacy SoftLayer-authenticated users and can only be invoked for IBMid-authenticated users.List<Binding>Customer.Service. getExternalBindings()The external authentication bindings that link an external identifier to a SoftLayer user.List<Hardware>Customer.Service. getHardware()A portal user's accessible hardware.LongCustomer.Service. getHardwareCount()Retrieve the number of servers that a portal user has access to.List<Hardware>Customer.Service. getHardwareNotifications()Hardware notifications associated with this user.BooleanCustomer.Service. getHasAcknowledgedSupportPolicyFlag()Whether or not a user has acknowledged the support policy.BooleanCustomer.Service. getHasFullDedicatedHostAccessFlag()Permission granting the user access to all Dedicated Host devices on the account.BooleanCustomer.Service. getHasFullHardwareAccessFlag()Whether or not a portal user has access to all hardware on their account.BooleanCustomer.Service. getHasFullVirtualGuestAccessFlag()Whether or not a portal user has access to all virtual guests on their account.LinkCustomer.Service. getIbmIdLink()Specifically relating the Customer instance to an IBMid.StringCustomer.Service. getImpersonationToken()List<Profile>Customer.Service. getLayoutProfiles()Contains the definition of the layout profile.LocaleCustomer.Service. getLocale()A user's locale.List<Authentication>Customer.Service. getLoginAttempts()A user's attempts to log into the SoftLayer customer portal.CommonCustomer.Service. getLoginToken(Contract request)Attempt to authenticate a user to the SoftLayer customer portal using the provided authentication container.List<Account>Customer.Service. getMappedAccounts(String providerType)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.List<MobileDevice>Customer.Service. getMobileDevices()A portal user's associated mobile device profiles.List<Subscriber>Customer.Service. getNotificationSubscribers()Notification subscription records for the user.CustomerCustomer.Service. getObject()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.MigrationStateCustomer.Service. getOpenIdConnectMigrationState()This API returns a SoftLayer_Container_User_Customer_OpenIdConnect_MigrationState object containing the necessary information to determine what migration state the user is in.List<Ticket>Customer.Service. getOpenTickets()An user's associated open tickets.List<Overrides>Customer.Service. getOverrides()A portal user's vpn accessible subnets.CustomerCustomer.Service. getParent()A portal user's parent user.PasswordSetCustomer.Service. getPasswordRequirements(Boolean isVpn)List<Permission>Customer.Service. getPermissions()A portal user's permissions.TokenCustomer.Service. getPortalLoginToken(String username, String password, Long securityQuestionId, String securityQuestionAnswer)Attempt to authenticate a username and password to the SoftLayer customer portal.PreferenceCustomer.Service. getPreference(String preferenceTypeKeyName)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.List<Preference>Customer.Service. getPreferences()Data type contains a single user preference to a specific preference type.List<Type>Customer.Service. getPreferenceTypes()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.PasswordSetCustomer.Service. getRequirementsForPasswordSet(PasswordSet passwordSet)Retrieve the authentication requirements for an outstanding password set/reset request.List<Role>Customer.Service. getRoles()LinkCustomer.Service. getSalesforceUserLink()[DEPRECATED]List<Answer>Customer.Service. getSecurityAnswers()A portal user's security question answers.List<Subscriber>Customer.Service. getSubscribers()A user's notification subscription records.List<Authentication>Customer.Service. getSuccessfulLogins()A user's successful attempts to log into the SoftLayer customer portal.List<Locale>Customer.Service. getSupportedLocales()LongCustomer.Service. getSupportPolicyAcknowledgementRequiredFlag()Whether or not a user is required to acknowledge the support policy for portal access.byte[]Customer.Service. getSupportPolicyDocument()StringCustomer.Service. getSupportPolicyName()BooleanCustomer.Service. getSurveyRequiredFlag()Whether or not a user must take a brief survey the next time they log into the SoftLayer customer portal.List<Survey>Customer.Service. getSurveys()The surveys that a user has taken in the SoftLayer customer portal.List<Ticket>Customer.Service. getTickets()An user's associated tickets.TimezoneCustomer.Service. getTimezone()A portal user's time zone.List<Authentication>Customer.Service. getUnsuccessfulLogins()A user's unsuccessful attempts to log into the SoftLayer customer portal.LongCustomer.Service. getUserIdForPasswordSet(String key)Retrieve a user id using a password token provided to the user in an email generated by the SoftLayer_User_Customer::initiatePortalPasswordChange request.List<Link>Customer.Service. getUserLinks()User customer link with IBMid and IAMid.List<Profile>Customer.Service. getUserPreferences(String profileName, String containerKeyname)StatusCustomer.Service. getUserStatus()A portal user's status, which controls overall access to the SoftLayer customer portal and VPN access to the private network.LongCustomer.Service. getVirtualGuestCount()Retrieve the number of CloudLayer Computing Instances that a portal user has access to.List<Guest>Customer.Service. getVirtualGuests()A portal user's accessible CloudLayer Computing Instances.StringCustomer.Service. initiateExternalAuthentication(Binding authenticationContainer)The service initiates an external authentication with the given external authentication vendor.BooleanCustomer.Service. initiatePortalPasswordChange(String username)Sends password change email to the user containing url that allows the user the change their password.BooleanCustomer.Service. initiatePortalPasswordChangeByBrandAgent(String username)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.BooleanCustomer.Service. inTerminalStatus()VoidCustomer.Service. inviteUserToLinkOpenIdConnect(String providerType)Send email invitation to a user to join a SoftLayer account and authenticate with OpenIdConnect.BooleanCustomer.Service. isMasterUser()Deprecated.BooleanCustomer.Service. isValidPortalPassword(String password)Determine if a string is the given user's login password to the SoftLayer customer portal.TokenCustomer.Service. performExternalAuthentication(Binding authenticationContainer)The perform external authentication method will authenticate the given external authentication container with an external vendor.BooleanCustomer.Service. processPasswordSetRequest(PasswordSet passwordSet, Binding authenticationContainer)Set the password for a user who has an outstanding password request.BooleanCustomer.Service. removeAllDedicatedHostAccessForThisUser()Revoke access to all dedicated hosts on the account for this user.BooleanCustomer.Service. removeAllHardwareAccessForThisUser()Remove all hardware from a portal user's hardware access list.BooleanCustomer.Service. removeAllVirtualAccessForThisUser()Remove all cloud computing instances from a portal user's instance access list.BooleanCustomer.Service. removeApiAuthenticationKey(Long keyId)Remove a user's API authentication key, removing that user's access to query the SoftLayer API.BooleanCustomer.Service. removeBulkDedicatedHostAccess(List<Long> dedicatedHostIds)Revokes access for the user to one or more dedicated host devices.BooleanCustomer.Service. removeBulkHardwareAccess(List<Long> hardwareIds)Remove multiple hardware from a portal user's hardware access list.BooleanCustomer.Service. removeBulkPortalPermission(List<Permission> permissions, Boolean cascadePermissionsFlag)Remove (revoke) multiple permissions from a portal user's permission set.VoidCustomer.Service. removeBulkRoles(List<Role> roles)BooleanCustomer.Service. removeBulkVirtualGuestAccess(List<Long> virtualGuestIds)Remove multiple CloudLayer Computing Instances from a portal user's access list.BooleanCustomer.Service. removeDedicatedHostAccess(Long dedicatedHostId)Revokes access for the user to a single dedicated host device.BooleanCustomer.Service. removeExternalBinding(Binding externalBinding)BooleanCustomer.Service. removeHardwareAccess(Long hardwareId)Remove hardware from a portal user's hardware access list.BooleanCustomer.Service. removePortalPermission(Permission permission, Boolean cascadePermissionsFlag)Remove (revoke) a permission from a portal user's permission set.VoidCustomer.Service. removeRole(Role role)BooleanCustomer.Service. removeSecurityAnswers()BooleanCustomer.Service. removeVirtualGuestAccess(Long virtualGuestId)Remove a CloudLayer Computing Instance from a portal user's access list.VoidCustomer.Service. resetOpenIdConnectLink(String providerType, String newIbmIdUsername, Boolean removeSecuritySettings)This method will change the IBMid that a SoftLayer user is linked to, if we need to do that for some reason.VoidCustomer.Service. resetOpenIdConnectLinkUnifiedUserManagementMode(String providerType, String newIbmIdUsername, Boolean removeSecuritySettings)This method will change the IBMid that a SoftLayer master user is linked to, if we need to do that for some reason.TokenCustomer.Service. samlAuthenticate(String accountId, String samlResponse)StringCustomer.Service. samlBeginAuthentication(Long accountId)StringCustomer.Service. samlBeginLogout()VoidCustomer.Service. samlLogout(String samlResponse)VoidCustomer.Service. selfPasswordChange(String currentPassword, String newPassword)AccountCustomer.Service. setDefaultAccount(String providerType, Long accountId)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.BooleanCustomer.Service. silentlyMigrateUserOpenIdConnect(String providerType)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.BooleanCustomer.Service. updateNotificationSubscriber(String notificationKeyName, Long active)Update the active status for a notification that the user is subscribed to.BooleanCustomer.Service. updateSecurityAnswers(List<Question> questions, List<String> answers)Update a user's login security questions and answers on the SoftLayer customer portal.BooleanCustomer.Service. updateSubscriberDeliveryMethod(String notificationKeyName, List<String> deliveryMethodKeyNames, Long active)Update a delivery method for a notification that the user is subscribed to.BooleanCustomer.Service. updateVpnPassword(String password)Update a user's VPN password on the SoftLayer customer portal.BooleanCustomer.Service. updateVpnUser()Always call this function to enable changes when manually configuring VPN subnet access.TokenCustomer.Service. validateAuthenticationToken(Token authenticationToken) -
Uses of ApiMethod in com.softlayer.api.service.user.customer
Methods in com.softlayer.api.service.user.customer with annotations of type ApiMethod Modifier and Type Method Description VoidOpenIdConnect.Service. activateOpenIdConnectUser(String verificationCode, Customer userInfo, String iamId)Completes invitation process for an OpenIdConnect user created by Bluemix Unified User Console.BooleanOpenIdConnect.Service. checkPhoneFactorAuthenticationForPasswordSet(PasswordSet passwordSet, Binding authenticationContainer)Add a description here
VoidOpenIdConnect.Service. completeInvitationAfterLogin(String providerType, String accessToken, String emailRegistrationCode)MobileDeviceMobileDevice.Service. createObject(MobileDevice templateObject)Create a new mobile device association for a user.OpenIdConnectOpenIdConnect.Service. createObject(OpenIdConnect templateObject, String password, String vpnPassword)Create a new user in the SoftLayer customer portal.VoidOpenIdConnect.Service. createOpenIdConnectUserAndCompleteInvitation(String providerType, Customer user, String password, String registrationCode)VoidOpenIdConnect.Service. declineInvitation(String providerType, String registrationCode)Declines an invitation to link an OpenIdConnect identity to a SoftLayer (Atlas) identity and account.BooleanMobileDevice.Service. deleteObject()Delete a mobile device association for a user.ApiAuthenticationApiAuthentication.Service. editObject(ApiAuthentication templateObject)BooleanMobileDevice.Service. editObject(MobileDevice templateObject)Edit the object by passing in a modified instance of the objectList<Status>Status.Service. getAllObjects()Retrieve all user status objects.List<Notification>MobileDevice.Service. getAvailablePushNotificationSubscriptions()Notification subscriptions available to a mobile device.CustomerMobileDevice.Service. getCustomer()The user this mobile device belongs to.AccountOpenIdConnect.Service. getDefaultAccount(String providerType)This API gets the account associated with the default user for the OpenIdConnect identity that is linked to the current active SoftLayer user identity.LoginAccountInfoOpenIdConnect.Service. getLoginAccountInfoOpenIdConnect(String providerType, String accessToken)Validates a supplied OpenIdConnect access token to the SoftLayer customer portal and returns the default account name and id for the active user.List<Account>OpenIdConnect.Service. getMappedAccounts(String providerType)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.ApiAuthenticationApiAuthentication.Service. getObject()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.InvitationInvitation.Service. getObject()MobileDeviceMobileDevice.Service. getObject()StatusStatus.Service. getObject()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.OpenIdConnectOpenIdConnect.Service. getObjectForOpenIdConnect()RegistrationInformationOpenIdConnect.Service. getOpenIdRegistrationInfoFromCode(String providerType, String registrationCode)OperatingSystemMobileDevice.Service. getOperatingSystem()The operating system this device is usingTokenOpenIdConnect.Service. getPortalLoginTokenOpenIdConnect(String providerType, String accessToken, Long accountId, Long securityQuestionId, String securityQuestionAnswer)Deprecated.List<Subscriber>MobileDevice.Service. getPushNotificationSubscriptions()Notification subscriptions attached to a mobile device.PasswordSetOpenIdConnect.Service. getRequirementsForPasswordSetForOpenIdConnect(PasswordSet passwordSet)Retrieve the authentication requirements for an outstanding password set/reset request.TypeMobileDevice.Service. getType()The type of device this user is usingCustomerApiAuthentication.Service. getUser()The user who owns the api authentication key.CustomerInvitation.Service. getUser()OpenIdConnectOpenIdConnect.Service. getUserForUnifiedInvitation(String openIdConnectUserId, String uniqueIdentifier, String searchInvitationsNotLinksFlag)Returns an IMS User Object from the provided OpenIdConnect User ID or IBMid Unique Identifier for the Account of the active user.LongOpenIdConnect.Service. getUserIdForPasswordSet(String key)Retrieve a user id using a password token provided to the user in an email generated by the SoftLayer_User_Customer::initiatePortalPasswordChange request.BooleanOpenIdConnect.Service. initiatePortalPasswordChange(String username)Sends password change email to the user containing url that allows the user the change their password.BooleanOpenIdConnect.Service. initiatePortalPasswordChangeByBrandAgent(String username)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.BooleanOpenIdConnect.Service. isValidPortalPassword(String password)Determine if a string is the given user's login password to the SoftLayer customer portal.BooleanOpenIdConnect.Service. processPasswordSetRequest(PasswordSet passwordSet, Binding authenticationContainer)Set the password for a user who has an outstanding password request.VoidOpenIdConnect.Service. selfPasswordChange(String currentPassword, String newPassword)AccountOpenIdConnect.Service. setDefaultAccount(String providerType, Long accountId)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. -
Uses of ApiMethod in com.softlayer.api.service.user.customer.customerpermission
Methods in com.softlayer.api.service.user.customer.customerpermission with annotations of type ApiMethod Modifier and Type Method Description List<Permission>Permission.Service. getAllObjects()Deprecated.PermissionPermission.Service. getObject()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. -
Uses of ApiMethod in com.softlayer.api.service.user.customer.external
Methods in com.softlayer.api.service.user.customer.external with annotations of type ApiMethod Modifier and Type Method Description BooleanBinding.Service. disable(String reason)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.BooleanBinding.Service. enable()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.BindingBinding.Service. getObjectForBinding()CustomerBinding.Service. getUser()The SoftLayer user that the external authentication binding belongs to. -
Uses of ApiMethod in com.softlayer.api.service.user.customer.external.binding
Methods in com.softlayer.api.service.user.customer.external.binding with annotations of type ApiMethod Modifier and Type Method Description BooleanTotp.Service. activate()BooleanPhone.Service. checkPhoneValidationResult(String token)Return a phone validation result.BooleanTotp.Service. deactivate()BooleanVerisign.Service. deleteObjectForVerisign()Delete a VeriSign external binding.BooleanPhone.Service. disable(String reason)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.BooleanVerisign.Service. disable(String reason)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.BooleanPhone.Service. enableForPhone()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.BooleanVerisign.Service. enableForVerisign()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.StringTotp.Service. generateSecretKey()StringVerisign.Service. getActivationCodeForMobileClient()An activation code is required when provisioning a new mobile credential from Verisign.List<String>Phone.Service. getAllAuthenticationModes()This service returns key names of all available authentication modes.List<String>Phone.Service. getAllAuthenticationPinModes(String authenticationModeKeyName)This service returns key names of all available authentication modes.ModePhone.Service. getAuthenticationMode()StringPhone.Service. getBindingStatus()The current external binding status.StringVerisign.Service. getCredentialExpirationDate()The date that a VeriSign credential expires.StringVerisign.Service. getCredentialLastUpdateDate()The last time a VeriSign credential was updated.StringVerisign.Service. getCredentialState()The current state of a VeriSign credential.StringVerisign.Service. getCredentialType()The type of VeriSign credential.PhonePhone.Service. getObjectForPhone()TotpTotp.Service. getObjectForTotp()VendorVendor.Service. getObjectForVendor()VerisignVerisign.Service. getObjectForVerisign()List<Attribute>Phone.Service. getPhoneAppActivationCode()Some vendor's mobile app requires an activation code.List<Phone>Phone.Service. getPhoneData()StringPhone.Service. getPinLength()StringPhone.Service. requestPhoneValidation(Phone phoneData)Initiates a phone validation requests and returns a unique token.BooleanVerisign.Service. unlock(String securityCode)If a VeriSign credential becomes locked because of too many failed login attempts the unlock method can be used to unlock a VeriSign credential.BooleanPhone.Service. updateAuthenticationMode(Mode mode)This service allow you to change your phone authentication mode.BooleanPhone.Service. updatePhone(List<Phone> phoneData)Phone external binding supports a primary and a backup phone number.BooleanVerisign.Service. validateCredentialId(Long userId, String externalId)Validate the user id and VeriSign credential id used to create an external authentication binding. -
Uses of ApiMethod in com.softlayer.api.service.user.customer.mobiledevice
Methods in com.softlayer.api.service.user.customer.mobiledevice with annotations of type ApiMethod Modifier and Type Method Description List<OperatingSystem>OperatingSystem.Service. getAllObjects()List<Type>Type.Service. getAllObjects()OperatingSystemOperatingSystem.Service. getObject()TypeType.Service. getObject() -
Uses of ApiMethod in com.softlayer.api.service.user.customer.notification
Methods in com.softlayer.api.service.user.customer.notification with annotations of type ApiMethod Modifier and Type Method Description HardwareHardware.Service. createObject(Hardware templateObject)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.List<Hardware>Hardware.Service. createObjects(List<Hardware> templateObjects)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.BooleanHardware.Service. deleteObjects(List<Hardware> templateObjects)Like any other API object, the customer notification objects can be deleted by passing an instance of them into this function.List<Hardware>Hardware.Service. findByHardwareId(Long hardwareId)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.HardwareHardware.Service. getHardware()The hardware object that will be monitored.HardwareHardware.Service. getObject()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.CustomerHardware.Service. getUser()The user that will be notified when the associated hardware object fails a monitoring instance. -
Uses of ApiMethod in com.softlayer.api.service.user.customer.notification.virtual
Methods in com.softlayer.api.service.user.customer.notification.virtual with annotations of type ApiMethod Modifier and Type Method Description GuestGuest.Service. createObject(Guest templateObject)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.List<Guest>Guest.Service. createObjects(List<Guest> templateObjects)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.BooleanGuest.Service. deleteObjects(List<Guest> templateObjects)Like any other API object, the customer notification objects can be deleted by passing an instance of them into this function.List<Guest>Guest.Service. findByGuestId(Long id)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.GuestGuest.Service. getGuest()The virtual guest object that will be monitored.GuestGuest.Service. getObject()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.CustomerGuest.Service. getUser()The user that will be notified when the associated virtual guest object fails a monitoring instance. -
Uses of ApiMethod in com.softlayer.api.service.user.customer.openidconnect
Methods in com.softlayer.api.service.user.customer.openidconnect with annotations of type ApiMethod Modifier and Type Method Description StringTrustedProfile.Service. addApiAuthenticationKeyForTrustedProfile()Create a user's API authentication key, allowing that user access to query the SoftLayer API.BindingTrustedProfile.Service. addExternalBinding(Binding externalBinding)BooleanTrustedProfile.Service. checkPhoneFactorAuthenticationForPasswordSet(PasswordSet passwordSet, Binding authenticationContainer)Add a description here
TrustedProfileTrustedProfile.Service. createObject(TrustedProfile templateObject, String password, String vpnPassword)TrustedProfileTrustedProfile.Service. getObjectForTrustedProfile()TokenTrustedProfile.Service. getPortalLoginTokenOpenIdConnect(String providerType, String accessToken, Long accountId, Long securityQuestionId, String securityQuestionAnswer)Deprecated.PasswordSetTrustedProfile.Service. getRequirementsForPasswordSetForTrustedProfile(PasswordSet passwordSet)Retrieve the authentication requirements for an outstanding password set/reset request.LongTrustedProfile.Service. getUserIdForPasswordSet(String key)Retrieve a user id using a password token provided to the user in an email generated by the SoftLayer_User_Customer::initiatePortalPasswordChange request.BooleanTrustedProfile.Service. initiatePortalPasswordChange(String username)Sends password change email to the user containing url that allows the user the change their password.BooleanTrustedProfile.Service. initiatePortalPasswordChangeByBrandAgent(String username)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.BooleanTrustedProfile.Service. isValidPortalPassword(String password)Determine if a string is the given user's login password to the SoftLayer customer portal.BooleanTrustedProfile.Service. processPasswordSetRequest(PasswordSet passwordSet, Binding authenticationContainer)Set the password for a user who has an outstanding password request.BooleanTrustedProfile.Service. updateVpnUserForTrustedProfile()Always call this function to enable changes when manually configuring VPN subnet access. -
Uses of ApiMethod in com.softlayer.api.service.user.customer.profile.event
Methods in com.softlayer.api.service.user.customer.profile.event with annotations of type ApiMethod Modifier and Type Method Description BooleanHyperWarp.Service. receiveEventDirect(ProfileChange eventJson) -
Uses of ApiMethod in com.softlayer.api.service.user.customer.prospect.serviceprovider
Methods in com.softlayer.api.service.user.customer.prospect.serviceprovider with annotations of type ApiMethod Modifier and Type Method Description EnrollRequestEnrollRequest.Service. enroll(EnrollRequest templateObject)Create a new Service Provider EnrollmentTypeEnrollRequest.Service. getCompanyType()Catalyst company types.EnrollRequestEnrollRequest.Service. getObject() -
Uses of ApiMethod in com.softlayer.api.service.user.customer.security
Methods in com.softlayer.api.service.user.customer.security with annotations of type ApiMethod Modifier and Type Method Description AnswerAnswer.Service. getObject()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.QuestionAnswer.Service. getQuestion()The question the security answer is associated with.CustomerAnswer.Service. getUser()The user who the security answer belongs to. -
Uses of ApiMethod in com.softlayer.api.service.user.external
Methods in com.softlayer.api.service.user.external with annotations of type ApiMethod Modifier and Type Method Description BooleanBinding.Service. deleteObject()Delete an external authentication binding.List<Attribute>Binding.Service. getAttributes()Attributes of an external authentication binding.ItemBinding.Service. getBillingItem()Information regarding the billing item for external authentication.StringBinding.Service. getNote()An optional note for identifying the external binding.BindingBinding.Service. getObject()TypeBinding.Service. getType()The type of external authentication binding.VendorBinding.Service. getVendor()The vendor of an external authentication binding.BooleanBinding.Service. updateNote(String text)Update the note of an external binding. -
Uses of ApiMethod in com.softlayer.api.service.user.external.binding
Methods in com.softlayer.api.service.user.external.binding with annotations of type ApiMethod Modifier and Type Method Description List<Vendor>Vendor.Service. getAllObjects()getAllObjects() will return a list of the available external binding vendors that SoftLayer supports.VendorVendor.Service. getObject() -
Uses of ApiMethod in com.softlayer.api.service.user.permission
Methods in com.softlayer.api.service.user.permission with annotations of type ApiMethod Modifier and Type Method Description VoidGroup.Service. addAction(Action action)Assigns a SoftLayer_User_Permission_Action object to the group.VoidGroup.Service. addBulkActions(List<Action> actions)Assigns multiple SoftLayer_User_Permission_Action objects to the group.BooleanGroup.Service. addBulkResourceObjects(List<Entity> resourceObjects, String resourceTypeKeyName)Links multiple SoftLayer_Hardware_Server, SoftLayer_Virtual_Guest, or SoftLayer_Virtual_DedicatedHost objects to the group.BooleanGroup.Service. addResourceObject(Entity resourceObject, String resourceTypeKeyName)Links a SoftLayer_Hardware_Server, SoftLayer_Virtual_Guest, or SoftLayer_Virtual_DedicatedHost object to the group.VoidRole.Service. addUser(Customer user)Assigns a SoftLayer_User_Customer object to the role.GroupGroup.Service. createObject(Group templateObject)Customer created permission groups must be of type NORMAL.RoleRole.Service. createObject(Role templateObject)Customer created permission roles must set the systemFlag attribute to false.BooleanGroup.Service. deleteObject()Customer users can only delete permission groups of type NORMAL.BooleanRole.Service. deleteObject()Customer users can only delete permission roles with systemFlag set to false.GroupGroup.Service. editObject(Group templateObject)Allows a user to modify the name and description of an existing customer permission group.RoleRole.Service. editObject(Role templateObject)Allows a user to modify the name and description of an existing customer permission role.AccountGroup.Service. getAccount()AccountRole.Service. getAccount()List<Action>Group.Service. getActions()List<Action>Role.Service. getActions()List<Action>Action.Service. getAllObjects()Object filters and result limits are enabled on this method.List<Group>Role.Service. getGroups()ActionAction.Service. getObject()GroupGroup.Service. getObject()RoleRole.Service. getObject()List<Role>Group.Service. getRoles()TypeGroup.Service. getType()The type of the permission group.List<Customer>Role.Service. getUsers()VoidRole.Service. linkGroup(Group group)Links a SoftLayer_User_Permission_Group object to the role.VoidGroup.Service. linkRole(Role role)Links a SoftLayer_User_Permission_Role object to the group.VoidGroup.Service. removeAction(Action action)Unassigns a SoftLayer_User_Permission_Action object from the group.VoidGroup.Service. removeBulkActions(List<Action> actions)Unassigns multiple SoftLayer_User_Permission_Action objects from the group.BooleanGroup.Service. removeBulkResourceObjects(List<Entity> resourceObjects, String resourceTypeKeyName)Unlinks multiple SoftLayer_Hardware_Server, SoftLayer_Virtual_Guest, or SoftLayer_Virtual_DedicatedHost objects from the group.BooleanGroup.Service. removeResourceObject(Entity resourceObject, String resourceTypeKeyName)Unlinks a SoftLayer_Hardware_Server, SoftLayer_Virtual_Guest, or SoftLayer_Virtual_DedicatedHost object from the group.VoidRole.Service. removeUser(Customer user)Unassigns a SoftLayer_User_Customer object from the role.VoidRole.Service. unlinkGroup(Group group)Unlinks a SoftLayer_User_Permission_Group object to the role.VoidGroup.Service. unlinkRole(Role role)Removes a link from SoftLayer_User_Permission_Role object to the group. -
Uses of ApiMethod in com.softlayer.api.service.user.permission.group
Methods in com.softlayer.api.service.user.permission.group with annotations of type ApiMethod Modifier and Type Method Description List<Group>Type.Service. getGroups()The groups that are of this type.TypeType.Service. getObject() -
Uses of ApiMethod in com.softlayer.api.service.user.permission.resource
Methods in com.softlayer.api.service.user.permission.resource with annotations of type ApiMethod Modifier and Type Method Description List<Type>Type.Service. getAllObjects()Retrieve an array of SoftLayer_User_Permission_Resource_Type objects.TypeType.Service. getObject() -
Uses of ApiMethod in com.softlayer.api.service.user.security
Methods in com.softlayer.api.service.user.security with annotations of type ApiMethod Modifier and Type Method Description List<Question>Question.Service. getAllObjects()Retrieve all viewable security questions.QuestionQuestion.Service. getObject()getAllObjects retrieves all the SoftLayer_User_Security_Question objects where it is set to be viewable. -
Uses of ApiMethod in com.softlayer.api.service.utility
Methods in com.softlayer.api.service.utility with annotations of type ApiMethod Modifier and Type Method Description StringNetwork.Service. nsLookup(String address, String type)A method used to return the nameserver information for a given addressStringNetwork.Service. whois(String address)Perform a WHOIS lookup from SoftLayer's application servers on the given IP address or hostname and return the raw results of that command. -
Uses of ApiMethod in com.softlayer.api.service.virtual
Methods in com.softlayer.api.service.virtual with annotations of type ApiMethod Modifier and Type Method Description BooleanGuest.Service. activatePrivatePort()Activate the private network portBooleanGuest.Service. activatePublicPort()Activate the public network portBooleanGuest.Service. allowAccessToNetworkStorage(Storage networkStorageTemplateObject)This method is used to allow access to a SoftLayer_Network_Storage volume that supports host- or network-level access control.BooleanGuest.Service. allowAccessToNetworkStorageList(List<Storage> networkStorageTemplateObjects)This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support host- or network-level access control.TransactionGuest.Service. attachDiskImage(Long imageId)Creates a transaction to attach a guest's disk image.VoidGuest.Service. cancelIsolationForDestructiveAction()Reopens the public and/or private ports to reverse the changes made when the server was isolated for a destructive action.GroupGuest.Service. captureImage(Template captureTemplate)Captures a Flex Image of the hard disk on the virtual machine, based on the capture template parameter.BooleanGuest.Service. checkHostDiskAvailability(Long diskCapacity)Checks the associated host for available disk space to determine if guest migration is necessary.TransactionGuest.Service. configureMetadataDisk()Creates a transaction to configure the guest's metadata disk.GroupGuest.Service. createArchiveTemplate(String groupName, List<Device> blockDevices, String note)Create a transaction to archive a computing instance's block devicesTransactionGuest.Service. createArchiveTransaction(String groupName, List<Device> blockDevices, String note)Deprecated.GuestGuest.Service. createObject(Guest templateObject)
createObject() enables the creation of computing instances on an account.PlacementGroupPlacementGroup.Service. createObject(PlacementGroup templateObject)Add a placement group to your account for use during VSI provisioning.List<Guest>Guest.Service. createObjects(List<Guest> templateObjects)
createObjects() enables the creation of multiple computing instances on an account in a single call.BooleanGuest.Service. createPostSoftwareInstallTransaction(String data, Boolean returnBoolean)BooleanDedicatedHost.Service. deleteObject()This method will cancel a dedicated host immediately.BooleanGuest.Service. deleteObject()
This method will cancel a computing instance effective immediately.BooleanPlacementGroup.Service. deleteObject()Delete a placement group from your account.BooleanGuest.Service. deleteTag(String tagName)VoidGuest.Service. deleteTransientWebhook()TransactionGuest.Service. detachDiskImage(Long imageId)Creates a transaction to detach a guest's disk image.BooleanDedicatedHost.Service. editObject(DedicatedHost templateObject)Edit a dedicated host's properties.BooleanGuest.Service. editObject(Guest templateObject)Edit a computing instance's propertiesBooleanPlacementGroup.Service. editObject(PlacementGroup templateObject)Update a placement group.BooleanReservedCapacityGroup.Service. editObject(ReservedCapacityGroup templateObject)Update a reserved capacity group.BooleanGuest.Service. executeIderaBareMetalRestore()Reboot a guest into the Idera Bare Metal Restore image.BooleanGuest.Service. executeR1SoftBareMetalRestore()Reboot a guest into the R1Soft Bare Metal Restore image.VoidGuest.Service. executeRemoteScript(String uri)Download and run remote script from uri on virtual guests.BooleanGuest.Service. executeRescueLayer()Reboot a Linux guest into the Xen rescue image.List<Guest>Guest.Service. findByHostname(String hostname)Find VSIs by hostname.GuestGuest.Service. findByIpAddress(String ipAddress)Find CCI by only its primary public or private IP address.OrderGuest.Service. generateOrderTemplate(Guest templateObject)
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]].AccountDedicatedHost.Service. getAccount()The account that the dedicated host belongs to.AccountGuest.Service. getAccount()The account that a virtual guest belongs to.AccountHost.Service. getAccount()The account which a virtual host belongs to.AccountPlacementGroup.Service. getAccount()The account that the placement group is implemented on.AccountReservedCapacityGroup.Service. getAccount()The account that the reserved capacity group is implemented on.BooleanGuest.Service. getAccountOwnedPoolFlag()List<Incident>Guest.Service. getActiveNetworkMonitorIncident()A virtual guest's currently active network monitoring incidents.List<Ticket>Guest.Service. getActiveTickets()TransactionGuest.Service. getActiveTransaction()A transaction that is still be performed on a cloud server.List<Transaction>Guest.Service. getActiveTransactions()Any active transaction(s) that are currently running for the server (example: os reload).List<Price>Guest.Service. getAdditionalRequiredPricesForOsReload(Configuration config)Return a collection of SoftLayer_Item_Price objects for an OS reloadAllocationStatusDedicatedHost.Service. getAllocationStatus()The container that represents allocations on the dedicated host.HostGuest.Service. getAllowedHost()The SoftLayer_Network_Storage_Allowed_Host information to connect this Virtual Guest to Network Storage volumes that require access control lists.List<Storage>Guest.Service. getAllowedNetworkStorage()The SoftLayer_Network_Storage objects that this SoftLayer_Virtual_Guest has access to.List<Storage>Guest.Service. getAllowedNetworkStorageReplicas()The SoftLayer_Network_Storage objects whose Replica that this SoftLayer_Virtual_Guest has access to.ComponentGuest.Service. getAntivirusSpywareSoftwareComponent()A antivirus / spyware software component object.ControllerGuest.Service. getApplicationDeliveryController()List<Storage>Guest.Service. getAttachedNetworkStorages(String nasType)This method is retrieve a list of SoftLayer_Network_Storage volumes that are authorized access to this SoftLayer_Virtual_Guest.List<Attribute>Guest.Service. getAttributes()List<String>Guest.Service. getAvailableBlockDevicePositions()List<Instance>ReservedCapacityGroup.Service. getAvailableInstances()The instances available for guest provisions on this reserved capacity group.List<Stratum>Guest.Service. getAvailableMonitoring()An object that stores the maximum level for the monitoring query types and response types.List<Storage>Guest.Service. getAvailableNetworkStorages(String nasType)This method retrieves a list of SoftLayer_Network_Storage volumes that can be authorized to this SoftLayer_Virtual_Guest.List<Hardware>DedicatedHost.Service. getAvailableRouters(DedicatedHost dedicatedHost)This method will get the available backend routers to order a dedicated host.List<Hardware>PlacementGroup.Service. getAvailableRouters(Long datacenterId)Returns all routers available for use with placement groups.BigDecimalGuest.Service. getAverageDailyPrivateBandwidthUsage()The average daily private bandwidth usage for the current billing cycle.BigDecimalGuest.Service. getAverageDailyPublicBandwidthUsage()The average daily public bandwidth usage for the current billing cycle.List<Component>Guest.Service. getBackendNetworkComponents()A guests's backend network components.BackendDedicatedHost.Service. getBackendRouter()The backend router behind dedicated host's pool of resources.BackendPlacementGroup.Service. getBackendRouter()The router the placement group is implemented on.BackendReservedCapacityGroup.Service. getBackendRouter()The router the reserved capacity group is implemented on.List<Hardware>Guest.Service. getBackendRouters()A guest's backend or private router.BigDecimalGuest.Service. getBandwidthAllocation()A computing instance's allotted bandwidth (measured in GB).DetailGuest.Service. getBandwidthAllotmentDetail()A computing instance's allotted detail record.List<Data>Guest.Service. getBandwidthDataByDate(GregorianCalendar startDateTime, GregorianCalendar endDateTime, String networkType)Use this method when needing the metric data for bandwidth for a single guest.List<Data>Guest.Service. getBandwidthForDateRange(GregorianCalendar startDate, GregorianCalendar endDate)Retrieve a collection of bandwidth data from an individual public or private network tracking object.GraphOutputsGuest.Service. getBandwidthImage(String networkType, String snapshotRange, GregorianCalendar dateSpecified, GregorianCalendar dateSpecifiedEnd)Use this method when needing a bandwidth image for a single guest.GraphOutputsGuest.Service. getBandwidthImageByDate(GregorianCalendar startDateTime, GregorianCalendar endDateTime, String networkType)Use this method when needing a bandwidth image for a single guest.LongGuest.Service. getBandwidthTotal(GregorianCalendar startDateTime, GregorianCalendar endDateTime, String direction, String side)Returns the total amount of bandwidth used during the time specified for a computing instance.BooleanHost.Service. getBilledPerGuestFlag()Boolean flag indicating whether this virtualization platform gets billed per guest rather than at a fixed rate.BooleanHost.Service. getBilledPerMemoryUsageFlag()Boolean flag indicating whether this virtualization platform gets billed per memory usage rather than at a fixed rate.List<Usage>Guest.Service. getBillingCycleBandwidthUsage()The raw bandwidth usage data for the current billing cycle.UsageGuest.Service. getBillingCyclePrivateBandwidthUsage()The raw private bandwidth usage data for the current billing cycle.UsageGuest.Service. getBillingCyclePublicBandwidthUsage()The raw public bandwidth usage data for the current billing cycle.DedicatedHostDedicatedHost.Service. getBillingItem()The billing item for the dedicated host.GuestGuest.Service. getBillingItem()The billing item for a CloudLayer Compute Instance.BooleanGuest.Service. getBlockCancelBecauseDisconnectedFlag()Determines whether the instance is ineligible for cancellation because it is disconnected.List<Device>Guest.Service. getBlockDevices()A computing instance's block devices.GroupGuest.Service. getBlockDeviceTemplateGroup()The global identifier for the image template that was used to provision or reload a guest.StringGuest.Service. getBootMode()Retrieves the boot mode of the VSI.StringGuest.Service. getBootOrder()List<BrowserConsoleAccessLog>Guest.Service. getBrowserConsoleAccessLogs()A virtual guest's browser access logs.List<Syslog>Guest.Service. getConsoleAccessLog()Gets the console access logs for a computing instanceConsoleDataGuest.Service. getConsoleData()A container for a guest's console dataBooleanGuest.Service. getConsoleIpAddressFlag()A flag indicating a computing instance's console IP address is assigned.IpAddressGuest.Service. getConsoleIpAddressRecord()A record containing information about a computing instance's console IP and port number.ComponentGuest.Service. getContinuousDataProtectionSoftwareComponent()A continuous data protection software component object.ComponentGuest.Service. getControlPanel()A guest's control panel.PriceGuest.Service. getCoreRestrictedOperatingSystemPrice()If the virtual server currently has an operating system that has a core capacity restriction, return the associated core-restricted operating system item price.List<Data>Guest.Service. getCpuMetricDataByDate(GregorianCalendar startDateTime, GregorianCalendar endDateTime, List<Long> cpuIndexes)Use this method when needing the metric data for a single guest's CPUs.GraphOutputsGuest.Service. getCpuMetricImage(String snapshotRange, GregorianCalendar dateSpecified)Use this method when needing a cpu usage image for a single guest.GraphOutputsGuest.Service. getCpuMetricImageByDate(GregorianCalendar startDateTime, GregorianCalendar endDateTime, List<Long> cpuIndexes)Use this method when needing a CPU usage image for a single guest.ConfigurationGuest.Service. getCreateObjectOptions()
There are many options that may be provided while ordering a computing instance, this method can be used to determine what these options are.SummaryGuest.Service. getCurrentBandwidthSummary()An object that provides commonly used bandwidth summary components for the current billing cycle.List<Item>Guest.Service. getCurrentBillingDetail()Get the billing detail for this instance for the current billing period.BigDecimalGuest.Service. getCurrentBillingTotal()Get the total bill amount in US Dollars ($) for this instance in the current billing period.GraphGuest.Service. getCustomBandwidthDataByDate(Graph graphData)Retrieve bandwidth graph by date.GraphGuest.Service. getCustomMetricDataByDate(Graph graphData)Retrieve bandwidth graph by date.LocationDedicatedHost.Service. getDatacenter()The datacenter that the dedicated host resides in.LocationGuest.Service. getDatacenter()The datacenter that a virtual guest resides in.DedicatedHostGuest.Service. getDedicatedHost()The dedicated host associated with this guest.StatusGuest.Service. getDeviceStatus()The device status of this virtual guest.PriceGuest.Service. getDriveRetentionItemPrice()Return a drive retention SoftLayer_Item_Price object for a guest.List<Storage>Guest.Service. getEvaultNetworkStorage()A guest's associated EVault network storage service account.List<Subnet>Guest.Service. getFirewallProtectableSubnets()Get the subnets associated with this CloudLayer computing instance that are protectable by a network component firewall.FirewallGuest.Service. getFirewallServiceComponent()A computing instance's hardware firewall services.StringGuest.Service. getFirstAvailableBlockDevicePosition()List<Component>Guest.Service. getFrontendNetworkComponents()A guest's frontend network components.HardwareGuest.Service. getFrontendRouters()A guest's frontend or public router.StringGuest.Service. getGlobalIdentifier()A guest's universally unique identifier.LongGuest.Service. getGpuCount()The number of GPUs attached to the guest.StringGuest.Service. getGpuType()The name of the GPU type attached to the guest.ParameterGuest.Service. getGuestBootParameter()List<Guest>DedicatedHost.Service. getGuests()The guests associated with the dedicated host.List<Guest>Host.Service. getGuests()The guests associated with a virtual host.List<Guest>PlacementGroup.Service. getGuests()The virtual guests that are members of the placement group.ServerHost.Service. getHardware()The hardware record which a virtual host resides on.StringGuest.Service. getHardwareFunctionDescription()The object's function.HostGuest.Service. getHost()The virtual host on which a virtual guest resides (available only on private clouds).ComponentGuest.Service. getHostIpsSoftwareComponent()A host IPS software component object.BooleanGuest.Service. getHourlyBillingFlag()A guest's hourly billing status.BigDecimalGuest.Service. getInboundPrivateBandwidthUsage()The total private inbound bandwidth for this computing instance for the current billing cycle.BigDecimalGuest.Service. getInboundPublicBandwidthUsage()The total public inbound bandwidth for this computing instance for the current billing cycle.List<Instance>ReservedCapacityGroup.Service. getInstances()The guest instances that are members of this reserved capacity group.LongReservedCapacityGroup.Service. getInstancesCount()The number of instances that are members of this reserved capacity group.List<Reference>DedicatedHost.Service. getInternalTagReferences()List<Reference>Guest.Service. getInternalTagReferences()ImageGuest.Service. getIsoBootImage()List<Item>Guest.Service. getItemPricesFromSoftwareDescriptions(List<Description> softwareDescriptions, Boolean includeTranslationsFlag, Boolean returnAllPricesFlag)Return a collection of SoftLayer_Item_Price objects from a collection of SoftLayer_Software_DescriptionStateGuest.Service. getLastKnownPowerState()The last known power state of a virtual guest in the event the guest is turned off outside of IMS or has gone offline.TransactionGuest.Service. getLastOperatingSystemReload()The last transaction that a cloud server's operating system was loaded.TransactionGuest.Service. getLastTransaction()The last transaction a cloud server had performed.IncidentGuest.Service. getLatestNetworkMonitorIncident()A virtual guest's latest network monitoring incident.GuestHost.Service. getLiveGuestByUuid(String uuid)Query a virtualization platform directly to retrieve details regarding a guest.List<Guest>Host.Service. getLiveGuestList()Query a virtualization platform directly to retrieve a list of known guests.List<Object>Host.Service. getLiveGuestRecentMetricData(String uuid, Long time, Long limit, Long interval)Query a virtualization platform directly to retrieve recent metric data for a guest.BooleanGuest.Service. getLocalDiskFlag()A flag indicating that the virtual guest has at least one disk which is local to the host it runs on.LocationGuest.Service. getLocation()Where guest is located within SoftLayer's location hierarchy.BooleanGuest.Service. getManagedResourceFlag()A flag indicating that the virtual guest is a managed resource.List<Data>Guest.Service. getMemoryMetricDataByDate(GregorianCalendar startDateTime, GregorianCalendar endDateTime)Use this method when needing the metric data for memory for a single computing instance.GraphOutputsGuest.Service. getMemoryMetricImage(String snapshotRange, GregorianCalendar dateSpecified)Use this method when needing a memory usage image for a single guest.GraphOutputsGuest.Service. getMemoryMetricImageByDate(GregorianCalendar startDateTime, GregorianCalendar endDateTime)Use this method when needing a image displaying the amount of memory used over time for a single computing instance.ObjectGuest.Service. getMetricTrackingObject()A guest's metric tracking object.ObjectHost.Service. getMetricTrackingObject()The metric tracking object for this virtual host.LongGuest.Service. getMetricTrackingObjectId()The metric tracking object id for this guest.RobotGuest.Service. getMonitoringRobot()StratumGuest.Service. getMonitoringServiceComponent()A virtual guest's network monitoring services.BooleanGuest.Service. getMonitoringServiceEligibilityFlag()List<Guest>Guest.Service. getMonitoringUserNotification()The monitoring notification objects for this guest.List<IpAddress>Guest.Service. getNetworkComponentFirewallProtectableIpAddresses()Get the IP addresses associated with this CloudLayer computing instance that are protectable by a network component firewall.List<Component>Guest.Service. getNetworkComponents()A guests's network components.List<Incident>Guest.Service. getNetworkMonitorIncidents()All of a virtual guest's network monitoring incidents.List<Host>Guest.Service. getNetworkMonitors()A guests's network monitors.List<Storage>Guest.Service. getNetworkStorage()A guest's associated network storage accounts.List<Vlan>Guest.Service. getNetworkVlans()The network Vlans that a guest's network components are associated with.DedicatedHostDedicatedHost.Service. getObject()GuestGuest.Service. getObject()HostHost.Service. getObject()PlacementGroupPlacementGroup.Service. getObject()ReservedCapacityGroupReservedCapacityGroup.Service. getObject()List<Instance>ReservedCapacityGroup.Service. getOccupiedInstances()The instances already occupied by a guest on this reserved capacity group.TicketGuest.Service. getOpenCancellationTicket()An open ticket requesting cancellation of this server, if one exists.OperatingSystemGuest.Service. getOperatingSystem()A guest's operating system.StringGuest.Service. getOperatingSystemReferenceCode()A guest's operating system software description.StringGuest.Service. getOrderedPackageId()The original package id provided with the order for a Cloud Computing Instance.OrderGuest.Service. getOrderTemplate(String billingType, List<Price> orderPrices)Obtain an order container that is ready to be sent to the [[SoftLayer_Product_Order#placeOrder|SoftLayer_Product_Order::placeOrder]] method.BigDecimalGuest.Service. getOutboundPrivateBandwidthUsage()The total private outbound bandwidth for this computing instance for the current billing cycle.BigDecimalGuest.Service. getOutboundPublicBandwidthUsage()The total public outbound bandwidth for this computing instance for the current billing cycle.LongGuest.Service. getOverBandwidthAllocationFlag()Whether the bandwidth usage for this computing instance for the current billing cycle exceeds the allocation.AllocationStatusDedicatedHost.Service. getPciDeviceAllocationStatus()The container that represents PCI device allocations on the dedicated host.List<PciDevice>DedicatedHost.Service. getPciDevices()A collection of SoftLayer_Virtual_Host_PciDevice objects on the host.List<PciDevice>Host.Service. getPciDevices()List<PendingMaintenanceAction>Guest.Service. getPendingMaintenanceActions()Returns a list of all the pending maintenance actions affecting this guest.BooleanGuest.Service. getPendingMigrationFlag()When true this virtual guest must be migrated using SoftLayer_Virtual_Guest::migrate.PlacementGroupGuest.Service. getPlacementGroup()The placement group that a virtual guest belongs to.StateGuest.Service. getPowerState()The current power state of a virtual guest.StringGuest.Service. getPrimaryBackendIpAddress()A guest's primary private IP address.ComponentGuest.Service. getPrimaryBackendNetworkComponent()A guest's primary backend network component.StringGuest.Service. getPrimaryIpAddress()The guest's primary public IP address.ComponentGuest.Service. getPrimaryNetworkComponent()A guest's primary public network component.BooleanGuest.Service. getPrivateNetworkOnlyFlag()Whether the computing instance only has access to the private network.LongGuest.Service. getProjectedOverBandwidthAllocationFlag()Whether the bandwidth usage for this computing instance for the current billing cycle is projected to exceed the allocation.BigDecimalGuest.Service. getProjectedPublicBandwidthUsage()The projected public outbound bandwidth for this computing instance for the current billing cycle.GregorianCalendarGuest.Service. getProvisionDate()List<Event>Guest.Service. getRecentEvents()Recent events that impact this computing instance.List<Object>Guest.Service. getRecentMetricData(Long time)Recent metric data for a guestRegionalGuest.Service. getRegionalGroup()The regional group this guest is in.RegistryGuest.Service. getRegionalInternetRegistry()ReservedCapacityGroupGuest.Service. getReservedCapacityGroup()The reserved capacity group the guest is associated with.BooleanGuest.Service. getReservedCapacityGroupFlag()Flag to indicate whether or not a guest is part of a reserved capacity group.InstanceGuest.Service. getReservedCapacityGroupInstance()The reserved capacity group instance the guest is associated with.List<Domain>Guest.Service. getReverseDomainRecords()Retrieve the reverse domain records associated with this server.RulePlacementGroup.Service. getRule()The placement rule that the placement group is implementing.List<Asset>Guest.Service. getScaleAssets()Collection of scale assets this guest corresponds to.BooleanGuest.Service. getScaledFlag()Whether or not this guest is a member of a scale group and was automatically created as part of a scale group action.GuestGuest.Service. getScaleMember()The scale member for this guest, if applicable.List<Request>Guest.Service. getSecurityScanRequests()A guest's vulnerability scan requests.LocationGuest.Service. getServerRoom()The server room that a guest is located at.List<Component>Guest.Service. getSoftwareComponents()A guest's installed software.List<Key>Guest.Service. getSshKeys()SSH keys to be installed on the server during provisioning or an OS reload.StatusGuest.Service. getStatus()A computing instance's status.List<Reference>DedicatedHost.Service. getTagReferences()List<Reference>Guest.Service. getTagReferences()BooleanGuest.Service. getTransientGuestFlag()Whether or not a computing instance is a Transient Instance.AttributeGuest.Service. getTransientWebhookURI()The endpoint used to notify customers their transient guest is terminating.TypeGuest.Service. getType()The type of this virtual guest.List<Price>Guest.Service. getUpgradeItemPrices(Boolean includeDowngradeItemPrices)Retrieves a list of all upgrades available to a virtual server.RequestGuest.Service. getUpgradeRequest()A computing instance's associated upgrade request object if any.List<Attribute>Guest.Service. getUserData()A base64 encoded string containing custom user data for a Cloud Computing Instance order.List<Customer>Guest.Service. getUsers()A list of users that have access to this computing instance.List<Group>Guest.Service. getValidBlockDeviceTemplateGroups(String visibility)This method will return the list of block device template groups that are valid to the host.AllotmentGuest.Service. getVirtualRack()The name of the bandwidth allotment that a hardware belongs too.LongGuest.Service. getVirtualRackId()The id of the bandwidth allotment that a computing instance belongs too.StringGuest.Service. getVirtualRackName()The name of the bandwidth allotment that a computing instance belongs too.BooleanGuest.Service. isBackendPingable()Issues a ping command and returns the success (true) or failure (false) of the ping command.BooleanGuest.Service. isCloudInit()Determines if the virtual guest was provisioned from a cloud-init enabled image.VoidGuest.Service. isolateInstanceForDestructiveAction()Closes the public or private ports to isolate the instance before a destructive action.BooleanGuest.Service. isPingable()Issues a ping command and returns the success (true) or failure (false) of the ping command.TransactionGuest.Service. migrate()Creates a transaction to migrate a virtual guest to a new host.VoidGuest.Service. migrateDedicatedHost(Long destinationHostId)Create a transaction to migrate an instance from one dedicated host to another dedicated hostTransactionGuest.Service. mountIsoImage(Long diskImageId)BooleanGuest.Service. pause()Pause a virtual guest.BooleanHost.Service. pauseLiveGuest(String uuid)Pause a virtual guestBooleanGuest.Service. powerCycle()Power cycle a virtual guestBooleanHost.Service. powerCycleLiveGuest(String uuid)Power cycle a virtual guestBooleanGuest.Service. powerOff()Power off a virtual guestBooleanHost.Service. powerOffLiveGuest(String uuid)Power off a virtual guestBooleanGuest.Service. powerOffSoft()Power off a virtual guestBooleanGuest.Service. powerOn()Power on a virtual guestBooleanHost.Service. powerOnLiveGuest(String uuid)Power on a virtual guestBooleanGuest.Service. rebootDefault()Power cycle a virtual guestBooleanGuest.Service. rebootHard()Power cycle a guest.BooleanGuest.Service. rebootSoft()Attempt to complete a soft reboot of a guest by shutting down the operating system.BooleanHost.Service. rebootSoftLiveGuest(String uuid)Attempt to complete a soft reboot of a guest by shutting down the operating system.TransactionGuest.Service. reloadCurrentOperatingSystemConfiguration()Create a transaction to perform an OS reloadStringGuest.Service. reloadOperatingSystem(String token, Configuration config)Reloads current operating system configuration.BooleanGuest.Service. removeAccessToNetworkStorage(Storage networkStorageTemplateObject)This method is used to remove access to a SoftLayer_Network_Storage volume that supports host- or network-level access control.BooleanGuest.Service. removeAccessToNetworkStorageList(List<Storage> networkStorageTemplateObjects)This method is used to allow access to multiple SoftLayer_Network_Storage volumes that support host- or network-level access control.BooleanGuest.Service. removeTags(String tags)BooleanGuest.Service. resume()Resume a virtual guest, this can only be called when a VSI is in Suspended state.BooleanHost.Service. resumeLiveGuest(String uuid)Resume a virtual guestVoidGuest.Service. sendTestReclaimScheduledAlert()BooleanGuest.Service. setPrivateNetworkInterfaceSpeed(Long newSpeed)Sets the private network interface speed to the new speed.BooleanGuest.Service. setPublicNetworkInterfaceSpeed(Long newSpeed)Sets the public network interface speed to the new speed.BooleanDedicatedHost.Service. setTags(String tags)BooleanGuest.Service. setTags(String tags)VoidGuest.Service. setTransientWebhook(String uri, String secret)BooleanGuest.Service. setUserMetadata(List<String> metadata)Sets the data that will be written to the configuration drive.BooleanGuest.Service. shutdownPrivatePort()Shuts down the private network portBooleanGuest.Service. shutdownPublicPort()Shuts down the public network portTransactionGuest.Service. unmountIsoImage()BooleanGuest.Service. validateImageTemplate(Long imageTemplateId)Validate an image template for OS ReloadBooleanGuest.Service. verifyReloadOperatingSystem(Configuration config)Verify that a virtual server can go through the operating system reload process. -
Uses of ApiMethod in com.softlayer.api.service.virtual.disk
Methods in com.softlayer.api.service.virtual.disk with annotations of type ApiMethod Modifier and Type Method Description BooleanImage.Service. editObject(Image templateObject)List<String>Image.Service. getAvailableBootModes()Returns a collection of boot modes that are supported for primary disks.ImageImage.Service. getBillingItem()The billing item for a virtual disk image.List<Device>Image.Service. getBlockDevices()The block devices that a disk image is attached to.BooleanImage.Service. getBootableVolumeFlag()BooleanImage.Service. getCloudInitFlag()Check if cloud-init is enabled.List<Image>Image.Service. getCoalescedDiskImages()BooleanImage.Service. getCopyOnWriteFlag()StringImage.Service. getDiskFileExtension()Return disk file extensionGroupImage.Service. getDiskImageStorageGroup()StringImage.Service. getImportedDiskType()Return imported disk typeBooleanImage.Service. getIsEncrypted()Return if image is encryptedBooleanImage.Service. getLocalDiskFlag()BooleanImage.Service. getMetadataFlag()Whether this disk image is meant for storage of custom user data supplied with a Cloud Computing Instance order.ImageImage.Service. getObject()List<Image>Image.Service. getPublicIsoImages()Retrieves images from the public ISO repositoryList<Software>Image.Service. getSoftwareReferences()References to the software that resides on a disk image.ImageImage.Service. getSourceDiskImage()The original disk image that the current disk image was cloned from.StorageGroupDetailsImage.Service. getStorageGroupDetails()Return storage group details for symantec diskList<Group>Image.Service. getStorageGroups()The storage group for a virtual disk image.RepositoryImage.Service. getStorageRepository()The storage repository that a disk image resides in.TypeImage.Service. getStorageRepositoryType()The type of storage repository that a disk image resides in.StringImage.Service. getSupportedHardware()Return supported hardware component IDs for symantec diskTemplateImage.Service. getTemplateBlockDevice()The template that attaches a disk image to a [[SoftLayer_Virtual_Guest_Block_Device_Template_Group|archive]].TypeImage.Service. getType()A virtual disk image's type. -
Uses of ApiMethod in com.softlayer.api.service.virtual.guest.block.device.template
Methods in com.softlayer.api.service.virtual.guest.block.device.template with annotations of type ApiMethod Modifier and Type Method Description BooleanGroup.Service. addByolAttribute()This method allows you to mark this image template as customer managed software license (BYOL)BooleanGroup.Service. addCloudInitAttribute()This method allows you to mark this image template as cloud initBooleanGroup.Service. addLocations(List<Location> locations)This method will create transaction(s) to add available locations to an archive image template.BooleanGroup.Service. addSupportedBootMode(String bootMode)This method allows you to mark this image's supported boot modes as 'HVM' or 'PV'.BooleanGroup.Service. copyToExternalSource(Configuration configuration)Create a transaction to export/copy a template to an external source.BooleanGroup.Service. copyToIcos(Configuration configuration)Create a transaction to export/copy a template to an ICOS.GroupGroup.Service. createFromExternalSource(Configuration configuration)Create a transaction to import a disk image from an external source and create a standard image template.GroupGroup.Service. createFromIcos(Configuration configuration)Create a process to import a disk image from ICOS and create a standardLongGroup.Service. createPublicArchiveTransaction(String groupName, String summary, String note, List<Location> locations)Create a transaction to copy archived block devices into public repositoryBooleanGroup.Service. deleteByolAttribute()This method allows you to remove BYOL attribute for a given image template.BooleanGroup.Service. deleteCloudInitAttribute()This method allows you to remove cloud init attribute for a given image template.TransactionGroup.Service. deleteObject()Deleting a block device template group is different from the deletion of other objects.BooleanGroup.Service. denySharingAccess(Long accountId)This method will deny another SoftLayer customer account's previously given access to provision CloudLayer Computing Instances from an image template group.BooleanGroup.Service. editObject(Group templateObject)Edit an image template group's associated name and note.List<Group>Group.Service. findGcImagesByCurrentUser(List<String> dataCenters, List<String> regions)Find block device template groups containing a GC enabled cloudinit image for the current active user.AccountGroup.Service. getAccount()A block device template group's [[SoftLayer_Account|account]].List<Contact>Group.Service. getAccountContacts()List<Accounts>Group.Service. getAccountReferences()The accounts which may have read-only access to an image template group.List<String>Group.Service. getAllAvailableCompatiblePlatformNames()Get all available compatible platform names that can be added to a template group.List<Template>Group.Service. getBlockDevices()The block devices that are part of an image template groupBigDecimalGroup.Service. getBlockDevicesDiskSpaceTotal()The total disk space of all images in a image template group.StringGroup.Service. getBootMode()This method returns the boot mode, if any, set on a given image template.BooleanGroup.Service. getByolFlag()A flag indicating that customer is providing the software licenses.List<Group>Group.Service. getChildren()The image template groups that are clones of an image template group.List<String>Group.Service. getCurrentCompatiblePlatformNames()Get compatible platform names currently set on the template group.LocationGroup.Service. getDatacenter()The location containing this image template group.List<Location>Group.Service. getDatacenters()A collection of locations containing a copy of this image template group.StringGroup.Service. getDefaultBootMode()This method returns the default boot mode set by the software descriptionList<String>Group.Service. getEncryptionAttributes()This method returns an array of encryption values, or empty array if none are foundGroupGroup.Service. getFirstChild()The first clone of the image template groupBooleanGroup.Service. getFlexImageFlag()A flag indicating if this is a flex image.StringGroup.Service. getGlobalIdentifier()An image template's universally unique identifier.TypeGroup.Service. getImageType()The virtual disk image type of this template.StringGroup.Service. getImageTypeKeyName()The virtual disk image type keyname (e.g.BooleanGroup.Service. getNextGenFlag()A flag indicating if this is a next generation image.GroupGroup.Service. getObject()GroupGroup.Service. getParent()The image template group that another image template group was cloned from.List<Group>Group.Service. getPublicCustomerOwnedImages()This method gets all public customer owned image templates that the user is allowed to see.List<Group>Group.Service. getPublicImages()This method gets all public image templates that the user is allowed to see.ResourceGroup.Service. getRegion()List<Resource>Group.Service. getRegions()RiasAccountGroup.Service. getRiasAccount(String secret)List<Key>Group.Service. getSshKeys()The ssh keys to be implemented on the server when provisioned or reloaded from an image template group.StatusGroup.Service. getStatus()A template group's status.List<Location>Group.Service. getStorageLocations()Returns the image storage locations.RepositoryGroup.Service. getStorageRepository()The storage repository that an image template group resides on.List<String>Group.Service. getSupportedBootModes()This method indicates which boot modes are supported by the image.List<Reference>Group.Service. getTagReferences()The tags associated with this image template group.StringGroup.Service. getTemplateDataCenterName()This method allows you to grab the first data center that the image(s) reside on so we can pull it from there.TransactionGroup.Service. getTransaction()A transaction that is being performed on a image template group.List<Description>Group.Service. getVhdImportSoftwareDescriptions()Returns an array of SoftLayer_Software_Description that are supported for VHD imports.BooleanGroup.Service. isByol()This method indicates whether or not this image is a customer supplied license image.BooleanGroup.Service. isByolCapableOperatingSystem()This method indicates whether or not this image uses an operating system capable of using a customer supplied license image.BooleanGroup.Service. isByolOnlyOperatingSystem()This method indicates whether or not this image uses an operating system that requires using a customer supplied license imageBooleanGroup.Service. isCloudInit()This method indicates whether or not this image is a cloud-init image.BooleanGroup.Service. isCloudInitOnlyOperatingSystem()This method indicates whether or not this image uses an operating system that requires cloud initBooleanGroup.Service. isEncrypted()This method indicates whether this image template contains an encrypted disk image.BooleanGroup.Service. permitSharingAccess(Long accountId)This method will permit another SoftLayer customer account access to provision CloudLayer Computing Instances from an image template group.BooleanGroup.Service. removeCompatiblePlatforms(List<String> platformNames)Removes compatible platforms on the template group.BooleanGroup.Service. removeLocations(List<Location> locations)This method will create transaction(s) to remove available locations from an archive image template.BooleanGroup.Service. removeSupportedBootMode(String bootMode)This method allows you to remove a supported boot mode attribute for a given image template.BooleanGroup.Service. setAvailableLocations(List<Location> locations)Create transaction(s) to set the archived block device available locationsBooleanGroup.Service. setBootMode(String newBootMode)This method allows you to specify the boot mode for a given image template.BooleanGroup.Service. setCompatiblePlatforms(List<String> platformNames)Sets compatible platforms on the template group.BooleanGroup.Service. setTags(String tags)Set the tags for this template group. -
Uses of ApiMethod in com.softlayer.api.service.virtual.guest.boot
Methods in com.softlayer.api.service.virtual.guest.boot with annotations of type ApiMethod Modifier and Type Method Description BooleanParameter.Service. createObject(Parameter templateObject)BooleanParameter.Service. deleteObject()BooleanParameter.Service. editObject(Parameter templateObject)GuestParameter.Service. getGuest()TypeParameter.Service. getGuestBootParameterType()ParameterParameter.Service. getObject() -
Uses of ApiMethod in com.softlayer.api.service.virtual.guest.boot.parameter
Methods in com.softlayer.api.service.virtual.guest.boot.parameter with annotations of type ApiMethod Modifier and Type Method Description List<Type>Type.Service. getAllObjects()TypeType.Service. getObject() -
Uses of ApiMethod in com.softlayer.api.service.virtual.guest.network
Methods in com.softlayer.api.service.virtual.guest.network with annotations of type ApiMethod Modifier and Type Method Description BooleanComponent.Service. disable()Completely restrict all incoming and outgoing bandwidth traffic to a network componentBooleanComponent.Service. enable()Allow incoming and outgoing bandwidth traffic to a network componentGuestComponent.Service. getGuest()The computing instance that this network component exists on.BooleanComponent.Service. getHighAvailabilityFirewallFlag()IcpBindingComponent.Service. getIcpBinding()List<IpAddress>Component.Service. getIpAddressBindings()The records of all IP addresses bound to a computing instance's network component.FirewallComponent.Service. getNetworkComponentFirewall()The upstream network component firewall.VlanComponent.Service. getNetworkVlan()The VLAN that a computing instance network component's subnet is associated with.ComponentComponent.Service. getObject()StringComponent.Service. getPrimaryIpAddress()A computing instance network component's primary IP address.IpAddressComponent.Service. getPrimaryIpAddressRecord()SubnetComponent.Service. getPrimarySubnet()A network component's subnet for its primary IP addressIpAddressComponent.Service. getPrimaryVersion6IpAddressRecord()A network component's primary IPv6 IP address record.RouterComponent.Service. getRouter()A network component's routers.List<NetworkComponentBinding>Component.Service. getSecurityGroupBindings()The bindings associating security groups to this network componentList<Subnet>Component.Service. getSubnets()A network component's subnets.BooleanComponent.Service. isPingable()Issues a ping command and returns the success (true) or failure (false) of the ping command.BooleanComponent.Service. securityGroupsReady() -
Uses of ApiMethod in com.softlayer.api.service.virtual.placementgroup
Methods in com.softlayer.api.service.virtual.placementgroup with annotations of type ApiMethod Modifier and Type Method Description List<Rule>Rule.Service. getAllObjects()Get all placement group rules.RuleRule.Service. getObject() -
Uses of ApiMethod in com.softlayer.api.service.virtual.reservedcapacitygroup
Methods in com.softlayer.api.service.virtual.reservedcapacitygroup with annotations of type ApiMethod Modifier and Type Method Description BooleanInstance.Service. getAvailableFlag()Flag to indecate whether or not the reserved instance is available or not.ItemInstance.Service. getBillingItem()The billing item for the reserved capacity group instance.GuestInstance.Service. getGuest()The virtual guest associated with this reserved capacity group instance.InstanceInstance.Service. getObject()ReservedCapacityGroupInstance.Service. getReservedCapacityGroup()The reserved instances that are members of this reserved capacity group. -
Uses of ApiMethod in com.softlayer.api.service.virtual.storage
Methods in com.softlayer.api.service.virtual.storage with annotations of type ApiMethod Modifier and Type Method Description AccountRepository.Service. getAccount()The [[SoftLayer_Account|account]] that a storage repository belongs to.BigDecimalRepository.Service. getArchiveDiskUsageRatePerGb()Returns the archive storage disk usage fee rate per gigabyte.BigDecimalRepository.Service. getAverageDiskUsageMetricDataFromInfluxByDate(GregorianCalendar startDateTime, GregorianCalendar endDateTime)Returns the average disk space usage for a storage repository.BigDecimalRepository.Service. getAverageUsageMetricDataByDate(GregorianCalendar startDateTime, GregorianCalendar endDateTime)Returns the average disk space usage for a storage repository.ItemRepository.Service. getBillingItem()The current billing item for a storage repository.LocationRepository.Service. getDatacenter()The datacenter that a virtual storage repository resides in.List<Image>Repository.Service. getDiskImages()The [[SoftLayer_Virtual_Disk_Image|disk images]] that are in a storage repository.List<Guest>Repository.Service. getGuests()The computing instances that have disk images in a storage repository.RepositoryRepository.Service. getMetricTrackingObject()RepositoryRepository.Service. getObject()ItemRepository.Service. getPublicImageBillingItem()The current billing item for a public storage repository.BigDecimalRepository.Service. getPublicImageDiskUsageRatePerGb()Returns the public image storage disk usage fee rate per gigabyte.List<Location>Repository.Service. getStorageLocations()Returns the public image storage locations.TypeRepository.Service. getType()A storage repository's [[SoftLayer_Virtual_Storage_Repository_Type|type]].List<Data>Repository.Service. getUsageMetricDataByDate(GregorianCalendar startDateTime, GregorianCalendar endDateTime)Retrieve disk usage data on a [[SoftLayer_Virtual_Guest|Cloud Computing Instance]] image for the time range you provide.GraphOutputsRepository.Service. getUsageMetricImageByDate(GregorianCalendar startDateTime, GregorianCalendar endDateTime)Returns a disk usage image based on disk usage specified by the input parameters. -
Uses of ApiMethod in com.softlayer.api.service.workload.citrix
Methods in com.softlayer.api.service.workload.citrix with annotations of type ApiMethod Modifier and Type Method Description DeploymentDeployment.Service. createObject(Deployment templateObject)Creates a new Citrix Virtual Apps and Desktops deployment.ResponseClient.Service. createResourceLocation(Request citrixCredentials)AccountDeployment.Service. getAccount()The [[SoftLayer_Account]] to which the deployment belongs.List<Deployment>Deployment.Service. getAllObjects()Get all Citrix Virtual Apps And Desktop deployments.ResponseDeployment.Service. getDeployment(Long deploymentId)Returns a response object [[SoftLayer_Workload_Citrix_Deployment_Response]] which represents the CVAD deployment [[SoftLayer_Workload_Citrix_Deployment]] together with all the resources ordered under the CVAD order.DeploymentDeployment.Service. getObject()ResponseClient.Service. getResourceLocations(Request citrixCredentials)List<Resource>Deployment.Service. getResources()It contains a collection of items under the CVAD deployment.TypeDeployment.Service. getType()It shows if the deployment is for Citrix Hypervisor or VMware.CustomerDeployment.Service. getUser()It is the [[SoftLayer_User_Customer]] who placed the order for CVAD.VlanDeployment.Service. getVlan()It is the VLAN resource for the CVAD deployment.ResponseClient.Service. validateCitrixCredentials(Request citrixCredentials) -
Uses of ApiMethod in com.softlayer.api.service.workload.citrix.deployment
Methods in com.softlayer.api.service.workload.citrix.deployment with annotations of type ApiMethod Modifier and Type Method Description ResourceResource.Service. createObject(Resource templateObject)This will add the resource into CVAD deployment.List<Resource>Resource.Service. getAllObjects()Get all the resources of Citrix Deployments.ItemResource.Service. getBillingItem()DeploymentResource.Service. getDeployment()ResourceResource.Service. getObject()getObject retrieves the SoftLayer_Workload_Citrix_Deployment_Resource object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Workload_Citrix_Deployment_Resource service.TypeType.Service. getObject()OrderResource.Service. getOrder()RoleResource.Service. getRole() -
Uses of ApiMethod in com.softlayer.api.service.workload.citrix.workspace
Methods in com.softlayer.api.service.workload.citrix.workspace with annotations of type ApiMethod Modifier and Type Method Description ResultOrder.Service. cancelWorkspaceResources(String vlanIdentifier, Boolean cancelImmediately, String customerNote)This method will cancel the resources associated with the provided VLAN and have a 'cvad' tag reference.ResultOrder.Service. getWorkspaceNames()This method will return the list of names of VLANs which have a 'cvad' tag reference.ResultOrder.Service. getWorkspaceResources(String vlanIdentifier)This method will return the list of resources which could be cancelled using cancelWorkspaceResourcesResponseOrder.Service. placeWorkspaceOrder(Container orderContainer)ResponseOrder.Service. verifyWorkspaceOrder(Container orderContainer)This service is used to verify that an order meets all the necessary requirements to purchase Citrix Virtual Apps and Desktops running on IBM cloud.
-