CommandReference.md

Functions

• Connect-OMEServer
• Copy-OMETemplate
• Disable-OMEAlertPolicy
• Disconnect-OMEServer
• Edit-OMEDiscovery
• Edit-OMEFabricUplink
• Edit-OMEGroup
• Edit-OMESecurityBanner
• Edit-OMESupportAssistGroup
• Enable-OMEAlertPolicy
• Get-OMEAlert
• Get-OMEAlertDefinition
• Get-OMEAlertPolicy
• Get-OMEApplianceInfo
• Get-OMEApplicationSettings
• Get-OMEAuditLog
• Get-OMECatalog
• Get-OMEConfigurationBaseline
• Get-OMEConfigurationCompliance
• Get-OMEDevice
• Get-OMEDeviceDetail
• Get-OMEDeviceNetworkDetail
• Get-OMEDirectoryService
• Get-OMEDirectoryServiceSearch
• Get-OMEDiscovery
• Get-OMEFabric
• Get-OMEFabricUplink
• Get-OMEFirmwareBaseline
• Get-OMEFirmwareCompliance
• Get-OMEGroup
• Get-OMEIdentityPool
• Get-OMEIdentityPoolUsage
• Get-OMEJob
• Get-OMEMXDomain
• Get-OMENetwork
• Get-OMEProfile
• Get-OMEReport
• Get-OMERole
• Get-OMESupportAssistCase
• Get-OMESupportAssistGroup
• Get-OMETemplate
• Get-OMETemplateNetwork
• Get-OMEUser
• Get-OMEWarranty
• Invoke-OMEApplianceBackup
• Invoke-OMEConfigurationBaselineRefresh
• Invoke-OMEDeviceReseat
• Invoke-OMEDirectoryServiceImportGroup
• Invoke-OMEFirmwareBaselineRefresh
• Invoke-OMEInventoryRefresh
• Invoke-OMEJobRun
• Invoke-OMEMcmGroupAddMember
• Invoke-OMEMcmGroupAssignBackupLead
• Invoke-OMEMcmGroupRetireLead
• Invoke-OMEOnboarding
• Invoke-OMEProfileAssign
• Invoke-OMEProfileRename
• Invoke-OMEProfileUnassign
• Invoke-OMEQuickDeploy
• Invoke-OMEReport
• Invoke-OMEResetApplication
• Invoke-OMETemplateDeploy
• New-OMEAlertPolicy
• New-OMECatalog
• New-OMEConfigurationBaseline
• New-OMEDirectoryService
• New-OMEDiscovery
• New-OMEFabric
• New-OMEFabricUplink
• New-OMEFirmwareBaseline
• New-OMEGroup
• New-OMEIdentityPool
• New-OMEMcmGroup
• New-OMENetwork
• New-OMEProfile
• New-OMESupportAssistGroup
• New-OMETemplateFromDevice
• New-OMETemplateFromFile
• New-OMEUser
• Remove-OMECatalog
• Remove-OMEDevice
• Remove-OMEDirectoryService
• Remove-OMEFabricUplink
• Remove-OMEFirmwareBaseline
• Remove-OMEGroup
• Remove-OMENetwork
• Remove-OMEProfile
• Remove-OMESupportAssistGroup
• Remove-OMETemplate
• Remove-OMEUser
• Set-OMEApplicationSettings
• Set-OMEChassisName
• Set-OMEChassisSlotName
• Set-OMEIOMPortBreakout
• Set-OMEPowerState
• Set-OMETemplateIdentityPool
• Set-OMETemplateNetwork
• Update-OMEConfiguration
• Update-OMEFirmware
• Update-OMEFirmwareDUP

Custom Types

Account

• Description (string Description {get;set;})
• DirectoryServiceId (int DirectoryServiceId {get;set;})
• Enabled (bool Enabled {get;set;})
• Id (int Id {get;set;})
• IsBuiltin (bool IsBuiltin {get;set;})
• IsVisible (bool IsVisible {get;set;})
• Locked (bool Locked {get;set;})
• Name (string Name {get;set;})
• RoleId (int RoleId {get;set;})
• UserName (string UserName {get;set;})
• UserTypeId (int UserTypeId {get;set;})

AccountProvider

• AttributeGroupMembership (string AttributeGroupMembership {get;set;})
• AttributeUserLogin (string AttributeUserLogin {get;set;})
• BaseDistinguishedName (string BaseDistinguishedName {get;set;})
• BindDN (string BindDN {get;set;})
• CertificateValidation (bool CertificateValidation {get;set;})
• DnsServer (string[] DnsServer {get;set;})
• GroupDomain (string GroupDomain {get;set;})
• Id (int Id {get;set;})
• Name (string Name {get;set;})
• NetworkTimeOut (int NetworkTimeOut {get;set;})
• SearchFilter (string SearchFilter {get;set;})
• SearchTimeOut (int SearchTimeOut {get;set;})
• ServerName (string[] ServerName {get;set;})
• ServerPort (int ServerPort {get;set;})
• ServerType (string ServerType {get;set;})

AlertPolicy

• DefaultPolicy (bool DefaultPolicy {get;set;})
• Description (string Description {get;set;})
• Enabled (bool Enabled {get;set;})
• Id (int Id {get;set;})
• Name (string Name {get;set;})
• Owner (string Owner {get;set;})
• PolicyData (psobject PolicyData {get;set;})
• State (bool State {get;set;})
• Visible (bool Visible {get;set;})

ApplianceInfo

• Branding (string Branding {get;set;})
• BuildDate (string BuildDate {get;set;})
• BuildNumber (string BuildNumber {get;set;})
• Description (string Description {get;set;})
• Guid (string Guid {get;set;})
• Name (string Name {get;set;})
• OperationStatus (string OperationStatus {get;set;})
• Vendor (string Vendor {get;set;})
• Version (version Version {get;set;})

Catalog

• BaseLocation (string BaseLocation {get;set;})
• Filename (string Filename {get;set;})
• Id (int Id {get;set;})
• LastUpdated (System.Nullable[datetime] LastUpdated {get;set;})
• ManifestVersion (string ManifestVersion {get;set;})
• NextUpdate (System.Nullable[datetime] NextUpdate {get;set;})
• ReleaseDate (System.Nullable[datetime] ReleaseDate {get;set;})
• Repository (Repository Repository {get;set;})
• Schedule (Schedule Schedule {get;set;})
• SourcePath (string SourcePath {get;set;})
• Status (string Status {get;set;})

ComponentCompliance

• ComplianceStatus (string ComplianceStatus {get;set;})
• ComponentType (string ComponentType {get;set;})
• Criticality (string Criticality {get;set;})
• CurrentVersion (string CurrentVersion {get;set;})
• DeviceId (int DeviceId {get;set;})
• DeviceModel (string DeviceModel {get;set;})
• DeviceName (string DeviceName {get;set;})
• Id (int Id {get;set;})
• ImpactAssessment (string ImpactAssessment {get;set;})
• Name (string Name {get;set;})
• Path (string Path {get;set;})
• PrerequisiteInfo (string PrerequisiteInfo {get;set;})
• RebootRequired (bool RebootRequired {get;set;})
• ServiceTag (string ServiceTag {get;set;})
• SourceName (string SourceName {get;set;})
• TargetIdentifier (string TargetIdentifier {get;set;})
• UniqueIdentifier (string UniqueIdentifier {get;set;})
• UpdateAction (string UpdateAction {get;set;})
• Uri (string Uri {get;set;})
• Version (string Version {get;set;})

ConfigurationBaseline

• BaselineTargets (psobject BaselineTargets {get;set;})
• Description (string Description {get;set;})
• Id (int Id {get;set;})
• LastRun (System.Nullable[datetime] LastRun {get;set;})
• Name (string Name {get;set;})
• Targets (int[] Targets {get;set;})
• TemplateId (int TemplateId {get;set;})
• TemplateName (string TemplateName {get;set;})
• TemplateType (int TemplateType {get;set;})

ConfigurationCompliance

• ComplianceStatus (string ComplianceStatus {get;set;})
• DeviceModel (string DeviceModel {get;set;})
• DeviceName (string DeviceName {get;set;})
• Id (int Id {get;set;})
• InventoryTime (string InventoryTime {get;set;})
• ServiceTag (string ServiceTag {get;set;})

Device

• AssetTag (string AssetTag {get;set;})
• ChassisServiceTag (string ChassisServiceTag {get;set;})
• ConnectionState (bool ConnectionState {get;set;})
• DeviceCapabilities (int[] DeviceCapabilities {get;set;})
• DeviceName (string DeviceName {get;set;})
• DeviceServiceTag (string DeviceServiceTag {get;set;})
• DnsName (string DnsName {get;set;})
• Id (int Id {get;set;})
• Identifier (string Identifier {get;set;})
• LastInventoryTime (System.Nullable[datetime] LastInventoryTime {get;set;})
• LastStatusTime (System.Nullable[datetime] LastStatusTime {get;set;})
• MacAddress (string MacAddress {get;set;})
• ManagedState (int ManagedState {get;set;})
• Model (string Model {get;set;})
• NetworkAddress (string NetworkAddress {get;set;})
• PowerState (int PowerState {get;set;})
• Status (int Status {get;set;})
• Type (int Type {get;set;})

DirectoryGroup

• CommonName (string CommonName {get;set;})
• DistinguishedName (string DistinguishedName {get;set;})
• DomainComponent (string[] DomainComponent {get;set;})
• GroupType (string GroupType {get;set;})
• ObjectGuid (string ObjectGuid {get;set;})
• ObjectSid (string ObjectSid {get;set;})

Discovery

• CommunityString (bool CommunityString {get;set;})
• ConnectionProfile (psobject ConnectionProfile {get;set;})
• CreateGroup (bool CreateGroup {get;set;})
• DeviceType (int[] DeviceType {get;set;})
• EmailRecipient (string EmailRecipient {get;set;})
• Hosts (DiscoveryTarget[] Hosts {get;set;})
• Id (int Id {get;set;})
• Name (string Name {get;set;})
• Schedule (Schedule Schedule {get;set;})
• TrapDestination (bool TrapDestination {get;set;})
• UseAllProfiles (bool UseAllProfiles {get;set;})

DiscoveryTarget

• AddressType (int AddressType {get;set;})
• Disabled (bool Disabled {get;set;})
• Exclude (bool Exclude {get;set;})
• NetworkAddressDetail (string NetworkAddressDetail {get;set;})
• SubnetMask (string SubnetMask {get;set;})

Domain

• BackupLead (bool BackupLead {get;set;})
• BackupLeadHealth (int BackupLeadHealth {get;set;})
• Capabilities (string[] Capabilities {get;set;})
• Description (string Description {get;set;})
• DeviceId (int DeviceId {get;set;})
• DomainRoleTypeId (int DomainRoleTypeId {get;set;})
• DomainRoleTypeValue (string DomainRoleTypeValue {get;set;})
• DomainTypeId (int DomainTypeId {get;set;})
• DomainTypeValue (string DomainTypeValue {get;set;})
• GroupId (string GroupId {get;set;})
• GroupName (string GroupName {get;set;})
• Id (int Id {get;set;})
• Identifier (string Identifier {get;set;})
• Local (bool Local {get;set;})
• Name (string Name {get;set;})
• PublicAddress (string[] PublicAddress {get;set;})
• Version (version Version {get;set;})

Fabric

• Description (string Description {get;set;})
• Id (string Id {get;set;})
• Name (string Name {get;set;})
• OverrideLLDPConfiguration (string OverrideLLDPConfiguration {get;set;})
• ScaleVLANProfile (string ScaleVLANProfile {get;set;})

FirmwareBaseline

• CatalogId (int CatalogId {get;set;})
• Description (string Description {get;set;})
• DowngradeEnabled (bool DowngradeEnabled {get;set;})
• Id (int Id {get;set;})
• LastRun (System.Nullable[datetime] LastRun {get;set;})
• Name (string Name {get;set;})
• RepositoryId (int RepositoryId {get;set;})
• RepositoryName (string RepositoryName {get;set;})
• RepositoryType (string RepositoryType {get;set;})
• Targets (int[] Targets {get;set;})
• TaskId (int TaskId {get;set;})
• TaskStatusId (int TaskStatusId {get;set;})

Group

• CreatedBy (string CreatedBy {get;set;})
• CreationTime (System.Nullable[datetime] CreationTime {get;set;})
• DefinitionDescription (string DefinitionDescription {get;set;})
• DefinitionId (int DefinitionId {get;set;})
• Description (string Description {get;set;})
• HasAttributes (bool HasAttributes {get;set;})
• Id (int Id {get;set;})
• MembershipTypeId (int MembershipTypeId {get;set;})
• Name (string Name {get;set;})
• ParentId (int ParentId {get;set;})
• TypeId (int TypeId {get;set;})
• UpdatedBy (string UpdatedBy {get;set;})
• UpdatedTime (System.Nullable[datetime] UpdatedTime {get;set;})
• Visible (bool Visible {get;set;})

IdentityPool

• CreatedBy (string CreatedBy {get;set;})
• CreationTime (System.Nullable[datetime] CreationTime {get;set;})
• Description (string Description {get;set;})
• EthernetSettings (psobject EthernetSettings {get;set;})
• FcoeSettings (psobject FcoeSettings {get;set;})
• FcSettings (psobject FcSettings {get;set;})
• Id (int Id {get;set;})
• IscsiSettings (psobject IscsiSettings {get;set;})
• LastUpdatedBy (string LastUpdatedBy {get;set;})
• LastUpdateTime (System.Nullable[datetime] LastUpdateTime {get;set;})
• Name (string Name {get;set;})

InventoryDetail

• DeviceId (string DeviceId {get;set;})
• DeviceName (string DeviceName {get;set;})
• DeviceServiceTag (string DeviceServiceTag {get;set;})
• InventoryInfo (psobject InventoryInfo {get;set;})
• InventoryType (string InventoryType {get;set;})

Job

• Builtin (bool Builtin {get;set;})
• CreatedBy (string CreatedBy {get;set;})
• Editable (bool Editable {get;set;})
• EndTime (System.Nullable[datetime] EndTime {get;set;})
• Id (int Id {get;set;})
• JobDescription (string JobDescription {get;set;})
• JobDetail (JobDetail[] JobDetail {get;set;})
• JobName (string JobName {get;set;})
• JobType (string JobType {get;set;})
• JobTypeId (int JobTypeId {get;set;})
• LastRun (System.Nullable[datetime] LastRun {get;set;})
• LastRunStatus (string LastRunStatus {get;set;})
• LastRunStatusId (int LastRunStatusId {get;set;})
• NextRun (System.Nullable[datetime] NextRun {get;set;})
• Schedule (string Schedule {get;set;})
• StartTime (System.Nullable[datetime] StartTime {get;set;})
• State (string State {get;set;})
• Targets (psobject[] Targets {get;set;})
• UpdatedBy (string UpdatedBy {get;set;})
• UserGenerated (bool UserGenerated {get;set;})
• Visible (bool Visible {get;set;})

JobDetail

• ElapsedTime (string ElapsedTime {get;set;})
• EndTime (System.Nullable[datetime] EndTime {get;set;})
• Id (int Id {get;set;})
• Key (string Key {get;set;})
• Output (string Output {get;set;})
• Progress (string Progress {get;set;})
• StartTime (System.Nullable[datetime] StartTime {get;set;})
• Status (string Status {get;set;})
• StatusId (string StatusId {get;set;})

Network

• Description (string Description {get;set;})
• Id (int Id {get;set;})
• Name (string Name {get;set;})
• Type (int Type {get;set;})
• VlanMaximum (int VlanMaximum {get;set;})
• VlanMinimum (int VlanMinimum {get;set;})

NetworkPartition

• CurrentMacAddress (string CurrentMacAddress {get;set;})
• DeviceId (string DeviceId {get;set;})
• DeviceName (string DeviceName {get;set;})
• DeviceServiceTag (string DeviceServiceTag {get;set;})
• FcoeMode (string FcoeMode {get;set;})
• Fqdd (string Fqdd {get;set;})
• IscsiMode (string IscsiMode {get;set;})
• LinkSpeed (int LinkSpeed {get;set;})
• LinkStatus (string LinkStatus {get;set;})
• ManagementIpAddress (string ManagementIpAddress {get;set;})
• ManagementMacAddress (string ManagementMacAddress {get;set;})
• MaxBandwidth (int MaxBandwidth {get;set;})
• MinBandwidth (int MinBandwidth {get;set;})
• Model (string Model {get;set;})
• NicId (string NicId {get;set;})
• NicMode (string NicMode {get;set;})
• PermanentFcoeMacAddress (string PermanentFcoeMacAddress {get;set;})
• PermanentMacAddress (string PermanentMacAddress {get;set;})
• PortId (string PortId {get;set;})
• VendorName (string VendorName {get;set;})
• VirtualFipMacAddress (string VirtualFipMacAddress {get;set;})
• VirtualIscsiMacAddress (string VirtualIscsiMacAddress {get;set;})
• VirtualMacAddress (string VirtualMacAddress {get;set;})

Profile

• ChassisId (int ChassisId {get;set;})
• ChassisName (string ChassisName {get;set;})
• CreatedBy (string CreatedBy {get;set;})
• CreatedDate (datetime CreatedDate {get;set;})
• DataSchemaId (int DataSchemaId {get;set;})
• DeploymentTaskId (int DeploymentTaskId {get;set;})
• DeviceIdInSlot (int DeviceIdInSlot {get;set;})
• EditedBy (string EditedBy {get;set;})
• GroupId (int GroupId {get;set;})
• GroupName (string GroupName {get;set;})
• Id (int Id {get;set;})
• LastDeployDate (System.Nullable[datetime] LastDeployDate {get;set;})
• LastEditDate (datetime LastEditDate {get;set;})
• LastRunStatus (int LastRunStatus {get;set;})
• NetworkBootToIso (psobject NetworkBootToIso {get;set;})
• ProfileDescription (string ProfileDescription {get;set;})
• ProfileModified (int ProfileModified {get;set;})
• ProfileName (string ProfileName {get;set;})
• ProfileState (int ProfileState {get;set;})
• TargetId (int TargetId {get;set;})
• TargetName (string TargetName {get;set;})
• TargetTypeId (int TargetTypeId {get;set;})
• TemplateId (int TemplateId {get;set;})
• TemplateName (string TemplateName {get;set;})

Repository

• CheckCertificate (bool CheckCertificate {get;set;})
• Description (string Description {get;set;})
• DomainName (string DomainName {get;set;})
• Id (int Id {get;set;})
• Name (string Name {get;set;})
• Password (string Password {get;set;})
• RepositoryType (string RepositoryType {get;set;})
• Source (string Source {get;set;})
• Username (string Username {get;set;})

Role

• AssignedPrivileges (string[] AssignedPrivileges {get;set;})
• Description (string Description {get;set;})
• Id (string Id {get;set;})
• IsPredefined (bool IsPredefined {get;set;})
• IsScopeSupported (bool IsScopeSupported {get;set;})
• Name (string Name {get;set;})
• OemPrivileges (string[] OemPrivileges {get;set;})

Schedule

• Cron (string Cron {get;set;})
• EndTime (System.Nullable[datetime] EndTime {get;set;})
• RunLater (bool RunLater {get;set;})
• RunNow (bool RunNow {get;set;})
• StartTime (System.Nullable[datetime] StartTime {get;set;})

SessionAuth

• Host (string Host {get;set;})
• Id (string Id {get;set;})
• IgnoreCertificateWarning (bool IgnoreCertificateWarning {get;set;})
• Token (string Token {get;set;})
• Version (version Version {get;set;})

SupportAssistGroup

• ContactOptIn (bool ContactOptIn {get;set;})
• CustomerDetails (psobject CustomerDetails {get;set;})
• Description (string Description {get;set;})
• DispatchOptIn (bool DispatchOptIn {get;set;})
• Id (int Id {get;set;})
• MyAccountId (string MyAccountId {get;set;})
• Name (string Name {get;set;})

Template

• Content (string Content {get;set;})
• CreatedBy (string CreatedBy {get;set;})
• CreationTime (string CreationTime {get;set;})
• Description (string Description {get;set;})
• HasIdentityAttributes (bool HasIdentityAttributes {get;set;})
• Id (int Id {get;set;})
• IdentityPoolId (int IdentityPoolId {get;set;})
• IsBuiltIn (bool IsBuiltIn {get;set;})
• IsPersistencePolicyValid (bool IsPersistencePolicyValid {get;set;})
• IsStatelessAvailable (bool IsStatelessAvailable {get;set;})
• LastUpdatedBy (string LastUpdatedBy {get;set;})
• LastUpdatedTime (System.Nullable[datetime] LastUpdatedTime {get;set;})
• Name (string Name {get;set;})
• SourceDeviceId (int SourceDeviceId {get;set;})
• Status (int Status {get;set;})
• TaskId (int TaskId {get;set;})
• TypeId (int TypeId {get;set;})
• Views (string Views {get;set;})
• ViewTypeId (int ViewTypeId {get;set;})

TemplateAttribute

• AttributeEditInfoId (int AttributeEditInfoId {get;set;})
• AttributeId (int AttributeId {get;set;})
• CustomId (int CustomId {get;set;})
• Description (string Description {get;set;})
• DisplayName (string DisplayName {get;set;})
• IsIgnored (bool IsIgnored {get;set;})
• IsLinkedToSecure (bool IsLinkedToSecure {get;set;})
• IsReadOnly (bool IsReadOnly {get;set;})
• IsSecure (bool IsSecure {get;set;})
• TargetSpecificTypeId (int TargetSpecificTypeId {get;set;})
• Value (string Value {get;set;})

TemplateNetwork

• CustomId (int CustomId {get;set;})
• NICIdentifier (string NICIdentifier {get;set;})
• Port (int Port {get;set;})
• VlanTagged (int[] VlanTagged {get;set;})
• VlanUnTagged (int VlanUnTagged {get;set;})

Uplink

• Description (string Description {get;set;})
• Id (string Id {get;set;})
• MediaType (string MediaType {get;set;})
• Name (string Name {get;set;})
• NativeVLAN (int NativeVLAN {get;set;})
• NetworkCount (int NetworkCount {get;set;})
• Networks (int[] Networks {get;set;})
• PortCount (int PortCount {get;set;})
• Ports (string[] Ports {get;set;})
• UfdEnable (string UfdEnable {get;set;})