Class BaseConfigurationType

Namespace

CENTREL.XIA.Configuration.Types

Assembly

CENTREL.XIA.Configuration.Types.dll

Represents the base item type.

public class BaseConfigurationType : GlobalSerializableClassicBase

Inheritance

object

BaseConfigurationType

Derived

ActiveDirectoryDomain

AzureTenant

BackupExecServer

Contact

Container

Customer

EntraDirectory

ExchangeOrganization

ExternalLink

HardwareItem

HyperVServer

IisServer

KnowledgeBaseArticle

Location

MicrosoftDhcpServer

MicrosoftDnsServer

MicrosoftFailoverCluster

MicrosoftNlbCluster

PasswordList

Resource

Room

SoftwarePackage

SqlInstance

SupportProvision

TerminalServer

VMwareSystem

WINSService

XenDesktopSite

Constructors

BaseConfigurationType()

Creates a new base configuration type.

public BaseConfigurationType()

Properties

ClientInformation

Gets or sets information obtained about the XIA Configuration Client that was used to scan this item.

public ClientInformation ClientInformation { get; set; }

Property Value

ClientInformation

ComplianceBenchmarks

Gets or sets the compliance benchmarks for this item.

public ComplianceBenchmarks ComplianceBenchmarks { get; set; }

Property Value

ComplianceBenchmarks

CustomAttributes

Gets or sets the custom attributes assigned to this item.

public CustomAttributes CustomAttributes { get; set; }

Property Value

CustomAttributes

Description

Gets or sets the simple single line description of the item.

public virtual OverrideString Description { get; set; }

Property Value

OverrideString

Details

Gets or sets additional user assigned details for this item in XHTML format.

public string Details { get; set; }

Property Value

string

Identifier

Gets or sets the unique identifier of the item.

public Guid Identifier { get; set; }

Property Value

Guid

Identifiers

Gets or sets the item identifiers for this item - for example the item's device name and serial number. This information is used to identify an existing item when importing data from the XIA Configuration Client into the XIA Configuration Server.

public ItemIdentifiers Identifiers { get; set; }

Property Value

ItemIdentifiers

IsManual

Gets whether the item has been manually created and not subsequently updated by the XIA Configuration Client.

public bool IsManual { get; }

Property Value

bool

IsScanned

Gets whether the item has been scanned by the XIA Configuration Client.

public bool IsScanned { get; }

Property Value

bool

ItemID

Gets or sets the unique ID of this item. This property is used only by XIA Configuration Server.

public int ItemID { get; set; }

Property Value

int

LastCacheCheck

Gets or sets the date and time that the cache was last checked for validity. This property is used by XIA Configuration Server only.

public DateTime LastCacheCheck { get; set; }

Property Value

DateTime

Name

Gets or sets the name of the item - for example "DEMO-SRV01".

public virtual string Name { get; set; }

Property Value

string

PrimaryOwnerContact

Gets or sets the contact details for the primary owner of this item -this could be the telephone number or email address.

public OverrideString PrimaryOwnerContact { get; set; }

Property Value

OverrideString

PrimaryOwnerName

Gets or sets the name of the primary owner of this item.

public OverrideString PrimaryOwnerName { get; set; }

Property Value

OverrideString

SupportsClientScan

Gets whether this item type supports the ability to be scanned by the XIA Configuration Client.

public bool SupportsClientScan { get; }

Property Value

bool

SupportsLocations

Gets whether this item type supports the ability to be assigned to physical locations.

public bool SupportsLocations { get; }

Property Value

bool

SupportsServiceNowSynchronization

Gets whether this item type supports the ability to be synchronized with a ServiceNow instance.

public bool SupportsServiceNowSynchronization { get; }

Property Value

bool

Remarks

NOTE: The Windows PC item type is currently manually coded as this shares a data model with Windows server items.

SupportsSupportProvisions

Gets whether this item type supports the ability to be assigned support provisions.

public bool SupportsSupportProvisions { get; }

Property Value

bool

Type

Gets or sets the type of item that this represents - for example "NetworkSwitch" or "WindowsServer".

public virtual ItemType Type { get; set; }

Property Value

ItemType

TypeDisplayName

Gets the display name of the item type - for example "Network Switch" or "Hyper-V Server".

public string TypeDisplayName { get; set; }

Property Value

string

UserName

Gets or sets the username of the user to have last modified this this item - for example "CORP\rsmith01". This setting is used by XIA Configuration Server only.

public string UserName { get; set; }

Property Value

string

Version

Returns version of this DLL file as a string.

public static string Version { get; }

Property Value

string

VersionDate

Gets or sets the date the current version of this item was created. This value is managed by XIA Configuration Server and is not used by the XIA Configuration Client.

public DateTime VersionDate { get; set; }

Property Value

DateTime

VersionDescription

Gets or sets the description assigned to the current version of this item. This setting is used by XIA Configuration Server only.

public string VersionDescription { get; set; }

Property Value

string

VersionID

Gets or sets the version number of the current version of this item. This value is always 1.00 for the Agent as XIA Configuration Server manages all version numbers.

public decimal VersionID { get; set; }

Property Value

decimal

VersionString

Gets the version as a human readable string.

public string VersionString { get; }

Property Value

string

Methods

Clone()

Returns a CENTREL.XIA.Configuration.Types.BaseConfigurationType cloned from this object.

public BaseConfigurationType Clone()

Returns

BaseConfigurationType

A CENTREL.XIA.Configuration.Types.BaseConfigurationType.

FromBinary(byte[])

Converts the specified binary data to an base item type.

public static BaseConfigurationType FromBinary(byte[] data)

Parameters

data byte[]

The binary representation of this item.

Returns

BaseConfigurationType

FromXml(string)

Returns the item represented by the specified XML.

public static BaseConfigurationType FromXml(string xml)

Parameters

xml string

The XML representing the item.

Returns

BaseConfigurationType

The item represented by the specified XML.

FromXml(string, bool)

Returns the item represented by the specified XML.

public static BaseConfigurationType FromXml(string xml, bool validateSignature)

Parameters

xml string

The XML representing the item.

validateSignature bool

Determines whether the RSA signature should validated.

Returns

BaseConfigurationType

The item represented by the specified XML.

GetItemType(ItemType)

Gets the System.Type for the specified base item type.

public static Type GetItemType(ItemType itemType)

Parameters

itemType ItemType

The ItemType of item for which the type should be returned.

Returns

Type

The System.Type for the specified base item type.

GetItemTypesByDisplayName()

Gets the possible item types sorted by display name.

public static ItemTypeCollection GetItemTypesByDisplayName()

Returns

ItemTypeCollection

The possible item types sorted by display name.

GetSupportsClientScan(ItemType)

Determines whether the specified item type supports the ability to be scanned by the XIA Configuration Client.

public static bool GetSupportsClientScan(ItemType itemType)

Parameters

itemType ItemType

The item type to evaluate.

Returns

bool

A System.Boolean value that indicates whether the specified item type supports the ability to be scanned by the XIA Configuration Client.

GetSupportsLocations(ItemType)

Determines whether the specified item type supports the ability to be assigned to physical locations.

public static bool GetSupportsLocations(ItemType itemType)

Parameters

itemType ItemType

The item type to evaluate.

Returns

bool

A System.Boolean value that indicates whether the specified item type supports the ability to be assigned to physical locations.

GetSupportsServiceNowSynchronization(ItemType)

Determines whether the specified item type supports the ability to be synchronized with a ServiceNow instance.

public static bool GetSupportsServiceNowSynchronization(ItemType itemType)

Parameters

itemType ItemType

The item type to evaluate.

Returns

bool

A System.Boolean value that indicates whether the specified item type supports the ability to be synchronized with a ServiceNow instance.

Remarks

NOTE: The Windows PC item type is currently manually coded as this shares a data model with Windows server items.

GetSupportsSupportProvisions(ItemType)

Determines whether the specified item type supports the ability to be assigned support provisions.

public static bool GetSupportsSupportProvisions(ItemType itemType)

Parameters

itemType ItemType

The item type to evaluate.

Returns

bool

A System.Boolean value that indicates whether the specified item type supports the ability to be assigned support provisions.

GetTypeDisplayName()

Gets the display name of the item type - for example "Network Switch" or "Hyper-V Server".

public override string GetTypeDisplayName()

Returns

string

The display name of the item type - for example "Network Switch" or "Hyper-V Server".

GetTypeDisplayName(ItemType)

Gets the display name of the item type - for example "Network Switch" or "Hyper-V Server".

public static string GetTypeDisplayName(ItemType itemType)

Parameters

itemType ItemType

The item type for which the display name should be returned.

Returns

string

The display name of the item type - for example "Network Switch" or "Hyper-V Server".

LoadBinary(string)

Returns the item represented by the specified binary file.

public static BaseConfigurationType LoadBinary(string path)

Parameters

path string

The path to the binary file to load.

Returns

BaseConfigurationType

The item represented by the specified binary file.

LoadXml(string)

Returns the item represented by the specified XML.

public static BaseConfigurationType LoadXml(string path)

Parameters

path string

The path to the XML file to load.

Returns

BaseConfigurationType

The item represented by the specified XML file.

LoadXml(string, bool)

Returns the item represented by the specified XML.

public static BaseConfigurationType LoadXml(string path, bool validateSignature)

Parameters

path string

The path to the XML file to load.

validateSignature bool

Determines whether the RSA signature should validated.

Returns

BaseConfigurationType

The item represented by the specified XML file.

ToBinary()

Converts the current item to a byte array.

public byte[] ToBinary()

Returns

byte[]

The current item in binary format.