GET v1/bunits/{bunitId}/nodes?includeDescendants={includeDescendants}

OBSOLETE: Nodes are no longer directly related to business unit.
Please use bunits/{bunitId}/consumers

Get all nodes belonging to the business unit (and descendants if requested)

Request Information

URI Parameters

Name	Description	Type	Additional information
bunitId	The ID of the business unit to whom the backup nodes belong.	integer	Required
includeDescendants	If nodes of descendants are required add this parameter. Default is false	boolean	Default value is False

Body Parameters

None.

Response Information

Resource Description

A list of all nodes of the business unit (and descendants if requested)

Collection of Node

Name	Description	Type	Additional information
ActivityLogs	Activity logs of the backup node created when mount point problems occur. These are not associated with any activities	Collection of ActivityLog	None.
ClientOptionSet	The client option set on the IBM Storage Protect server the backup node is associated with	ClientOptionSet	Required.
Consumer	Consumption unit that relates the VM to a business unit	Consumer	None.
Domain	The domain on the IBM Storage Protect server the backup node is associated with	Domain	Required.
Events	The events of the backup node	Collection of Event	None.
ProxyTargets		Collection of Node	None.
ProxyAgents		Collection of Node	None.
ActivityLogFilters	A list of filters for creating warnings based on activity logs of node	Collection of ActivityLogFilter	None.
Filespaces	The file spaces getting backed up for this node.	Collection of Filespace	None.
NodeGroups	A list of node groups the backup node is related to on the IBM Storage Protect server	Collection of NodeGroup	None.
RetentionSets	A list of the retention sets the backup node is a part of	Collection of RetentionSet	None.
RemoteActivities	A list of activities reported into Cloutility from a remote system Currently only used for SAP HANA	Collection of RemoteActivity	None.
Id	A unique ID for the object.	integer	Read-only.
Locked	When locked the backup node is prevented from accessing and performing operations on the IBM Storage Protect server	boolean	None.
Ticket	The installation ticket for the backup node.	globally unique identifier	None.
TsmPassword	The password generated by the system and used on activation on IBM Storage Protect server. May not be correct as this is not updated once the end user updates it through the client.	string	None.
Hypervisor	The hypervisor vendor (SP information)	string	None.
CpuCount	The number of CPUs installed in the backup node. This is used in some SP licensing models.	integer	Required. Must be an integer larger than 1.
TcpName	Name of the machine (TCPName) (SP information)	string	None.
TcpAddress	IP address (TCPAddress) (SP information)	string	None.
ActivatedDate	The date the backup node was activated and created on the IBM Storage Protect server	date	None.
LastAccessTime	Last time the backup node was accessed (SP information)	date	None.
CreatedDate	Time and date the object was created.	date	Read-only.
ArchivedDate	Time and date the object was or is going to be archived. Unarchived objects have no value in ArchivedDate	date	Read-only.
TsmNodeId	The ID of the backup node in SP. This ID is set automatically when the backup node is activated.	string	None.
RegisteredTime	Time the backup node was registered (SP information)	date	None.
ReplicationState	Whether the backup node uses replication or not SP reponse can be ENabled or DISabled	boolean	None.
ReplicationMode	Replication mode can be None = 0 Send = 1 Receive = 2	ReplicationMode	None.
ReplicationServerPrimary	Name of the IBM Storage Protect server hosting the backup node that is source for replication	string	None.
ReplicationServerSecondary	Name of the IBM Storage Protect server hosting the backup node that is target for latest replication	string	None.
Name	Name of the data-source	string	None.
Decommissioned	Whether or not the backup node has been decommissioned	boolean	None.
DecommissionDate	The date a backup node was decommissioned	date	None.
MacAddress	MAC address (MACADDR) (SP information)	string	None.
DedupStatsGeneratedTime	The most recent generating of dedup stats	date	None.
Contact	Contact (SP information)	string	None.
ReplicationServerSecondary2		string	None.
AvailableForMerge	If true other backup nodes can be merged into this to get its history Missing nodes are always available for merge even if AvailableForMerge=false	boolean	None.
OperatingSystem	Operating system	NodeOperatingSystem	Required.
Type	Type (file server, workstation or application server)	NodeType	Required.
SyncState	The synchronization state of the backup node	NodeSyncState	Read-only.
Schedules	The schedules associated with the backup node	Collection of Schedule	None.
NodeSchedules	The schedules associated with the backup node	Collection of NodeSchedule	None.
UnscheduledActivities	The activities of the backup node	Collection of Activity	None.
DeleteCommand	The command that will be sent to IBM Storage Protect server if the backup node is to be deleted This property is only set if the backup node is archived	string	None.
TsmName		string	None.
Platform	The platform of the backup node (SP information)	NodePlatform	None.
TsmClientVersion	The current version of the client installed on the backup node (SP information)	NodeTsmClientVersion	None.
OsLevel	The OS level (SP Information)	NodeOsLevel	None.
SessionSecurity	Information about session security Options are string and transitional	SessionSecurity	None.
ContainsVmFilespaces	Whether or not the backup node has any file spaces that is or can be assigned as VM file space	boolean	None.
DeleteProcess	Information about the deletion of the backup node if this has been requested	DeleteProcess	None.
DataSourceState		DataSourceState	None.
DataSourcePlatform		DataSourcePlatform	None.
DataSourceType		DataSourceType	None.
BackupServer		Server	None.
Operations		Collection of OperationResult	None.

Response Formats