cfme.configure.configuration package

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', Select('select#session_timeout_hours', multi=False)), ('timeout_m', Select('select#session_timeout_mins', multi=False)), ('auth_mode', Select('select#authentication_mode', multi=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.AnalysisProfile(name, description, files=None, events=None, categories=None, registry=None)[source]

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

Analysis profiles. Do not use this class but the derived one.

Example

p = VMAnalysisProfile(name, description)
p.files = [
    "/somefile",
    {"Name": "/some/anotherfile", "Collect Contents?": True}
]
p.categories = ["check_system"]
p.create()
p.delete()
CREATE_LOC = None
copy(name=None)[source]
create()[source]
delete()[source]
exists[source]
form = <cfme.web_ui.tabstrip.TabStripForm fields=[('name', 'input#name'), ('description', 'input#description'), ('categories', <cfme.web_ui.tabstrip._TabStripField ident_string='Category', arg=<cfme.web_ui.CheckboxSelect _root={Version ('lowest'): 'table#formtest', '5.5': "//h3[normalize-space(.)='Category Selection']/..//div[contains(@class, 'col-md-8')]"}>>), ('registry', <cfme.web_ui.tabstrip._TabStripField ident_string='Registry', arg=<cfme.web_ui.DynamicTable root_loc="//div[@id='registry']/fieldset/table", default_row_item=None>>), ('files', <cfme.web_ui.tabstrip._TabStripField ident_string='File', arg=<cfme.web_ui.DynamicTable root_loc="//div[@id='file']/fieldset/table", default_row_item='Name'>>), ('events', <cfme.web_ui.tabstrip._TabStripField ident_string='Event Log', arg=<cfme.web_ui.DynamicTable root_loc="//div[@id='event_log']/fieldset/table", default_row_item=None>>)]>
pretty_attrs = ('name', 'description', 'files', 'events')
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', Select('select#session_timeout_hours', multi=False)), ('timeout_m', Select('select#session_timeout_mins', multi=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)[source]

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

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

Bases: utils.pretty.Pretty

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.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', Select('select#session_timeout_hours', multi=False)), ('timeout_m', Select('select#session_timeout_mins', multi=False)), ('auth_mode', Select('select#authentication_mode', multi=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', Select('select#action_typ', multi=False)), ('log_protocol', Select('select#log_protocol', multi=False)), ('depot_name', {'5.3': None, '5.4': <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', Select('select#timer_typ', multi=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)), ('time_zone', Select('select#time_zone', multi=False)), ('start_date', {'5.3': <cfme.web_ui.Calendar >, '5.4': <cfme.web_ui.Calendar >}), ('start_hour', Select('select#start_hour', multi=False)), ('start_min', Select('select#start_min', multi=False))]>
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', Select('select#session_timeout_hours', multi=False)), ('timeout_m', Select('select#session_timeout_mins', multi=False)), ('auth_mode', Select('select#authentication_mode', multi=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.HostAnalysisProfile(name, description, files=None, events=None, categories=None, registry=None)[source]

Bases: cfme.configure.configuration.AnalysisProfile

CREATE_LOC = 'host_analysis_profile_add'
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', Select('select#session_timeout_hours', multi=False)), ('timeout_m', Select('select#session_timeout_mins', multi=False)), ('auth_mode', Select('select#authentication_mode', multi=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 object at 0x7f4d235fe750>}), ('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_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()
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', Select('select#smtp_openssl_verify_mode', multi=False)), ('auth', Select('select#smtp_authentication', multi=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)[source]

Bases: utils.pretty.Pretty

Configure/Configuration/Region/Schedules functionality

CReate, Update, Delete functionality. Todo: Maybe the row handling might go into Table class?

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.
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.
classmethod delete_by_name(name, cancel=False)[source]

Finds a particular schedule by its name and then deletes it.

Parameters:
  • name – Name of the schedule.
  • cancel – Whether to click on the cancel button in the pop-up.
disable()[source]

Enable the schedule via table checkbox and Configuration menu.

classmethod disable_by_names(*names)[source]

Checks all schedules that are passed with names and then disables them via menu.

Parameters:*names – Names of schedules to disable.
enable()[source]

Enable the schedule via table checkbox and Configuration menu.

classmethod enable_by_names(*names)[source]

Checks all schedules that are passed with names and then enables them via menu.

Parameters:*names – Names of schedules to enable.
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>), ('name', <cfme.web_ui.Input _names=('name',), _use_id=False>), ('action', Select('select#action_typ', multi=False)), ('filter_type', Select('select#filter_typ', multi=False)), ('filter_value', Select('select#filter_value', multi=False)), ('timer_type', Select('select#timer_typ', multi=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)), ('time_zone', Select('select#time_zone', multi=False)), ('start_date', {'5.3': <cfme.web_ui.Calendar >, '5.4': <cfme.web_ui.Calendar >}), ('start_hour', Select('select#start_hour', multi=False)), ('start_min', Select('select#start_min', multi=False))]>
pretty_attrs = ['name', 'description', 'run_type', 'run_every', 'start_date', 'start_hour', 'start_min']
classmethod select_by_names(*names)[source]

Select all checkboxes at the schedules with specified names.

Can select multiple of them.

Candidate for DRY in Table class.

Parameters:*names – Arguments with all schedules’ names.
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.ServerLogDepot[source]

Bases: utils.pretty.Pretty

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

Usage:

log_credentials = ServerLogDepot.Credentials("nfs", "backup.acme.com")
log_credentials.update()
ServerLogDepot.collect_all()
ServerLogDepot.Credentials.clear()
class Credentials(p_type, name, uri, username=None, password=None)[source]

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

This class represents the credentials for log depots.

Parameters:
  • p_type – One of ftp, nfs, or smb.
  • uri – Hostname/IP address of the machine.
  • username – User name used for logging in (ftp, smb only).
  • password – Password used for logging in (ftp, smb only).

Usage:

log_credentials = ServerLogDepot.Credentials("nfs", "backup.acme.com")
log_credentials.update()
log_credentials = ServerLogDepot.Credentials(
    "smb",
    "foobar",
    "backup.acme.com",
    username="jdoe",
    password="xyz",
)
log_credentials.update()
classmethod clear(cancel=False)[source]

Navigate to correct page and set <No Depot>.

Parameters:cancel – If set to True, the Cancel button is clicked instead of saving.
p_types[source]
pretty_attrs = ['p_type', 'name', 'uri', 'username', 'password']
save_button = {Version ('lowest'): FormButton('Save Changes'), '5.4': FormButton('Save changes')}
server_collect_logs = <cfme.web_ui.Form fields=[('type', Select('select#log_protocol', multi=False)), ('name', {Version ('lowest'): None, '5.4': <cfme.web_ui.Input _names=('depot_name',), _use_id=False>}), ('uri', <cfme.web_ui.Input _names=('uri',), _use_id=False>), ('user', <cfme.web_ui.Input _names=('log_userid',), _use_id=False>), ('password', <cfme.web_ui.MultiFill object at 0x7f4d236013d0>)]>
update(validate=True, cancel=False)[source]

Navigate to a correct page, change details and save.

Parameters:
  • validate – Whether validate the credentials (not for NFS)
  • cancel – If set to True, the Cancel button is clicked instead of saving.
validate = FormButton('Validate the credentials by logging into the Server')
classmethod ServerLogDepot.collect_all()[source]

Initiate and wait for collection of all logs to finish.

classmethod ServerLogDepot.collect_current()[source]

Initiate and wait for collection of the current log to finish.

ServerLogDepot.elements = <cfme.web_ui.Region title=None>
classmethod ServerLogDepot.get_last_collection()[source]

Returns the Last Log Collection that is displayed in the InfoBlock.

Returns: If it is Never, returns None, otherwise utils.timeutil.parsetime.

classmethod ServerLogDepot.get_last_message()[source]

Returns the Last Message that is displayed in the InfoBlock.

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

Bases: utils.pretty.Pretty

create()[source]
delete(cancel=True)[source]
pretty_attrs = ['name', 'display_name', 'category']
update(updates)[source]
class cfme.configure.configuration.VMAnalysisProfile(name, description, files=None, events=None, categories=None, registry=None)[source]

Bases: cfme.configure.configuration.AnalysisProfile

CREATE_LOC = 'vm_analysis_profile_add'
class cfme.configure.configuration.Zone(name=None, description=None, smartproxy_ip=None, ntp_server_1=None, ntp_server_2=None, ntp_server_3=None, max_scans=None, user=None, password=None, verify=None)[source]

Bases: utils.pretty.Pretty

Configure/Configuration/Region/Zones functionality

Create/Read/Update/Delete functionality.

create(cancel=False)[source]

Create a new Zone from the information stored in the object.

Parameters:cancel – Whether to click on the cancel button to interrupt the creation.
delete(cancel=False)[source]

Delete the Zone represented by this object.

Parameters:cancel – Whether to click on the cancel button in the pop-up.
exists[source]
classmethod go_to_by_description(description)[source]

Finds and navigates to a particular Zone by its description.

This method looks for a Zone with the provided description. If it finds one (and only one) Zone with that description, it navigates to it. Otherwise, it raises an Exception.

Parameters:description – description of the Zone.
Raises:ZoneNotFound – If no single Zone is found with the specified description.
pretty_attrs = ['name', 'description', 'smartproxy_ip', 'ntp_server_1', 'ntp_server_2', 'ntp_server_3', 'max_scans', 'user', 'password', 'verify']
update(updates, cancel=False)[source]

Modify an existing zone with information from this instance.

Parameters:
  • updates – Dict with fields to be updated
  • cancel – Whether to click on the cancel button to interrupt the edit.
cfme.configure.configuration.add_tag(cat_name)[source]
cfme.configure.configuration.edit_tag(cat_name, tag_name)[source]
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_id()[source]
cfme.configure.configuration.server_name()[source]
cfme.configure.configuration.server_region()[source]
cfme.configure.configuration.server_region_pair()[source]
cfme.configure.configuration.server_roles_disabled(*roles)[source]
cfme.configure.configuration.server_roles_enabled(*roles)[source]
cfme.configure.configuration.server_zone_description()[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_database_external_appliance(hostname)[source]

Set the database as an external from another appliance

Parameters:hostname – Host name of the another appliance
cfme.configure.configuration.set_database_external_postgres(hostname, database, username, password)[source]

Set the database as an external Postgres DB

Parameters:
  • hostname – Host name of the Postgres server
  • database – Database name
  • username – User name
  • password – User password
cfme.configure.configuration.set_database_internal()[source]

Set the database as the internal one.

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