Alignak realm (realm)

The realm model is used to represent a realm of the monitored system.

The Alignak framework distributed architecture allows to have a unique Alignak instance to manage a huge system. I nsuch a cas, it is interesting to be able to cut this huge configuration into parts for different sites, customers, … For Alignak, those parts are realms.

A realm is a group of resources (hosts ) tha users will be able to manage. All resources in the Alignak backend are attached to a realm. At minimum, it is the All realm that always exist in any Alignak instance.

The realm organization is hierarchical. A realm may have sub-realms that also may have sub-realms. Sub-realms visibility of the resources allow the Alignak backend users to view the resources defined in upper realms.

resources/../_static/config_realm.png
Properties
Property Type Required Default Relation
Children
objectid list   [] realm
Children
objectid list   [] realm
Level
integer   0  
Parent
objectid   None realm
Parents
objectid list   [] realm
_users_delete
objectid list     user
_users_read
objectid list     user
_users_update
objectid list     user
Alias
string      
Default realm
boolean   False  
Definition order
integer   100  
global_critical_threshold
integer   5  
global_warning_threshold
integer   3  
hosts_critical_threshold
integer   5  
hosts_warning_threshold
integer   3  
Imported from
string   unknown  
Realm name
string True    
Notes
string      
schema_version
integer   1  
services_critical_threshold
integer   5  
services_warning_threshold
integer   3  

_all_children: List of all the children in the hierarchy

_children: List of the immediate children in the hierarchy

_level: Level in the hierarchy

_parent: Immediate parent in the hierarchy

_tree_parents: List of parents in the hierarchy

alias: Element friendly name used by the Web User Interface.

default: This realm is the default realm used when no realm information is provided.

definition_order: Priority level if several elements have the same name

imported_from: Item importation source (alignak-backend-import, …)

name: Unique realm name

notes: Element notes. Free text to store element information.