Skip to main content

LXC1Connection class

This data object contains information about the current connection to XClarity One.

This object is read-only and can be instantiated only using the Connect-LXC1 cmdlet.

Namespace: Lenovo.XC1.PowerShell.Automation.DataTypes

Assembly: Lenovo.XC1.PowerShell.Automation.DataTypes

Properties

public string Id { get; }
Connection ID for the current connection as registered on the XClarity One portal
public bool IsConnected { get; }
Indicates whether a connection is established with the XClarity One portal. This can be one of the following values.
  • true. A connection is established with the XClarity One portal.

  • false. A connection is not established with the XClarity One portal.

public string PortalAddress { get }
IP address or hostname for XClarity One portal in the cloud, or the FQDN of the XClarity One portal hosted on premises
public int Port { get; }
Port on the XClarity One portal that is used for this connection
public int Timeout { get; }
Number of seconds that the cmdlet waits for an HTTPS response from the XClarity One portal
public string ClientID {get; internal set; }
Unique client ID that was generated for the REST API key used for authentication
public DateTime? LoginTime {get; internal set; }
Timestamp when the connection to XClarity One was established

Methods

public virtual bool Equals (object obj);
Determines whether the specified object is equal to the current object.

(Inherited from System.Object)

public virtual int GetHashCode ();
Serves as the default hash function

(Inherited from System.Object)

public Type GetType ();
Gets the System.Type of the current instance

(Inherited from System.Object)

public virtual string ToString ();
Returns a string that represents the current object.

(Inherited from System.Object)