Reference: Tables

Edit online

Reference tables overview

This section contains reference tables for common API parameters, separated by endpoint. Note that filter tables may contain other reference tables for completeness.

Action Reference Tables

Action Mode:

  • DISABLED:

    Do not recommend or perform the action. When you disable an action, the user interface will no longer display actions of that type.

  • RECOMMENDED:

    Recommend the action so a user can execute it via the given hypervisor or by other external means

  • MANUAL:

    Recommend the action, and provide the option to execute that action through the Turbonomic user interface or an /actions API request.

  • AUTOMATED:

    You have directed Turbonomic to execute the action automatically.

  • COLLECTION (UNUSED):

    Legacy action mode, no longer used.

Action State:

  • DISABLED:

    An action whose policy has been disabled.

  • RECOMMEND:

    An action that cannot be automated due to policy settings or must be executed outside the system, such as the purchase of hardware.

  • PENDING_ACCEPT:

    When the action mode is set to manual, a recommended action that has not been accepted or cleared.

  • ACCEPTED:

    An action that has been accepted, but is not yet in progress.

  • IN_PROGRESS:

    An action that is being executed.

  • SUCCEEDED:

    An action that was accepted and completed successfully.

  • FAILED:

    An action that was accepted and did not complete successfully.

  • REJECTED:

    When the action mode is set to manual, an action that has been rejected by the user.

  • CLEARED:

    When the action mode is set to manual, an action that is no longer recommended by the market.

  • ACCOUNTING:

    For cloud entities, an action to resize in order to use a different instance template.

  • QUEUED:

    When more than 10 actions are to be executed for a single target, Turbonomic will place the 11th and all subsequent actions into a QUEUED state, and they will execute as the previous actions complete.

Action Type:

  • START:

    Start an entity, and add it to the Turbonomic market.

  • MOVE:

    Move an entity from one provider to another. For example, moving a VM between hosts, or a datastore between disk arrays.

  • SUSPEND:

    Suspend the entity to exclude its capacity from your environment. Suspend does not remove the entity from your environment, but the market does not include the entity in its analysis. Based on market conditions, analysis can recommend restarting suspended entities, which includes them in market analysis once again.

  • ADD PROVIDER:

    This is equivalent to the START action, but for storage entities.

  • CHANGE:

    Move a virtual machine's storage between datastores.

  • PROVISION:

    Add capacity to your environment.

  • RECONFIGURE:

    Analysis recommends this when a VM is not able to correct a misconfiguration via another type of action. For example, analysis can recommend a RECONFIGURE action when a placement policy requires a VM to move to a host on a particular cluster, but cross-cluster moves are not permitted.

  • DELETE:

    This is equivalent to the SUSPEND action, but for storage entities.

  • RESERVE_ON_PM:

    When using the reservation functionality, this is the action to reserve the resources of a VM on a particular host.

  • RESERVE_ON_DS:

    When using the reservation functionality, this is the action to reserve the resources of a VM on a particular datastore.

  • RESIZE_FOR_EFFICIENCY:

    A resize that reduces the capacity of a commodity, such as vCPU, or vMEM.

  • RESIZE_FOR_PERFORMANCE:

    A resize that increases the capacity of a commodity, such as vCPU, or vMEM.

Action Filter Criteria:

  • actionModeList

    • DISABLED:

      Do not recommend or perform the action. When you disable an action, the user interface will no longer display actions of that type.

    • RECOMMENDED:

      Recommend the action so a user can execute it via the given hypervisor or by other external means

    • MANUAL:

      Recommend the action, and provide the option to execute that action through the Turbonomic user interface or an /actions API request.

    • AUTOMATED:

      You have directed Turbonomic to execute the action automatically.

    • COLLECTION (UNUSED):

      Legacy action mode, no longer used.

  • actionStateList

    • DISABLED:

      An action whose policy has been disabled.

    • RECOMMEND:

      An action that cannot be automated due to policy settings or must be executed outside the system, such as the purchase of hardware.

    • PENDING_ACCEPT:

      When the action mode is set to manual, a recommended action that has not been accepted or cleared.

    • ACCEPTED:

      An action that has been accepted, but is not yet in progress.

    • IN_PROGRESS:

      An action that is being executed.

    • SUCCEEDED:

      An action that was accepted and completed successfully.

    • FAILED:

      An action that was accepted and did not complete successfully.

    • REJECTED:

      When the action mode is set to manual, an action that has been rejected by the user.

    • CLEARED:

      When the action mode is set to manual, an action that is no longer recommended by the market.

    • ACCOUNTING:

      For cloud entities, an action to resize in order to use a different instance template.

    • QUEUED:

      When more than 10 actions are to be executed for a single target, Turbonomic will place the 11th and all subsequent actions into a QUEUED state, and they will execute as the previous actions complete.

  • actionTypeList

    • START:

      Start an entity, and add it to the Turbonomic market.

    • MOVE:

      Move an entity from one provider to another. For example, moving a VM between hosts, or a datastore between disk arrays.

    • SUSPEND:

      Suspend the entity to exclude its capacity from your environment. Suspend does not remove the entity from your environment, but the market does not include the entity in its analysis. Based on market conditions, analysis can recommend restarting suspended entities, which includes them in market analysis once again.

    • ADD PROVIDER:

      This is equivalent to the START action, but for storage entities.

    • CHANGE:

      Move a virtual machine's storage between datastores.

    • PROVISION:

      Add capacity to your environment.

    • RECONFIGURE:

      Analysis recommends this when a VM is not able to correct a misconfiguration via another type of action. For example, analysis can recommend a RECONFIGURE action when a placement policy requires a VM to move to a host on a particular cluster, but cross-cluster moves are not permitted.

    • DELETE:

      This is equivalent to the SUSPEND action, but for storage entities.

    • RESERVE_ON_PM:

      When using the reservation functionality, this is the action to reserve the resources of a VM on a particular host.

    • RESERVE_ON_DS:

      When using the reservation functionality, this is the action to reserve the resources of a VM on a particular datastore.

    • RESIZE_FOR_EFFICIENCY:

      A resize that reduces the capacity of a commodity, such as vCPU, or vMEM.

    • RESIZE_FOR_PERFORMANCE:

      A resize that increases the capacity of a commodity, such as vCPU, or vMEM.

  • cleared

    Default: false.

    When true, actions that were removed from the action list before being executed will be returned.

  • costType

    • Saving

      An action that will decrease cloud spending.

    • Investment

      An action that will increase cloud spending.

  • cumulative

    Default: false.

    When true, shows the savings for each action in a scope as a cumulative total, rather than showing the savings for individual actions.

  • environmentType

    • ONPREM:

      Returns only actions related to entities that are part of your on-prem environment.

    • CLOUD:

      Returns only actions related to entities that are part of your cloud environment.

  • groupBy

    You may group the actions returned by the following criteria: [actionModes, actionStates, actionTypes, risk, riskSeverity, riskSubCategory]

  • hasReservedInstance

    Default: false.

    When true, only actions that are related to reserved instances will be returned.

  • relatedEntityTypes

    Returns only actions related to entities of these types within the scope. For example, if your scope is a virtual datacenter and you specify VirtualMachine as a related entity type, the request will include only those actions related to VMs in the specified virtual datacenter.

    Choose from the following entity types: [ Datacenter, PhysicalMachine, VirtualMachine, Storage, Application, Chassis, DiskArray, IOModule, StorageControl, Switch, VirtualDataCenter, VPod, DPod, Container, Database, DatabaseServerContainer, LogicalPool ]

  • riskSeverityList

    Returns only actions of the given severities: [ Unknown, Normal, Minor, Major, Critical ]

  • riskSubCategoryList

  • returns only actions of the given subcategories: [ Performance Assurance, Efficiency Improvement, Prevention, Compliance ]

Entity Reference Tables

Entity State:

  • ACTIVE:

    Entity is actively consuming resources.

  • EVACUATED:

    Entity is ready to suspend and will not participate in the market, but will not generate a SUSPEND action.

    Note: This state replaces the SUSPEND state, and requires additional configuration to enable. Turbonomic does not recommend enabling this state.

  • FAILOVER:

    This entity is reserved for failover and will not participate in the market.

  • IDLE:

    Entity is powered off and not actively consuming market resources.

  • LAUNCH:

    Entity is starting.

  • MAINTENANCE:

    Entity is in maintenance mode.

  • NOT_MONITORED:

    Entity is not currently monitored by Turbonomic.

  • QUEUED:

    Entity is in the process of changing from one state to another.

    Note: This state is internal to Turbonomic and will not appear in the UI, but may appear in an API response if the call is executed at the precise moment the entity is changing state.

  • RESOURCE_ALLOCATION:

    Cloud entity is being created.

  • RESOURCE_RELEASE:

    Cloud Entity is being deleted.

  • SUSPEND:

    Entity is suspended or the guest OS is in sleep, standby, or suspended state. The entity is not removed from the environment, but will not be used in market decisions. Based on market conditions, suspended entities can be started, re-adding them to the market.

  • SUSPEND_PENDING:

    Entity is making preparations to suspend, or is the next entity of its type to suspend.

  • TERMINATE_PENDING:

    Entity is in the process of being deleted.

  • UNKNOWN:

    Turbonomic is unable to obtain the current state of the entity.

    This occurs when the entity is reported to the hypervisor as having a state of DISCONNECTED, ORPHANED, or INVALID.

Entity Type:

  • APPLICATION

  • APPLICATION_SERVER

  • BUSINESS_ACCOUNT

  • BUSINESS_UNIT

  • CHASSIS

  • CLOUD_SERVICE

  • CONTAINER

  • CONTAINER_POD

  • DATABASE

  • DATABASE_SERVER

  • DATACENTER

  • DISK_ARRAY

  • IO_MODULE

  • LOAD_BALANCER

  • LOGICAL_POOL

  • NETWORK

  • PHYSICAL_MACHINE

  • STORAGE

  • STORAGE_CONTROLLER

  • SWITCH

  • VIRTUAL_APPLICATION

  • VIRTUAL_DATACENTER

  • VIRTUAL_MACHINE