Aviatrix v0.0.10, Jan 21 23

aviatrix.AviatrixNetflowAgent

Explore with Pulumi AI

The aviatrix_netflow_agent resource allows the enabling and disabling of netflow agent.

Example Usage

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

return await Deployment.RunAsync(() => 
{
    // Enable netflow agent
    var testNetflowAgent = new Aviatrix.AviatrixNetflowAgent("testNetflowAgent", new()
    {
        ExcludedGateways = new[]
        {
            "a",
            "b",
        },
        Port = 10,
        ServerIp = "1.2.3.4",
        Version = 5,
    });

});

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.NewAviatrixNetflowAgent(ctx, "testNetflowAgent", &aviatrix.AviatrixNetflowAgentArgs{
			ExcludedGateways: pulumi.StringArray{
				pulumi.String("a"),
				pulumi.String("b"),
			},
			Port:     pulumi.Int(10),
			ServerIp: pulumi.String("1.2.3.4"),
			Version:  pulumi.Int(5),
		})
		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.AviatrixNetflowAgent;
import com.pulumi.aviatrix.AviatrixNetflowAgentArgs;
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 testNetflowAgent = new AviatrixNetflowAgent("testNetflowAgent", AviatrixNetflowAgentArgs.builder()        
            .excludedGateways(            
                "a",
                "b")
            .port(10)
            .serverIp("1.2.3.4")
            .version(5)
            .build());

    }
}

import pulumi
import pulumi_aviatrix as aviatrix

# Enable netflow agent
test_netflow_agent = aviatrix.AviatrixNetflowAgent("testNetflowAgent",
    excluded_gateways=[
        "a",
        "b",
    ],
    port=10,
    server_ip="1.2.3.4",
    version=5)

import * as pulumi from "@pulumi/pulumi";
import * as aviatrix from "@pulumi/aviatrix";

// Enable netflow agent
const testNetflowAgent = new aviatrix.AviatrixNetflowAgent("test_netflow_agent", {
    excludedGateways: [
        "a",
        "b",
    ],
    port: 10,
    serverIp: "1.2.3.4",
    version: 5,
});

resources:
  # Enable netflow agent
  testNetflowAgent:
    type: aviatrix:AviatrixNetflowAgent
    properties:
      excludedGateways:
        - a
        - b
      port: 10
      serverIp: 1.2.3.4
      version: 5

Create AviatrixNetflowAgent Resource

new AviatrixNetflowAgent(name: string, args: AviatrixNetflowAgentArgs, opts?: CustomResourceOptions);

@overload
def AviatrixNetflowAgent(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         excluded_gateways: Optional[Sequence[str]] = None,
                         port: Optional[int] = None,
                         server_ip: Optional[str] = None,
                         version: Optional[int] = None)
@overload
def AviatrixNetflowAgent(resource_name: str,
                         args: AviatrixNetflowAgentArgs,
                         opts: Optional[ResourceOptions] = None)

func NewAviatrixNetflowAgent(ctx *Context, name string, args AviatrixNetflowAgentArgs, opts ...ResourceOption) (*AviatrixNetflowAgent, error)

public AviatrixNetflowAgent(string name, AviatrixNetflowAgentArgs args, CustomResourceOptions? opts = null)

public AviatrixNetflowAgent(String name, AviatrixNetflowAgentArgs args)
public AviatrixNetflowAgent(String name, AviatrixNetflowAgentArgs args, CustomResourceOptions options)

type: aviatrix:AviatrixNetflowAgent
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args AviatrixNetflowAgentArgs: 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 AviatrixNetflowAgentArgs: 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 AviatrixNetflowAgentArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args AviatrixNetflowAgentArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args AviatrixNetflowAgentArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

AviatrixNetflowAgent 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 AviatrixNetflowAgent resource accepts the following input properties:

Port int: Netflow server port.
ServerIp string: Netflow server IP address.
ExcludedGateways List<string>: List of gateways to be excluded from logging. e.g.: ["gateway01", "gateway02", "gateway01-hagw"].
Version int: Netflow version (5 or 9). 5 by default.

Port int: Netflow server port.
ServerIp string: Netflow server IP address.
ExcludedGateways []string: List of gateways to be excluded from logging. e.g.: ["gateway01", "gateway02", "gateway01-hagw"].
Version int: Netflow version (5 or 9). 5 by default.

port Integer: Netflow server port.
serverIp String: Netflow server IP address.
excludedGateways List<String>: List of gateways to be excluded from logging. e.g.: ["gateway01", "gateway02", "gateway01-hagw"].
version Integer: Netflow version (5 or 9). 5 by default.

port number: Netflow server port.
serverIp string: Netflow server IP address.
excludedGateways string[]: List of gateways to be excluded from logging. e.g.: ["gateway01", "gateway02", "gateway01-hagw"].
version number: Netflow version (5 or 9). 5 by default.

port int: Netflow server port.
server_ip str: Netflow server IP address.
excluded_gateways Sequence[str]: List of gateways to be excluded from logging. e.g.: ["gateway01", "gateway02", "gateway01-hagw"].
version int: Netflow version (5 or 9). 5 by default.

port Number: Netflow server port.
serverIp String: Netflow server IP address.
excludedGateways List<String>: List of gateways to be excluded from logging. e.g.: ["gateway01", "gateway02", "gateway01-hagw"].
version Number: Netflow version (5 or 9). 5 by default.

Outputs

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

Id string: The provider-assigned unique ID for this managed resource.
Status string: The status of netflow agent.

Id string: The provider-assigned unique ID for this managed resource.
Status string: The status of netflow agent.

id String: The provider-assigned unique ID for this managed resource.
status String: The status of netflow agent.

id string: The provider-assigned unique ID for this managed resource.
status string: The status of netflow agent.

id str: The provider-assigned unique ID for this managed resource.
status str: The status of netflow agent.

id String: The provider-assigned unique ID for this managed resource.
status String: The status of netflow agent.

Look up Existing AviatrixNetflowAgent Resource

Get an existing AviatrixNetflowAgent 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?: AviatrixNetflowAgentState, opts?: CustomResourceOptions): AviatrixNetflowAgent

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        excluded_gateways: Optional[Sequence[str]] = None,
        port: Optional[int] = None,
        server_ip: Optional[str] = None,
        status: Optional[str] = None,
        version: Optional[int] = None) -> AviatrixNetflowAgent

func GetAviatrixNetflowAgent(ctx *Context, name string, id IDInput, state *AviatrixNetflowAgentState, opts ...ResourceOption) (*AviatrixNetflowAgent, error)

public static AviatrixNetflowAgent Get(string name, Input<string> id, AviatrixNetflowAgentState? state, CustomResourceOptions? opts = null)

public static AviatrixNetflowAgent get(String name, Output<String> id, AviatrixNetflowAgentState 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:

ExcludedGateways List<string>: List of gateways to be excluded from logging. e.g.: ["gateway01", "gateway02", "gateway01-hagw"].
Port int: Netflow server port.
ServerIp string: Netflow server IP address.
Status string: The status of netflow agent.
Version int: Netflow version (5 or 9). 5 by default.

ExcludedGateways []string: List of gateways to be excluded from logging. e.g.: ["gateway01", "gateway02", "gateway01-hagw"].
Port int: Netflow server port.
ServerIp string: Netflow server IP address.
Status string: The status of netflow agent.
Version int: Netflow version (5 or 9). 5 by default.

excludedGateways List<String>: List of gateways to be excluded from logging. e.g.: ["gateway01", "gateway02", "gateway01-hagw"].
port Integer: Netflow server port.
serverIp String: Netflow server IP address.
status String: The status of netflow agent.
version Integer: Netflow version (5 or 9). 5 by default.

excludedGateways string[]: List of gateways to be excluded from logging. e.g.: ["gateway01", "gateway02", "gateway01-hagw"].
port number: Netflow server port.
serverIp string: Netflow server IP address.
status string: The status of netflow agent.
version number: Netflow version (5 or 9). 5 by default.

excluded_gateways Sequence[str]: List of gateways to be excluded from logging. e.g.: ["gateway01", "gateway02", "gateway01-hagw"].
port int: Netflow server port.
server_ip str: Netflow server IP address.
status str: The status of netflow agent.
version int: Netflow version (5 or 9). 5 by default.

excludedGateways List<String>: List of gateways to be excluded from logging. e.g.: ["gateway01", "gateway02", "gateway01-hagw"].
port Number: Netflow server port.
serverIp String: Netflow server IP address.
status String: The status of netflow agent.
version Number: Netflow version (5 or 9). 5 by default.

Import

netflow_agent can be imported using “netflow_agent”, e.g.

 $ pulumi import aviatrix:index/aviatrixNetflowAgent:AviatrixNetflowAgent test netflow_agent

Package Details

Repository: aviatrix astipkovits/pulumi-aviatrix
License: Apache-2.0
Notes: This Pulumi package is based on the aviatrix Terraform Provider.