Skip to main content

OpSystem

Operating systems for the C++ Replication API

Each piece of physical Hardware may contain one or more operating systems — for example, a single computer could have a virtual machine with Windows installed and another running Linux. Each OpSystem has one or more Volume(s).

Operating sytems for the C++ Replication API

ReplicationManagerC++APIoperating systemsOSwindowslinux

Class

FCREPLIp

IP address representation of the hardware.

Getters

Getters are not applicable.

Inherited getters

Table 1. Inherited getters

IP address identification

int GetID();

IP address

const char *GetAddress();

IP address type

const char *GetType();

OpSystem identification

Note

This is linked to the FCREPLOpSystem class.

int GetOSID();



Setters

Table 2. Setters

IP address

void SetAddress(const char *address) { ((pRCESIp)this)->SetAddress(address); };

IP address type

void SetType(const char *type) { ((pRCESIp)this)->SetType(type); };



Inherited setters

Table 3. Inherited setters

IP address identification

void SetID( int id );

Address

void SetAddress( const char *address );

Type

void SetType( const char *type );

OpSystem identification

Note

This is linked to the FCREPLOPSystem class.

void SetOSID( int osID );



Class

FCREPLOpSystem

This class is below Hardware in the hierarchy. It contains a list of Volumes. It represents the operating system running on a physical machine or a virtual machine.

Getters

Table 4. Getters

List of IP addresses for the OpSystem

void GetIPAddresses(ppFCREPLIp *ipList, int *ipCount) { ((pRCESOpSystem)this)->GetIPAddresses((ppRCESIp *)ipList, ipCount); };



Inherited getters

Table 5. Inherited getters

OpSystem identification

int GetID();

Hardware identification

Note

This is linked to the FCREPLHardware class

int GetHardwareID();

OpSystem name

const char *GetName();

OpSystem hostname

const char *GetHostName();

OpSystem IP list with count

void GetIPAddresses(ppRCESIp *ipList, int *ipCount);

OpSystem type

const char *GetType();

OpSystem edition

const char *GetEdition();

OpSystem description

const char *GetDescription();

OpSystem memory

int GetMemory();

OpSystem disk space

int GetDiskSpace();

OpSystem CPU count

int GetCPU();

OpSystem path is case sensitive

bool isPathCaseSensitive();

OpSystem platform

RCESPlatform GetPlatform();



Setters

Table 6. Setters

List of IP addresses for the OpSystem

void SetIPAddresses(ppFCREPLIp ipList, int ipCount) { ((pRCESOpSystem)this)->SetIPAddresses((ppRCESIp)ipList, ipCount); };

OpSystem name

void SetName(const char *name) { ((pRCESOpSystem)this)->SetName(name); };

OpSystem hostname

void SetHostName(const char *hostName) { ((pRCESOpSystem)this)->SetHostName(hostName); };

OpSystem type

void SetType(const char *type) { ((pRCESOpSystem)this)->SetType(type); };

OpSystem edition

void SetEdition(const char *edition) { ((pRCESOpSystem)this)->SetEdition(edition); };

OpSystem description

void SetDescription(const char *description) { ((pRCESOpSystem)this)->SetDescription(description); };



Inherited setters

Table 7. Inherited setters

OpSystem identification

void SetID(int id);

Hardware identification

Note

This is linked to the FCREPLHardware class.

void SetHardwareID(int hardwareId);

OpSystem name

void SetName(const char *name);

OpSystem hostname

void SetHostName(const char *hostName);

OpSystem IP list with count

void SetIPAddresses(ppRCESIp ipList, int ipCount);

OpSystem type

void SetType(const char *type);

OpSystem edition

void SetEdition(const char *edition);

OpSystem description

void SetDescription(const char *description);

OpSystem memory

void SetMemory(int memory);

OpSystem disk space

void SetDiskSpace(int diskSpace);

OpSystem CPU count

void SetCPU(int cpu);

OpSystem set path case sensitive

void SetPathCaseSensitive(bool pathCaseSensitive);

OpSystem platform

void SetPlatform(RCESPlatform platform);



Retrieve all the OpSystem entity objects for the given hardware identification.

Prototype

FCREPL_API int fcReplGetOSs(pFCREPLConn replConn, int hardwareID, ppFCREPLOpSystem *osList, int *osCount);

Parameters

Table 8. Parameters

Parameter

Description

replConn [IN]

Replication connection handle

hardwareID [IN]

Hardware identification

osList [OUT]

OS entity list

osCount [OUT]

Number of OS entities in the list



Return

Error code

Retrieve the OS entity object by its name.

Prototype

FCREPL_API int fcReplGetOS(pFCREPLConn replConn, int hardwareID, const char *name, ppFCREPLOpSystem opSystem);

Parameters

Table 9. Parameters

Parameter

Description

replConn [IN]

Replication connection handle

hardwareID [IN]

Hardware identification

name [IN]

Hardware name

opSystem [OUT]

OS entity retrieved



Return

Error code

Retrieve the OS entity object by its hostname.

Prototype

FCREPL_API int fcReplGetOS(pFCREPLConn replConn, const char *hostName, ppFCREPLOpSystem opSystem);

Parameters

Table 10. Parameters

Parameter

Description

replConn [IN]

Replication connection handle

hostName [IN]

Hostname

opSystem [OUT]

OS entity retrieved



Return

Error code

Retrieve the OS entity object by its IP address.

Prototype

FCREPL_API int fcReplGetOSByIP(pFCREPLConn replConn, const char *ipAddress, ppFCREPLOpSystem opSystem);

Parameters

Table 11. Parameters

Parameter

Description

replConn [IN]

Replication connection handle

ipAddress [IN]

IP address

opSystem [OUT]

OS entity retrieved



Return

Error code

Add an operating system entity into the database. If there already is an operating system with the given hardware ID/name, update the existing record.

Prototype

FCREPL_API int fcReplPersistOS(pFCREPLConn replConn, pFCREPLOpSystem opSystem);

Parameters

Table 12. Parameters

Parameter

Description

replConn [IN]

Replication connection handle

opSystem [IN]

OS entity to be persisted



Return

Error code

Delete the OS by its identification.

Prototype

FCREPL_API int fcReplRemoveOS(pFCREPLConn replConn, int osID, bool recursive);

Parameters

Table 13. Parameters

Parameter

Description

replConn [IN]

Replication connection handle

osID [IN]

OS identification

recursive [IN]

Recursive flag



Return

Error code