ovh

package
v0.32.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 8, 2023 License: Apache-2.0 Imports: 6 Imported by: 1

Documentation

Overview

A Pulumi package for creating and managing OVH cloud resources.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type GetInstallationTemplatesResult 

type GetInstallationTemplatesResult struct {
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// The list of installation templates IDs available for dedicated servers.
	Results []string `pulumi:"results"`
}

A collection of values returned by getInstallationTemplates.

func GetInstallationTemplates 

func GetInstallationTemplates(ctx *pulumi.Context, opts ...pulumi.InvokeOption) (*GetInstallationTemplatesResult, error)

Use this data source to get the list of installation templates available for dedicated servers.

## Example Usage

```go package main

import ( 

"github.com/lbrlabs/pulumi-ovh/sdk/go/ovh"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ovh.GetInstallationTemplates(ctx, nil, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

```

type GetServerArgs 

type GetServerArgs struct {
	// The serviceName of your dedicated server.
	ServiceName string `pulumi:"serviceName"`
}

A collection of arguments for invoking getServer.

type GetServerOutputArgs 

type GetServerOutputArgs struct {
	// The serviceName of your dedicated server.
	ServiceName pulumi.StringInput `pulumi:"serviceName"`
}

A collection of arguments for invoking getServer.

func (GetServerOutputArgs) ElementType 

func (GetServerOutputArgs) ElementType() reflect.Type

type GetServerResult 

type GetServerResult struct {
	// boot id of the server
	BootId int `pulumi:"bootId"`
	// dedicated server commercial range
	CommercialRange string `pulumi:"commercialRange"`
	// dedicated datacenter localisation (bhs1,bhs2,...)
	Datacenter string `pulumi:"datacenter"`
	// List of enabled public VNI uuids
	EnabledPublicVnis []string `pulumi:"enabledPublicVnis"`
	// List of enabled vrackAggregation VNI uuids
	EnabledVrackAggregationVnis []string `pulumi:"enabledVrackAggregationVnis"`
	// List of enabled vrack VNI uuids
	EnabledVrackVnis []string `pulumi:"enabledVrackVnis"`
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// dedicated server ip (IPv4)
	Ip string `pulumi:"ip"`
	// dedicated server ip blocks
	Ips []string `pulumi:"ips"`
	// link speed of the server
	LinkSpeed int `pulumi:"linkSpeed"`
	// Icmp monitoring state
	Monitoring bool `pulumi:"monitoring"`
	// User defined VirtualNetworkInterface name
	Name string `pulumi:"name"`
	// Operating system
	Os string `pulumi:"os"`
	// Does this server have professional use option
	ProfessionalUse bool `pulumi:"professionalUse"`
	// rack id of the server
	Rack string `pulumi:"rack"`
	// rescue mail of the server
	RescueMail string `pulumi:"rescueMail"`
	// dedicated server reverse
	Reverse string `pulumi:"reverse"`
	// root device of the server
	RootDevice string `pulumi:"rootDevice"`
	// your server id
	ServerId    int    `pulumi:"serverId"`
	ServiceName string `pulumi:"serviceName"`
	// error, hacked, hackedBlocked, ok
	State string `pulumi:"state"`
	// Dedicated server support level (critical, fastpath, gs, pro)
	SupportLevel string `pulumi:"supportLevel"`
	// URN of the dedicated server instance
	Urn string `pulumi:"urn"`
	// the list of Virtualnetworkinterface assiociated with this server
	Vnis []GetServerVni `pulumi:"vnis"`
}

A collection of values returned by getServer.

func GetServer 

func GetServer(ctx *pulumi.Context, args *GetServerArgs, opts ...pulumi.InvokeOption) (*GetServerResult, error)

Use this data source to retrieve information about a dedicated server associated with your OVHcloud Account.

## Example Usage

```go package main

import ( 

"github.com/lbrlabs/pulumi-ovh/sdk/go/ovh"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ovh.GetServer(ctx, &ovh.GetServerArgs{
			ServiceName: "XXXXXX",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

```

type GetServerResultOutput 

type GetServerResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getServer.

func GetServerOutput 

func GetServerOutput(ctx *pulumi.Context, args GetServerOutputArgs, opts ...pulumi.InvokeOption) GetServerResultOutput

func (GetServerResultOutput) BootId 

func (o GetServerResultOutput) BootId() pulumi.IntOutput

boot id of the server

func (GetServerResultOutput) CommercialRange 

func (o GetServerResultOutput) CommercialRange() pulumi.StringOutput

dedicated server commercial range

func (GetServerResultOutput) Datacenter 

func (o GetServerResultOutput) Datacenter() pulumi.StringOutput

dedicated datacenter localisation (bhs1,bhs2,...)

func (GetServerResultOutput) ElementType 

func (GetServerResultOutput) ElementType() reflect.Type

func (GetServerResultOutput) EnabledPublicVnis 

func (o GetServerResultOutput) EnabledPublicVnis() pulumi.StringArrayOutput

List of enabled public VNI uuids

func (GetServerResultOutput) EnabledVrackAggregationVnis 

func (o GetServerResultOutput) EnabledVrackAggregationVnis() pulumi.StringArrayOutput

List of enabled vrackAggregation VNI uuids

func (GetServerResultOutput) EnabledVrackVnis 

func (o GetServerResultOutput) EnabledVrackVnis() pulumi.StringArrayOutput

List of enabled vrack VNI uuids

func (GetServerResultOutput) Id 

func (o GetServerResultOutput) Id() pulumi.StringOutput

The provider-assigned unique ID for this managed resource.

func (GetServerResultOutput) Ip 

func (o GetServerResultOutput) Ip() pulumi.StringOutput

dedicated server ip (IPv4)

func (GetServerResultOutput) Ips 

func (o GetServerResultOutput) Ips() pulumi.StringArrayOutput

dedicated server ip blocks

func (GetServerResultOutput) LinkSpeed 

func (o GetServerResultOutput) LinkSpeed() pulumi.IntOutput

link speed of the server

func (GetServerResultOutput) Monitoring 

func (o GetServerResultOutput) Monitoring() pulumi.BoolOutput

Icmp monitoring state

func (GetServerResultOutput) Name 

func (o GetServerResultOutput) Name() pulumi.StringOutput

User defined VirtualNetworkInterface name

func (GetServerResultOutput) Os 

func (o GetServerResultOutput) Os() pulumi.StringOutput

Operating system

func (GetServerResultOutput) ProfessionalUse 

func (o GetServerResultOutput) ProfessionalUse() pulumi.BoolOutput

Does this server have professional use option

func (GetServerResultOutput) Rack 

func (o GetServerResultOutput) Rack() pulumi.StringOutput

rack id of the server

func (GetServerResultOutput) RescueMail 

func (o GetServerResultOutput) RescueMail() pulumi.StringOutput

rescue mail of the server

func (GetServerResultOutput) Reverse 

func (o GetServerResultOutput) Reverse() pulumi.StringOutput

dedicated server reverse

func (GetServerResultOutput) RootDevice 

func (o GetServerResultOutput) RootDevice() pulumi.StringOutput

root device of the server

func (GetServerResultOutput) ServerId 

func (o GetServerResultOutput) ServerId() pulumi.IntOutput

your server id

func (GetServerResultOutput) ServiceName 

func (o GetServerResultOutput) ServiceName() pulumi.StringOutput

func (GetServerResultOutput) State 

func (o GetServerResultOutput) State() pulumi.StringOutput

error, hacked, hackedBlocked, ok

func (GetServerResultOutput) SupportLevel 

func (o GetServerResultOutput) SupportLevel() pulumi.StringOutput

Dedicated server support level (critical, fastpath, gs, pro)

func (GetServerResultOutput) ToGetServerResultOutput 

func (o GetServerResultOutput) ToGetServerResultOutput() GetServerResultOutput

func (GetServerResultOutput) ToGetServerResultOutputWithContext 

func (o GetServerResultOutput) ToGetServerResultOutputWithContext(ctx context.Context) GetServerResultOutput

func (GetServerResultOutput) Urn added in v0.32.0 

func (o GetServerResultOutput) Urn() pulumi.StringOutput

URN of the dedicated server instance

func (GetServerResultOutput) Vnis 

func (o GetServerResultOutput) Vnis() GetServerVniArrayOutput

the list of Virtualnetworkinterface assiociated with this server

type GetServerVni 

type GetServerVni struct {
	// VirtualNetworkInterface activation state
	Enabled bool `pulumi:"enabled"`
	// VirtualNetworkInterface mode (public,vrack,vrack_aggregation)
	Mode string `pulumi:"mode"`
	// User defined VirtualNetworkInterface name
	Name string `pulumi:"name"`
	// NetworkInterfaceControllers bound to this VirtualNetworkInterface
	Nics []string `pulumi:"nics"`
	// Server bound to this VirtualNetworkInterface
	ServerName string `pulumi:"serverName"`
	// VirtualNetworkInterface unique id
	Uuid string `pulumi:"uuid"`
	// vRack name
	Vrack string `pulumi:"vrack"`
}

type GetServerVniArgs 

type GetServerVniArgs struct {
	// VirtualNetworkInterface activation state
	Enabled pulumi.BoolInput `pulumi:"enabled"`
	// VirtualNetworkInterface mode (public,vrack,vrack_aggregation)
	Mode pulumi.StringInput `pulumi:"mode"`
	// User defined VirtualNetworkInterface name
	Name pulumi.StringInput `pulumi:"name"`
	// NetworkInterfaceControllers bound to this VirtualNetworkInterface
	Nics pulumi.StringArrayInput `pulumi:"nics"`
	// Server bound to this VirtualNetworkInterface
	ServerName pulumi.StringInput `pulumi:"serverName"`
	// VirtualNetworkInterface unique id
	Uuid pulumi.StringInput `pulumi:"uuid"`
	// vRack name
	Vrack pulumi.StringInput `pulumi:"vrack"`
}

func (GetServerVniArgs) ElementType 

func (GetServerVniArgs) ElementType() reflect.Type

func (GetServerVniArgs) ToGetServerVniOutput 

func (i GetServerVniArgs) ToGetServerVniOutput() GetServerVniOutput

func (GetServerVniArgs) ToGetServerVniOutputWithContext 

func (i GetServerVniArgs) ToGetServerVniOutputWithContext(ctx context.Context) GetServerVniOutput

type GetServerVniArray 

type GetServerVniArray []GetServerVniInput

func (GetServerVniArray) ElementType 

func (GetServerVniArray) ElementType() reflect.Type

func (GetServerVniArray) ToGetServerVniArrayOutput 

func (i GetServerVniArray) ToGetServerVniArrayOutput() GetServerVniArrayOutput

func (GetServerVniArray) ToGetServerVniArrayOutputWithContext 

func (i GetServerVniArray) ToGetServerVniArrayOutputWithContext(ctx context.Context) GetServerVniArrayOutput

type GetServerVniArrayInput 

type GetServerVniArrayInput interface {
	pulumi.Input

	ToGetServerVniArrayOutput() GetServerVniArrayOutput
	ToGetServerVniArrayOutputWithContext(context.Context) GetServerVniArrayOutput
}

GetServerVniArrayInput is an input type that accepts GetServerVniArray and GetServerVniArrayOutput values. You can construct a concrete instance of `GetServerVniArrayInput` via: 

GetServerVniArray{ GetServerVniArgs{...} }

type GetServerVniArrayOutput 

type GetServerVniArrayOutput struct{ *pulumi.OutputState }

func (GetServerVniArrayOutput) ElementType 

func (GetServerVniArrayOutput) ElementType() reflect.Type

func (GetServerVniArrayOutput) Index 

func (o GetServerVniArrayOutput) Index(i pulumi.IntInput) GetServerVniOutput

func (GetServerVniArrayOutput) ToGetServerVniArrayOutput 

func (o GetServerVniArrayOutput) ToGetServerVniArrayOutput() GetServerVniArrayOutput

func (GetServerVniArrayOutput) ToGetServerVniArrayOutputWithContext 

func (o GetServerVniArrayOutput) ToGetServerVniArrayOutputWithContext(ctx context.Context) GetServerVniArrayOutput

type GetServerVniInput 

type GetServerVniInput interface {
	pulumi.Input

	ToGetServerVniOutput() GetServerVniOutput
	ToGetServerVniOutputWithContext(context.Context) GetServerVniOutput
}

GetServerVniInput is an input type that accepts GetServerVniArgs and GetServerVniOutput values. You can construct a concrete instance of `GetServerVniInput` via: 

GetServerVniArgs{...}

type GetServerVniOutput 

type GetServerVniOutput struct{ *pulumi.OutputState }

func (GetServerVniOutput) ElementType 

func (GetServerVniOutput) ElementType() reflect.Type

func (GetServerVniOutput) Enabled 

func (o GetServerVniOutput) Enabled() pulumi.BoolOutput

VirtualNetworkInterface activation state

func (GetServerVniOutput) Mode 

func (o GetServerVniOutput) Mode() pulumi.StringOutput

VirtualNetworkInterface mode (public,vrack,vrack_aggregation)

func (GetServerVniOutput) Name 

func (o GetServerVniOutput) Name() pulumi.StringOutput

User defined VirtualNetworkInterface name

func (GetServerVniOutput) Nics 

func (o GetServerVniOutput) Nics() pulumi.StringArrayOutput

NetworkInterfaceControllers bound to this VirtualNetworkInterface

func (GetServerVniOutput) ServerName 

func (o GetServerVniOutput) ServerName() pulumi.StringOutput

Server bound to this VirtualNetworkInterface

func (GetServerVniOutput) ToGetServerVniOutput 

func (o GetServerVniOutput) ToGetServerVniOutput() GetServerVniOutput

func (GetServerVniOutput) ToGetServerVniOutputWithContext 

func (o GetServerVniOutput) ToGetServerVniOutputWithContext(ctx context.Context) GetServerVniOutput

func (GetServerVniOutput) Uuid 

func (o GetServerVniOutput) Uuid() pulumi.StringOutput

VirtualNetworkInterface unique id

func (GetServerVniOutput) Vrack 

func (o GetServerVniOutput) Vrack() pulumi.StringOutput

vRack name

type GetServersResult 

type GetServersResult struct {
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// The list of dedicated servers IDs associated with your OVHcloud Account.
	Results []string `pulumi:"results"`
}

A collection of values returned by getServers.

func GetServers 

func GetServers(ctx *pulumi.Context, opts ...pulumi.InvokeOption) (*GetServersResult, error)

Use this data source to get the list of dedicated servers associated with your OVHcloud Account.

## Example Usage

```go package main

import ( 

"github.com/lbrlabs/pulumi-ovh/sdk/go/ovh"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ovh.GetServers(ctx, nil, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

```

type GetVrackNetworksArgs 

type GetVrackNetworksArgs struct {
	// The internal name of your IP load balancing
	ServiceName string `pulumi:"serviceName"`
	// Filters networks on the subnet.
	Subnet *string `pulumi:"subnet"`
	// Filters networks on the vlan id.
	VlanId *int `pulumi:"vlanId"`
}

A collection of arguments for invoking getVrackNetworks.

type GetVrackNetworksOutputArgs 

type GetVrackNetworksOutputArgs struct {
	// The internal name of your IP load balancing
	ServiceName pulumi.StringInput `pulumi:"serviceName"`
	// Filters networks on the subnet.
	Subnet pulumi.StringPtrInput `pulumi:"subnet"`
	// Filters networks on the vlan id.
	VlanId pulumi.IntPtrInput `pulumi:"vlanId"`
}

A collection of arguments for invoking getVrackNetworks.

func (GetVrackNetworksOutputArgs) ElementType 

func (GetVrackNetworksOutputArgs) ElementType() reflect.Type

type GetVrackNetworksResult 

type GetVrackNetworksResult struct {
	// The provider-assigned unique ID for this managed resource.
	Id string `pulumi:"id"`
	// The list of vrack network ids.
	Results     []int   `pulumi:"results"`
	ServiceName string  `pulumi:"serviceName"`
	Subnet      *string `pulumi:"subnet"`
	VlanId      *int    `pulumi:"vlanId"`
}

A collection of values returned by getVrackNetworks.

func GetVrackNetworks 

func GetVrackNetworks(ctx *pulumi.Context, args *GetVrackNetworksArgs, opts ...pulumi.InvokeOption) (*GetVrackNetworksResult, error)

Use this data source to get the list of Vrack network ids available for your IPLoadbalancer associated with your OVHcloud account.

## Example Usage

```go package main

import ( 

"github.com/lbrlabs/pulumi-ovh/sdk/go/ovh"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ovh.GetVrackNetworks(ctx, &ovh.GetVrackNetworksArgs{
			ServiceName: "XXXXXX",
			Subnet:      pulumi.StringRef("10.0.0.0/24"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

```

type GetVrackNetworksResultOutput 

type GetVrackNetworksResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getVrackNetworks.

func GetVrackNetworksOutput 

func GetVrackNetworksOutput(ctx *pulumi.Context, args GetVrackNetworksOutputArgs, opts ...pulumi.InvokeOption) GetVrackNetworksResultOutput

func (GetVrackNetworksResultOutput) ElementType 

func (GetVrackNetworksResultOutput) ElementType() reflect.Type

func (GetVrackNetworksResultOutput) Id 

func (o GetVrackNetworksResultOutput) Id() pulumi.StringOutput

The provider-assigned unique ID for this managed resource.

func (GetVrackNetworksResultOutput) Results 

func (o GetVrackNetworksResultOutput) Results() pulumi.IntArrayOutput

The list of vrack network ids.

func (GetVrackNetworksResultOutput) ServiceName 

func (o GetVrackNetworksResultOutput) ServiceName() pulumi.StringOutput

func (GetVrackNetworksResultOutput) Subnet 

func (o GetVrackNetworksResultOutput) Subnet() pulumi.StringPtrOutput

func (GetVrackNetworksResultOutput) ToGetVrackNetworksResultOutput 

func (o GetVrackNetworksResultOutput) ToGetVrackNetworksResultOutput() GetVrackNetworksResultOutput

func (GetVrackNetworksResultOutput) ToGetVrackNetworksResultOutputWithContext 

func (o GetVrackNetworksResultOutput) ToGetVrackNetworksResultOutputWithContext(ctx context.Context) GetVrackNetworksResultOutput

func (GetVrackNetworksResultOutput) VlanId 

func (o GetVrackNetworksResultOutput) VlanId() pulumi.IntPtrOutput

type Provider 

type Provider struct {
	pulumi.ProviderResourceState

	// The OVH API Application Key.
	ApplicationKey pulumi.StringPtrOutput `pulumi:"applicationKey"`
	// The OVH API Application Secret.
	ApplicationSecret pulumi.StringPtrOutput `pulumi:"applicationSecret"`
	// The OVH API Consumer key.
	ConsumerKey pulumi.StringPtrOutput `pulumi:"consumerKey"`
	// The OVH API endpoint to target (ex: "ovh-eu").
	Endpoint pulumi.StringPtrOutput `pulumi:"endpoint"`
}

The provider type for the ovh package. By default, resources use package-wide configuration settings, however an explicit `Provider` instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the [documentation](https://www.pulumi.com/docs/reference/programming-model/#providers) for more information.

func NewProvider 

func NewProvider(ctx *pulumi.Context,
	name string, args *ProviderArgs, opts ...pulumi.ResourceOption) (*Provider, error)

NewProvider registers a new resource with the given unique name, arguments, and options.

func (*Provider) ElementType 

func (*Provider) ElementType() reflect.Type

func (*Provider) ToProviderOutput 

func (i *Provider) ToProviderOutput() ProviderOutput

func (*Provider) ToProviderOutputWithContext 

func (i *Provider) ToProviderOutputWithContext(ctx context.Context) ProviderOutput

type ProviderArgs 

type ProviderArgs struct {
	// The OVH API Application Key.
	ApplicationKey pulumi.StringPtrInput
	// The OVH API Application Secret.
	ApplicationSecret pulumi.StringPtrInput
	// The OVH API Consumer key.
	ConsumerKey pulumi.StringPtrInput
	// The OVH API endpoint to target (ex: "ovh-eu").
	Endpoint pulumi.StringPtrInput
}

The set of arguments for constructing a Provider resource.

func (ProviderArgs) ElementType 

func (ProviderArgs) ElementType() reflect.Type

type ProviderInput 

type ProviderInput interface {
	pulumi.Input

	ToProviderOutput() ProviderOutput
	ToProviderOutputWithContext(ctx context.Context) ProviderOutput
}

type ProviderOutput 

type ProviderOutput struct{ *pulumi.OutputState }

func (ProviderOutput) ApplicationKey 

func (o ProviderOutput) ApplicationKey() pulumi.StringPtrOutput

The OVH API Application Key.

func (ProviderOutput) ApplicationSecret 

func (o ProviderOutput) ApplicationSecret() pulumi.StringPtrOutput

The OVH API Application Secret.

func (ProviderOutput) ConsumerKey 

func (o ProviderOutput) ConsumerKey() pulumi.StringPtrOutput

The OVH API Consumer key.

func (ProviderOutput) ElementType 

func (ProviderOutput) ElementType() reflect.Type

func (ProviderOutput) Endpoint 

func (o ProviderOutput) Endpoint() pulumi.StringPtrOutput

The OVH API endpoint to target (ex: "ovh-eu").

func (ProviderOutput) ToProviderOutput 

func (o ProviderOutput) ToProviderOutput() ProviderOutput

func (ProviderOutput) ToProviderOutputWithContext 

func (o ProviderOutput) ToProviderOutputWithContext(ctx context.Context) ProviderOutput

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.