Default language.

Important This documentation space contains information about the SaaS version of BMC Helix Discovery. If you are using the on-premises version of BMC Helix Discovery, see BMC Helix Discovery 25.2 (On-Premises).

File System node

A File System node represents a file system mounted on a host. On a host there is a File System node for each discovered local, exported, and remote file system.

Currently File System nodes are not synced to CMDB by the default syncmapping sets. This can be extended.

File System Model Illustration

fs_design_pattern.png

FileSystem nodes come in the following types:

  • LOCAL — A filesystem that is LOCAL to the device, for instance a directly attached disk drive. SAN storage appears to the OS as LUNs on a SCSI chain filesystem, so these devices are reported as LOCAL.
  • REMOTE — A filesystem that is attached over the network from another device. This is the client side of a network filesystem.
  • EXPORTED — A filesystem (or part of a filesystem) which is available for other devices to use. This is the server side of a network filesystem.

An important aspect of this model is that the REMOTE type is the client's view of an EXPORTED filesystem. If both server and client ends are discovered there is a single EXPORTED FileSystem node attached to the server Host node and multiple REMOTE FileSystem instances, a single instance attached to each client Host node.

Network file systems generally export a fraction of an underlying LOCAL filesystem. Thus, on a server exporting filesystems it is expected that the LOCAL and EXPORTED FileSystems instances will be related by the FileSystem:Local:NetworkFileSystem:Exported:FileSystem relationship showing which LOCAL filesystem supports the EXPORTED filesystem. There might be several EXPORTED FileSystem nodes related to the same LOCAL FileSystem node, for instance on a Windows server the two shares C$ and ADMIN$ will usually both be exported from the same C: local filesystem.

The above diagram shows a client (right side) and server (left side) Host. The server might be a UNIX server exporting a section of a local filesystem via NFS, or a Windows server exporting a shared folder via SMB. For each client mounting the NFS/SMB filesystem, the filesystem will be represented by a REMOTE FileSystem.

It is important to remember this distinction if you are considering synchronizing these nodes to the CMDB. The BMC Discovery model and the Common Data Model (CDM) have very different semantics around "remote" filesystems. Currently it is recommended to simply synchronize these to BMC_FileSystem.

File System Lifecycle

A File System node is related to the host it is contained in. Therefore, the File System node lifecycle is directly tied to the Host node and is destroyed when the Host node is destroyed. See Host-node.
This is a Containment Removal type, see Containment Removal.

Additionally, if both ends of a network filesystem can be discovered the system builds a NetworkFileSystem relationship between the appropriate REMOTE and EXPORTED FileSystem nodes.

Attributes of the FileSystem node

The attributes of the FileSystem node are described in the following table:

UI Name
Attribute Name and Type		Description 
Key
key : string 		File system unique identifier
Name
name : string 		Meaningful file system name for reporting
Filesystem Name
fs_name : string 		File system name
Kind
fs_kind : string 		File system kind
Type
fs_type : string 		File system type
Mount
mount : string 		File system mount
Size
size : int 		File system size in KB
Used
used : int 		File system used in KB
Free
free : int 		File system free in KB
Used Percentage
used_percentage : int 		File system used percentage
Free Percentage
free_percentage : int 		File system free percentage
Snapshot Size
snapshot_size : int 		Snapshot size in KB
Snapshot Used
snapshot_used : int 		Snapshot used in KB
Snapshot Free
snapshot_free : int 		Snapshot free in KB
Remote Hostname
remote_hostname : string 		Hostname of remote server for REMOTE File Systems
Remote IP Address
remote_ip : string 		IP Address of remote server for REMOTE File Systems
Remote Username
remote_username : string 		Username used to access REMOTE File System
Remote Name
remote_fs_name : string 		Remote file system name
Exported Path
path : string 		Exported path
Has Qtrees
has_qtrees : boolean 		Has related Qtrees
Is a Qtree
qtree : boolean 		Is a Qtree
Owning Volume
root_volume : string 		Root Volume
Alternative Filesystem Names
fs_aliases : list:string 		Aliases for file system name
Cloud Identifier
cloud_id : string 		Unique cloud identifier
External Identifiers
external_ids : string 		Identifiers in other systems

Relationships of the FileSystem node

The relationships of the FileSystem node are described in the following table:

UI Name Relationship Description 
Deployments Member:
Collection:
Collection:
Deployment 		Deployments this File System is a member of
Namespace Member:
Collection:
Collection:
Namespace 		Namespace this File System is in
Administrative Collections Member:
Collection:
Collection:
AdminCollection 		Administrative Collections this File System is a member of
Collections Member:
Collection:
Collection:
Collection 		Collections this File System is a member of
Subnets Member:
Collection:
Collection:
Subnet 		Subnets this File System is a member of
Exported From Exported:
ExportedFileSystem:
Local:
FileSystem 		Exported to Local network file system
Exported Directories Local:
ExportedFileSystem:
Exported:
FileSystem 		Local to Exported network file system
Host MountedFileSystem:
FileSystemMount:
Mounter:
Host 		Host with this File System
Cloud Service MountedFileSystem:
FileSystemMount:
Mounter:
CloudService 		Cloud Service with this File System
Storage System MountedFileSystem:
FileSystemMount:
Mounter:
StorageSystem 		Storage System with this File System
Storage System Group MountedFileSystem:
FileSystemMount:
Mounter:
StorageSystemGroup 		Storage System Group with this File System
Subsidiary File Systems Parent:
Hierarchy:
Child:
FileSystem 		File Systems allocated from this one
Parent File System Child:
Hierarchy:
Parent:
FileSystem 		File System of which this one is a part
Primary Business Application InferredElement:
Inference:
Primary:
BusinessApplicationInstance 		Business Application from which the existence of this File System was inferred
Primary Business Service InferredElement:
Inference:
Primary:
BusinessService 		Business Service from which the existence of this File System was inferred
Primary Technical Service InferredElement:
Inference:
Primary:
TechnicalService 		Technical Service from which the existence of this File System was inferred
Primary Container InferredElement:
Inference:
Primary:
ContainerInfo 		Container from which the existence of this File System was inferred
Primary Contained Software Instance InferredElement:
Inference:
Primary:
ContainedSoftwareInstance 		Contained Software Instance from which the existence of this File System was inferred
Primary Device Info InferredElement:
Inference:
Primary:
DeviceInfo 		Device Info from which the existence of this File System was inferred
Primary Discovered Application Component InferredElement:
Inference:
Primary:
DiscoveredApplicationComponent 		Discovered Application Component from which the existence of this File System was inferred
Primary Discovered Cloud API Result List InferredElement:
Inference:
Primary:
DiscoveredCloudAPIResultList 		Discovered Cloud API Result List from which the existence of this File System was inferred
Primary Discovered Coupling Facility InferredElement:
Inference:
Primary:
DiscoveredCouplingFacility 		Discovered Coupling Facility from which the existence of this File System was inferred
Primary Discovered Database InferredElement:
Inference:
Primary:
DiscoveredDatabase 		Discovered Database from which the existence of this File System was inferred
Primary Discovered Database Detail InferredElement:
Inference:
Primary:
DiscoveredDatabaseDetail 		Discovered Database Detail from which the existence of this File System was inferred
Primary Discovered Directory Entry InferredElement:
Inference:
Primary:
DiscoveredDirectoryEntry 		Discovered Directory Entry from which the existence of this File System was inferred
Primary Discovered Disk Drive InferredElement:
Inference:
Primary:
DiscoveredDiskDrive 		Discovered Disk Drive from which the existence of this File System was inferred
Primary Discovered File InferredElement:
Inference:
Primary:
DiscoveredFile 		Discovered File from which the existence of this File System was inferred
Primary Discovered File System InferredElement:
Inference:
Primary:
DiscoveredFileSystem 		Discovered File System from which the existence of this File System was inferred
Primary Discovered HBA InferredElement:
Inference:
Primary:
DiscoveredHBA 		Discovered HBA from which the existence of this File System was inferred
Primary Discovered IP Address InferredElement:
Inference:
Primary:
DiscoveredIPAddress 		Discovered IP Address from which the existence of this File System was inferred
Primary Listening Port InferredElement:
Inference:
Primary:
DiscoveredListeningPort 		Listening Port from which the existence of this File System was inferred
Primary Discovered MFPart InferredElement:
Inference:
Primary:
DiscoveredMFPart 		Discovered MFPart from which the existence of this File System was inferred
Primary Discovered MQ Detail InferredElement:
Inference:
Primary:
DiscoveredMQDetail 		Discovered MQ Detail from which the existence of this File System was inferred
Primary Discovered Mainframe InferredElement:
Inference:
Primary:
DiscoveredMainframe 		Discovered Mainframe from which the existence of this File System was inferred
Primary Discovered Mainframe View Result InferredElement:
Inference:
Primary:
DiscoveredMainframeViewResult 		Discovered Mainframe View Result from which the existence of this File System was inferred
Primary Discovered Network Interface InferredElement:
Inference:
Primary:
DiscoveredNetworkInterface 		Discovered Network Interface from which the existence of this File System was inferred
Primary Discovered Process InferredElement:
Inference:
Primary:
DiscoveredProcess 		Discovered Process from which the existence of this File System was inferred
Primary Discovered Program InferredElement:
Inference:
Primary:
DiscoveredProgram 		Discovered Program from which the existence of this File System was inferred
Primary Discovered Registry Entry InferredElement:
Inference:
Primary:
DiscoveredRegistryEntry 		Discovered Registry Entry from which the existence of this File System was inferred
Primary Discovered Service InferredElement:
Inference:
Primary:
DiscoveredService 		Discovered Service from which the existence of this File System was inferred
Primary Discovered Software InferredElement:
Inference:
Primary:
DiscoveredSoftware 		Discovered Software from which the existence of this File System was inferred
Primary Discovered Storage Subsystem InferredElement:
Inference:
Primary:
DiscoveredStorageSubsystem 		Discovered Storage Subsystem from which the existence of this File System was inferred
Primary Discovered Sysplex InferredElement:
Inference:
Primary:
DiscoveredSysplex 		Discovered Sysplex from which the existence of this File System was inferred
Primary Discovered Tape Drive InferredElement:
Inference:
Primary:
DiscoveredTapeDrive 		Discovered Tape Drive from which the existence of this File System was inferred
Primary Discovered Transaction InferredElement:
Inference:
Primary:
DiscoveredTransaction 		Discovered Transaction from which the existence of this File System was inferred
Primary Discovered Virtual Machine InferredElement:
Inference:
Primary:
DiscoveredVirtualMachine 		Discovered Virtual Machine from which the existence of this File System was inferred
Primary Host Info InferredElement:
Inference:
Primary:
HostInfo 		Host Info from which the existence of this File System was inferred
Primary MF Part InferredElement:
Inference:
Primary:
MFPart 		MF Part from which the existence of this File System was inferred
Primary Network Connection List InferredElement:
Inference:
Primary:
NetworkConnectionList 		Network Connection List from which the existence of this File System was inferred
Primary Software Component InferredElement:
Inference:
Primary:
SoftwareComponent 		Software Component from which the existence of this File System was inferred
Primary Software Container InferredElement:
Inference:
Primary:
SoftwareContainer 		Software Container from which the existence of this File System was inferred
Primary Software Instance InferredElement:
Inference:
Primary:
SoftwareInstance 		Software Instance from which the existence of this File System was inferred
Disk Drive Consumer:
StorageUse:
Provider:
DiskDrive 		Disk Drive providing storage
Storage Pool Consumer:
StorageUse:
Provider:
StoragePool 		Storage Pool providing storage
Storage Volume Consumer:
StorageUse:
Provider:
StorageVolume 		Storage Volume providing storage
Mounted From Consumer:
StorageUse:
Provider:
FileSystem 		Remote to Exported network file system
Mounted As Provider:
StorageUse:
Consumer:
FileSystem 		Export to Remote network file system
Storage Volume Consumers Provider:
StorageUse:
Consumer:
StorageVolume 		Storage Volume consumers for this File System
Storage System Consumers Provider:
StorageUse:
Consumer:
StorageSystem 		Storage System consumers for this File System

Expressions of the FileSystem node

The expressions of the FileSystem node are described in the following table: {anchor:exprs}

UI Name Expression Description
Size size_display : formatQuantity(size * 1024, "B1024") Size of the FileSystem
Used used_display : formatQuantity(used * 1024, "B1024") Amount of space used on the FileSystem
Free free_display : formatQuantity(free * 1024, "B1024") Amount of space free on the File System
Snapshot Size snapshot_size_display : formatQuantity(snapshot_size_display * 1024, "B1024") Snapshot Size of the FileSystem
Snapshot Used snapshot_used_display : formatQuantity(snapshot_used_display * 1024, "B1024") Amount of snapshot space used on the FileSystem
Snapshot Free snapshot_free_display : formatQuantity(snapshot_free_display * 1024, "B1024") Amount of snapshot space free on the File System

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*