node-ovh-ts/dist/handlers/HorizonView.d.ts

OVH API wrapper library for TypeScript

import { HorizonViewDedicatedHorizon } from '../models/HorizonViewDedicatedHorizon.js';
import { HorizonViewPool } from '../models/HorizonViewPool.js';
import { HorizonViewAccessPointTypeEnum } from '../models/HorizonViewAccessPointTypeEnum.js';
import { ServiceTerminationReasonEnum } from '../models/ServiceTerminationReasonEnum.js';
import { HorizonViewCustomerNetwork } from '../models/HorizonViewCustomerNetwork.js';
import { HorizonViewDatacenter } from '../models/HorizonViewDatacenter.js';
import { HorizonViewCustomerNetworkPool } from '../models/HorizonViewCustomerNetworkPool.js';
import { HorizonViewPoolType } from '../models/HorizonViewPoolType.js';
import { ServiceTerminationFutureUseEnum } from '../models/ServiceTerminationFutureUseEnum.js';
import { HorizonViewCustomerUser } from '../models/HorizonViewCustomerUser.js';
import { HorizonViewTask } from '../models/HorizonViewTask.js';
import { HorizonViewUser } from '../models/HorizonViewUser.js';
import { HorizonViewDomainTrust } from '../models/HorizonViewDomainTrust.js';
import { ServicesService } from '../models/ServicesService.js';
import OVHBase from '../ovh.js';
import '../models/HorizonViewZone.js';
import '../models/HorizonViewStateEnum.js';
import '../models/HorizonViewTaskStateEnum.js';
import '../models/ServiceStateEnum.js';
import '../models/ServiceRenewType.js';
import '../models/ServiceRenewalTypeEnum.js';
import '../endpoints.js';

declare class HorizonViewHandler {
    ovh: OVHBase;
    constructor(ovh: OVHBase);
    /** List available services */
    list: () => Promise<string[]>;
    /** Get this object properties */
    getByServiceName: (serviceName: string) => Promise<HorizonViewDatacenter>;
    /** Pool associated with this Datacenter */
    getAccessPointByServiceName: (serviceName: string) => Promise<number[]>;
    /** Add new access point to create a new network */
    addAccessPointByServiceName: (serviceName: string, body: {
        poolType: HorizonViewPoolType;
        privateBlock?: string;
        privateVlan?: number;
        vrouterPoolPublicIp?: string;
    }) => Promise<HorizonViewTask[]>;
    /** Delete this access point  */
    deleteAccessPointByServiceNameAndAccessPointId: (accessPointId: number, serviceName: string) => Promise<HorizonViewTask[]>;
    /** Get this object properties */
    getAccessPointByServiceNameAndAccessPointId: (accessPointId: number, serviceName: string) => Promise<HorizonViewPool>;
    /** Manage your session Timeout on Unified Access Gateway */
    postAccessPointChangeSessionTimeoutByServiceNameAndAccessPointId: (accessPointId: number, serviceName: string, body: {
        expiration: number;
        onSingleAP?: HorizonViewAccessPointTypeEnum;
    }) => Promise<HorizonViewTask>;
    /** You can reach from the Desktops your private network */
    getAccessPointCustomerNetworkByServiceNameAndAccessPointId: (accessPointId: number, serviceName: string) => Promise<number[]>;
    /** Add a new network  */
    addAccessPointCustomerNetworkByServiceNameAndAccessPointId: (accessPointId: number, serviceName: string, body: {
        network: string;
    }) => Promise<HorizonViewTask[]>;
    /** Delete this Customer Network */
    deleteAccessPointCustomerNetworkByServiceNameAndAccessPointIdAndCustomerNetworkId: (accessPointId: number, customerNetworkId: number, serviceName: string) => Promise<HorizonViewTask[]>;
    /** Get this object properties */
    getAccessPointCustomerNetworkByServiceNameAndAccessPointIdAndCustomerNetworkId: (accessPointId: number, customerNetworkId: number, serviceName: string) => Promise<HorizonViewCustomerNetworkPool>;
    /** Disable two factor authentication on your pool */
    disableAccessPointTwoFAByServiceNameAndAccessPointId: (accessPointId: number, serviceName: string) => Promise<HorizonViewTask>;
    /** Disable windows Username option on Unified Access Gateway */
    disableAccessPointWindowsUsernameOptionByServiceNameAndAccessPointId: (accessPointId: number, serviceName: string, body: {
        onSingleAP?: HorizonViewAccessPointTypeEnum;
    }) => Promise<HorizonViewTask>;
    /** Enable two factor authentication on your pool */
    enableAccessPointTwoFAByServiceNameAndAccessPointId: (accessPointId: number, serviceName: string, body: {
        onSingleAP?: HorizonViewAccessPointTypeEnum;
        radiusIp: string;
        secret: string;
    }) => Promise<HorizonViewTask>;
    /** Enable windows Username option on Unified Access Gateway */
    enableAccessPointWindowsUsernameOptionByServiceNameAndAccessPointId: (accessPointId: number, serviceName: string, body: {
        onSingleAP?: HorizonViewAccessPointTypeEnum;
    }) => Promise<HorizonViewTask>;
    /** Confirm termination of your service */
    confirmTerminationByServiceName: (serviceName: string, body: {
        commentary?: string;
        futureUse?: ServiceTerminationFutureUseEnum;
        reason?: ServiceTerminationReasonEnum;
        token: string;
    }) => Promise<string>;
    /** You can reach from the Desktops your private network */
    getCustomerNetworkByServiceName: (serviceName: string) => Promise<number[]>;
    /** Add a new network  */
    addCustomerNetworkByServiceName: (serviceName: string, body: {
        name: string;
        network: string;
    }) => Promise<HorizonViewTask[]>;
    /** Delete this Customer Network */
    deleteCustomerNetworkByServiceNameAndCustomerNetworkId: (customerNetworkId: number, serviceName: string) => Promise<HorizonViewTask[]>;
    /** Get this object properties */
    getCustomerNetworkByServiceNameAndCustomerNetworkId: (customerNetworkId: number, serviceName: string) => Promise<HorizonViewCustomerNetwork>;
    /** Get this object properties */
    getDedicatedHorizonByServiceName: (serviceName: string) => Promise<HorizonViewDedicatedHorizon>;
    /** Account to access to your pool */
    getDedicatedHorizonCustomerUserByServiceName: (serviceName: string) => Promise<string[]>;
    /** Create a new customer user  */
    createDedicatedHorizonCustomerUserByServiceName: (serviceName: string, body: {
        email?: string;
        password?: string;
        username: string;
    }) => Promise<HorizonViewTask[]>;
    /** Delete this Customer User */
    deleteDedicatedHorizonCustomerUserByServiceNameAndUsername: (serviceName: string, username: string) => Promise<HorizonViewTask[]>;
    /** Get this object properties */
    getDedicatedHorizonCustomerUserByServiceNameAndUsername: (serviceName: string, username: string) => Promise<HorizonViewCustomerUser>;
    /** Change Horizon View Customer  user password */
    updateDedicatedHorizonCustomerUserPasswordByServiceNameAndUsername: (serviceName: string, username: string, body: {
        password?: string;
    }) => Promise<HorizonViewTask>;
    /** Disable the View Storage Accelerator option on VCenter */
    disableDedicatedHorizonStorageAcceleratorByServiceName: (serviceName: string) => Promise<HorizonViewTask>;
    /** Enable the View Storage Accelerator option on VCenter */
    enableDedicatedHorizonStorageAcceleratorByServiceName: (serviceName: string) => Promise<HorizonViewTask>;
    /** Tasks associated with this Dedicated Horizon */
    getDedicatedHorizonTaskByServiceName: (serviceName: string) => Promise<number[]>;
    /** Get this object properties */
    getDedicatedHorizonTaskByServiceNameAndTaskId: (serviceName: string, taskId: number) => Promise<HorizonViewTask>;
    /** Get this object properties */
    getDedicatedHorizonUserByServiceName: (serviceName: string) => Promise<HorizonViewUser>;
    /** Change Horizon View user password */
    updateDedicatedHorizonUserPasswordByServiceName: (serviceName: string, body: {
        password?: string;
    }) => Promise<HorizonViewTask>;
    /** Change horizon view user properties */
    updateDedicatedHorizonUserPropertiesByServiceName: (serviceName: string, body: {
        email?: string;
    }) => Promise<HorizonViewTask>;
    /** List all Active Directories linked to your CDI Active Directory */
    listDomainTrustByServiceName: (serviceName: string) => Promise<number[]>;
    /** Link your Active Directory to your CDI Active Directory */
    postDomainTrustByServiceName: (serviceName: string, body: {
        activeDirectoryIP: string;
        dns1?: string;
        dns2?: string;
        domain: string;
    }) => Promise<HorizonViewTask[]>;
    /** Get this object properties */
    getDomainTrustByServiceNameAndDomainTrustId: (domainTrustId: number, serviceName: string) => Promise<HorizonViewDomainTrust>;
    /** Add a child domain for this domain. */
    addDomainTrustChildDomainByServiceNameAndDomainTrustId: (domainTrustId: number, serviceName: string, body: {
        activeDirectoryIP: string;
        domain: string;
        passphrase: string;
        serviceAccountPassword: string;
    }) => Promise<HorizonViewTask>;
    /** Add a Domain Controller for this domain. */
    addDomainTrustDomainControllerByServiceNameAndDomainTrustId: (domainTrustId: number, serviceName: string, body: {
        domain: string;
        domainControllerIp: string;
    }) => Promise<HorizonViewTask>;
    /** Add a domain user to add your desktop in your Active Directory */
    addDomainTrustDomainUserOnComposerByServiceNameAndDomainTrustId: (domainTrustId: number, serviceName: string, body: {
        domain: string;
        password: string;
        username: string;
    }) => Promise<HorizonViewTask>;
    /** Change Horizon View user password */
    updateDomainTrustCreateTrustByServiceNameAndDomainTrustId: (domainTrustId: number, serviceName: string, body: {
        passphrase: string;
        serviceAccountPassword: string;
    }) => Promise<HorizonViewTask>;
    /** Get this object properties */
    getServiceInfosByServiceName: (serviceName: string) => Promise<ServicesService>;
    /** Alter this object properties */
    updateServiceInfosByServiceName: (serviceName: string, body: ServicesService) => Promise<void>;
    /** Terminate your service */
    postTerminateByServiceName: (serviceName: string) => Promise<string>;
}

export { HorizonViewHandler };