aviatrix logo
Aviatrix v0.0.10, Jan 21 23

aviatrix.AviatrixRemoteSyslog

The aviatrix_remote_syslog resource allows the enabling and disabling of remote syslog.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Aviatrix = Pulumi.Aviatrix;

return await Deployment.RunAsync(() => 
{
    // Enable remote syslog without TLS
    var testRemoteSyslog = new Aviatrix.AviatrixRemoteSyslog("testRemoteSyslog", new()
    {
        Index = 0,
        Port = 10,
        Protocol = "TCP",
        Server = "1.2.3.4",
    });

});
package main

import (
	"github.com/astipkovits/pulumi-aviatrix/sdk/go/aviatrix"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := aviatrix.NewAviatrixRemoteSyslog(ctx, "testRemoteSyslog", &aviatrix.AviatrixRemoteSyslogArgs{
			Index:    pulumi.Int(0),
			Port:     pulumi.Int(10),
			Protocol: pulumi.String("TCP"),
			Server:   pulumi.String("1.2.3.4"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aviatrix.AviatrixRemoteSyslog;
import com.pulumi.aviatrix.AviatrixRemoteSyslogArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var testRemoteSyslog = new AviatrixRemoteSyslog("testRemoteSyslog", AviatrixRemoteSyslogArgs.builder()        
            .index(0)
            .port(10)
            .protocol("TCP")
            .server("1.2.3.4")
            .build());

    }
}
import pulumi
import pulumi_aviatrix as aviatrix

# Enable remote syslog without TLS
test_remote_syslog = aviatrix.AviatrixRemoteSyslog("testRemoteSyslog",
    index=0,
    port=10,
    protocol="TCP",
    server="1.2.3.4")
import * as pulumi from "@pulumi/pulumi";
import * as aviatrix from "@pulumi/aviatrix";

// Enable remote syslog without TLS
const testRemoteSyslog = new aviatrix.AviatrixRemoteSyslog("test_remote_syslog", {
    index: 0,
    port: 10,
    protocol: "TCP",
    server: "1.2.3.4",
});
resources:
  # Enable remote syslog without TLS
  testRemoteSyslog:
    type: aviatrix:AviatrixRemoteSyslog
    properties:
      index: 0
      port: 10
      protocol: TCP
      server: 1.2.3.4
using System.Collections.Generic;
using System.IO;
using Pulumi;
using Aviatrix = Pulumi.Aviatrix;

return await Deployment.RunAsync(() => 
{
    // Enable remote syslog with TLS
    var testRemoteSyslog = new Aviatrix.AviatrixRemoteSyslog("testRemoteSyslog", new()
    {
        Index = 0,
        Server = "1.2.3.4",
        Port = 10,
        Protocol = "TCP",
        CaCertificateFile = File.ReadAllText("/path/to/ca.pem"),
        PublicCertificateFile = File.ReadAllText("/path/to/server.pem"),
        PrivateKeyFile = File.ReadAllText("/path/to/client.pem"),
    });

});
package main

import (
	"io/ioutil"

	"github.com/astipkovits/pulumi-aviatrix/sdk/go/aviatrix"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func readFileOrPanic(path string) pulumi.StringPtrInput {
	data, err := ioutil.ReadFile(path)
	if err != nil {
		panic(err.Error())
	}
	return pulumi.String(string(data))
}

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := aviatrix.NewAviatrixRemoteSyslog(ctx, "testRemoteSyslog", &aviatrix.AviatrixRemoteSyslogArgs{
			Index:                 pulumi.Int(0),
			Server:                pulumi.String("1.2.3.4"),
			Port:                  pulumi.Int(10),
			Protocol:              pulumi.String("TCP"),
			CaCertificateFile:     readFileOrPanic("/path/to/ca.pem"),
			PublicCertificateFile: readFileOrPanic("/path/to/server.pem"),
			PrivateKeyFile:        readFileOrPanic("/path/to/client.pem"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aviatrix.AviatrixRemoteSyslog;
import com.pulumi.aviatrix.AviatrixRemoteSyslogArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var testRemoteSyslog = new AviatrixRemoteSyslog("testRemoteSyslog", AviatrixRemoteSyslogArgs.builder()        
            .index(0)
            .server("1.2.3.4")
            .port(10)
            .protocol("TCP")
            .caCertificateFile(Files.readString(Paths.get("/path/to/ca.pem")))
            .publicCertificateFile(Files.readString(Paths.get("/path/to/server.pem")))
            .privateKeyFile(Files.readString(Paths.get("/path/to/client.pem")))
            .build());

    }
}
import pulumi
import pulumi_aviatrix as aviatrix

# Enable remote syslog with TLS
test_remote_syslog = aviatrix.AviatrixRemoteSyslog("testRemoteSyslog",
    index=0,
    server="1.2.3.4",
    port=10,
    protocol="TCP",
    ca_certificate_file=(lambda path: open(path).read())("/path/to/ca.pem"),
    public_certificate_file=(lambda path: open(path).read())("/path/to/server.pem"),
    private_key_file=(lambda path: open(path).read())("/path/to/client.pem"))
import * as pulumi from "@pulumi/pulumi";
import * as aviatrix from "@astipkovits/aviatrix";
import * as fs from "fs";

// Enable remote syslog with TLS
const testRemoteSyslog = new aviatrix.AviatrixRemoteSyslog("testRemoteSyslog", {
    index: 0,
    server: "1.2.3.4",
    port: 10,
    protocol: "TCP",
    caCertificateFile: fs.readFileSync("/path/to/ca.pem"),
    publicCertificateFile: fs.readFileSync("/path/to/server.pem"),
    privateKeyFile: fs.readFileSync("/path/to/client.pem"),
});
resources:
  # Enable remote syslog with TLS
  testRemoteSyslog:
    type: aviatrix:AviatrixRemoteSyslog
    properties:
      index: 0
      server: 1.2.3.4
      port: 10
      protocol: TCP
      caCertificateFile:
        fn::readFile: /path/to/ca.pem
      publicCertificateFile:
        fn::readFile: /path/to/server.pem
      privateKeyFile:
        fn::readFile: /path/to/client.pem

Create AviatrixRemoteSyslog Resource

new AviatrixRemoteSyslog(name: string, args: AviatrixRemoteSyslogArgs, opts?: CustomResourceOptions);
@overload
def AviatrixRemoteSyslog(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         ca_certificate_file: Optional[str] = None,
                         excluded_gateways: Optional[Sequence[str]] = None,
                         index: Optional[int] = None,
                         name: Optional[str] = None,
                         port: Optional[int] = None,
                         private_key_file: Optional[str] = None,
                         protocol: Optional[str] = None,
                         public_certificate_file: Optional[str] = None,
                         server: Optional[str] = None,
                         template: Optional[str] = None)
@overload
def AviatrixRemoteSyslog(resource_name: str,
                         args: AviatrixRemoteSyslogArgs,
                         opts: Optional[ResourceOptions] = None)
func NewAviatrixRemoteSyslog(ctx *Context, name string, args AviatrixRemoteSyslogArgs, opts ...ResourceOption) (*AviatrixRemoteSyslog, error)
public AviatrixRemoteSyslog(string name, AviatrixRemoteSyslogArgs args, CustomResourceOptions? opts = null)
public AviatrixRemoteSyslog(String name, AviatrixRemoteSyslogArgs args)
public AviatrixRemoteSyslog(String name, AviatrixRemoteSyslogArgs args, CustomResourceOptions options)
type: aviatrix:AviatrixRemoteSyslog
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args AviatrixRemoteSyslogArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args AviatrixRemoteSyslogArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args AviatrixRemoteSyslogArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args AviatrixRemoteSyslogArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args AviatrixRemoteSyslogArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

AviatrixRemoteSyslog Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The AviatrixRemoteSyslog resource accepts the following input properties:

Port int

Port number.

Server string

Server IP.

CaCertificateFile string

The Certificate Authority (CA) certificate. Use the file function to read from a file.

ExcludedGateways List<string>

List of gateways to be excluded from logging. e.g.: ["gateway01", "gateway02", "gateway01-hagw"].

Index int

Profile index. An index from 0 to 9 is supported. 0 by default.

Name string

Profile name.

PrivateKeyFile string

The private key of the controller that pairs with the public certificate. Use the file function to read from a file.

Protocol string

TCP or UDP. TCP by default.

PublicCertificateFile string

The public certificate of the controller signed by the same CA. Use the file function to read from a file.

Template string

Optional custom template.

Port int

Port number.

Server string

Server IP.

CaCertificateFile string

The Certificate Authority (CA) certificate. Use the file function to read from a file.

ExcludedGateways []string

List of gateways to be excluded from logging. e.g.: ["gateway01", "gateway02", "gateway01-hagw"].

Index int

Profile index. An index from 0 to 9 is supported. 0 by default.

Name string

Profile name.

PrivateKeyFile string

The private key of the controller that pairs with the public certificate. Use the file function to read from a file.

Protocol string

TCP or UDP. TCP by default.

PublicCertificateFile string

The public certificate of the controller signed by the same CA. Use the file function to read from a file.

Template string

Optional custom template.

port Integer

Port number.

server String

Server IP.

caCertificateFile String

The Certificate Authority (CA) certificate. Use the file function to read from a file.

excludedGateways List<String>

List of gateways to be excluded from logging. e.g.: ["gateway01", "gateway02", "gateway01-hagw"].

index Integer

Profile index. An index from 0 to 9 is supported. 0 by default.

name String

Profile name.

privateKeyFile String

The private key of the controller that pairs with the public certificate. Use the file function to read from a file.

protocol String

TCP or UDP. TCP by default.

publicCertificateFile String

The public certificate of the controller signed by the same CA. Use the file function to read from a file.

template String

Optional custom template.

port number

Port number.

server string

Server IP.

caCertificateFile string

The Certificate Authority (CA) certificate. Use the file function to read from a file.

excludedGateways string[]

List of gateways to be excluded from logging. e.g.: ["gateway01", "gateway02", "gateway01-hagw"].

index number

Profile index. An index from 0 to 9 is supported. 0 by default.

name string

Profile name.

privateKeyFile string

The private key of the controller that pairs with the public certificate. Use the file function to read from a file.

protocol string

TCP or UDP. TCP by default.

publicCertificateFile string

The public certificate of the controller signed by the same CA. Use the file function to read from a file.

template string

Optional custom template.

port int

Port number.

server str

Server IP.

ca_certificate_file str

The Certificate Authority (CA) certificate. Use the file function to read from a file.

excluded_gateways Sequence[str]

List of gateways to be excluded from logging. e.g.: ["gateway01", "gateway02", "gateway01-hagw"].

index int

Profile index. An index from 0 to 9 is supported. 0 by default.

name str

Profile name.

private_key_file str

The private key of the controller that pairs with the public certificate. Use the file function to read from a file.

protocol str

TCP or UDP. TCP by default.

public_certificate_file str

The public certificate of the controller signed by the same CA. Use the file function to read from a file.

template str

Optional custom template.

port Number

Port number.

server String

Server IP.

caCertificateFile String

The Certificate Authority (CA) certificate. Use the file function to read from a file.

excludedGateways List<String>

List of gateways to be excluded from logging. e.g.: ["gateway01", "gateway02", "gateway01-hagw"].

index Number

Profile index. An index from 0 to 9 is supported. 0 by default.

name String

Profile name.

privateKeyFile String

The private key of the controller that pairs with the public certificate. Use the file function to read from a file.

protocol String

TCP or UDP. TCP by default.

publicCertificateFile String

The public certificate of the controller signed by the same CA. Use the file function to read from a file.

template String

Optional custom template.

Outputs

All input properties are implicitly available as output properties. Additionally, the AviatrixRemoteSyslog resource produces the following output properties:

Id string

The provider-assigned unique ID for this managed resource.

Notls bool

This attribute is true if the remote syslog is not protected by TLS.

Status string

The status of remote syslog.

Id string

The provider-assigned unique ID for this managed resource.

Notls bool

This attribute is true if the remote syslog is not protected by TLS.

Status string

The status of remote syslog.

id String

The provider-assigned unique ID for this managed resource.

notls Boolean

This attribute is true if the remote syslog is not protected by TLS.

status String

The status of remote syslog.

id string

The provider-assigned unique ID for this managed resource.

notls boolean

This attribute is true if the remote syslog is not protected by TLS.

status string

The status of remote syslog.

id str

The provider-assigned unique ID for this managed resource.

notls bool

This attribute is true if the remote syslog is not protected by TLS.

status str

The status of remote syslog.

id String

The provider-assigned unique ID for this managed resource.

notls Boolean

This attribute is true if the remote syslog is not protected by TLS.

status String

The status of remote syslog.

Look up Existing AviatrixRemoteSyslog Resource

Get an existing AviatrixRemoteSyslog resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: AviatrixRemoteSyslogState, opts?: CustomResourceOptions): AviatrixRemoteSyslog
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        ca_certificate_file: Optional[str] = None,
        excluded_gateways: Optional[Sequence[str]] = None,
        index: Optional[int] = None,
        name: Optional[str] = None,
        notls: Optional[bool] = None,
        port: Optional[int] = None,
        private_key_file: Optional[str] = None,
        protocol: Optional[str] = None,
        public_certificate_file: Optional[str] = None,
        server: Optional[str] = None,
        status: Optional[str] = None,
        template: Optional[str] = None) -> AviatrixRemoteSyslog
func GetAviatrixRemoteSyslog(ctx *Context, name string, id IDInput, state *AviatrixRemoteSyslogState, opts ...ResourceOption) (*AviatrixRemoteSyslog, error)
public static AviatrixRemoteSyslog Get(string name, Input<string> id, AviatrixRemoteSyslogState? state, CustomResourceOptions? opts = null)
public static AviatrixRemoteSyslog get(String name, Output<String> id, AviatrixRemoteSyslogState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
CaCertificateFile string

The Certificate Authority (CA) certificate. Use the file function to read from a file.

ExcludedGateways List<string>

List of gateways to be excluded from logging. e.g.: ["gateway01", "gateway02", "gateway01-hagw"].

Index int

Profile index. An index from 0 to 9 is supported. 0 by default.

Name string

Profile name.

Notls bool

This attribute is true if the remote syslog is not protected by TLS.

Port int

Port number.

PrivateKeyFile string

The private key of the controller that pairs with the public certificate. Use the file function to read from a file.

Protocol string

TCP or UDP. TCP by default.

PublicCertificateFile string

The public certificate of the controller signed by the same CA. Use the file function to read from a file.

Server string

Server IP.

Status string

The status of remote syslog.

Template string

Optional custom template.

CaCertificateFile string

The Certificate Authority (CA) certificate. Use the file function to read from a file.

ExcludedGateways []string

List of gateways to be excluded from logging. e.g.: ["gateway01", "gateway02", "gateway01-hagw"].

Index int

Profile index. An index from 0 to 9 is supported. 0 by default.

Name string

Profile name.

Notls bool

This attribute is true if the remote syslog is not protected by TLS.

Port int

Port number.

PrivateKeyFile string

The private key of the controller that pairs with the public certificate. Use the file function to read from a file.

Protocol string

TCP or UDP. TCP by default.

PublicCertificateFile string

The public certificate of the controller signed by the same CA. Use the file function to read from a file.

Server string

Server IP.

Status string

The status of remote syslog.

Template string

Optional custom template.

caCertificateFile String

The Certificate Authority (CA) certificate. Use the file function to read from a file.

excludedGateways List<String>

List of gateways to be excluded from logging. e.g.: ["gateway01", "gateway02", "gateway01-hagw"].

index Integer

Profile index. An index from 0 to 9 is supported. 0 by default.

name String

Profile name.

notls Boolean

This attribute is true if the remote syslog is not protected by TLS.

port Integer

Port number.

privateKeyFile String

The private key of the controller that pairs with the public certificate. Use the file function to read from a file.

protocol String

TCP or UDP. TCP by default.

publicCertificateFile String

The public certificate of the controller signed by the same CA. Use the file function to read from a file.

server String

Server IP.

status String

The status of remote syslog.

template String

Optional custom template.

caCertificateFile string

The Certificate Authority (CA) certificate. Use the file function to read from a file.

excludedGateways string[]

List of gateways to be excluded from logging. e.g.: ["gateway01", "gateway02", "gateway01-hagw"].

index number

Profile index. An index from 0 to 9 is supported. 0 by default.

name string

Profile name.

notls boolean

This attribute is true if the remote syslog is not protected by TLS.

port number

Port number.

privateKeyFile string

The private key of the controller that pairs with the public certificate. Use the file function to read from a file.

protocol string

TCP or UDP. TCP by default.

publicCertificateFile string

The public certificate of the controller signed by the same CA. Use the file function to read from a file.

server string

Server IP.

status string

The status of remote syslog.

template string

Optional custom template.

ca_certificate_file str

The Certificate Authority (CA) certificate. Use the file function to read from a file.

excluded_gateways Sequence[str]

List of gateways to be excluded from logging. e.g.: ["gateway01", "gateway02", "gateway01-hagw"].

index int

Profile index. An index from 0 to 9 is supported. 0 by default.

name str

Profile name.

notls bool

This attribute is true if the remote syslog is not protected by TLS.

port int

Port number.

private_key_file str

The private key of the controller that pairs with the public certificate. Use the file function to read from a file.

protocol str

TCP or UDP. TCP by default.

public_certificate_file str

The public certificate of the controller signed by the same CA. Use the file function to read from a file.

server str

Server IP.

status str

The status of remote syslog.

template str

Optional custom template.

caCertificateFile String

The Certificate Authority (CA) certificate. Use the file function to read from a file.

excludedGateways List<String>

List of gateways to be excluded from logging. e.g.: ["gateway01", "gateway02", "gateway01-hagw"].

index Number

Profile index. An index from 0 to 9 is supported. 0 by default.

name String

Profile name.

notls Boolean

This attribute is true if the remote syslog is not protected by TLS.

port Number

Port number.

privateKeyFile String

The private key of the controller that pairs with the public certificate. Use the file function to read from a file.

protocol String

TCP or UDP. TCP by default.

publicCertificateFile String

The public certificate of the controller signed by the same CA. Use the file function to read from a file.

server String

Server IP.

status String

The status of remote syslog.

template String

Optional custom template.

Import

remote_syslog can be imported using “remote_syslog_” + index, e.g.

 $ pulumi import aviatrix:index/aviatrixRemoteSyslog:AviatrixRemoteSyslog test remote_syslog_0

Package Details

Repository
aviatrix astipkovits/pulumi-aviatrix
License
Apache-2.0
Notes

This Pulumi package is based on the aviatrix Terraform Provider.