ipaserver.plugins.server.server

class ipaserver.plugins.server.server(api)[source]

Bases: ipaserver.plugins.baseldap.LDAPObject

IPA server

Public Methods:

normalize_location(kw, **options)

Return the DN of location

convert_location(entry_attrs, **options)

Return a location name from DN

get_enabled_roles(entry_attrs, **options)

Inherited from LDAPObject

get_dn(*keys, **kwargs)

Construct an LDAP DN.

get_dn_if_exists(*keys, **kwargs)

get_primary_key_from_dn(dn)

get_ancestor_primary_keys()

has_objectclass(classes, objectclass)

convert_attribute_members(entry_attrs, ...)

get_indirect_members(entry_attrs, attrs_list)

get_memberindirect(group_entry)

Get indirect members

get_memberofindirect(entry)

get_password_attributes(ldap, dn, entry_attrs)

Search on the entry to determine if it has a password or keytab set.

handle_not_found(*keys)

Handle NotFound exception

handle_duplicate_entry(*keys)

__json__()

Inherited from Object

backend

methods

params

primary_key

params_minus_pk

params_minus(*names)

Yield all Param whose name is not in names.

get_dn(*keys, **kwargs)

Construct an LDAP DN.

get_params()

This method gets called by HasParam._create_param_namespace().

__json__()

Inherited from Plugin

__init__(api)

finalize()

Finalize plugin initialization.

ensure_finalized()

Finalize plugin initialization if it has not yet been finalized.

__repr__()

Return 'module_name.class_name()' representation.

Inherited from ReadOnly

__lock__()

Put this instance into a read-only state.

__islocked__()

Return True if instance is locked, otherwise False.

__setattr__(name, value)

If unlocked, set attribute named name to value.

__delattr__(name)

If unlocked, delete attribute named name.

Private Data Attributes:

Inherited from ReadOnly

_ReadOnly__locked

Private Methods:

_get_suffixes()

_apply_suffixes(entry, suffixes)

Inherited from Object

_on_finalize()

Do custom finalization.

_Object__get_attrs(name)

Inherited from HasParam

_get_param_iterable(name[, verb])

Return an iterable of params defined by the attribute named name.

_filter_param_by_context(name[, env])

Filter params on attribute named name by environment env.

_create_param_namespace(name[, env])

Inherited from Plugin

_Plugin__name_getter()

_Plugin__full_name_getter()

_Plugin__bases_getter()

_Plugin__doc_getter()

_Plugin__summary_getter()

_on_finalize()

Do custom finalization.


property Backend
property Command
NO_CLI = False
__annotations__ = {}
__delattr__(name)

If unlocked, delete attribute named name.

If this instance is locked, an AttributeError will be raised.

Parameters

name – Name of attribute to delete.

__dict__ = mappingproxy({'__module__': 'ipaserver.plugins.server', '__doc__': '\n    IPA server\n    ', 'container_dn': ipapython.dn.DN('cn=masters,cn=ipa,cn=etc'), 'object_name': Gettext('server', domain='ipa', localedir=None), 'object_name_plural': Gettext('servers', domain='ipa', localedir=None), 'object_class': ['top'], 'possible_objectclasses': ['ipaLocationMember'], 'search_attributes': ['cn'], 'default_attributes': ['cn', 'iparepltopomanagedsuffix', 'ipamindomainlevel', 'ipamaxdomainlevel', 'ipalocation', 'ipaserviceweight'], 'label': Gettext('IPA Servers', domain='ipa', localedir=None), 'label_singular': Gettext('IPA Server', domain='ipa', localedir=None), 'attribute_members': {'iparepltopomanagedsuffix': ['topologysuffix'], 'ipalocation': ['location'], 'role': ['servrole']}, 'relationships': {'iparepltopomanagedsuffix': ('Managed', '', 'no_'), 'ipalocation': ('IPA', 'in_', 'not_in_'), 'role': ('Enabled', '', 'no_')}, 'permission_filter_objectclasses': ['ipaConfigObject'], 'managed_permissions': {'System: Read Locations of IPA Servers': {'ipapermright': {'read', 'search', 'compare'}, 'ipapermdefaultattr': {'ipaserviceweight', 'objectclass', 'cn', 'ipalocation'}, 'default_privileges': {'DNS Administrators'}}, 'System: Read Status of Services on IPA Servers': {'ipapermright': {'read', 'search', 'compare'}, 'ipapermdefaultattr': {'objectclass', 'ipaconfigstring', 'cn'}, 'default_privileges': {'DNS Administrators'}}}, 'takes_params': (Str('cn', cli_name='name', doc=Gettext('IPA server hostname', domain='ipa', localedir=None), label=Gettext('Server name', domain='ipa', localedir=None), primary_key=True), Str('iparepltopomanagedsuffix*', flags=[u'no_update', u'no_create', u'no_search']), Str('iparepltopomanagedsuffix_topologysuffix*', flags=[u'no_update', u'no_create', u'no_search', u'virtual_attribute'], label=Gettext('Managed suffixes', domain='ipa', localedir=None)), Int('ipamindomainlevel', cli_name='minlevel', doc=Gettext('Minimum domain level', domain='ipa', localedir=None), flags=[u'no_create', u'no_update'], label=Gettext('Min domain level', domain='ipa', localedir=None)), Int('ipamaxdomainlevel', cli_name='maxlevel', doc=Gettext('Maximum domain level', domain='ipa', localedir=None), flags=[u'no_create', u'no_update'], label=Gettext('Max domain level', domain='ipa', localedir=None)), DNSNameParam('ipalocation_location?', cli_name='location', doc=Gettext('Server location', domain='ipa', localedir=None), flags=[u'no_search'], label=Gettext('Location', domain='ipa', localedir=None), only_relative=True), Int('ipaserviceweight?', cli_name='service_weight', doc=Gettext('Weight for server services', domain='ipa', localedir=None), flags=[u'no_search'], label=Gettext('Service weight', domain='ipa', localedir=None), maxvalue=65535, minvalue=0), Str('service_relative_weight', doc=Gettext('Relative weight for server services (counts per location)', domain='ipa', localedir=None), flags=[u'no_update', u'no_create', u'no_search', u'virtual_attribute'], label=Gettext('Service relative weight', domain='ipa', localedir=None)), Str('enabled_role_servrole*', doc=Gettext('List of enabled roles', domain='ipa', localedir=None), flags=[u'no_update', u'no_create', u'no_search', u'virtual_attribute'], label=Gettext('Enabled server roles', domain='ipa', localedir=None))), '_get_suffixes': <function server._get_suffixes>, '_apply_suffixes': <function server._apply_suffixes>, 'normalize_location': <function server.normalize_location>, 'convert_location': <function server.convert_location>, 'get_enabled_roles': <function server.get_enabled_roles>, '__annotations__': {}})
__init__(api)
__islocked__()

Return True if instance is locked, otherwise False.

__json__()
__lock__()

Put this instance into a read-only state.

After the instance has been locked, attempting to set or delete an attribute will raise an AttributeError.

__module__ = 'ipaserver.plugins.server'
__repr__()

Return ‘module_name.class_name()’ representation.

This representation could be used to instantiate this Plugin instance given the appropriate environment.

__setattr__(name, value)

If unlocked, set attribute named name to value.

If this instance is locked, an AttributeError will be raised.

Parameters
  • name – Name of attribute to set.

  • value – Value to assign to attribute.

__weakref__

list of weak references to the object (if defined)

_apply_suffixes(entry, suffixes)[source]
_create_param_namespace(name, env=None)
_filter_param_by_context(name, env=None)

Filter params on attribute named name by environment env.

For example:

>>> from ipalib.config import Env
>>> class Example(HasParam):
...
...     takes_args = (
...         Str('foo_only', include=['foo']),
...         Str('not_bar', exclude=['bar']),
...         'both',
...     )
...
...     def get_args(self):
...         return self._get_param_iterable('args')
...
...
>>> eg = Example()
>>> foo = Env(context='foo')
>>> bar = Env(context='bar')
>>> another = Env(context='another')
>>> (foo.context, bar.context, another.context)
(u'foo', u'bar', u'another')
>>> list(eg._filter_param_by_context('args', foo))
[Str('foo_only', include=['foo']), Str('not_bar', exclude=['bar']), Str('both')]
>>> list(eg._filter_param_by_context('args', bar))
[Str('both')]
>>> list(eg._filter_param_by_context('args', another))
[Str('not_bar', exclude=['bar']), Str('both')]
_get_param_iterable(name, verb='takes')

Return an iterable of params defined by the attribute named name.

A sequence of params can be defined one of three ways: as a tuple; as a callable that returns an iterable; or as a param spec (a Param or str instance). This method returns a uniform iterable regardless of how the param sequence was defined.

For example, when defined with a tuple:

>>> class ByTuple(HasParam):
...     takes_args = (Param('foo'), Param('bar'))
...
>>> by_tuple = ByTuple()
>>> list(by_tuple._get_param_iterable('args'))
[Param('foo'), Param('bar')]

Or you can define your param sequence with a callable when you need to reference attributes on your plugin instance (for validation rules, etc.). For example:

>>> class ByCallable(HasParam):
...     def takes_args(self):
...         yield Param('foo', self.validate_foo)
...         yield Param('bar', self.validate_bar)
...
...     def validate_foo(self, _, value, **kw):
...         if value != 'Foo':
...             return _("must be 'Foo'")
...
...     def validate_bar(self, _, value, **kw):
...         if value != 'Bar':
...             return _("must be 'Bar'")
...
>>> by_callable = ByCallable()
>>> list(by_callable._get_param_iterable('args'))
[Param('foo', validate_foo), Param('bar', validate_bar)]

Lastly, as a convenience for when a param sequence contains a single param, your defining attribute may a param spec (either a Param or an str instance). For example:

>>> class BySpec(HasParam):
...     takes_args = Param('foo')
...     takes_options = 'bar?'
...
>>> by_spec = BySpec()
>>> list(by_spec._get_param_iterable('args'))
[Param('foo')]
>>> list(by_spec._get_param_iterable('options'))
['bar?']

For information on how an str param spec is interpreted, see the create_param() and parse_param_spec() functions in the ipalib.parameters module.

Also see HasParam._filter_param_by_context().

_get_suffixes()[source]
_on_finalize()

Do custom finalization.

This method is called from finalize(). Subclasses can override this method in order to add custom finalization.

allow_rename = False
already_exists_msg = Gettext('%(oname)s with name "%(pkey)s" already exists', domain='ipa', localedir=None)
property api

Return API instance passed to __init__().

attribute_members = {'ipalocation': ['location'], 'iparepltopomanagedsuffix': ['topologysuffix'], 'role': ['servrole']}
backend = None
backend_name = 'ldap2'
bases = (<class 'ipaserver.plugins.baseldap.LDAPObject'>,)
bindable = False
container_dn = ipapython.dn.DN('cn=masters,cn=ipa,cn=etc')
container_not_found_msg = Gettext('container entry (%(container)s) not found', domain='ipa', localedir=None)
property context
convert_attribute_members(entry_attrs, *keys, **options)
convert_location(entry_attrs, **options)[source]

Return a location name from DN

default_attributes = ['cn', 'iparepltopomanagedsuffix', 'ipamindomainlevel', 'ipamaxdomainlevel', 'ipalocation', 'ipaserviceweight']
disallow_object_classes = []
doc = '\n    IPA server\n    '
ensure_finalized()

Finalize plugin initialization if it has not yet been finalized.

property env
finalize()

Finalize plugin initialization.

This method calls _on_finalize() and locks the plugin object.

Subclasses should not override this method. Custom finalization is done in _on_finalize().

class finalize_attr(name, value=None)

Bases: object

Create a stub object for plugin attribute that isn’t set until the finalization of the plugin initialization.

When the stub object is accessed, it calls ensure_finalized() to make sure the plugin initialization is finalized. The stub object is expected to be replaced with the actual attribute value during the finalization (preferably in _on_finalize()), otherwise an AttributeError is raised.

This is used to implement on-demand finalization of plugin initialization.

__annotations__ = {}
__get__(obj, cls)
__init__(name, value=None)
__module__ = 'ipalib.plugable'
__slots__ = ('name', 'value')
name
value
full_name = 'server/1'
get_ancestor_primary_keys()
get_dn(*keys, **kwargs)

Construct an LDAP DN.

get_dn_if_exists(*keys, **kwargs)
get_enabled_roles(entry_attrs, **options)[source]
get_indirect_members(entry_attrs, attrs_list)
get_memberindirect(group_entry)

Get indirect members

get_memberofindirect(entry)
get_params()

This method gets called by HasParam._create_param_namespace().

get_password_attributes(ldap, dn, entry_attrs)

Search on the entry to determine if it has a password or keytab set.

A tuple is used to determine which attribute is set in entry_attrs. The value is set to True/False whether a given password type is set.

get_primary_key_from_dn(dn)
handle_duplicate_entry(*keys)
handle_not_found(*keys)

Handle NotFound exception

Must raise errors.NotFound again.

has_objectclass(classes, objectclass)
hidden_attributes = ['objectclass', 'aci']
json_friendly_attributes = ('parent_object', 'container_dn', 'object_name', 'object_name_plural', 'object_class', 'object_class_config', 'default_attributes', 'label', 'label_singular', 'hidden_attributes', 'uuid_attribute', 'attribute_members', 'name', 'takes_params', 'rdn_attribute', 'bindable', 'relationships')
label = Gettext('IPA Servers', domain='ipa', localedir=None)
label_singular = Gettext('IPA Server', domain='ipa', localedir=None)
limit_object_classes = []
managed_permissions = {'System: Read Locations of IPA Servers': {'default_privileges': {'DNS Administrators'}, 'ipapermdefaultattr': {'cn', 'ipalocation', 'ipaserviceweight', 'objectclass'}, 'ipapermright': {'compare', 'read', 'search'}}, 'System: Read Status of Services on IPA Servers': {'default_privileges': {'DNS Administrators'}, 'ipapermdefaultattr': {'cn', 'ipaconfigstring', 'objectclass'}, 'ipapermright': {'compare', 'read', 'search'}}}
methods = None
name = 'server'
normalize_location(kw, **options)[source]

Return the DN of location

object_class = ['top']
object_class_config = None
object_name = Gettext('server', domain='ipa', localedir=None)
object_name_plural = Gettext('servers', domain='ipa', localedir=None)
object_not_found_msg = Gettext('%(pkey)s: %(oname)s not found', domain='ipa', localedir=None)
params = None
params_minus(*names)

Yield all Param whose name is not in names.

params_minus_pk = None
parent_not_found_msg = Gettext('%(parent)s: %(oname)s not found', domain='ipa', localedir=None)
parent_object = ''
password_attributes = []
permission_filter_objectclasses = ['ipaConfigObject']
possible_objectclasses = ['ipaLocationMember']
primary_key = None
rdn_attribute = ''
relationships = {'ipalocation': ('IPA', 'in_', 'not_in_'), 'iparepltopomanagedsuffix': ('Managed', '', 'no_'), 'role': ('Enabled', '', 'no_')}
search_attributes = ['cn']
search_attributes_config = None
search_display_attributes = []
summary = 'IPA server'
takes_params = (Str('cn', cli_name='name', doc=Gettext('IPA server hostname', domain='ipa', localedir=None), label=Gettext('Server name', domain='ipa', localedir=None), primary_key=True), Str('iparepltopomanagedsuffix*', flags=[u'no_update', u'no_create', u'no_search']), Str('iparepltopomanagedsuffix_topologysuffix*', flags=[u'no_update', u'no_create', u'no_search', u'virtual_attribute'], label=Gettext('Managed suffixes', domain='ipa', localedir=None)), Int('ipamindomainlevel', cli_name='minlevel', doc=Gettext('Minimum domain level', domain='ipa', localedir=None), flags=[u'no_create', u'no_update'], label=Gettext('Min domain level', domain='ipa', localedir=None)), Int('ipamaxdomainlevel', cli_name='maxlevel', doc=Gettext('Maximum domain level', domain='ipa', localedir=None), flags=[u'no_create', u'no_update'], label=Gettext('Max domain level', domain='ipa', localedir=None)), DNSNameParam('ipalocation_location?', cli_name='location', doc=Gettext('Server location', domain='ipa', localedir=None), flags=[u'no_search'], label=Gettext('Location', domain='ipa', localedir=None), only_relative=True), Int('ipaserviceweight?', cli_name='service_weight', doc=Gettext('Weight for server services', domain='ipa', localedir=None), flags=[u'no_search'], label=Gettext('Service weight', domain='ipa', localedir=None), maxvalue=65535, minvalue=0), Str('service_relative_weight', doc=Gettext('Relative weight for server services (counts per location)', domain='ipa', localedir=None), flags=[u'no_update', u'no_create', u'no_search', u'virtual_attribute'], label=Gettext('Service relative weight', domain='ipa', localedir=None)), Str('enabled_role_servrole*', doc=Gettext('List of enabled roles', domain='ipa', localedir=None), flags=[u'no_update', u'no_create', u'no_search', u'virtual_attribute'], label=Gettext('Enabled server roles', domain='ipa', localedir=None)))
uuid_attribute = ''
version = '1'