cfme.infrastructure.provider package

Submodules

• cfme.infrastructure.provider.kubevirt module
• cfme.infrastructure.provider.openstack_infra module
• cfme.infrastructure.provider.rhevm module
• cfme.infrastructure.provider.scvmm module
• cfme.infrastructure.provider.virtualcenter module

Module contents

A model of an Infrastructure Provider in CFME

class cfme.infrastructure.provider.Add(obj, navigate_obj)

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

VIEW

alias of InfraProviderAddView

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()

class cfme.infrastructure.provider.All(obj, navigate_obj)

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

VIEW

alias of InfraProvidersView

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()

step()

class cfme.infrastructure.provider.Details(obj, navigate_obj)

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

VIEW

alias of InfraProviderDetailsView

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()

Reset view and selection

step()

class cfme.infrastructure.provider.DetailsFromProvider(obj, navigate_obj)

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

VIEW

alias of ProviderClustersView

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)

Navigate to the correct view

class cfme.infrastructure.provider.Discover(obj, navigate_obj)

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

VIEW

alias of InfraProvidersDiscoverView

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()

class cfme.infrastructure.provider.Edit(obj, navigate_obj)

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

VIEW

alias of ProviderEditView

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()

class cfme.infrastructure.provider.EditTags(obj, navigate_obj)

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

VIEW

alias of TagPageView

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()

class cfme.infrastructure.provider.InfraProvider(parent, endpoints=NOTHING, name=None, key=None, zone=None, start_ip=None, end_ip=None, provider_data=None)

Bases: cfme.common.provider.BaseProvider, cfme.common.provider.CloudInfraProviderMixin, cfme.utils.pretty.Pretty, widgetastic.utils.Fillable, cfme.common.PolicyProfileAssignable, cfme.common.Taggable

Abstract model of an infrastructure provider in cfme. See VMwareProvider or RHEVMProvider.

Parameters:

• name – Name of the provider.
• details – a details record (see VMwareDetails, RHEVMDetails inner class).
• key – The CFME key of the provider in the yaml.
• endpoints – one or several provider endpoints like DefaultEndpoint. it should be either dict
• format dict{endpoint.name, endpoint, endpoint_n.name, endpoint_n}, list of endpoints or (in) –
• one endpoint (mere) –

Usage:

credentials = Credential(principal='bad', secret='reallybad')
endpoint = DefaultEndpoint(hostname='some_host', api_port=65536, credentials=credentials)
myprov = VMwareProvider(name='foo',
                     region='us-west-1'
                     endpoints=endpoint)
myprov.create()

SNAPSHOT_TITLE = 'name'

STATS_TO_MATCH = ['num_template', 'num_vm', 'num_datastore', 'num_host', 'num_cluster']

__ge__(other)

Automatically created by attrs.

__gt__(other)

Automatically created by attrs.

__le__(other)

Automatically created by attrs.

__lt__(other)

Automatically created by attrs.

__ne__(other)

Check equality and either forward a NotImplemented or return the result negated.

__repr__()

Automatically created by attrs.

as_fill_value()

category = 'infra'

db_types = ['InfraManager']

get_clusters()

returns the list of clusters belonging to the provider

hosts

hosts_menu_item = 'Hosts'

num_cluster(*args, **kwargs)

num_cluster_db = None

num_cluster_ui = None

num_datastore(*args, **kwargs)

num_datastore_ui = None

num_host(*args, **kwargs)

num_host_db = None

num_host_ui = None

pretty_attrs = ['name', 'key', 'zone']

provider_types = {}

remove_hosts_credentials()

setup_hosts_credentials()

Setup credentials for all provider’s hosts

string_name = 'Infrastructure'

template_class

alias of InfraTemplate

template_name = 'Templates'

templates_destination_name = 'Templates'

view_value_mapping

vm_class

alias of InfraVm

vm_name = 'Virtual Machines'

class cfme.infrastructure.provider.InfraProviderCollection(parent, filters=NOTHING)

Bases: cfme.modeling.base.BaseCollection

Collection object for InfraProvider object

ENTITY

alias of InfraProvider

__ge__(other)

Automatically created by attrs.

__gt__(other)

Automatically created by attrs.

__le__(other)

Automatically created by attrs.

__lt__(other)

Automatically created by attrs.

__ne__(other)

Check equality and either forward a NotImplemented or return the result negated.

__repr__()

Automatically created by attrs.

all()

create(prov_class, *args, **kwargs)

discover(discover_cls, cancel=False, start_ip=None, end_ip=None)

Discover infrastructure providers. Note: only starts discovery, doesn’t wait for it to finish.

Parameters:

• discover_cls – Instance of provider class
• cancel – Whether to cancel out of the discover UI.
• start_ip – String start of the IP range for discovery
• end_ip – String end of the IP range for discovery

instantiate(prov_class, *args, **kwargs)

wait_for_a_provider()

class cfme.infrastructure.provider.ProviderClustersView(*args, **kwargs)

Bases: cfme.infrastructure.cluster.ClusterView

The all view page for clusters open from provider detail page

breadcrumb

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.

entities

is_displayed

Determine if this page is currently being displayed

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.infrastructure.provider.ProviderHosts(obj, navigate_obj)

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

VIEW

alias of ProviderAllHostsView

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.infrastructure.provider.ProviderNodes(obj, navigate_obj)

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

VIEW

alias of ProviderNodesView

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()

class cfme.infrastructure.provider.ProviderTemplates(obj, navigate_obj)

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

VIEW

alias of ProviderTemplatesView

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()

class cfme.infrastructure.provider.ProviderVms(obj, navigate_obj)

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

VIEW

alias of ProviderVmsView

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()

class cfme.infrastructure.provider.Timelines(obj, navigate_obj)

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

VIEW

alias of ProviderTimelinesView

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()