Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Aviatrix
  3. API Docs
  4. AviatrixNetflowAgent
Aviatrix v0.0.11 published on Saturday, Jun 17, 2023 by Aviatrix
astipkovits/pulumi-aviatrix

aviatrix.AviatrixNetflowAgent

Explore with Pulumi AI

aviatrix logo
Aviatrix v0.0.11 published on Saturday, Jun 17, 2023 by Aviatrix
astipkovits/pulumi-aviatrix

    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 * 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,
});

    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)

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

    Create AviatrixNetflowAgent Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new AviatrixNetflowAgent(name: string, args: AviatrixNetflowAgentArgs, opts?: CustomResourceOptions);
    @overload
def AviatrixNetflowAgent(resource_name: str,
                         args: AviatrixNetflowAgentArgs,
                         opts: Optional[ResourceOptions] = None)

@overload
def AviatrixNetflowAgent(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         port: Optional[int] = None,
                         server_ip: Optional[str] = None,
                         excluded_gateways: Optional[Sequence[str]] = None,
                         version: Optional[int] = 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.

    Parameters

    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.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var aviatrixNetflowAgentResource = new Aviatrix.AviatrixNetflowAgent("aviatrixNetflowAgentResource", new()
{
    Port = 0,
    ServerIp = "string",
    ExcludedGateways = new[]
    {
        "string",
    },
    Version = 0,
});

    example, err := aviatrix.NewAviatrixNetflowAgent(ctx, "aviatrixNetflowAgentResource", &aviatrix.AviatrixNetflowAgentArgs{
	Port:     pulumi.Int(0),
	ServerIp: pulumi.String("string"),
	ExcludedGateways: pulumi.StringArray{
		pulumi.String("string"),
	},
	Version: pulumi.Int(0),
})

    var aviatrixNetflowAgentResource = new AviatrixNetflowAgent("aviatrixNetflowAgentResource", AviatrixNetflowAgentArgs.builder()
    .port(0)
    .serverIp("string")
    .excludedGateways("string")
    .version(0)
    .build());

    aviatrix_netflow_agent_resource = aviatrix.AviatrixNetflowAgent("aviatrixNetflowAgentResource",
    port=0,
    server_ip="string",
    excluded_gateways=["string"],
    version=0)

    const aviatrixNetflowAgentResource = new aviatrix.AviatrixNetflowAgent("aviatrixNetflowAgentResource", {
    port: 0,
    serverIp: "string",
    excludedGateways: ["string"],
    version: 0,
});

    type: aviatrix:AviatrixNetflowAgent
properties:
    excludedGateways:
        - string
    port: 0
    serverIp: string
    version: 0

    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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    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)
    resources:  _:    type: aviatrix:AviatrixNetflowAgent    get:      id: ${id}
    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

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    aviatrix astipkovits/pulumi-aviatrix
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aviatrix Terraform Provider.
    aviatrix logo
    Aviatrix v0.0.11 published on Saturday, Jun 17, 2023 by Aviatrix
    astipkovits/pulumi-aviatrix