cfme.cloud.instance package

Submodules

• cfme.cloud.instance.azure module
• cfme.cloud.instance.ec2 module
• cfme.cloud.instance.gce module
• cfme.cloud.instance.image module
• cfme.cloud.instance.openstack module

Module contents

class cfme.cloud.instance.All(obj, navigate_obj)

Bases: cfme.utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of InstanceAllView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

resetter(*args, **kwargs)

step()

class cfme.cloud.instance.AllForProvider(obj, navigate_obj)

Bases: cfme.utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of InstanceProviderAllView

prerequisite

This is a helper descriptor for destinations which are linked to an attribute of the object.

For instance, imagine you have an object that has an attribute(parent) which has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToAttribute as a helper, supplying only the name of the attribute which stores the object to be used in the navigation, and the destination name. This will set prerequisite to be a callable that will navigate to the prerequisite step.

resetter(*args, **kwargs)

step(*args, **kwargs)

class cfme.cloud.instance.CloudInstanceView(parent, logger=None, **kwargs)

Bases: cfme.base.login.BaseLoggedInPage

Base view for header/nav check, inherit for navigatable views

in_cloud_instance

class cfme.cloud.instance.Details(obj, navigate_obj)

Bases: cfme.utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of InstanceDetailsView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

resetter(*args, **kwargs)

step()

class cfme.cloud.instance.Edit(obj, navigate_obj)

Bases: cfme.utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of EditView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)

class cfme.cloud.instance.EditManagementEngineRelationship(obj, navigate_obj)

Bases: cfme.utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ManagementEngineView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)

class cfme.cloud.instance.Instance(name, provider, template_name=None, appliance=None)

Bases: cfme.common.vm.VM, cfme.utils.appliance.Navigatable

Represents a generic instance in CFME. This class is used if none of the inherited classes will match.

Parameters:

• name – Name of the instance
• provider – cfme.cloud.provider.Provider object
• template_name – Name of the template to use for provisioning
• appliance – :py:class: utils.appliance.IPAppliance object

Note

This class cannot be instantiated. Use instance_factory() instead.

ALL_LIST_LOCATION = 'clouds_instances'

PROVISION_CANCEL = 'Add of new VM Provision Request was cancelled by the user'

PROVISION_START = 'VM Provision Request was Submitted, you will be notified when your VMs are ready'

QUADICON_TYPE = 'instance'

REMOVE_SINGLE = 'Remove Instance'

TO_OPEN_EDIT = 'Edit this Instance'

TO_RETIRE = 'Retire this Instance'

VM_TYPE = 'Instance'

create(form_values, cancel=False)

Provisions an instance with the given properties through CFME

Parameters:form_values – dictionary of form values for provisioning, structured into tabs

Note

Calling create on a sub-class of instance will generate the properly formatted dictionary when the correct fields are supplied.

exists

find_quadicon(**kwargs)

Find and return a quadicon belonging to a specific instance

TODO: remove this method and refactor callers to use view entities instead

Args: Returns: entity of appropriate type

get_collection_via_rest()

get_vm_via_rest()

on_details(force=False)

A function to determine if the browser is already on the proper instance details page.

An instance may not be assigned to a provider if archived or orphaned

If no provider is listed, default to False since we may be on the details page for an instance on the wrong provider.

power_control_from_cfme(*args, **kwargs)

Power controls a VM from within CFME using details or collection

Raises:

• InstanceNotFound – the instance wasn’t found when navigating
• OptionNotAvailable – option param is not visible or enabled

set_ownership(user=None, group=None, click_cancel=False, click_reset=False)

Set instance ownership

TODO: collapse this back to common.vm after both subclasses converted to widgetastic :param user: username for ownership :type user: str :param group: groupname for ownership :type group: str :param click_cancel: Whether to cancel form submission :type click_cancel: bool :param click_reset: Whether to reset form after filling

unset_ownership()

Remove user ownership and return group to EvmGroup-Administrator

update(values, cancel=False, reset=False)

Update cloud instance

Parameters:

• values – Dictionary of form key/value pairs
• cancel – Boolean, cancel the form submission
• reset – Boolean, reset form after fill - returns immediately after reset

Note

The edit form contains a ‘Reset’ button - if this is c

wait_for_instance_state_change(desired_state, timeout=900)

Wait for an instance to come to desired state.

This function waits just the needed amount of time thanks to wait_for.

Parameters:

• desired_state – A string or list of strings indicating desired state
• timeout – Specify amount of time (in seconds) to wait until TimedOutError is raised

class cfme.cloud.instance.InstanceAccordion(parent, logger=None, **kwargs)

Bases: widgetastic.widget.View

The accordion on the instances page

images

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

images_by_provider

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

instances

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

instances_by_provider

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.instance.InstanceAllView(parent, logger=None, **kwargs)

Bases: cfme.cloud.instance.CloudInstanceView

The collection page for instances

adv_search_clear

entities

is_displayed

paginator

sidebar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.instance.InstanceDetailsToolbar(parent, logger=None, **kwargs)

Bases: widgetastic.widget.View

The toolbar on the details screen for an instance

access

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

configuration

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

download

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

lifecycle

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

monitoring

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

policy

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

power

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

reload

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.instance.InstanceDetailsView(parent, logger=None, **kwargs)

Bases: cfme.cloud.instance.CloudInstanceView

entities

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed

sidebar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.instance.InstanceProviderAllView(parent, logger=None, **kwargs)

Bases: cfme.cloud.instance.CloudInstanceView

adv_search_clear

entities

instances_by_provider

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

is_displayed

paginator

sidebar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

toolbar

This class handles instantiating and caching of the widgets on view.

It stores the class and the parameters it should be instantiated with. Once it is accessed from the instance of the class where it was defined on, it passes the instance to the widget class followed by args and then kwargs.

It also acts as a counter, so you can then order the widgets by their “creation” stamp.

class cfme.cloud.instance.InstanceTimelinesView(parent, logger=None, **kwargs)

Bases: widgetastic_manageiq.TimelinesView, cfme.cloud.instance.CloudInstanceView

is_displayed

class cfme.cloud.instance.ManagePolicies(obj, navigate_obj)

Bases: cfme.utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ManagePoliciesView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)

class cfme.cloud.instance.PolicySimulation(obj, navigate_obj)

Bases: cfme.utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of PolicySimulationView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)

class cfme.cloud.instance.Provision(obj, navigate_obj)

Bases: cfme.utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of ProvisionView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)

class cfme.cloud.instance.SetOwnership(obj, navigate_obj)

Bases: cfme.utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of SetOwnershipView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)

class cfme.cloud.instance.SetRetirement(obj, navigate_obj)

Bases: cfme.utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of RetirementView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)

class cfme.cloud.instance.Timelines(obj, navigate_obj)

Bases: cfme.utils.appliance.implementations.ui.CFMENavigateStep

VIEW

alias of InstanceTimelinesView

prerequisite

This is a helper descriptor for navigation destinations which are linked to the same class.

For instance, imagine you have an object that has a ‘ViewAll’, destination that needs to be visited before you can click on ‘New’. In this instance, you would need to make the ‘New’ destination use ‘ViewAll’ as a prerequisite. As this would need no other special input, we can use NavigateToSibling as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step.

step(*args, **kwargs)