NodeInfo Class

Information about a node in Service Fabric cluster.

Inheritance

Model

NodeInfo

Constructor

NodeInfo(*, name: Optional[str] = None, ip_address_or_fqdn: Optional[str] = None, type: Optional[str] = None, code_version: Optional[str] = None, config_version: Optional[str] = None, node_status=None, node_up_time_in_seconds: Optional[str] = None, health_state=None, is_seed_node: Optional[bool] = None, upgrade_domain: Optional[str] = None, fault_domain: Optional[str] = None, id=None, instance_id: Optional[str] = None, node_deactivation_info=None, is_stopped: Optional[bool] = None, node_down_time_in_seconds: Optional[str] = None, node_up_at=None, node_down_at=None, node_tags=None, is_node_by_node_upgrade_in_progress: Optional[bool] = None, infrastructure_placement_id: Optional[str] = None, **kwargs)

Parameters

name

str

Required

The name of a Service Fabric node.

ip_address_or_fqdn

str

Required

The IP address or fully qualified domain name of the node.

type

str

Required

The type of the node.

code_version

str

Required

The version of Service Fabric binaries that the node is running.

config_version

str

Required

The version of Service Fabric cluster manifest that the node is using.

node_status

str or NodeStatus

Required

The status of the node. Possible values include: 'Invalid', 'Up', 'Down', 'Enabling', 'Disabling', 'Disabled', 'Unknown', 'Removed'

node_up_time_in_seconds

str

Required

Time in seconds since the node has been in NodeStatus Up. Value zero indicates that the node is not Up.

health_state

str or HealthState

Required

The health state of a Service Fabric entity such as Cluster, Node, Application, Service, Partition, Replica etc. Possible values include: 'Invalid', 'Ok', 'Warning', 'Error', 'Unknown'

is_seed_node

bool

Required

Indicates if the node is a seed node or not. Returns true if the node is a seed node, otherwise false. A quorum of seed nodes are required for proper operation of Service Fabric cluster.

upgrade_domain

str

Required

The upgrade domain of the node.

fault_domain

str

Required

The fault domain of the node.

id

NodeId

Required

An internal ID used by Service Fabric to uniquely identify a node. Node Id is deterministically generated from node name.

instance_id

str

Required

The ID representing the node instance. While the ID of the node is deterministically generated from the node name and remains same across restarts, the InstanceId changes every time node restarts.

node_deactivation_info

NodeDeactivationInfo

Required

Information about the node deactivation. This information is valid for a node that is undergoing deactivation or has already been deactivated.

is_stopped

bool

Required

Indicates if the node is stopped by calling stop node API or not. Returns true if the node is stopped, otherwise false.

node_down_time_in_seconds

str

Required

Time in seconds since the node has been in NodeStatus Down. Value zero indicates node is not NodeStatus Down.

node_up_at

datetime

Required

Date time in UTC when the node came up. If the node has never been up then this value will be zero date time.

node_down_at

datetime

Required

Date time in UTC when the node went down. If node has never been down then this value will be zero date time.

node_tags

list[str]

Required

List that contains tags, which will be applied to the nodes.

is_node_by_node_upgrade_in_progress

bool

Required

Indicates if a node-by-node upgrade is currently being performed on this node.

infrastructure_placement_id

str

Required

PlacementID used by the InfrastructureService.