Class ProbeAPI

Probe module

Hierarchy

AutomateBaseAPI
- ProbeAPI

Index

Methods

deleteAgentPushCredentials deleteProbeConfiguration enableProbe getAgentPushCredentialsList getProbeConfiguration getProbeEventLevelList getProbeEventList getProbeSnmpConfigurationAsync getScanFrequencyList getSnmpEncryptionMethodList getSnmpHashMethodList getStatusScanNetworkPortOptionList patchProbeConfiguration patchProbeSnmpConfigurationAsync postProbeConfiguration putAgentPushCredentialsList request upgradeProbe

Methods

deleteAgentPushCredentials

deleteAgentPushCredentials(probeConfigurationId: number): Promise<undefined>
Parameters
- probeConfigurationId: number
Returns Promise<undefined>
- Defined in src/Automate/ProbeAPI.ts:167

deleteProbeConfiguration

deleteProbeConfiguration(locationId: number): Promise<undefined>
Parameters
- locationId: number
Returns Promise<undefined>
- Defined in src/Automate/ProbeAPI.ts:69

enableProbe

enableProbe(
    computerId: number,
): Promise<
    {
        AgentDeploymentAttemptMaximum?: number;
        AutomatedDeploymentEnabled?: boolean;
        DiscoverySettings?: {
            ConcurrentThreadCount?: number;
            DiscoveryScanFrequency?: {
                DisplayName?: string;
                FrequencyCategory?: { CategoryId?: number; Description?: string };
                FrequencyInMinutes?: number;
                ScanFrequencyId?: number;
            };
            DiscoveryWindowEnd?: string;
            DiscoveryWindowStart?: string;
            IsMacAddresScanningEnabled?: boolean;
            LimitDiscoveryToScanWindow?: boolean;
        };
        IsDataCollectionEnabled?: boolean;
        LocationId?: number;
        ProbeConfigurationId?: number;
        SnmpSettings?: { CommunityStringsGet?: string; TimeoutInSeconds?: number };
        SnmpTrapServerListeningPort?: number;
        StatusSettings?: {
            NetworkPortOption?: {
                Description?: string;
                StatusScanNetworkPortOptionId?: number;
            };
            StatusScanFrequency?: {
                DisplayName?: string;
                FrequencyCategory?: { CategoryId?: number; Description?: string };
                FrequencyInMinutes?: number;
                ScanFrequencyId?: number;
            };
            StatusScanNetworkPortList?: string;
        };
        SyslogSettings?: {
            SyslogServerIpFilter?: string;
            SyslogServerListeningPort?: number;
        };
        TftpSettings?: {
            AllowTftpUploads?: boolean;
            TftpServerIpFilter?: string;
            TftpServerListeningPort?: number;
        };
    },
>
Parameters
- computerId: number
Returns Promise<
    {
        AgentDeploymentAttemptMaximum?: number;
        AutomatedDeploymentEnabled?: boolean;
        DiscoverySettings?: {
            ConcurrentThreadCount?: number;
            DiscoveryScanFrequency?: {
                DisplayName?: string;
                FrequencyCategory?: { CategoryId?: number; Description?: string };
                FrequencyInMinutes?: number;
                ScanFrequencyId?: number;
            };
            DiscoveryWindowEnd?: string;
            DiscoveryWindowStart?: string;
            IsMacAddresScanningEnabled?: boolean;
            LimitDiscoveryToScanWindow?: boolean;
        };
        IsDataCollectionEnabled?: boolean;
        LocationId?: number;
        ProbeConfigurationId?: number;
        SnmpSettings?: { CommunityStringsGet?: string; TimeoutInSeconds?: number };
        SnmpTrapServerListeningPort?: number;
        StatusSettings?: {
            NetworkPortOption?: {
                Description?: string;
                StatusScanNetworkPortOptionId?: number;
            };
            StatusScanFrequency?: {
                DisplayName?: string;
                FrequencyCategory?: { CategoryId?: number; Description?: string };
                FrequencyInMinutes?: number;
                ScanFrequencyId?: number;
            };
            StatusScanNetworkPortList?: string;
        };
        SyslogSettings?: {
            SyslogServerIpFilter?: string;
            SyslogServerListeningPort?: number;
        };
        TftpSettings?: {
            AllowTftpUploads?: boolean;
            TftpServerIpFilter?: string;
            TftpServerListeningPort?: number;
        };
    },
>
- Defined in src/Automate/ProbeAPI.ts:196

getAgentPushCredentialsList

getAgentPushCredentialsList(
    probeConfigurationId: number,
    params?: Automate.CommonParameters,
): Promise<
    {
        AttemptSequence?: number;
        CredentialDetails?: {
            ClientId?: number;
            CredentialsId?: number;
            ExpirationDate?: string;
            IsActive?: boolean;
            Title?: string;
        };
        CredentialId?: number;
        CredentialsAlias?: string;
        ProbeConfigurationCredentialsId?: number;
        ProbeConfigurationId?: number;
    }[],
>
Parameters
- probeConfigurationId: number
- params: Automate.CommonParameters = {}
Returns Promise<
    {
        AttemptSequence?: number;
        CredentialDetails?: {
            ClientId?: number;
            CredentialsId?: number;
            ExpirationDate?: string;
            IsActive?: boolean;
            Title?: string;
        };
        CredentialId?: number;
        CredentialsAlias?: string;
        ProbeConfigurationCredentialsId?: number;
        ProbeConfigurationId?: number;
    }[],
>
- Defined in src/Automate/ProbeAPI.ts:145

getProbeConfiguration

getProbeConfiguration(
    locationId: number,
    params?: Automate.CommonParameters,
): Promise<
    {
        AgentDeploymentAttemptMaximum?: number;
        AutomatedDeploymentEnabled?: boolean;
        DiscoverySettings?: {
            ConcurrentThreadCount?: number;
            DiscoveryScanFrequency?: {
                DisplayName?: string;
                FrequencyCategory?: { CategoryId?: number; Description?: string };
                FrequencyInMinutes?: number;
                ScanFrequencyId?: number;
            };
            DiscoveryWindowEnd?: string;
            DiscoveryWindowStart?: string;
            IsMacAddresScanningEnabled?: boolean;
            LimitDiscoveryToScanWindow?: boolean;
        };
        IsDataCollectionEnabled?: boolean;
        LocationId?: number;
        ProbeConfigurationId?: number;
        SnmpSettings?: { CommunityStringsGet?: string; TimeoutInSeconds?: number };
        SnmpTrapServerListeningPort?: number;
        StatusSettings?: {
            NetworkPortOption?: {
                Description?: string;
                StatusScanNetworkPortOptionId?: number;
            };
            StatusScanFrequency?: {
                DisplayName?: string;
                FrequencyCategory?: { CategoryId?: number; Description?: string };
                FrequencyInMinutes?: number;
                ScanFrequencyId?: number;
            };
            StatusScanNetworkPortList?: string;
        };
        SyslogSettings?: {
            SyslogServerIpFilter?: string;
            SyslogServerListeningPort?: number;
        };
        TftpSettings?: {
            AllowTftpUploads?: boolean;
            TftpServerIpFilter?: string;
            TftpServerListeningPort?: number;
        };
    },
>
Parameters
- locationId: number
- params: Automate.CommonParameters = {}
Returns Promise<
    {
        AgentDeploymentAttemptMaximum?: number;
        AutomatedDeploymentEnabled?: boolean;
        DiscoverySettings?: {
            ConcurrentThreadCount?: number;
            DiscoveryScanFrequency?: {
                DisplayName?: string;
                FrequencyCategory?: { CategoryId?: number; Description?: string };
                FrequencyInMinutes?: number;
                ScanFrequencyId?: number;
            };
            DiscoveryWindowEnd?: string;
            DiscoveryWindowStart?: string;
            IsMacAddresScanningEnabled?: boolean;
            LimitDiscoveryToScanWindow?: boolean;
        };
        IsDataCollectionEnabled?: boolean;
        LocationId?: number;
        ProbeConfigurationId?: number;
        SnmpSettings?: { CommunityStringsGet?: string; TimeoutInSeconds?: number };
        SnmpTrapServerListeningPort?: number;
        StatusSettings?: {
            NetworkPortOption?: {
                Description?: string;
                StatusScanNetworkPortOptionId?: number;
            };
            StatusScanFrequency?: {
                DisplayName?: string;
                FrequencyCategory?: { CategoryId?: number; Description?: string };
                FrequencyInMinutes?: number;
                ScanFrequencyId?: number;
            };
            StatusScanNetworkPortList?: string;
        };
        SyslogSettings?: {
            SyslogServerIpFilter?: string;
            SyslogServerListeningPort?: number;
        };
        TftpSettings?: {
            AllowTftpUploads?: boolean;
            TftpServerIpFilter?: string;
            TftpServerListeningPort?: number;
        };
    },
>
- Defined in src/Automate/ProbeAPI.ts:47

getProbeEventLevelList

getProbeEventLevelList(
params?: Automate.CommonParameters,
): Promise<{ Id?: number; Name?: string }[]>
Parameters
- params: Automate.CommonParameters = {}
Returns Promise<{ Id?: number; Name?: string }[]>
- Defined in src/Automate/ProbeAPI.ts:95

getProbeEventList

getProbeEventList(
    params?: Automate.CommonParameters,
): Promise<
    {
        EventLevel?: { Id?: number; Name?: string };
        EventTime?: string;
        Message?: string;
        ProbeId?: number;
    }[],
>
Parameters
- params: Automate.CommonParameters = {}
Returns Promise<
    {
        EventLevel?: { Id?: number; Name?: string };
        EventTime?: string;
        Message?: string;
        ProbeId?: number;
    }[],
>
- Defined in src/Automate/ProbeAPI.ts:205

getProbeSnmpConfigurationAsync

getProbeSnmpConfigurationAsync(
    probeConfigurationId: number,
    params?: Automate.CommonParameters,
): Promise<
    {
        CommunityStringGetList?: string;
        ProbeConfigurationId?: number;
        ProbeSnmpConfigurationId?: number;
        SnmpTimeoutInSeconds?: number;
        SnmpV3Settings?: {
            Authentication?: {
                AuthenticationSecret?: string;
                HashMethod?: { Id?: number; Name?: string };
                ProbeSnmpConfigurationId?: number;
                SnmpAuthenticationId?: number;
            };
            Encryption?: {
                EncryptionMethod?: { Id?: number; Name?: string };
                EncryptionPassword?: string;
                ProbeSnmpConfigurationId?: number;
                SnmpEncryptionId?: number;
            };
            ProbeSnmpConfigurationId?: number;
            SnmpV3Username?: string;
        };
    },
>
Parameters
- probeConfigurationId: number
- params: Automate.CommonParameters = {}
Returns Promise<
    {
        CommunityStringGetList?: string;
        ProbeConfigurationId?: number;
        ProbeSnmpConfigurationId?: number;
        SnmpTimeoutInSeconds?: number;
        SnmpV3Settings?: {
            Authentication?: {
                AuthenticationSecret?: string;
                HashMethod?: { Id?: number; Name?: string };
                ProbeSnmpConfigurationId?: number;
                SnmpAuthenticationId?: number;
            };
            Encryption?: {
                EncryptionMethod?: { Id?: number; Name?: string };
                EncryptionPassword?: string;
                ProbeSnmpConfigurationId?: number;
                SnmpEncryptionId?: number;
            };
            ProbeSnmpConfigurationId?: number;
            SnmpV3Username?: string;
        };
    },
>
- Defined in src/Automate/ProbeAPI.ts:174

getScanFrequencyList

getScanFrequencyList(
    params?: Automate.CommonParameters,
): Promise<
    {
        DisplayName?: string;
        FrequencyCategory?: { CategoryId?: number; Description?: string };
        FrequencyInMinutes?: number;
        ScanFrequencyId?: number;
    }[],
>
Parameters
- params: Automate.CommonParameters = {}
Returns Promise<
    {
        DisplayName?: string;
        FrequencyCategory?: { CategoryId?: number; Description?: string };
        FrequencyInMinutes?: number;
        ScanFrequencyId?: number;
    }[],
>
- Defined in src/Automate/ProbeAPI.ts:105

getSnmpEncryptionMethodList

getSnmpEncryptionMethodList(
params?: Automate.CommonParameters,
): Promise<{ Id?: number; Name?: string }[]>
Parameters
- params: Automate.CommonParameters = {}
Returns Promise<{ Id?: number; Name?: string }[]>
- Defined in src/Automate/ProbeAPI.ts:115

getSnmpHashMethodList

getSnmpHashMethodList(
params?: Automate.CommonParameters,
): Promise<{ Id?: number; Name?: string }[]>
Parameters
- params: Automate.CommonParameters = {}
Returns Promise<{ Id?: number; Name?: string }[]>
- Defined in src/Automate/ProbeAPI.ts:125

getStatusScanNetworkPortOptionList

getStatusScanNetworkPortOptionList(
params?: Automate.CommonParameters,
): Promise<
{ Description?: string; StatusScanNetworkPortOptionId?: number }[],
>
Parameters
- params: Automate.CommonParameters = {}
Returns Promise<{ Description?: string; StatusScanNetworkPortOptionId?: number }[]>
- Defined in src/Automate/ProbeAPI.ts:135

patchProbeConfiguration

patchProbeConfiguration(
    locationId: number,
    PatchOperationArray: {
        content: {
            "application/json": {
                Op?: string;
                Path?: string;
                Value?: Record<string, never>;
            }[];
            "application/x-www-form-urlencoded": {
                Op?: string;
                Path?: string;
                Value?: Record<string, never>;
            }[];
            "application/xml": {
                Op?: string;
                Path?: string;
                Value?: Record<string, never>;
            }[];
            "text/json": {
                Op?: string;
                Path?: string;
                Value?: Record<string, never>;
            }[];
            "text/xml": { Op?: string; Path?: string; Value?: Record<string, never> }[];
        };
    },
): Promise<
    {
        AgentDeploymentAttemptMaximum?: number;
        AutomatedDeploymentEnabled?: boolean;
        DiscoverySettings?: {
            ConcurrentThreadCount?: number;
            DiscoveryScanFrequency?: {
                DisplayName?: string;
                FrequencyCategory?: { CategoryId?: number; Description?: string };
                FrequencyInMinutes?: number;
                ScanFrequencyId?: number;
            };
            DiscoveryWindowEnd?: string;
            DiscoveryWindowStart?: string;
            IsMacAddresScanningEnabled?: boolean;
            LimitDiscoveryToScanWindow?: boolean;
        };
        IsDataCollectionEnabled?: boolean;
        LocationId?: number;
        ProbeConfigurationId?: number;
        SnmpSettings?: { CommunityStringsGet?: string; TimeoutInSeconds?: number };
        SnmpTrapServerListeningPort?: number;
        StatusSettings?: {
            NetworkPortOption?: {
                Description?: string;
                StatusScanNetworkPortOptionId?: number;
            };
            StatusScanFrequency?: {
                DisplayName?: string;
                FrequencyCategory?: { CategoryId?: number; Description?: string };
                FrequencyInMinutes?: number;
                ScanFrequencyId?: number;
            };
            StatusScanNetworkPortList?: string;
        };
        SyslogSettings?: {
            SyslogServerIpFilter?: string;
            SyslogServerListeningPort?: number;
        };
        TftpSettings?: {
            AllowTftpUploads?: boolean;
            TftpServerIpFilter?: string;
            TftpServerListeningPort?: number;
        };
    },
>
Parameters
- locationId: number
- PatchOperationArray: {
      content: {
          "application/json": {
              Op?: string;
              Path?: string;
              Value?: Record<string, never>;
          }[];
          "application/x-www-form-urlencoded": {
              Op?: string;
              Path?: string;
              Value?: Record<string, never>;
          }[];
          "application/xml": {
              Op?: string;
              Path?: string;
              Value?: Record<string, never>;
          }[];
          "text/json": { Op?: string; Path?: string; Value?: Record<string, never> }[];
          "text/xml": { Op?: string; Path?: string; Value?: Record<string, never> }[];
      };
  }
Returns Promise<
    {
        AgentDeploymentAttemptMaximum?: number;
        AutomatedDeploymentEnabled?: boolean;
        DiscoverySettings?: {
            ConcurrentThreadCount?: number;
            DiscoveryScanFrequency?: {
                DisplayName?: string;
                FrequencyCategory?: { CategoryId?: number; Description?: string };
                FrequencyInMinutes?: number;
                ScanFrequencyId?: number;
            };
            DiscoveryWindowEnd?: string;
            DiscoveryWindowStart?: string;
            IsMacAddresScanningEnabled?: boolean;
            LimitDiscoveryToScanWindow?: boolean;
        };
        IsDataCollectionEnabled?: boolean;
        LocationId?: number;
        ProbeConfigurationId?: number;
        SnmpSettings?: { CommunityStringsGet?: string; TimeoutInSeconds?: number };
        SnmpTrapServerListeningPort?: number;
        StatusSettings?: {
            NetworkPortOption?: {
                Description?: string;
                StatusScanNetworkPortOptionId?: number;
            };
            StatusScanFrequency?: {
                DisplayName?: string;
                FrequencyCategory?: { CategoryId?: number; Description?: string };
                FrequencyInMinutes?: number;
                ScanFrequencyId?: number;
            };
            StatusScanNetworkPortList?: string;
        };
        SyslogSettings?: {
            SyslogServerIpFilter?: string;
            SyslogServerListeningPort?: number;
        };
        TftpSettings?: {
            AllowTftpUploads?: boolean;
            TftpServerIpFilter?: string;
            TftpServerListeningPort?: number;
        };
    },
>
- Defined in src/Automate/ProbeAPI.ts:76

patchProbeSnmpConfigurationAsync

patchProbeSnmpConfigurationAsync(
    probeConfigurationId: number,
    PatchOperationArray: {
        content: {
            "application/json": {
                Op?: string;
                Path?: string;
                Value?: Record<string, never>;
            }[];
            "application/x-www-form-urlencoded": {
                Op?: string;
                Path?: string;
                Value?: Record<string, never>;
            }[];
            "application/xml": {
                Op?: string;
                Path?: string;
                Value?: Record<string, never>;
            }[];
            "text/json": {
                Op?: string;
                Path?: string;
                Value?: Record<string, never>;
            }[];
            "text/xml": { Op?: string; Path?: string; Value?: Record<string, never> }[];
        };
    },
): Promise<
    {
        CommunityStringGetList?: string;
        ProbeConfigurationId?: number;
        ProbeSnmpConfigurationId?: number;
        SnmpTimeoutInSeconds?: number;
        SnmpV3Settings?: {
            Authentication?: {
                AuthenticationSecret?: string;
                HashMethod?: { Id?: number; Name?: string };
                ProbeSnmpConfigurationId?: number;
                SnmpAuthenticationId?: number;
            };
            Encryption?: {
                EncryptionMethod?: { Id?: number; Name?: string };
                EncryptionPassword?: string;
                ProbeSnmpConfigurationId?: number;
                SnmpEncryptionId?: number;
            };
            ProbeSnmpConfigurationId?: number;
            SnmpV3Username?: string;
        };
    },
>
Parameters
- probeConfigurationId: number
- PatchOperationArray: {
      content: {
          "application/json": {
              Op?: string;
              Path?: string;
              Value?: Record<string, never>;
          }[];
          "application/x-www-form-urlencoded": {
              Op?: string;
              Path?: string;
              Value?: Record<string, never>;
          }[];
          "application/xml": {
              Op?: string;
              Path?: string;
              Value?: Record<string, never>;
          }[];
          "text/json": { Op?: string; Path?: string; Value?: Record<string, never> }[];
          "text/xml": { Op?: string; Path?: string; Value?: Record<string, never> }[];
      };
  }
Returns Promise<
    {
        CommunityStringGetList?: string;
        ProbeConfigurationId?: number;
        ProbeSnmpConfigurationId?: number;
        SnmpTimeoutInSeconds?: number;
        SnmpV3Settings?: {
            Authentication?: {
                AuthenticationSecret?: string;
                HashMethod?: { Id?: number; Name?: string };
                ProbeSnmpConfigurationId?: number;
                SnmpAuthenticationId?: number;
            };
            Encryption?: {
                EncryptionMethod?: { Id?: number; Name?: string };
                EncryptionPassword?: string;
                ProbeSnmpConfigurationId?: number;
                SnmpEncryptionId?: number;
            };
            ProbeSnmpConfigurationId?: number;
            SnmpV3Username?: string;
        };
    },
>
- Defined in src/Automate/ProbeAPI.ts:185

postProbeConfiguration

postProbeConfiguration(
    locationId: number,
    NewProbeConfiguration: {
        CredentialsList?: {
            AttemptSequence?: number;
            CredentialDetails?: {
                ClientId?: number;
                CredentialsId?: number;
                ExpirationDate?: string;
                IsActive?: boolean;
                Title?: string;
            };
            CredentialId?: number;
            CredentialsAlias?: string;
            ProbeConfigurationCredentialsId?: number;
            ProbeConfigurationId?: number;
        }[];
        IsAgentPushEnabled?: boolean;
        IsAutomatedDeploymentEnabled?: boolean;
        IsDataCollectionEnabled?: boolean;
        IsSnmpTrapServerEnabled?: boolean;
        IsSyslogServerEnabled?: boolean;
        IsTftpServerEnabled?: boolean;
    },
): Promise<
    {
        AgentDeploymentAttemptMaximum?: number;
        AutomatedDeploymentEnabled?: boolean;
        DiscoverySettings?: {
            ConcurrentThreadCount?: number;
            DiscoveryScanFrequency?: {
                DisplayName?: string;
                FrequencyCategory?: { CategoryId?: number; Description?: string };
                FrequencyInMinutes?: number;
                ScanFrequencyId?: number;
            };
            DiscoveryWindowEnd?: string;
            DiscoveryWindowStart?: string;
            IsMacAddresScanningEnabled?: boolean;
            LimitDiscoveryToScanWindow?: boolean;
        };
        IsDataCollectionEnabled?: boolean;
        LocationId?: number;
        ProbeConfigurationId?: number;
        SnmpSettings?: { CommunityStringsGet?: string; TimeoutInSeconds?: number };
        SnmpTrapServerListeningPort?: number;
        StatusSettings?: {
            NetworkPortOption?: {
                Description?: string;
                StatusScanNetworkPortOptionId?: number;
            };
            StatusScanFrequency?: {
                DisplayName?: string;
                FrequencyCategory?: { CategoryId?: number; Description?: string };
                FrequencyInMinutes?: number;
                ScanFrequencyId?: number;
            };
            StatusScanNetworkPortList?: string;
        };
        SyslogSettings?: {
            SyslogServerIpFilter?: string;
            SyslogServerListeningPort?: number;
        };
        TftpSettings?: {
            AllowTftpUploads?: boolean;
            TftpServerIpFilter?: string;
            TftpServerListeningPort?: number;
        };
    },
>
Parameters
- locationId: number
- NewProbeConfiguration: {
      CredentialsList?: {
          AttemptSequence?: number;
          CredentialDetails?: {
              ClientId?: number;
              CredentialsId?: number;
              ExpirationDate?: string;
              IsActive?: boolean;
              Title?: string;
          };
          CredentialId?: number;
          CredentialsAlias?: string;
          ProbeConfigurationCredentialsId?: number;
          ProbeConfigurationId?: number;
      }[];
      IsAgentPushEnabled?: boolean;
      IsAutomatedDeploymentEnabled?: boolean;
      IsDataCollectionEnabled?: boolean;
      IsSnmpTrapServerEnabled?: boolean;
      IsSyslogServerEnabled?: boolean;
      IsTftpServerEnabled?: boolean;
  }
Returns Promise<
    {
        AgentDeploymentAttemptMaximum?: number;
        AutomatedDeploymentEnabled?: boolean;
        DiscoverySettings?: {
            ConcurrentThreadCount?: number;
            DiscoveryScanFrequency?: {
                DisplayName?: string;
                FrequencyCategory?: { CategoryId?: number; Description?: string };
                FrequencyInMinutes?: number;
                ScanFrequencyId?: number;
            };
            DiscoveryWindowEnd?: string;
            DiscoveryWindowStart?: string;
            IsMacAddresScanningEnabled?: boolean;
            LimitDiscoveryToScanWindow?: boolean;
        };
        IsDataCollectionEnabled?: boolean;
        LocationId?: number;
        ProbeConfigurationId?: number;
        SnmpSettings?: { CommunityStringsGet?: string; TimeoutInSeconds?: number };
        SnmpTrapServerListeningPort?: number;
        StatusSettings?: {
            NetworkPortOption?: {
                Description?: string;
                StatusScanNetworkPortOptionId?: number;
            };
            StatusScanFrequency?: {
                DisplayName?: string;
                FrequencyCategory?: { CategoryId?: number; Description?: string };
                FrequencyInMinutes?: number;
                ScanFrequencyId?: number;
            };
            StatusScanNetworkPortList?: string;
        };
        SyslogSettings?: {
            SyslogServerIpFilter?: string;
            SyslogServerListeningPort?: number;
        };
        TftpSettings?: {
            AllowTftpUploads?: boolean;
            TftpServerIpFilter?: string;
            TftpServerListeningPort?: number;
        };
    },
>
- Defined in src/Automate/ProbeAPI.ts:58

putAgentPushCredentialsList

putAgentPushCredentialsList(
    probeConfigurationId: number,
    labTechRepositoriesMySQLDomainModelsNetworkProbeProbeConfigurationCredentialss: {
        AttemptSequence?: number;
        CredentialDetails?: {
            ClientId?: number;
            CredentialsId?: number;
            ExpirationDate?: string;
            IsActive?: boolean;
            Title?: string;
        };
        CredentialId?: number;
        CredentialsAlias?: string;
        ProbeConfigurationCredentialsId?: number;
        ProbeConfigurationId?: number;
    }[],
): Promise<
    {
        AttemptSequence?: number;
        CredentialDetails?: {
            ClientId?: number;
            CredentialsId?: number;
            ExpirationDate?: string;
            IsActive?: boolean;
            Title?: string;
        };
        CredentialId?: number;
        CredentialsAlias?: string;
        ProbeConfigurationCredentialsId?: number;
        ProbeConfigurationId?: number;
    }[],
>
Parameters
- probeConfigurationId: number
- labTechRepositoriesMySQLDomainModelsNetworkProbeProbeConfigurationCredentialss: {
      AttemptSequence?: number;
      CredentialDetails?: {
          ClientId?: number;
          CredentialsId?: number;
          ExpirationDate?: string;
          IsActive?: boolean;
          Title?: string;
      };
      CredentialId?: number;
      CredentialsAlias?: string;
      ProbeConfigurationCredentialsId?: number;
      ProbeConfigurationId?: number;
  }[]
  - OptionalAttemptSequence?: number
    Format: int32
  - OptionalCredentialDetails?: {
        ClientId?: number;
        CredentialsId?: number;
        ExpirationDate?: string;
        IsActive?: boolean;
        Title?: string;
    }
    OptionalClientId?: number
    Format: int32
    
    OptionalCredentialsId?: number
    Format: int32
    
    OptionalExpirationDate?: string
    Format: date-time
    
    OptionalIsActive?: boolean
    OptionalTitle?: string
  - OptionalCredentialId?: number
    Format: int32
  - OptionalCredentialsAlias?: string
  - OptionalProbeConfigurationCredentialsId?: number
    Format: int32
  - OptionalProbeConfigurationId?: number
    Format: int32
Returns Promise<
    {
        AttemptSequence?: number;
        CredentialDetails?: {
            ClientId?: number;
            CredentialsId?: number;
            ExpirationDate?: string;
            IsActive?: boolean;
            Title?: string;
        };
        CredentialId?: number;
        CredentialsAlias?: string;
        ProbeConfigurationCredentialsId?: number;
        ProbeConfigurationId?: number;
    }[],
>
- Defined in src/Automate/ProbeAPI.ts:156

`Protected`request

request<T = unknown>(args: RequestOptions): Promise<T>
Type Parameters
- T = unknown
Parameters
- args: RequestOptions
Returns Promise<T>
Inherited from AutomateBaseAPI.request
- Defined in src/BaseAPI.ts:52

upgradeProbe

upgradeProbe(
locationId: number,
params?: Automate.CommonParameters,
): Promise<undefined>
Parameters
- locationId: number
- params: Automate.CommonParameters = {}
Returns Promise<undefined>
- Defined in src/Automate/ProbeAPI.ts:87

Class ProbeAPI

Hierarchy

Index

Methods

Methods

deleteAgentPushCredentials

Parameters

Returns Promise<undefined>

deleteProbeConfiguration

Parameters

Returns Promise<undefined>

enableProbe

Parameters

getAgentPushCredentialsList

Parameters

getProbeConfiguration

Parameters

getProbeEventLevelList

Parameters

Returns Promise<{ Id?: number; Name?: string }[]>

getProbeEventList

Parameters

Returns Promise< { EventLevel?: { Id?: number; Name?: string }; EventTime?: string; Message?: string; ProbeId?: number; }[],>

getProbeSnmpConfigurationAsync

Parameters

getScanFrequencyList

Parameters

Returns Promise< { DisplayName?: string; FrequencyCategory?: { CategoryId?: number; Description?: string }; FrequencyInMinutes?: number; ScanFrequencyId?: number; }[],>

getSnmpEncryptionMethodList

Parameters

Returns Promise<{ Id?: number; Name?: string }[]>

getSnmpHashMethodList

Parameters

Returns Promise<{ Id?: number; Name?: string }[]>

getStatusScanNetworkPortOptionList

Parameters

Returns Promise<{ Description?: string; StatusScanNetworkPortOptionId?: number }[]>

patchProbeConfiguration

Parameters

patchProbeSnmpConfigurationAsync

Parameters

postProbeConfiguration

Parameters

putAgentPushCredentialsList

Parameters

OptionalAttemptSequence?: number

OptionalCredentialDetails?: { ClientId?: number; CredentialsId?: number; ExpirationDate?: string; IsActive?: boolean; Title?: string;}

OptionalClientId?: number

OptionalCredentialsId?: number

OptionalExpirationDate?: string

OptionalIsActive?: boolean

OptionalTitle?: string

OptionalCredentialId?: number

OptionalCredentialsAlias?: string

OptionalProbeConfigurationCredentialsId?: number

OptionalProbeConfigurationId?: number

Protectedrequest

Type Parameters

Parameters

Returns Promise<T>

upgradeProbe

Parameters

Returns Promise<undefined>

Settings

On This Page

Returns Promise<
{
EventLevel?: { Id?: number; Name?: string };
EventTime?: string;
Message?: string;
ProbeId?: number;
}[],
>

Returns Promise<
{
DisplayName?: string;
FrequencyCategory?: { CategoryId?: number; Description?: string };
FrequencyInMinutes?: number;
ScanFrequencyId?: number;
}[],
>

`Optional`AttemptSequence?: number

`Optional`CredentialDetails?: {
ClientId?: number;
CredentialsId?: number;
ExpirationDate?: string;
IsActive?: boolean;
Title?: string;
}

`Optional`ClientId?: number

`Optional`CredentialsId?: number

`Optional`ExpirationDate?: string

`Optional`IsActive?: boolean

`Optional`Title?: string

`Optional`CredentialId?: number

`Optional`CredentialsAlias?: string

`Optional`ProbeConfigurationCredentialsId?: number

`Optional`ProbeConfigurationId?: number

`Protected`request