# NodeType (Complex Type)

### Namespace: http://midpoint.evolveum.com/xml/ns/public/common/common-3

Supertype: AssignmentHolderType
Node describes a single installation of midPoint. MidPoint installations can work in cluster. The Node objects are the way how the nodes in cluster know about each other.

Item Summary
Name | Type | Multiplicity | Description
--- | --- | --- | ---
name | property PolyStringType | [0,1] | Human-readable, mutable name of the object.
description | property string | [0,1] | Free-form textual description of the object.
documentation | property string | [0,1] | AsciiDoc-formatted technical documentation of the object.
subtype | property string | [0,-1] | Type of the object.
fetchResult | property OperationResultType | [0,1] | Result of the operation that fetched this instance of the object.
extension | container ExtensionType | [0,1] | Extension container that provides generic extensibility mechanism.
parentOrgRef | reference ObjectReferenceType | [0,-1] | Set of the orgs (organizational units, projects, teams) that the object relates to.
trigger | container TriggerType | [0,-1] | Triggers for this object.
metadata | container MetadataType | [0,1] | Meta-data about object creation, modification, etc.
tenantRef | reference ObjectReferenceType | [0,1] | Reference to the tenant to which this object belongs.
lifecycleState | property string | [0,1] | Lifecycle state of the object.
operationExecution | container OperationExecutionType | [0,-1] | Description of recent operations executed on this object (or related objects in special cases).
lensContext | container LensContextType | [0,1] | Model context describing executed operation
policySituation | property anyURI | [0,-1] | The policy situation(s) of this object.
triggeredPolicyRule | property EvaluatedPolicyRuleType | [0,-1] | Triggered policy rules for this object.
policyException | container PolicyExceptionType | [0,-1] | Recorded exception from a policy rule.
diagnosticInformation | property DiagnosticInformationType | [0,-1] | Diagnostic information attached to this object.
indestructible | property boolean | [0,1] | Protection against accidental deletion.
effectiveMarkRef | reference ObjectReferenceType | [0,-1] | Effective object marks for this object.
policyStatement | container PolicyStatementType | [0,-1] | Policy statements to manually add or exclude effective marks of shadow.
effectiveOperationPolicy | container ObjectOperationPolicyType | [0,1] | Effective provisioning policy derived from Shadow marks and resource configuration.
assignment | container AssignmentType | [0,-1] | Set of object's assignments.
iteration | property int | [0,1] | Iteration number.
iterationToken | property string | [0,1] | Iteration token.
archetypeRef | reference ObjectReferenceType | [0,-1] | References to all applicable archetypes, including "indirect" archetypes such as archetype supertypes.
roleMembershipRef | reference ObjectReferenceType | [0,-1] | References to abstract roles (roles, orgs, services) that this focus currently belongs to - directly or indirectly.
delegatedRef | reference ObjectReferenceType | [0,-1] | References to objects (abstract roles as well as users) obtained via delegation.
roleInfluenceRef | reference ObjectReferenceType | [0,-1] | References to abstract roles (roles and orgs) that this focus may directly belong to.
nodeIdentifier | property string | [0,1] | Short, cluster-wide identifier of the node.
hostname | property string | [0,1] | Hostname of the node that can be used by other nodes to contact this node over the network.
url | property string | [0,1] | URL of midPoint that can be used by other nodes to contact this node over the network.
urlOverride | property string | [0,1] | Value to override constructed or determined URL.
ipAddress | property string | [0,-1] | IP addresses of the node (both IPv4 and IPv6 addresses in textual notation).
lastCheckInTime | property dateTime | [0,1] | The time when this node last checked-in.
operationalState | property NodeOperationalStateType | [0,1] | Basic node operational state: whether it is up (e.
clustered | property boolean | [0,1] | Whether this node is a part of a cluster.
internalNodeIdentifier | property string | [0,1] | Internal (generated) node identifier, used primarily to detect whether the node information was not overwritten by another node.
executionState | property NodeExecutionStateType | [0,1] | Actual node state from the point of executing tasks.
errorState | property NodeErrorStateType | [0,1] | More detailed characterization of the error state.
connectionResult | property OperationResultType | [0,1] | Result of the operation that connected to this node.
build | container BuildInformationType | [0,1] | Information about midPoint build running on this node.
secret | property ProtectedStringType | [0,1] | The secret used for intra-cluster authentication.
secretUpdateTimestamp | property dateTime | [0,1] | When was the secret created or last changed.
taskExecutionLimitations | property TaskExecutionLimitationsType | [0,1] | Limitations for execution of tasks on this node.

- ### Items

  - #### name

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order: 0

    Human-readable, mutable name of the object. It may also be an identifier (login name, group name). It is usually unique in the respective context of interpretation. E.g. the name of the UserType subtype is usually unique in the whole system. The name of the ShadowType subtype is usually unique in the scope of resource (target system) that it belongs to.

    The name may not be human-readable in a sense to display to a common end-user. It is intended to be displayed to IDM system administrator. Therefore it may contain quite a "ugly" structures such as LDAP DN or URL.

    Name is mutable. It is considered to be ordinary property of the object. Therefore it can be changed by invoking usual modifyObject operations. However, change of the name may have side effects (rename process).

    Although name is specified as optional by this schema, it is in fact mandatory for most object types. The reason for specifying the name as optional is that the name may be generated by the system instead of supplied by the clients. However, all objects stored in the repository must have a name.

  - #### description

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order: 10

    Free-form textual description of the object. This is meant to be displayed in the user interface.

  - #### documentation

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order: 11

    AsciiDoc-formatted technical documentation of the object.

  - #### subtype

    Flags: RAM,runtime

    Multiplicity: [0,-1]

    Display order: 15

    Type of the object. It is used to distinguish what a specific object represents. Whether it is a different kind of organizational unit, project, team, or different kind of user, etc.

  - #### fetchResult

    Flags: RAM,runtime,oper

    Multiplicity: [0,1]

    Display order:

    Result of the operation that fetched this instance of the object. It is mostly used to indicate that the object is not complete or there is some problem with the object. This is used instead of exception if the object is part of larger structures (lists as in list/search operations or composite objects). If not present then the "SUCCESS" state is assumed.

    This field is TRANSIENT. It must only be used in runtime. It should never be stored in the repository.

  - #### extension

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order: 1000

    Extension container that provides generic extensibility mechanism. Almost any extension property can be placed in this container. This mechanism is used to extend objects with new properties. The extension is treated exactly the same as other object properties by the code (storage, modifications, etc), except that the system may not be able to understand their meaning.

  - #### parentOrgRef

    Flags: RAM,oper

    Multiplicity: [0,-1]

    Display order: 240

    Set of the orgs (organizational units, projects, teams) that the object relates to. This usually means that the object belongs to them but it may have other meanings as well (e.g. user manages an organizational unit).

  - #### trigger

    Flags: RAM,runtime,oper

    Multiplicity: [0,-1]

    Display order:

    Triggers for this object. They drive invocations of corresponding trigger handlers at specified time.

  - #### metadata

    Flags: RAM,runtime,oper

    Multiplicity: [0,1]

    Display order:

    Meta-data about object creation, modification, etc.

  - #### tenantRef

    Flags: RAM,oper

    Multiplicity: [0,1]

    Display order: 250

    Reference to the tenant to which this object belongs. It is a computed value set automatically by midPoint. It is determined from the organizational structure. Even though this value is computed it is also stored in the repository due to performance reasons.

  - #### lifecycleState

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order: 20

    Lifecycle state of the object. This property defines whether the object represents a draft, proposed definition, whether it is active, deprecated, archived, and so on. See "Object Lifecycle" in the documentation.

  - #### operationExecution

    Flags: RAM,runtime,oper

    Multiplicity: [0,-1]

    Display order:

    Description of recent operations executed on this object (or related objects in special cases). The number of operations to be kept here is configurable.

  - #### lensContext

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order:

    Model context describing executed operation

  - #### policySituation

    Flags: RAM,runtime,oper

    Multiplicity: [0,-1]

    Display order:

    The policy situation(s) of this object. The situations are result of evaluation of the policy rules. This property is recorded for each object and can be used for reporting, diagnostics, target selection in certification campaigns, etc.

  - #### triggeredPolicyRule

    Flags: RAM,runtime,oper

    Multiplicity: [0,-1]

    Display order:

    Triggered policy rules for this object. (Not necessarily complete; subject to specified storage strategy.) This is EXPERIMENTAL functionality. It is possibly to change in the near future.

  - #### policyException

    Flags: RAM,runtime

    Multiplicity: [0,-1]

    Display order:

    Recorded exception from a policy rule. The exceptions that are approved are recoded here to avoid re-evaluating and re-approving them all the time. This is EXPERIMENTAL functionality. It is likely to change in the near future.

  - #### diagnosticInformation

    Flags: RAM,runtime

    Multiplicity: [0,-1]

    Display order:

    Diagnostic information attached to this object.

  - #### indestructible

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order:

    Protection against accidental deletion. If set to true then this object cannot be deleted. If the object needs to be deleted then it has to be modified first to reset this flag.

  - #### effectiveMarkRef

    Flags: RAM

    Multiplicity: [0,-1]

    Display order:

    Effective object marks for this object. When stored in the repository, this includes computed marks (for shadows by the marking mechanism, and for other objects by the policy rules), as well as applied policy statements. Conditions that these values hold: 1. They always have an OID. 2. For shadows: They have either a default relation, or `org:related` one. The latter means that the reference is inactive, and is present only for the purpose of holding value metadata (usually that it was computed by a rule, but disabled by a statement). 3. They are computed using the `production` configuration (regarding statements, and later e.g. marking rules). Value metadata (currently applies only to shadows): 1. provenance/markingRule is set when the value is provided by the automatic marking rule; 2. provenance/policyStatement is set when the value is influenced by the policy statement (either enforced or suppressed).

  - #### policyStatement

    Flags: RAM,runtime

    Multiplicity: [0,-1]

    Display order:

    Policy statements to manually add or exclude effective marks of shadow.

  - #### effectiveOperationPolicy

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order:

    Effective provisioning policy derived from Shadow marks and resource configuration. Currently supported for shadows only. Transient: not stored in the repository.

  - #### assignment

    Flags: RAM,runtime

    Multiplicity: [0,-1]

    Display order:

    Set of object's assignments. Assignments define the privileges and "features" that this object should have, that this object is entitled to. Typical assignment will point to a role or define a construction of an account.

    Assignments represent what the object SHOULD HAVE. The assignments represent a policy, a desired state of things (cf. linkRef, roleMembershipRef).

  - #### iteration

    Flags: RAM,runtime,oper

    Multiplicity: [0,1]

    Display order:

    Iteration number. Starts with 0. It is used to iteratively find unique identifier for the object.

  - #### iterationToken

    Flags: RAM,runtime,oper

    Multiplicity: [0,1]

    Display order:

    Iteration token. String value that is usually a suffix to the identifier based on iteration number. E.g. ".007". It is used to iteratively find unique identifier for the object.

  - #### archetypeRef

    Flags: RAM,oper

    Multiplicity: [0,-1]

    Display order:

    References to all applicable archetypes, including "indirect" archetypes such as archetype supertypes. Contains references to active archetypes only.

    Note: the value of this reference is only updated when object is recomputed. Therefore if a role definition changes then all the affected objects must be recomputed for this reference to be consistent.

    This is an operational property. It is set and managed by the system. It is used for efficient use of archetypes.

  - #### roleMembershipRef

    Flags: RAM,oper

    Multiplicity: [0,-1]

    Display order:

    References to abstract roles (roles, orgs, services) that this focus currently belongs to - directly or indirectly. This reference points to all the roles in the role hierarchy. It only points to the roles that were evaluated as active during last recompute (conditions were true, validity constraints not violated).

    Note: the value of this reference is only updated when a focal object is recomputed. Therefore if a role definition changes then all the affected focal objects must be recomputed for this reference to be consistent.

    Roles mentioned here are those that are NOT obtained via delegation, i.e. "deputy" relations. Relations acquired by delegation are listed in delegatedRef item.

    This is an operational property. It is set and managed by the system. It is used for efficient search of all current role members, e.g. for the purpose of displaying this information in the GUI.

    Note: roleMembershipRef will be probably renamed to something like linkRef or outboundLinkRef. We need to generalize it to contain information on generic links between objects (e.g. between child and its parents).

  - #### delegatedRef

    Flags: RAM,oper

    Multiplicity: [0,-1]

    Display order:

    References to objects (abstract roles as well as users) obtained via delegation. If A1 is a deputy of A, its delegatedRef contains a union of A, A.roleMembershipRef and A.delegatedRef.

    This is an operational property. It is set and managed by the system. It is used for efficient search of all current role members, e.g. for the purpose of displaying this information in the GUI.

  - #### roleInfluenceRef

    Flags: RAM,oper

    Multiplicity: [0,-1]

    Display order:

    References to abstract roles (roles and orgs) that this focus may directly belong to. This reference only points to the next role in the hierarchy. However, it is backed by a "closure" index in the repository subsystem. Therefore it can efficiently support tree-like queries. This reference points to the roles for whose the condition is not true. Therefore it does not reliably show who actually has a role. It shows potential role members - all the object that are possibly influenced when a role definition changes.

    This is an operational property. It is set and managed by the system. It is used for efficient search of all possible role members, e.g. for the purpose of recomputing all role members after the role definition is changed.

    TODO. NOT IMPLEMENTED YET. EXPERIMENTAL. UNSTABLE.

  - #### nodeIdentifier

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order:

    Short, cluster-wide identifier of the node. It may be a hostname, a number, or a short string. It should be short as it is used e.g. in audit records. Its use is planned also for lightweight IDs.

  - #### hostname

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order:

    Hostname of the node that can be used by other nodes to contact this node over the network. It is automatically determined and updated.

  - #### url

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order:

    URL of midPoint that can be used by other nodes to contact this node over the network. It is either provided manually (see urlOverride), constructed using infrastructure/intraClusterHttpUrlPattern configuration property, or determined automatically.

  - #### urlOverride

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order:

    Value to override constructed or determined URL.

  - #### ipAddress

    Flags: RAM,runtime

    Multiplicity: [0,-1]

    Display order:

    IP addresses of the node (both IPv4 and IPv6 addresses in textual notation).

  - #### lastCheckInTime

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order:

    The time when this node last checked-in.

  - #### operationalState

    Flags: RAM,runtime,AVals:3

    Multiplicity: [0,1]

    Display order:

    Basic node operational state: whether it is up (e.g. should be accepting REST queries), or it is down (known to be turned off or just not checking-in for a longer time), or starting. Does NOT indicate anything about the scheduler status. Supersedes "running" property. Renamed from "operationalStatus" property in 4.4.

  - #### clustered

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order:

    Whether this node is a part of a cluster. Used to detect misconfigurations.

  - #### internalNodeIdentifier

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order:

    Internal (generated) node identifier, used primarily to detect whether the node information was not overwritten by another node.

  - #### executionState

    Flags: RAM,runtime,AVals:7

    Multiplicity: [0,1]

    Display order:

    Actual node state from the point of executing tasks. This field is TRANSIENT. It must only be used in runtime. It should never be stored in the repository.

  - #### errorState

    Flags: RAM,runtime,AVals:6

    Multiplicity: [0,1]

    Display order:

    More detailed characterization of the error state. This field is TRANSIENT. It must only be used in runtime. It should never be stored in the repository.

  - #### connectionResult

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order:

    Result of the operation that connected to this node. This field is TRANSIENT. It must only be used in runtime. It should never be stored in the repository.

  - #### build

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order:

    Information about midPoint build running on this node.

  - #### secret

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order:

    The secret used for intra-cluster authentication.

  - #### secretUpdateTimestamp

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order:

    When was the secret created or last changed.

  - #### taskExecutionLimitations

    Flags: RAM,runtime

    Multiplicity: [0,1]

    Display order:

    Limitations for execution of tasks on this node.