1. Packages
  2. F5 BIG-IP
  3. API Docs
  4. ltm
  5. Node
f5 BIG-IP v3.16.0 published on Monday, Feb 19, 2024 by Pulumi

f5bigip.ltm.Node

Explore with Pulumi AI

f5bigip logo
f5 BIG-IP v3.16.0 published on Monday, Feb 19, 2024 by Pulumi

    f5bigip.ltm.Node Manages a node configuration

    For resources should be named with their full path.The full path is the combination of the partition + name of the resource( example: /Common/my-node ) or partition + Direcroty + name of the resource ( example: /Common/test/my-node ). When including directory in full path we have to make sure it is created in the given partition before using it.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using F5BigIP = Pulumi.F5BigIP;
    
    return await Deployment.RunAsync(() => 
    {
        var node = new F5BigIP.Ltm.Node("node", new()
        {
            Address = "192.168.30.1",
            ConnectionLimit = 0,
            Description = "Test-Node",
            DynamicRatio = 1,
            Fqdn = new F5BigIP.Ltm.Inputs.NodeFqdnArgs
            {
                AddressFamily = "ipv4",
                Interval = "3000",
            },
            Monitor = "/Common/icmp",
            Name = "/Common/terraform_node1",
            RateLimit = "disabled",
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-f5bigip/sdk/v3/go/f5bigip/ltm"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := ltm.NewNode(ctx, "node", &ltm.NodeArgs{
    			Address:         pulumi.String("192.168.30.1"),
    			ConnectionLimit: pulumi.Int(0),
    			Description:     pulumi.String("Test-Node"),
    			DynamicRatio:    pulumi.Int(1),
    			Fqdn: &ltm.NodeFqdnArgs{
    				AddressFamily: pulumi.String("ipv4"),
    				Interval:      pulumi.String("3000"),
    			},
    			Monitor:   pulumi.String("/Common/icmp"),
    			Name:      pulumi.String("/Common/terraform_node1"),
    			RateLimit: pulumi.String("disabled"),
    		})
    		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.f5bigip.ltm.Node;
    import com.pulumi.f5bigip.ltm.NodeArgs;
    import com.pulumi.f5bigip.ltm.inputs.NodeFqdnArgs;
    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 node = new Node("node", NodeArgs.builder()        
                .address("192.168.30.1")
                .connectionLimit("0")
                .description("Test-Node")
                .dynamicRatio("1")
                .fqdn(NodeFqdnArgs.builder()
                    .addressFamily("ipv4")
                    .interval("3000")
                    .build())
                .monitor("/Common/icmp")
                .name("/Common/terraform_node1")
                .rateLimit("disabled")
                .build());
    
        }
    }
    
    import pulumi
    import pulumi_f5bigip as f5bigip
    
    node = f5bigip.ltm.Node("node",
        address="192.168.30.1",
        connection_limit=0,
        description="Test-Node",
        dynamic_ratio=1,
        fqdn=f5bigip.ltm.NodeFqdnArgs(
            address_family="ipv4",
            interval="3000",
        ),
        monitor="/Common/icmp",
        name="/Common/terraform_node1",
        rate_limit="disabled")
    
    import * as pulumi from "@pulumi/pulumi";
    import * as f5bigip from "@pulumi/f5bigip";
    
    const node = new f5bigip.ltm.Node("node", {
        address: "192.168.30.1",
        connectionLimit: 0,
        description: "Test-Node",
        dynamicRatio: 1,
        fqdn: {
            addressFamily: "ipv4",
            interval: "3000",
        },
        monitor: "/Common/icmp",
        name: "/Common/terraform_node1",
        rateLimit: "disabled",
    });
    
    resources:
      node:
        type: f5bigip:ltm:Node
        properties:
          address: 192.168.30.1
          connectionLimit: '0'
          description: Test-Node
          dynamicRatio: '1'
          fqdn:
            addressFamily: ipv4
            interval: '3000'
          monitor: /Common/icmp
          name: /Common/terraform_node1
          rateLimit: disabled
    

    Create Node Resource

    new Node(name: string, args: NodeArgs, opts?: CustomResourceOptions);
    @overload
    def Node(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             address: Optional[str] = None,
             connection_limit: Optional[int] = None,
             description: Optional[str] = None,
             dynamic_ratio: Optional[int] = None,
             fqdn: Optional[NodeFqdnArgs] = None,
             monitor: Optional[str] = None,
             name: Optional[str] = None,
             rate_limit: Optional[str] = None,
             ratio: Optional[int] = None,
             session: Optional[str] = None,
             state: Optional[str] = None)
    @overload
    def Node(resource_name: str,
             args: NodeArgs,
             opts: Optional[ResourceOptions] = None)
    func NewNode(ctx *Context, name string, args NodeArgs, opts ...ResourceOption) (*Node, error)
    public Node(string name, NodeArgs args, CustomResourceOptions? opts = null)
    public Node(String name, NodeArgs args)
    public Node(String name, NodeArgs args, CustomResourceOptions options)
    
    type: f5bigip:ltm:Node
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    name string
    The unique name of the resource.
    args NodeArgs
    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 NodeArgs
    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 NodeArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NodeArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NodeArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    Address string
    IP or hostname of the node
    Name string
    Name of the node
    ConnectionLimit int
    Specifies the maximum number of connections allowed for the node or node address.
    Description string
    User-defined description give ltm_node
    DynamicRatio int
    Specifies the fixed ratio value used for a node during ratio load balancing.
    Fqdn Pulumi.F5BigIP.Ltm.Inputs.NodeFqdn
    Monitor string
    specifies the name of the monitor or monitor rule that you want to associate with the node.
    RateLimit string
    Specifies the maximum number of connections per second allowed for a node or node address. The default value is 'disabled'.
    Ratio int
    Sets the ratio number for the node.
    Session string
    Enables or disables the node for new sessions. The default value is user-enabled.
    State string

    Default is "user-up" you can set to "user-down" if you want to disable

    NOTE Below attributes needs to be configured under fqdn option.

    Address string
    IP or hostname of the node
    Name string
    Name of the node
    ConnectionLimit int
    Specifies the maximum number of connections allowed for the node or node address.
    Description string
    User-defined description give ltm_node
    DynamicRatio int
    Specifies the fixed ratio value used for a node during ratio load balancing.
    Fqdn NodeFqdnArgs
    Monitor string
    specifies the name of the monitor or monitor rule that you want to associate with the node.
    RateLimit string
    Specifies the maximum number of connections per second allowed for a node or node address. The default value is 'disabled'.
    Ratio int
    Sets the ratio number for the node.
    Session string
    Enables or disables the node for new sessions. The default value is user-enabled.
    State string

    Default is "user-up" you can set to "user-down" if you want to disable

    NOTE Below attributes needs to be configured under fqdn option.

    address String
    IP or hostname of the node
    name String
    Name of the node
    connectionLimit Integer
    Specifies the maximum number of connections allowed for the node or node address.
    description String
    User-defined description give ltm_node
    dynamicRatio Integer
    Specifies the fixed ratio value used for a node during ratio load balancing.
    fqdn NodeFqdn
    monitor String
    specifies the name of the monitor or monitor rule that you want to associate with the node.
    rateLimit String
    Specifies the maximum number of connections per second allowed for a node or node address. The default value is 'disabled'.
    ratio Integer
    Sets the ratio number for the node.
    session String
    Enables or disables the node for new sessions. The default value is user-enabled.
    state String

    Default is "user-up" you can set to "user-down" if you want to disable

    NOTE Below attributes needs to be configured under fqdn option.

    address string
    IP or hostname of the node
    name string
    Name of the node
    connectionLimit number
    Specifies the maximum number of connections allowed for the node or node address.
    description string
    User-defined description give ltm_node
    dynamicRatio number
    Specifies the fixed ratio value used for a node during ratio load balancing.
    fqdn NodeFqdn
    monitor string
    specifies the name of the monitor or monitor rule that you want to associate with the node.
    rateLimit string
    Specifies the maximum number of connections per second allowed for a node or node address. The default value is 'disabled'.
    ratio number
    Sets the ratio number for the node.
    session string
    Enables or disables the node for new sessions. The default value is user-enabled.
    state string

    Default is "user-up" you can set to "user-down" if you want to disable

    NOTE Below attributes needs to be configured under fqdn option.

    address str
    IP or hostname of the node
    name str
    Name of the node
    connection_limit int
    Specifies the maximum number of connections allowed for the node or node address.
    description str
    User-defined description give ltm_node
    dynamic_ratio int
    Specifies the fixed ratio value used for a node during ratio load balancing.
    fqdn NodeFqdnArgs
    monitor str
    specifies the name of the monitor or monitor rule that you want to associate with the node.
    rate_limit str
    Specifies the maximum number of connections per second allowed for a node or node address. The default value is 'disabled'.
    ratio int
    Sets the ratio number for the node.
    session str
    Enables or disables the node for new sessions. The default value is user-enabled.
    state str

    Default is "user-up" you can set to "user-down" if you want to disable

    NOTE Below attributes needs to be configured under fqdn option.

    address String
    IP or hostname of the node
    name String
    Name of the node
    connectionLimit Number
    Specifies the maximum number of connections allowed for the node or node address.
    description String
    User-defined description give ltm_node
    dynamicRatio Number
    Specifies the fixed ratio value used for a node during ratio load balancing.
    fqdn Property Map
    monitor String
    specifies the name of the monitor or monitor rule that you want to associate with the node.
    rateLimit String
    Specifies the maximum number of connections per second allowed for a node or node address. The default value is 'disabled'.
    ratio Number
    Sets the ratio number for the node.
    session String
    Enables or disables the node for new sessions. The default value is user-enabled.
    state String

    Default is "user-up" you can set to "user-down" if you want to disable

    NOTE Below attributes needs to be configured under fqdn option.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Node 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 Node Resource

    Get an existing Node 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?: NodeState, opts?: CustomResourceOptions): Node
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            address: Optional[str] = None,
            connection_limit: Optional[int] = None,
            description: Optional[str] = None,
            dynamic_ratio: Optional[int] = None,
            fqdn: Optional[NodeFqdnArgs] = None,
            monitor: Optional[str] = None,
            name: Optional[str] = None,
            rate_limit: Optional[str] = None,
            ratio: Optional[int] = None,
            session: Optional[str] = None,
            state: Optional[str] = None) -> Node
    func GetNode(ctx *Context, name string, id IDInput, state *NodeState, opts ...ResourceOption) (*Node, error)
    public static Node Get(string name, Input<string> id, NodeState? state, CustomResourceOptions? opts = null)
    public static Node get(String name, Output<String> id, NodeState 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:
    Address string
    IP or hostname of the node
    ConnectionLimit int
    Specifies the maximum number of connections allowed for the node or node address.
    Description string
    User-defined description give ltm_node
    DynamicRatio int
    Specifies the fixed ratio value used for a node during ratio load balancing.
    Fqdn Pulumi.F5BigIP.Ltm.Inputs.NodeFqdn
    Monitor string
    specifies the name of the monitor or monitor rule that you want to associate with the node.
    Name string
    Name of the node
    RateLimit string
    Specifies the maximum number of connections per second allowed for a node or node address. The default value is 'disabled'.
    Ratio int
    Sets the ratio number for the node.
    Session string
    Enables or disables the node for new sessions. The default value is user-enabled.
    State string

    Default is "user-up" you can set to "user-down" if you want to disable

    NOTE Below attributes needs to be configured under fqdn option.

    Address string
    IP or hostname of the node
    ConnectionLimit int
    Specifies the maximum number of connections allowed for the node or node address.
    Description string
    User-defined description give ltm_node
    DynamicRatio int
    Specifies the fixed ratio value used for a node during ratio load balancing.
    Fqdn NodeFqdnArgs
    Monitor string
    specifies the name of the monitor or monitor rule that you want to associate with the node.
    Name string
    Name of the node
    RateLimit string
    Specifies the maximum number of connections per second allowed for a node or node address. The default value is 'disabled'.
    Ratio int
    Sets the ratio number for the node.
    Session string
    Enables or disables the node for new sessions. The default value is user-enabled.
    State string

    Default is "user-up" you can set to "user-down" if you want to disable

    NOTE Below attributes needs to be configured under fqdn option.

    address String
    IP or hostname of the node
    connectionLimit Integer
    Specifies the maximum number of connections allowed for the node or node address.
    description String
    User-defined description give ltm_node
    dynamicRatio Integer
    Specifies the fixed ratio value used for a node during ratio load balancing.
    fqdn NodeFqdn
    monitor String
    specifies the name of the monitor or monitor rule that you want to associate with the node.
    name String
    Name of the node
    rateLimit String
    Specifies the maximum number of connections per second allowed for a node or node address. The default value is 'disabled'.
    ratio Integer
    Sets the ratio number for the node.
    session String
    Enables or disables the node for new sessions. The default value is user-enabled.
    state String

    Default is "user-up" you can set to "user-down" if you want to disable

    NOTE Below attributes needs to be configured under fqdn option.

    address string
    IP or hostname of the node
    connectionLimit number
    Specifies the maximum number of connections allowed for the node or node address.
    description string
    User-defined description give ltm_node
    dynamicRatio number
    Specifies the fixed ratio value used for a node during ratio load balancing.
    fqdn NodeFqdn
    monitor string
    specifies the name of the monitor or monitor rule that you want to associate with the node.
    name string
    Name of the node
    rateLimit string
    Specifies the maximum number of connections per second allowed for a node or node address. The default value is 'disabled'.
    ratio number
    Sets the ratio number for the node.
    session string
    Enables or disables the node for new sessions. The default value is user-enabled.
    state string

    Default is "user-up" you can set to "user-down" if you want to disable

    NOTE Below attributes needs to be configured under fqdn option.

    address str
    IP or hostname of the node
    connection_limit int
    Specifies the maximum number of connections allowed for the node or node address.
    description str
    User-defined description give ltm_node
    dynamic_ratio int
    Specifies the fixed ratio value used for a node during ratio load balancing.
    fqdn NodeFqdnArgs
    monitor str
    specifies the name of the monitor or monitor rule that you want to associate with the node.
    name str
    Name of the node
    rate_limit str
    Specifies the maximum number of connections per second allowed for a node or node address. The default value is 'disabled'.
    ratio int
    Sets the ratio number for the node.
    session str
    Enables or disables the node for new sessions. The default value is user-enabled.
    state str

    Default is "user-up" you can set to "user-down" if you want to disable

    NOTE Below attributes needs to be configured under fqdn option.

    address String
    IP or hostname of the node
    connectionLimit Number
    Specifies the maximum number of connections allowed for the node or node address.
    description String
    User-defined description give ltm_node
    dynamicRatio Number
    Specifies the fixed ratio value used for a node during ratio load balancing.
    fqdn Property Map
    monitor String
    specifies the name of the monitor or monitor rule that you want to associate with the node.
    name String
    Name of the node
    rateLimit String
    Specifies the maximum number of connections per second allowed for a node or node address. The default value is 'disabled'.
    ratio Number
    Sets the ratio number for the node.
    session String
    Enables or disables the node for new sessions. The default value is user-enabled.
    state String

    Default is "user-up" you can set to "user-down" if you want to disable

    NOTE Below attributes needs to be configured under fqdn option.

    Supporting Types

    NodeFqdn, NodeFqdnArgs

    AddressFamily string
    Specifies the node's address family. The default is 'unspecified', or IP-agnostic. This needs to be specified inside the fqdn (fully qualified domain name).
    Autopopulate string
    Specifies whether the node should scale to the IP address set returned by DNS.
    Downinterval int
    Specifies the number of attempts to resolve a domain name. The default is 5.
    Interval string
    Specifies the amount of time before sending the next DNS query. Default is 3600. This needs to be specified inside the fqdn (fully qualified domain name).
    Name string
    Name of the node
    AddressFamily string
    Specifies the node's address family. The default is 'unspecified', or IP-agnostic. This needs to be specified inside the fqdn (fully qualified domain name).
    Autopopulate string
    Specifies whether the node should scale to the IP address set returned by DNS.
    Downinterval int
    Specifies the number of attempts to resolve a domain name. The default is 5.
    Interval string
    Specifies the amount of time before sending the next DNS query. Default is 3600. This needs to be specified inside the fqdn (fully qualified domain name).
    Name string
    Name of the node
    addressFamily String
    Specifies the node's address family. The default is 'unspecified', or IP-agnostic. This needs to be specified inside the fqdn (fully qualified domain name).
    autopopulate String
    Specifies whether the node should scale to the IP address set returned by DNS.
    downinterval Integer
    Specifies the number of attempts to resolve a domain name. The default is 5.
    interval String
    Specifies the amount of time before sending the next DNS query. Default is 3600. This needs to be specified inside the fqdn (fully qualified domain name).
    name String
    Name of the node
    addressFamily string
    Specifies the node's address family. The default is 'unspecified', or IP-agnostic. This needs to be specified inside the fqdn (fully qualified domain name).
    autopopulate string
    Specifies whether the node should scale to the IP address set returned by DNS.
    downinterval number
    Specifies the number of attempts to resolve a domain name. The default is 5.
    interval string
    Specifies the amount of time before sending the next DNS query. Default is 3600. This needs to be specified inside the fqdn (fully qualified domain name).
    name string
    Name of the node
    address_family str
    Specifies the node's address family. The default is 'unspecified', or IP-agnostic. This needs to be specified inside the fqdn (fully qualified domain name).
    autopopulate str
    Specifies whether the node should scale to the IP address set returned by DNS.
    downinterval int
    Specifies the number of attempts to resolve a domain name. The default is 5.
    interval str
    Specifies the amount of time before sending the next DNS query. Default is 3600. This needs to be specified inside the fqdn (fully qualified domain name).
    name str
    Name of the node
    addressFamily String
    Specifies the node's address family. The default is 'unspecified', or IP-agnostic. This needs to be specified inside the fqdn (fully qualified domain name).
    autopopulate String
    Specifies whether the node should scale to the IP address set returned by DNS.
    downinterval Number
    Specifies the number of attempts to resolve a domain name. The default is 5.
    interval String
    Specifies the amount of time before sending the next DNS query. Default is 3600. This needs to be specified inside the fqdn (fully qualified domain name).
    name String
    Name of the node

    Package Details

    Repository
    f5 BIG-IP pulumi/pulumi-f5bigip
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the bigip Terraform Provider.
    f5bigip logo
    f5 BIG-IP v3.16.0 published on Monday, Feb 19, 2024 by Pulumi