cfme.configure.settings module

class cfme.configure.settings.DefaultFilters(appliance, my_settings, name=None, filters=None)[source]

Bases: cfme.utils.update.Updateable, cfme.utils.pretty.Pretty, cfme.utils.appliance.NavigatableMixin

pretty_attrs = ['name', 'filters']
update(updates)[source]
Parameters:updates – Dictionary containing ‘filters’ key. Values are tuples of ([path], bool) Where bool is whether to check or uncheck the filter

Returns: None

class cfme.configure.settings.DefaultFiltersForm(*args, **kwargs)[source]

Bases: widgetastic.widget.View

save

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.

tree

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.configure.settings.DefaultFiltersStep(obj, navigate_obj)[source]

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

VIEW

alias of MySettingsView

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()[source]
step()[source]
class cfme.configure.settings.DefaultViews(appliance, my_settings)[source]

Bases: cfme.utils.update.Updateable, cfme.utils.appliance.NavigatableMixin

get_default_view(button_group_name, fieldset=None)[source]
look_up = {'Flavors': ['clouds', 'flavors'], 'Catalog Items': ['services', 'catalog_items'], 'Nodes': ['containers', 'nodes'], 'Containers': ['containers', 'containers'], 'VMs & Instances': ['services', 'vms_instances'], 'Templates': ['containers', 'templates'], 'Containers Providers': ['containers', 'providers'], 'Image Registries': ['containers', 'image_registries'], 'Stacks': ['clouds', 'stacks'], 'Availability Zones': ['clouds', 'availability_zones'], 'Cloud Providers': ['clouds', 'providers'], 'Services': ['containers', 'services'], 'Projects': ['containers', 'projects'], 'Builds': ['containers', 'builds'], 'Container Images': ['containers', 'images'], 'Templates & Images': ['services', 'templates'], 'Volumes': ['containers', 'volumes'], 'Routes': ['containers', 'routes'], 'Pods': ['containers', 'pods'], 'VMs': ['infrastructure', 'vms'], 'Compare': ['general', 'compare'], 'Replicators': ['containers', 'replicators'], 'Infrastructure Providers': ['infrastructure', 'infrastructure_providers'], 'My Services': ['services', 'my_services'], 'Instances': ['clouds', 'instances'], 'Compare Mode': ['general', 'compare_mode'], 'Configuration Management Providers': ['infrastructure', 'configuration_management_providers'], 'Images': ['clouds', 'images']}
set_default_view(button_group_names, defaults, fieldset=None)[source]

This function sets default views for the objects.

Parameters:
  • button_group_names – either the name of the button_group_name or list of the button groups to set the default view for.
  • defaults – the default view to set. in case that button_group_names is a list, you can either set 1 view and it’ll be set for all the button_group_names or you can use a list (default view per button_group_name).
Raises:

AssertionError

set_default_view_switch_off()[source]
set_default_view_switch_on()[source]
class cfme.configure.settings.DefaultViewsForm(*args, **kwargs)[source]

Bases: widgetastic.widget.View

clouds

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.

containers

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.

general

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.

infrastructure

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.

save

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.

services

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.

vm_visibility

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.configure.settings.DefaultViewsStep(obj, navigate_obj)[source]

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

VIEW

alias of MySettingsView

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()[source]
step()[source]
class cfme.configure.settings.MySettings(appliance)[source]

Bases: cfme.utils.update.Updateable, cfme.utils.appliance.NavigatableMixin

The ‘My Settings’ page

default_filters

The ‘Default Filters’ tab on the ‘My Settings’ page

default_views

The ‘Default Views’ tab on the ‘My Settings’ page

time_profiles

The ‘Time Profiles’ tab on the ‘My Settings’ page

visual

The ‘Visual’ tab on the ‘My Settings’ page

class cfme.configure.settings.MySettingsEntities(*args, **kwargs)[source]

Bases: widgetastic.widget.View

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.

table

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.

title

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.configure.settings.MySettingsStep(obj, navigate_obj)[source]

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

VIEW

alias of MySettingsView

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.

step()[source]

Go to the My Settings view

class cfme.configure.settings.MySettingsView(*args, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

The My Settings page

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.

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
tabs

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.configure.settings.TimeProfile(parent, description=None, scope=None, days=True, hours=True, timezone=None)[source]

Bases: cfme.utils.update.Updateable, cfme.modeling.base.BaseEntity

copy(description=None, cancel=False)[source]

This method performs the copy of the provided time profile object. :param description: It’s the descriptive name of the new copied time_profile. :type description: str :param cancel: This variable performs cancel operation while copy. :type cancel: bool

return: It returns the object of the copied time_profile.

days = Attribute(name='days', default=True, validator=None, repr=True, cmp=True, hash=None, init=True, convert=None, metadata=mappingproxy({}))
description = Attribute(name='description', default=None, validator=None, repr=True, cmp=True, hash=None, init=True, convert=None, metadata=mappingproxy({}))
hours = Attribute(name='hours', default=True, validator=None, repr=True, cmp=True, hash=None, init=True, convert=None, metadata=mappingproxy({}))
scope = Attribute(name='scope', default=None, validator=None, repr=True, cmp=True, hash=None, init=True, convert=None, metadata=mappingproxy({}))
timezone = Attribute(name='timezone', default=None, validator=None, repr=True, cmp=True, hash=None, init=True, convert=None, metadata=mappingproxy({}))
update(updates)[source]

This method is used for updating the time_profile

Parameters:updates – It the object of the time_profile that we need to update.
class cfme.configure.settings.TimeProfileAdd(obj, navigate_obj)[source]

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

VIEW

alias of TimeProfileAddView

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()[source]
class cfme.configure.settings.TimeProfileAddView(*args, **kwargs)[source]

Bases: cfme.configure.settings.TimeProfileView

form

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
class cfme.configure.settings.TimeProfileCollection(parent, filters=NOTHING)[source]

Bases: cfme.modeling.base.BaseCollection

ENTITY

alias of TimeProfile

create(description=None, scope=None, days=True, hours=True, timezone=None, cancel=False)[source]
Parameters:
  • description (str) – It’s the descriptive name of the time_profile.
  • scope – It’s the option ‘All User’ or ‘Current User’ from dropdown.
  • days (bool) – It’s the option to switch on or switch off the days Bootstrap switch.
  • hours (bool) – It’s the option to switch on or switch off the hours Bootstrap switch.
  • timezone – It’s the required Time Zone for the time_profile.
  • cancel (bool) – It’s a flag used to cancel or not the create operation.

return: It returns the object of the newly created time_profile object.

delete(cancel=False, *time_objs)[source]

This method performs the delete operation.

Parameters:
  • cancel (bool) – It’s a flag used for selecting Ok or Cancel from delete confirmation dialogue box
  • time_objs – It’s time profile object.
class cfme.configure.settings.TimeProfileCollectionAll(obj, navigate_obj)[source]

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

VIEW

alias of MySettingsView

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()[source]
step()[source]
class cfme.configure.settings.TimeProfileCopy(obj, navigate_obj)[source]

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

VIEW

alias of TimeProfileAddView

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.

step()[source]
class cfme.configure.settings.TimeProfileEdit(obj, navigate_obj)[source]

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

VIEW

alias of TimeProfileEditView

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.

step()[source]
class cfme.configure.settings.TimeProfileEditView(*args, **kwargs)[source]

Bases: cfme.configure.settings.TimeProfileView

form

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
class cfme.configure.settings.TimeProfileEntities(*args, **kwargs)[source]

Bases: widgetastic.widget.View

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.

table

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.

title

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.configure.settings.TimeProfileForm(*args, **kwargs)[source]

Bases: widgetastic.widget.View

cancel

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.

days

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.

description

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.

help_block

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.

hours

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.

scope

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.

timezone

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.configure.settings.TimeProfileView(*args, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

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.

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.

class cfme.configure.settings.TimeProfiles(appliance, my_settings)[source]

Bases: cfme.utils.update.Updateable, cfme.utils.appliance.NavigatableMixin

class cfme.configure.settings.TimeProfilesView(*args, **kwargs)[source]

Bases: cfme.base.login.BaseLoggedInPage

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.

help_block

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.

table

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.configure.settings.Visual(appliance, my_settings)[source]

Bases: cfme.utils.update.Updateable, cfme.utils.appliance.NavigatableMixin

cloud_provider_quad
datastore_quad
grid_view_entities
grid_view_limit
host_quad
infra_provider_quad
list_view_entities
list_view_limit
login_page
report_view_entities
report_view_limit
template_quad
tile_view_entities
tile_view_limit
timezone
vm_quad
class cfme.configure.settings.VisualForm(*args, **kwargs)[source]

Bases: widgetastic.widget.View

default_items_per_page

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.

display_settings

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.

grid_tile_icons

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.

reset

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.

save

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.

start_page

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.

topology_default_items

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.configure.settings.VisualStep(obj, navigate_obj)[source]

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

VIEW

alias of MySettingsView

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()[source]
step()[source]