Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Meraki Provider
  3. API Docs
  4. networks
  5. Netflow
Cisco Meraki v0.3.2 published on Tuesday, Sep 24, 2024 by Pulumi
pulumi/pulumi-meraki

meraki.networks.Netflow

Explore with Pulumi AI

meraki logo
Cisco Meraki v0.3.2 published on Tuesday, Sep 24, 2024 by Pulumi
pulumi/pulumi-meraki

    Example Usage

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

const example = new meraki.networks.Netflow("example", {
    collectorIp: "1.2.3.4",
    collectorPort: 443,
    etaDstPort: 443,
    etaEnabled: true,
    networkId: "string",
    reportingEnabled: true,
});
export const merakiNetworksNetflowExample = example;

    import pulumi
import pulumi_meraki as meraki

example = meraki.networks.Netflow("example",
    collector_ip="1.2.3.4",
    collector_port=443,
    eta_dst_port=443,
    eta_enabled=True,
    network_id="string",
    reporting_enabled=True)
pulumi.export("merakiNetworksNetflowExample", example)

    package main

import (
	"github.com/pulumi/pulumi-meraki/sdk/go/meraki/networks"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := networks.NewNetflow(ctx, "example", &networks.NetflowArgs{
			CollectorIp:      pulumi.String("1.2.3.4"),
			CollectorPort:    pulumi.Int(443),
			EtaDstPort:       pulumi.Int(443),
			EtaEnabled:       pulumi.Bool(true),
			NetworkId:        pulumi.String("string"),
			ReportingEnabled: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		ctx.Export("merakiNetworksNetflowExample", example)
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Meraki = Pulumi.Meraki;

return await Deployment.RunAsync(() => 
{
    var example = new Meraki.Networks.Netflow("example", new()
    {
        CollectorIp = "1.2.3.4",
        CollectorPort = 443,
        EtaDstPort = 443,
        EtaEnabled = true,
        NetworkId = "string",
        ReportingEnabled = true,
    });

    return new Dictionary<string, object?>
    {
        ["merakiNetworksNetflowExample"] = example,
    };
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.meraki.networks.Netflow;
import com.pulumi.meraki.networks.NetflowArgs;
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 example = new Netflow("example", NetflowArgs.builder()
            .collectorIp("1.2.3.4")
            .collectorPort(443)
            .etaDstPort(443)
            .etaEnabled(true)
            .networkId("string")
            .reportingEnabled(true)
            .build());

        ctx.export("merakiNetworksNetflowExample", example);
    }
}

    resources:
  example:
    type: meraki:networks:Netflow
    properties:
      collectorIp: 1.2.3.4
      collectorPort: 443
      etaDstPort: 443
      etaEnabled: true
      networkId: string
      reportingEnabled: true
outputs:
  merakiNetworksNetflowExample: ${example}

    Create Netflow Resource

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

    Constructor syntax

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

@overload
def Netflow(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            network_id: Optional[str] = None,
            collector_ip: Optional[str] = None,
            collector_port: Optional[int] = None,
            eta_dst_port: Optional[int] = None,
            eta_enabled: Optional[bool] = None,
            reporting_enabled: Optional[bool] = None)
    func NewNetflow(ctx *Context, name string, args NetflowArgs, opts ...ResourceOption) (*Netflow, error)
    public Netflow(string name, NetflowArgs args, CustomResourceOptions? opts = null)
    public Netflow(String name, NetflowArgs args)
public Netflow(String name, NetflowArgs args, CustomResourceOptions options)

    type: meraki:networks:Netflow
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 NetflowArgs
    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 NetflowArgs
    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 NetflowArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NetflowArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NetflowArgs
    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 netflowResource = new Meraki.Networks.Netflow("netflowResource", new()
{
    NetworkId = "string",
    CollectorIp = "string",
    CollectorPort = 0,
    EtaDstPort = 0,
    EtaEnabled = false,
    ReportingEnabled = false,
});

    example, err := networks.NewNetflow(ctx, "netflowResource", &networks.NetflowArgs{
	NetworkId:        pulumi.String("string"),
	CollectorIp:      pulumi.String("string"),
	CollectorPort:    pulumi.Int(0),
	EtaDstPort:       pulumi.Int(0),
	EtaEnabled:       pulumi.Bool(false),
	ReportingEnabled: pulumi.Bool(false),
})

    var netflowResource = new Netflow("netflowResource", NetflowArgs.builder()
    .networkId("string")
    .collectorIp("string")
    .collectorPort(0)
    .etaDstPort(0)
    .etaEnabled(false)
    .reportingEnabled(false)
    .build());

    netflow_resource = meraki.networks.Netflow("netflowResource",
    network_id="string",
    collector_ip="string",
    collector_port=0,
    eta_dst_port=0,
    eta_enabled=False,
    reporting_enabled=False)

    const netflowResource = new meraki.networks.Netflow("netflowResource", {
    networkId: "string",
    collectorIp: "string",
    collectorPort: 0,
    etaDstPort: 0,
    etaEnabled: false,
    reportingEnabled: false,
});

    type: meraki:networks:Netflow
properties:
    collectorIp: string
    collectorPort: 0
    etaDstPort: 0
    etaEnabled: false
    networkId: string
    reportingEnabled: false

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

    NetworkId string
    networkId path parameter. Network ID
    CollectorIp string
    The IPv4 address of the NetFlow collector.
    CollectorPort int
    The port that the NetFlow collector will be listening on.
    EtaDstPort int
    The port that the Encrypted Traffic Analytics collector will be listening on.
    EtaEnabled bool
    Boolean indicating whether Encrypted Traffic Analytics is enabled (true) or disabled (false).
    ReportingEnabled bool
    Boolean indicating whether NetFlow traffic reporting is enabled (true) or disabled (false).
    NetworkId string
    networkId path parameter. Network ID
    CollectorIp string
    The IPv4 address of the NetFlow collector.
    CollectorPort int
    The port that the NetFlow collector will be listening on.
    EtaDstPort int
    The port that the Encrypted Traffic Analytics collector will be listening on.
    EtaEnabled bool
    Boolean indicating whether Encrypted Traffic Analytics is enabled (true) or disabled (false).
    ReportingEnabled bool
    Boolean indicating whether NetFlow traffic reporting is enabled (true) or disabled (false).
    networkId String
    networkId path parameter. Network ID
    collectorIp String
    The IPv4 address of the NetFlow collector.
    collectorPort Integer
    The port that the NetFlow collector will be listening on.
    etaDstPort Integer
    The port that the Encrypted Traffic Analytics collector will be listening on.
    etaEnabled Boolean
    Boolean indicating whether Encrypted Traffic Analytics is enabled (true) or disabled (false).
    reportingEnabled Boolean
    Boolean indicating whether NetFlow traffic reporting is enabled (true) or disabled (false).
    networkId string
    networkId path parameter. Network ID
    collectorIp string
    The IPv4 address of the NetFlow collector.
    collectorPort number
    The port that the NetFlow collector will be listening on.
    etaDstPort number
    The port that the Encrypted Traffic Analytics collector will be listening on.
    etaEnabled boolean
    Boolean indicating whether Encrypted Traffic Analytics is enabled (true) or disabled (false).
    reportingEnabled boolean
    Boolean indicating whether NetFlow traffic reporting is enabled (true) or disabled (false).
    network_id str
    networkId path parameter. Network ID
    collector_ip str
    The IPv4 address of the NetFlow collector.
    collector_port int
    The port that the NetFlow collector will be listening on.
    eta_dst_port int
    The port that the Encrypted Traffic Analytics collector will be listening on.
    eta_enabled bool
    Boolean indicating whether Encrypted Traffic Analytics is enabled (true) or disabled (false).
    reporting_enabled bool
    Boolean indicating whether NetFlow traffic reporting is enabled (true) or disabled (false).
    networkId String
    networkId path parameter. Network ID
    collectorIp String
    The IPv4 address of the NetFlow collector.
    collectorPort Number
    The port that the NetFlow collector will be listening on.
    etaDstPort Number
    The port that the Encrypted Traffic Analytics collector will be listening on.
    etaEnabled Boolean
    Boolean indicating whether Encrypted Traffic Analytics is enabled (true) or disabled (false).
    reportingEnabled Boolean
    Boolean indicating whether NetFlow traffic reporting is enabled (true) or disabled (false).

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Netflow Resource

    Get an existing Netflow 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?: NetflowState, opts?: CustomResourceOptions): Netflow
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        collector_ip: Optional[str] = None,
        collector_port: Optional[int] = None,
        eta_dst_port: Optional[int] = None,
        eta_enabled: Optional[bool] = None,
        network_id: Optional[str] = None,
        reporting_enabled: Optional[bool] = None) -> Netflow
    func GetNetflow(ctx *Context, name string, id IDInput, state *NetflowState, opts ...ResourceOption) (*Netflow, error)
    public static Netflow Get(string name, Input<string> id, NetflowState? state, CustomResourceOptions? opts = null)
    public static Netflow get(String name, Output<String> id, NetflowState 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:
    CollectorIp string
    The IPv4 address of the NetFlow collector.
    CollectorPort int
    The port that the NetFlow collector will be listening on.
    EtaDstPort int
    The port that the Encrypted Traffic Analytics collector will be listening on.
    EtaEnabled bool
    Boolean indicating whether Encrypted Traffic Analytics is enabled (true) or disabled (false).
    NetworkId string
    networkId path parameter. Network ID
    ReportingEnabled bool
    Boolean indicating whether NetFlow traffic reporting is enabled (true) or disabled (false).
    CollectorIp string
    The IPv4 address of the NetFlow collector.
    CollectorPort int
    The port that the NetFlow collector will be listening on.
    EtaDstPort int
    The port that the Encrypted Traffic Analytics collector will be listening on.
    EtaEnabled bool
    Boolean indicating whether Encrypted Traffic Analytics is enabled (true) or disabled (false).
    NetworkId string
    networkId path parameter. Network ID
    ReportingEnabled bool
    Boolean indicating whether NetFlow traffic reporting is enabled (true) or disabled (false).
    collectorIp String
    The IPv4 address of the NetFlow collector.
    collectorPort Integer
    The port that the NetFlow collector will be listening on.
    etaDstPort Integer
    The port that the Encrypted Traffic Analytics collector will be listening on.
    etaEnabled Boolean
    Boolean indicating whether Encrypted Traffic Analytics is enabled (true) or disabled (false).
    networkId String
    networkId path parameter. Network ID
    reportingEnabled Boolean
    Boolean indicating whether NetFlow traffic reporting is enabled (true) or disabled (false).
    collectorIp string
    The IPv4 address of the NetFlow collector.
    collectorPort number
    The port that the NetFlow collector will be listening on.
    etaDstPort number
    The port that the Encrypted Traffic Analytics collector will be listening on.
    etaEnabled boolean
    Boolean indicating whether Encrypted Traffic Analytics is enabled (true) or disabled (false).
    networkId string
    networkId path parameter. Network ID
    reportingEnabled boolean
    Boolean indicating whether NetFlow traffic reporting is enabled (true) or disabled (false).
    collector_ip str
    The IPv4 address of the NetFlow collector.
    collector_port int
    The port that the NetFlow collector will be listening on.
    eta_dst_port int
    The port that the Encrypted Traffic Analytics collector will be listening on.
    eta_enabled bool
    Boolean indicating whether Encrypted Traffic Analytics is enabled (true) or disabled (false).
    network_id str
    networkId path parameter. Network ID
    reporting_enabled bool
    Boolean indicating whether NetFlow traffic reporting is enabled (true) or disabled (false).
    collectorIp String
    The IPv4 address of the NetFlow collector.
    collectorPort Number
    The port that the NetFlow collector will be listening on.
    etaDstPort Number
    The port that the Encrypted Traffic Analytics collector will be listening on.
    etaEnabled Boolean
    Boolean indicating whether Encrypted Traffic Analytics is enabled (true) or disabled (false).
    networkId String
    networkId path parameter. Network ID
    reportingEnabled Boolean
    Boolean indicating whether NetFlow traffic reporting is enabled (true) or disabled (false).

    Import

    $ pulumi import meraki:networks/netflow:Netflow example "network_id"

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

    Package Details

    Repository
    meraki pulumi/pulumi-meraki
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the meraki Terraform Provider.
    meraki logo
    Cisco Meraki v0.3.2 published on Tuesday, Sep 24, 2024 by Pulumi
    pulumi/pulumi-meraki