cfme.configure.configuration package¶

Submodules¶

Module contents¶

class cfme.configure.configuration.AmazonAuthSetting(access_key, secret_key, get_groups=False, timeout_h=None, timeout_m=None)[source]¶

Bases: cfme.configure.configuration.AuthSetting

Authentication settings via Amazon.

Parameters:	access_key – Amazon access key secret_key – Amazon secret key get_groups – Whether to get groups from the auth provider (default False) timeout_h – Timeout in hours timeout_m – Timeout in minutes

Usage:

amiauth = AmazonAuthSetting("AJSHDGVJAG", "IUBDIUWQBQW")
amiauth.update()

form = <cfme.web_ui.Form fields=[('timeout_h', {Version('lowest'): Select('select#session_timeout_hours', multi=False), '5.5': <cfme.web_ui.AngularSelect _loc="//button[@data-id='session_timeout_hours']", none=None, multi=False, exact=False>}), ('timeout_m', {Version('lowest'): Select('select#session_timeout_mins', multi=False), '5.5': <cfme.web_ui.AngularSelect _loc="//button[@data-id='session_timeout_mins']", none=None, multi=False, exact=False>}), ('auth_mode', {Version('lowest'): Select('select#authentication_mode', multi=False), '5.5': <cfme.web_ui.AngularSelect _loc="//button[@data-id='authentication_mode']", none=None, multi=False, exact=False>}), ('access_key', <cfme.web_ui.Input _names=('authentication_amazon_key',), _use_id=False>), ('secret_key', <cfme.web_ui.Input _names=('authentication_amazon_secret',), _use_id=False>), ('get_groups', <cfme.web_ui.Input _names=('amazon_role',), _use_id=False>)]>¶

pretty_attrs = ['access_key', 'secret_key', 'get_groups', 'timeout_h', 'timeout_m']¶

update(updates=None)[source]¶

class cfme.configure.configuration.AuthSetting[source]¶

Bases: utils.update.Updateable, utils.pretty.Pretty

form = <cfme.web_ui.Form fields=[('timeout_h', {Version('lowest'): Select('select#session_timeout_hours', multi=False), '5.5': <cfme.web_ui.AngularSelect _loc="//button[@data-id='session_timeout_hours']", none=None, multi=False, exact=False>}), ('timeout_m', {Version('lowest'): Select('select#session_timeout_mins', multi=False), '5.5': <cfme.web_ui.AngularSelect _loc="//button[@data-id='session_timeout_mins']", none=None, multi=False, exact=False>})]>¶

classmethod set_session_timeout(hours=None, minutes=None)[source]¶: Sets the session timeout of the appliance.

class cfme.configure.configuration.BasicInformation(company_name=None, appliance_name=None, appliance_zone=None, time_zone=None, appliance=None)[source]¶

Bases: utils.update.Updateable, utils.pretty.Pretty, utils.appliance.Navigatable

This class represents the “Basic Info” section of the Configuration page.

Parameters:	company_name – Company name. appliance_name – Appliance name. appliance_zone – Appliance Zone. time_zone – Time Zone.

Usage:

basic_info = BasicInformation(company_name="ACME Inc.")
basic_info.update()

basic_information = <cfme.web_ui.Form fields=[('company_name', <cfme.web_ui.Input _names=('server_company',), _use_id=False>), ('appliance_name', <cfme.web_ui.Input _names=('server_name',), _use_id=False>), ('appliance_zone', Select('select#server_zone', multi=False)), ('time_zone', Select('select#server_timezone', multi=False))]>¶

pretty_attrs = ['company_name', 'appliance_name', 'appliance_zone', 'time_zone', 'appliance']¶

update()[source]¶: Navigate to a correct page, change details and save.

class cfme.configure.configuration.Category(name=None, display_name=None, description=None, show_in_console=True, single_value=True, capture_candu=False, appliance=None)[source]¶

Bases: utils.pretty.Pretty, utils.appliance.Navigatable

create(cancel=False)[source]¶

delete(cancel=True)[source]¶

pretty_attrs = ['name', 'display_name', 'description', 'show_in_console', 'single_value', 'capture_candu']¶

update(updates, cancel=False)[source]¶

class cfme.configure.configuration.CategoryAdd(obj, navigate_obj)[source]¶

Bases: utils.appliance.implementations.ui.CFMENavigateStep

Unlike most other Add operations, this one requires an instance

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.configuration.CategoryAll(obj, navigate_obj)[source]¶

Bases: utils.appliance.implementations.ui.CFMENavigateStep

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.configuration.CategoryEdit(obj, navigate_obj)[source]¶

Bases: utils.appliance.implementations.ui.CFMENavigateStep

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.configuration.DatabaseAuthSetting(timeout_h=None, timeout_m=None)[source]¶

Bases: cfme.configure.configuration.AuthSetting

Authentication settings for DB internal database.

Parameters:	timeout_h – Timeout in hours timeout_m – Timeout in minutes

Usage:

dbauth = DatabaseAuthSetting()
dbauth.update()

form = <cfme.web_ui.Form fields=[('timeout_h', {Version('lowest'): Select('select#session_timeout_hours', multi=False), '5.5': <cfme.web_ui.AngularSelect _loc="//button[@data-id='session_timeout_hours']", none=None, multi=False, exact=False>}), ('timeout_m', {Version('lowest'): Select('select#session_timeout_mins', multi=False), '5.5': <cfme.web_ui.AngularSelect _loc="//button[@data-id='session_timeout_mins']", none=None, multi=False, exact=False>}), ('auth_mode', {Version('lowest'): Select('select#authentication_mode', multi=False), '5.5': <cfme.web_ui.AngularSelect _loc="//button[@data-id='authentication_mode']", none=None, multi=False, exact=False>})]>¶

pretty_attrs = ['timeout_h', 'timeout_m']¶

update(updates=None)[source]¶

class cfme.configure.configuration.DatabaseBackupSchedule(name, description, active=True, protocol=None, depot_name=None, uri=None, username=None, password=None, password_verify=None, run_type='Once', run_every=None, time_zone=None, start_date=None, start_hour=None, start_min=None)[source]¶

Bases: cfme.configure.configuration.Schedule

Configure/Configuration/Region/Schedules - Database Backup type

Parameters:

name – Schedule name
description – Schedule description
active – Whether the schedule should be active (default True)
protocol – One of {'Samba', 'Network File System'}
run_type – Once, Hourly, Daily, ...
run_every – If run_type is not Once, then you can specify how often it should be run
time_zone – Time zone selection
start_date – Specify start date (mm/dd/yyyy or datetime.datetime())
start_hour – Starting hour
start_min – Starting minute

Usage:

smb_schedule = DatabaseBackupSchedule(
    name="Bi-hourly Samba Database Backup",
    description="Everybody's favorite backup schedule",
    protocol="Samba",
    uri="samba.example.com/share_name",
    username="samba_user",
    password="secret",
    password_verify="secret",
    time_zone="UTC",
    start_date=datetime.datetime.utcnow(),
    run_type="Hourly",
    run_every="2 Hours"
)
smb_schedule.create()
smb_schedule.delete()

... or ...

nfs_schedule = DatabaseBackupSchedule(
    name="One-time NFS Database Backup",
    description="The other backup schedule",
    protocol="Network File System",
    uri="nfs.example.com/path/to/share",
    time_zone="Chihuahua",
    start_date="21/6/2014",
    start_hour="7",
    start_min="45"
)
nfs_schedule.create()
nfs_schedule.delete()

create(cancel=False, samba_validate=False)[source]¶

Create a new schedule from the informations stored in the object.

Parameters:	cancel – Whether to click on the cancel button to interrupt the creation. samba_validate – Samba-only option to click the Validate button to check if entered samba credentials are valid or not

form = <cfme.web_ui.Form fields=[('name', <cfme.web_ui.Input _names=('name',), _use_id=False>), ('description', <cfme.web_ui.Input _names=('description',), _use_id=False>), ('active', <cfme.web_ui.Input _names=('enabled',), _use_id=False>), ('action', {Version('lowest'): Select('select#action_typ', multi=False), '5.5': <cfme.web_ui.AngularSelect _loc="//button[@data-id='action_typ']", none=None, multi=False, exact=False>}), ('log_protocol', {Version('lowest'): Select('select#log_protocol', multi=False), '5.5': <cfme.web_ui.AngularSelect _loc="//button[@data-id='log_protocol']", none=None, multi=False, exact=False>}), ('depot_name', <cfme.web_ui.Input _names=('depot_name',), _use_id=False>), ('uri', <cfme.web_ui.Input _names=('uri',), _use_id=False>), ('log_userid', <cfme.web_ui.Input _names=('log_userid',), _use_id=False>), ('log_password', <cfme.web_ui.Input _names=('log_password',), _use_id=False>), ('log_verify', <cfme.web_ui.Input _names=('log_verify',), _use_id=False>), ('timer_type', {Version('lowest'): Select('select#timer_typ', multi=False), '5.5': <cfme.web_ui.AngularSelect _loc="//button[@data-id='timer_typ']", none=None, multi=False, exact=False>}), ('timer_hours', Select('select#timer_hours', multi=False)), ('timer_days', Select('select#timer_days', multi=False)), ('timer_weeks', Select('select#timer_weekss', multi=False)), ('timer_months', Select('select#timer_months', multi=False)), ('timer_value', <cfme.web_ui.AngularSelect _loc="//button[@data-id='timer_value']", none=None, multi=False, exact=False>, {'appeared_in': '5.5'}), ('time_zone', <cfme.web_ui.AngularSelect _loc="//button[@data-id='time_zone']", none=None, multi=False, exact=False>), ('start_date', <cfme.web_ui.Calendar >), ('start_hour', <cfme.web_ui.AngularSelect _loc="//button[@data-id='start_hour']", none=None, multi=False, exact=False>), ('start_min', <cfme.web_ui.AngularSelect _loc="//button[@data-id='start_min']", none=None, multi=False, exact=False>)]>¶

last_date¶

update(updates, cancel=False, samba_validate=False)[source]¶

Modify an existing schedule with informations from this instance.

Parameters:	updates – Dict with fields to be updated cancel – Whether to click on the cancel button to interrupt the editation. samba_validate – Samba-only option to click the Validate button to check if entered samba credentials are valid or not

class cfme.configure.configuration.ExternalAuthSetting(get_groups=False, timeout_h='1', timeout_m='0')[source]¶

Bases: cfme.configure.configuration.AuthSetting

Authentication settings for authentication via httpd.

Parameters:	timeout_h – Timeout in hours timeout_m – Timeout in minutes get_groups – Get user groups from external auth source.

Usage:

dbauth = ExternalAuthSetting(get_groups=True)
dbauth.update()

form = <cfme.web_ui.Form fields=[('timeout_h', {Version('lowest'): Select('select#session_timeout_hours', multi=False), '5.5': <cfme.web_ui.AngularSelect _loc="//button[@data-id='session_timeout_hours']", none=None, multi=False, exact=False>}), ('timeout_m', {Version('lowest'): Select('select#session_timeout_mins', multi=False), '5.5': <cfme.web_ui.AngularSelect _loc="//button[@data-id='session_timeout_mins']", none=None, multi=False, exact=False>}), ('auth_mode', {Version('lowest'): Select('select#authentication_mode', multi=False), '5.5': <cfme.web_ui.AngularSelect _loc="//button[@data-id='authentication_mode']", none=None, multi=False, exact=False>}), ('get_groups', <cfme.web_ui.Input _names=('httpd_role',), _use_id=False>)]>¶

pretty_attrs = ['timeout_h', 'timeout_m', 'get_groups']¶

setup()[source]¶

update(updates=None)[source]¶

class cfme.configure.configuration.LDAPAuthSetting(hosts, user_type, user_suffix, base_dn=None, bind_dn=None, bind_password=None, get_groups=False, get_roles=False, follow_referrals=False, port=None, timeout_h=None, timeout_m=None)[source]¶

Bases: cfme.configure.configuration.AuthSetting

Authentication via LDAP

Parameters:

hosts – List of LDAP servers (max 3).
user_type – “userprincipalname”, “mail”, ...
user_suffix – User suffix.
base_dn – Base DN.
bind_dn – Bind DN.
bind_password – Bind Password.
get_groups – Get user groups from LDAP.
get_roles – Get roles from home forest.
follow_referrals – Follow Referrals.
port – LDAP connection port.
timeout_h – Timeout in hours
timeout_m – Timeout in minutes

Usage:

ldapauth = LDAPAuthSetting(
    ["host1", "host2"],
    "mail",
    "user.acme.com"
)
ldapauth.update()

AUTH_MODE = 'LDAP'¶

form = <cfme.web_ui.Form fields=[('timeout_h', {Version('lowest'): Select('select#session_timeout_hours', multi=False), '5.5': <cfme.web_ui.AngularSelect _loc="//button[@data-id='session_timeout_hours']", none=None, multi=False, exact=False>}), ('timeout_m', {Version('lowest'): Select('select#session_timeout_mins', multi=False), '5.5': <cfme.web_ui.AngularSelect _loc="//button[@data-id='session_timeout_mins']", none=None, multi=False, exact=False>}), ('auth_mode', {Version('lowest'): Select('select#authentication_mode', multi=False), '5.5': <cfme.web_ui.AngularSelect _loc="//button[@data-id='authentication_mode']", none=None, multi=False, exact=False>}), ('ldaphost_1', <cfme.web_ui.Input _names=('authentication_ldaphost_1',), _use_id=False>), ('ldaphost_2', <cfme.web_ui.Input _names=('authentication_ldaphost_2',), _use_id=False>), ('ldaphost_3', <cfme.web_ui.Input _names=('authentication_ldaphost_3',), _use_id=False>), ('port', <cfme.web_ui.Input _names=('authentication_ldapport',), _use_id=False>), ('user_type', {Version('lowest'): Select('select#authentication_user_type', multi=False), '5.5': <cfme.web_ui.AngularSelect _loc="//button[@data-id='authentication_user_type']", none=None, multi=False, exact=False>}), ('user_suffix', <cfme.web_ui.Input _names=('authentication_user_suffix',), _use_id=False>), ('get_groups', <cfme.web_ui.Input _names=('ldap_role',), _use_id=False>), ('get_roles', <cfme.web_ui.Input _names=('get_direct_groups',), _use_id=False>), ('default_groups', {Version('lowest'): Select('select#authentication_default_group_for_users', multi=False), '5.5': <cfme.web_ui.AngularSelect _loc="//button[@data-id='authentication_default_group_for_users']", none=None, multi=False, exact=False>}), ('get_direct_groups', <cfme.web_ui.Input _names=('get_direct_groups',), _use_id=False>), ('follow_referrals', <cfme.web_ui.Input _names=('follow_referrals',), _use_id=False>), ('base_dn', <cfme.web_ui.Input _names=('authentication_basedn',), _use_id=False>), ('bind_dn', <cfme.web_ui.Input _names=('authentication_bind_dn',), _use_id=False>), ('bind_password', <cfme.web_ui.Input _names=('authentication_bind_pwd',), _use_id=False>)]>¶

pretty_attrs = ['hosts', 'user_type', 'user_suffix', 'base_dn', 'bind_dn', 'bind_password']¶

update(updates=None)[source]¶

class cfme.configure.configuration.LDAPSAuthSetting(hosts, user_type, user_suffix, base_dn=None, bind_dn=None, bind_password=None, get_groups=False, get_roles=False, follow_referrals=False, port=None, timeout_h=None, timeout_m=None)[source]¶

Bases: cfme.configure.configuration.LDAPAuthSetting

Authentication via LDAPS

Parameters:

hosts – List of LDAPS servers (max 3).
user_type – “userprincipalname”, “mail”, ...
user_suffix – User suffix.
base_dn – Base DN.
bind_dn – Bind DN.
bind_password – Bind Password.
get_groups – Get user groups from LDAP.
get_roles – Get roles from home forest.
follow_referrals – Follow Referrals.
port – LDAPS connection port.
timeout_h – Timeout in hours
timeout_m – Timeout in minutes

Usage:

ldapauth = LDAPSAuthSetting(
    ["host1", "host2"],
    "mail",
    "user.acme.com"
)
ldapauth.update()

AUTH_MODE = 'LDAPS'¶

class cfme.configure.configuration.SMTPSettings(host=None, port=None, domain=None, start_tls=None, ssl_verify=None, auth=None, username=None, password=None, from_email=None, test_email=None)[source]¶

Bases: utils.update.Updateable

SMTP settings on the main page.

Parameters:	host – SMTP Server host name port – SMTP Server port domain – E-mail domain start_tls – Whether use StartTLS ssl_verify – SSL Verification auth – Authentication type username – User name password – User password from_email – E-mail address to be used as the “From:” test_email – Destination of the test-email.

Usage:

smtp = SMTPSettings(
    host="smtp.acme.com",
    start_tls=True,
    auth="login",
    username="mailer",
    password="secret"
)
smtp.update()

Note: TODO: send a test-email, if that will be needed.

buttons = <cfme.web_ui.Region title=None>¶

classmethod send_test_email(to_address)[source]¶

Send a testing e-mail on specified address. Needs configured SMTP.

Parameters:	to_address – Destination address.

smtp_settings = <cfme.web_ui.Form fields=[('host', <cfme.web_ui.Input _names=('smtp_host',), _use_id=False>), ('port', <cfme.web_ui.Input _names=('smtp_port',), _use_id=False>), ('domain', <cfme.web_ui.Input _names=('smtp_domain',), _use_id=False>), ('start_tls', <cfme.web_ui.Input _names=('smtp_enable_starttls_auto',), _use_id=False>), ('ssl_verify', <cfme.web_ui.AngularSelect _loc="//button[@data-id='smtp_openssl_verify_mode']", none=None, multi=False, exact=False>), ('auth', <cfme.web_ui.AngularSelect _loc="//button[@data-id='smtp_authentication']", none=None, multi=False, exact=False>), ('username', <cfme.web_ui.Input _names=('smtp_user_name',), _use_id=False>), ('password', <cfme.web_ui.Input _names=('smtp_password',), _use_id=False>), ('from_email', <cfme.web_ui.Input _names=('smtp_from',), _use_id=False>), ('to_email', <cfme.web_ui.Input _names=('smtp_test_to',), _use_id=False>)]>¶

update()[source]¶

class cfme.configure.configuration.Schedule(name, description, active=True, action=None, filter_type=None, filter_value=None, run_type='Once', run_every=None, time_zone=None, start_date=None, start_hour=None, start_min=None, appliance=None)[source]¶

Bases: utils.pretty.Pretty, utils.appliance.Navigatable

Configure/Configuration/Region/Schedules functionality

Create, Update, Delete functionality.

Parameters:

name – Schedule’s name.
description – Schedule description.
active – Whether the schedule should be active (default True)
action – Action type
filter_type – Filtering type
filter_value – If a more specific filter_type is selected, here is the place to choose hostnames, machines and so ...
run_type – Once, Hourly, Daily, ...
run_every – If run_type is not Once, then you can specify how often it should be run.
time_zone – Time zone selection.
start_date – Specify start date (mm/dd/yyyy or datetime.datetime()).
start_hour – Starting hour
start_min – Starting minute.

Usage:

schedule = Schedule(
    "My very schedule",
    "Some description here.",
    action="Datastore Analysis",
    filter_type="All Datastores for Host",
    filter_value="datastore.intra.acme.com",
    run_type="Hourly",
    run_every="2 Hours"
)
schedule.create()
schedule.disable()
schedule.enable()
schedule.delete()
# Or
Schedule.enable_by_names("One schedule", "Other schedule")
# And so.

Note: TODO: Maybe the row handling might go into Table class?

create(cancel=False)[source]¶

Create a new schedule from the informations stored in the object.

Parameters:	cancel – Whether to click on the cancel button to interrupt the creation.

delete(cancel=False)[source]¶

Delete the schedule represented by this object.

Calls the class method with the name of the schedule taken out from the object.

Parameters:	cancel – Whether to click on the cancel button in the pop-up.

disable()[source]¶: Enable the schedule via table checkbox and Configuration menu.

enable()[source]¶: Enable the schedule via table checkbox and Configuration menu.

form = <cfme.web_ui.Form fields=[('name', <cfme.web_ui.Input _names=('name',), _use_id=False>), ('description', <cfme.web_ui.Input _names=('description',), _use_id=False>), ('active', <cfme.web_ui.Input _names=('enabled',), _use_id=False>), ('action', {Version('lowest'): Select('select#action_typ', multi=False), '5.5': <cfme.web_ui.AngularSelect _loc="//button[@data-id='action_typ']", none=None, multi=False, exact=False>}), ('filter_type', {Version('lowest'): Select('select#filter_typ', multi=False), '5.5': <cfme.web_ui.AngularSelect _loc="//button[@data-id='filter_typ']", none=None, multi=False, exact=False>}), ('filter_value', {Version('lowest'): Select('select#filter_value', multi=False), '5.5': <cfme.web_ui.AngularSelect _loc="//button[@data-id='filter_value']", none=None, multi=False, exact=False>}), ('timer_type', {Version('lowest'): Select('select#timer_typ', multi=False), '5.5': <cfme.web_ui.AngularSelect _loc="//button[@data-id='timer_typ']", none=None, multi=False, exact=False>}), ('timer_hours', Select('select#timer_hours', multi=False)), ('timer_days', Select('select#timer_days', multi=False)), ('timer_weeks', Select('select#timer_weekss', multi=False)), ('timer_months', Select('select#timer_months', multi=False)), ('timer_value', <cfme.web_ui.AngularSelect _loc="//button[@data-id='timer_value']", none=None, multi=False, exact=False>, {'appeared_in': '5.5'}), ('time_zone', {Version('lowest'): Select('select#time_zone', multi=False), '5.5': <cfme.web_ui.AngularSelect _loc="//button[@data-id='time_zone']", none=None, multi=False, exact=False>}), ('start_date', <cfme.web_ui.Calendar >), ('start_hour', {Version('lowest'): Select('select#start_hour', multi=False), '5.5': <cfme.web_ui.AngularSelect _loc="//button[@data-id='start_hour']", none=None, multi=False, exact=False>}), ('start_min', {Version('lowest'): Select('select#start_min', multi=False), '5.5': <cfme.web_ui.AngularSelect _loc="//button[@data-id='start_min']", none=None, multi=False, exact=False>})]>¶

pretty_attrs = ['name', 'description', 'run_type', 'run_every', 'start_date', 'start_hour', 'start_min']¶

select()[source]¶: Select the checkbox for current schedule

tab = {'Monthly': 'timer_months', 'Hourly': 'timer_hours', 'Daily': 'timer_days', 'Weekly': 'timer_weeks'}¶

update(updates, cancel=False)[source]¶

Modify an existing schedule with informations from this instance.

Parameters:	updates – Dict with fields to be updated cancel – Whether to click on the cancel button to interrupt the editation.

class cfme.configure.configuration.ScheduleAdd(obj, navigate_obj)[source]¶

Bases: utils.appliance.implementations.ui.CFMENavigateStep

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.configuration.ScheduleAll(obj, navigate_obj)[source]¶

Bases: utils.appliance.implementations.ui.CFMENavigateStep

prerequisite¶

This is a helper descriptor for navigation destinations which are on another class/object.

For instance, imagine you have a different 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 NavigateToObject as a helper. This will set prerequisite to be a callable that will navigate to the prerequisite step on the other object.

step()[source]¶

class cfme.configure.configuration.ScheduleDetails(obj, navigate_obj)[source]¶

Bases: utils.appliance.implementations.ui.CFMENavigateStep

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.configuration.ScheduleEdit(obj, navigate_obj)[source]¶

Bases: utils.appliance.implementations.ui.CFMENavigateStep

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.configuration.ServerLogDepot(depot_type, depot_name=None, uri=None, username=None, password=None, zone_collect=False, second_server_collect=False, appliance=None)[source]¶

Bases: utils.pretty.Pretty, utils.appliance.Navigatable

This class represents the ‘Collect logs’ for the server.

Usage:

log_credentials = configure.ServerLogDepot("anon_ftp",
                                       depot_name=fauxfactory.gen_alphanumeric(),
                                       uri=fauxfactory.gen_alphanumeric())
log_credentials.create()
log_credentials.clear()

clear()[source]¶: Set depot type to “No Depot”

collect_all()[source]¶: Initiate and wait for collection of all logs to finish.

collect_current()[source]¶: Initiate and wait for collection of the current log to finish.

create(cancel=False)[source]¶

is_cleared¶

last_collection¶

last_message¶

class cfme.configure.configuration.Tag(name=None, display_name=None, category=None, appliance=None)[source]¶

Bases: utils.pretty.Pretty, utils.appliance.Navigatable

create()[source]¶

delete(cancel=True)[source]¶

pretty_attrs = ['name', 'display_name', 'category']¶

update(updates)[source]¶

class cfme.configure.configuration.TagsAdd(obj, navigate_obj)[source]¶

Bases: utils.appliance.implementations.ui.CFMENavigateStep

Unlike most other Add operations, this one requires an instance

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.configuration.TagsAll(obj, navigate_obj)[source]¶

Bases: utils.appliance.implementations.ui.CFMENavigateStep

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.configuration.TagsEdit(obj, navigate_obj)[source]¶

Bases: utils.appliance.implementations.ui.CFMENavigateStep

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.configuration.VMwareConsoleSupport(console_type, appliance=None)[source]¶

Bases: utils.update.Updateable, utils.pretty.Pretty, utils.appliance.Navigatable

This class represents the “VMware Console Support” section of the Configuration page. Note this is to support CFME 5.8 and beyond functionality.

Parameters:	console_type – One of the following strings ‘VMware VMRC Plugin’, ‘VNC’ or ‘VMware WebMKS’

Usage:

vmware_console_support = VMwareConsoleSupport(console_type="VNC")
vmware_console_support.update()

CONSOLE_TYPES = ['VNC', 'VMware VMRC Plugin', 'VMware WebMKS']¶

pretty_attrs = ['console_type']¶

update()[source]¶: Navigate to a correct page, change details and save.

vmware_console_form = <cfme.web_ui.Form fields=[('console_type', <cfme.web_ui.AngularSelect _loc="//button[@data-id='console_type']", none=None, multi=False, exact=False>)]>¶

cfme.configure.configuration.get_ntp_servers()[source]¶

cfme.configure.configuration.get_replication_backlog(navigate=True)[source]¶

Gets replication backlog from Configure / Configuration pages.

Returns: int representing the remaining items in the replication backlog.

cfme.configure.configuration.get_replication_status(navigate=True)[source]¶

Gets replication status from Configure / Configuration pages.

Returns: bool of whether replication is Active or Inactive.

cfme.configure.configuration.get_server_roles(navigate=True, db=True)[source]¶

Get server roles from Configure / Configuration

Returns: dict with the roles in the same format as set_server_roles(): accepts as kwargs.

cfme.configure.configuration.get_workers_list(do_not_navigate=False, refresh=True)[source]¶

Retrieves all workers.

Returns a dictionary where keys are names of the workers and values are lists (because worker can have multiple instances) which contain dictionaries with some columns.

cfme.configure.configuration.restart_workers(name, wait_time_min=1)[source]¶

Restarts workers by their name.

Parameters:	name – Name of the worker. Multiple workers can have the same name. Name is matched with in

Returns: bool whether the restart succeeded.

cfme.configure.configuration.server_roles_disabled(*roles)[source]¶

cfme.configure.configuration.server_roles_enabled(*roles)[source]¶

cfme.configure.configuration.set_auth_mode(mode, **kwargs)[source]¶

Set up authentication mode

Parameters:	mode – Authentication mode to set up. kwargs – A dict of keyword arguments used to initialize one of the *AuthSetting classes - class type is mode-dependent.
Raises:	`AuthModeUnknown` – when the given mode is not valid

cfme.configure.configuration.set_ntp_servers(*servers)[source]¶

Set NTP servers on Configure / Configuration pages.

Parameters:	*servers – Maximum of 3 hostnames.

cfme.configure.configuration.set_replication_worker_host(host, port='5432')[source]¶

Set replication worker host on Configure / Configuration pages.

Parameters:	host – Address of the hostname to replicate to.

cfme.configure.configuration.set_server_roles(db=True, **roles)[source]¶

Set server roles on Configure / Configuration pages.

Parameters:	**roles – Roles specified as in server_roles Form in this module. Set to True or False

cfme.configure.configuration.setup_authmode_database()[source]¶