cfme.base package

Module contents

class cfme.base.Region(parent, number=0)[source]

Bases: cfme.modeling.base.BaseEntity, sentaku.modeling.ElementMixin

advanced_settings

“GET zones/ – id/settings api endpoint to query region configuration

number = Attribute(name='number', default=0, validator=None, repr=True, cmp=True, hash=None, init=True, convert=None, metadata=mappingproxy({}))
replication
settings_string
update_advanced_settings(settings_dict)[source]

PATCH settings from the zone’s api/zones/:id/settings endpoint

Parameters:settings_dict – dictionary of the changes to be made to the yaml configuration JSON dumps settings_dict to pass as raw hash data to rest_api session
Raises:AssertionError – On an http result >=400 (RequestsResponse.ok)
class cfme.base.RegionCollection(parent, filters=NOTHING)[source]

Bases: cfme.modeling.base.BaseCollection, sentaku.modeling.ElementMixin

ENTITY

alias of Region

all()[source]
class cfme.base.Server(parent, name, sid=1)[source]

Bases: cfme.modeling.base.BaseEntity, sentaku.modeling.ElementMixin

address

descriptor for implementing context sensitive methods and registration of their implementations

class Example(Element):
    action = ContextualMethod()
    @action.implemented_for("db")
    def action(self):
        pass

   @action.implemented_for("test")
   def action(self):
       pass
advanced_settings

GET servers/ – id/settings api endpoint to query server configuration

authentication
collect_logs
current_full_name

descriptor for implementing context sensitive methods and registration of their implementations

class Example(Element):
    action = ContextualMethod()
    @action.implemented_for("db")
    def action(self):
        pass

   @action.implemented_for("test")
   def action(self):
       pass
current_group_name

descriptor for implementing context sensitive methods and registration of their implementations

class Example(Element):
    action = ContextualMethod()
    @action.implemented_for("db")
    def action(self):
        pass

   @action.implemented_for("test")
   def action(self):
       pass
current_username

descriptor for implementing context sensitive methods and registration of their implementations

class Example(Element):
    action = ContextualMethod()
    @action.implemented_for("db")
    def action(self):
        pass

   @action.implemented_for("test")
   def action(self):
       pass
group_names

descriptor for implementing context sensitive methods and registration of their implementations

class Example(Element):
    action = ContextualMethod()
    @action.implemented_for("db")
    def action(self):
        pass

   @action.implemented_for("test")
   def action(self):
       pass
logged_in

descriptor for implementing context sensitive methods and registration of their implementations

class Example(Element):
    action = ContextualMethod()
    @action.implemented_for("db")
    def action(self):
        pass

   @action.implemented_for("test")
   def action(self):
       pass
login

descriptor for implementing context sensitive methods and registration of their implementations

class Example(Element):
    action = ContextualMethod()
    @action.implemented_for("db")
    def action(self):
        pass

   @action.implemented_for("test")
   def action(self):
       pass
login_admin

descriptor for implementing context sensitive methods and registration of their implementations

class Example(Element):
    action = ContextualMethod()
    @action.implemented_for("db")
    def action(self):
        pass

   @action.implemented_for("test")
   def action(self):
       pass
logout

descriptor for implementing context sensitive methods and registration of their implementations

class Example(Element):
    action = ContextualMethod()
    @action.implemented_for("db")
    def action(self):
        pass

   @action.implemented_for("test")
   def action(self):
       pass
name = Attribute(name='name', default=NOTHING, validator=None, repr=True, cmp=True, hash=None, init=True, convert=None, metadata=mappingproxy({}))
settings
sid = Attribute(name='sid', default=1, validator=None, repr=True, cmp=True, hash=None, init=True, convert=None, metadata=mappingproxy({}))
slave_servers
update_advanced_settings(settings_dict)[source]

PATCH settings from the server’s api/server/:id/settings endpoint

Parameters:settings_dict – dictionary of the changes to be made to the yaml configuration JSON dumps settings_dict to pass as raw hash data to rest_api session
Raises:AssertionError – On an http result >=400 (RequestsResponse.ok)
update_password

descriptor for implementing context sensitive methods and registration of their implementations

class Example(Element):
    action = ContextualMethod()
    @action.implemented_for("db")
    def action(self):
        pass

   @action.implemented_for("test")
   def action(self):
       pass
zone
class cfme.base.ServerCollection(parent, filters=NOTHING)[source]

Bases: cfme.modeling.base.BaseCollection, sentaku.modeling.ElementMixin

ENTITY

alias of Server

all()[source]
get_master()[source]
class cfme.base.Zone(parent, name='default', description='Default Zone', id=None, smartproxy_ip=None, ntp_servers=None, max_scans=None, user=None)[source]

Bases: cfme.utils.pretty.Pretty, cfme.modeling.base.BaseEntity, sentaku.modeling.ElementMixin

Configure/Configuration/Region/Zones functionality

Create/Read/Update/Delete functionality.

advanced_settings

“GET zones/ – id/settings api endpoint to query zone configuration

collect_logs
delete

descriptor for implementing context sensitive methods and registration of their implementations

class Example(Element):
    action = ContextualMethod()
    @action.implemented_for("db")
    def action(self):
        pass

   @action.implemented_for("test")
   def action(self):
       pass
description = Attribute(name='description', default='Default Zone', validator=None, repr=True, cmp=True, hash=None, init=True, convert=None, metadata=mappingproxy({}))
exists
id = Attribute(name='id', default=None, validator=None, repr=True, cmp=True, hash=None, init=True, convert=None, metadata=mappingproxy({}))
max_scans = Attribute(name='max_scans', default=None, validator=None, repr=True, cmp=True, hash=None, init=True, convert=None, metadata=mappingproxy({}))
name = Attribute(name='name', default='default', validator=None, repr=True, cmp=True, hash=None, init=True, convert=None, metadata=mappingproxy({}))
ntp_servers = Attribute(name='ntp_servers', default=None, validator=None, repr=True, cmp=True, hash=None, init=True, convert=None, metadata=mappingproxy({}))
pretty_attrs = ['name', 'description', 'smartproxy_ip', 'ntp_servers', 'max_scans', 'user']
region
smartproxy_ip = Attribute(name='smartproxy_ip', default=None, validator=None, repr=True, cmp=True, hash=None, init=True, convert=None, metadata=mappingproxy({}))
update

descriptor for implementing context sensitive methods and registration of their implementations

class Example(Element):
    action = ContextualMethod()
    @action.implemented_for("db")
    def action(self):
        pass

   @action.implemented_for("test")
   def action(self):
       pass
update_advanced_settings(settings_dict)[source]

PATCH settings from the zone’s api/zones/:id/settings endpoint

Parameters:settings_dict – dictionary of the changes to be made to the yaml configuration JSON dumps settings_dict to pass as raw hash data to rest_api session
Raises:AssertionError – On an http result >=400 (RequestsResponse.ok)
user = Attribute(name='user', default=None, validator=None, repr=True, cmp=True, hash=None, init=True, convert=None, metadata=mappingproxy({}))
class cfme.base.ZoneCollection(parent, filters=NOTHING, region=None)[source]

Bases: cfme.modeling.base.BaseCollection, sentaku.modeling.ElementMixin

ENTITY

alias of Zone

all()[source]
create

descriptor for implementing context sensitive methods and registration of their implementations

class Example(Element):
    action = ContextualMethod()
    @action.implemented_for("db")
    def action(self):
        pass

   @action.implemented_for("test")
   def action(self):
       pass
region = Attribute(name='region', default=None, validator=None, repr=True, cmp=True, hash=None, init=True, convert=None, metadata=mappingproxy({}))