1. Packages
  2. Powerscale Provider
  3. API Docs
  4. getNetworkpool
powerscale 1.7.1 published on Wednesday, Apr 30, 2025 by dell

powerscale.getNetworkpool

Explore with Pulumi AI

powerscale logo
powerscale 1.7.1 published on Wednesday, Apr 30, 2025 by dell

    This datasource is used to query the existing network pools from PowerScale array. The information fetched from this datasource can be used for getting the details or for further processing in resource block. You can add network interfaces to network pools to associate address ranges with a node or a group of nodes.

    Using getNetworkpool

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getNetworkpool(args: GetNetworkpoolArgs, opts?: InvokeOptions): Promise<GetNetworkpoolResult>
    function getNetworkpoolOutput(args: GetNetworkpoolOutputArgs, opts?: InvokeOptions): Output<GetNetworkpoolResult>
    def get_networkpool(filter: Optional[GetNetworkpoolFilter] = None,
                        opts: Optional[InvokeOptions] = None) -> GetNetworkpoolResult
    def get_networkpool_output(filter: Optional[pulumi.Input[GetNetworkpoolFilterArgs]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetNetworkpoolResult]
    func LookupNetworkpool(ctx *Context, args *LookupNetworkpoolArgs, opts ...InvokeOption) (*LookupNetworkpoolResult, error)
    func LookupNetworkpoolOutput(ctx *Context, args *LookupNetworkpoolOutputArgs, opts ...InvokeOption) LookupNetworkpoolResultOutput

    > Note: This function is named LookupNetworkpool in the Go SDK.

    public static class GetNetworkpool 
    {
        public static Task<GetNetworkpoolResult> InvokeAsync(GetNetworkpoolArgs args, InvokeOptions? opts = null)
        public static Output<GetNetworkpoolResult> Invoke(GetNetworkpoolInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetNetworkpoolResult> getNetworkpool(GetNetworkpoolArgs args, InvokeOptions options)
    public static Output<GetNetworkpoolResult> getNetworkpool(GetNetworkpoolArgs args, InvokeOptions options)
    
    fn::invoke:
      function: powerscale:index/getNetworkpool:getNetworkpool
      arguments:
        # arguments dictionary

    The following arguments are supported:

    getNetworkpool Result

    The following output properties are available:

    Id string
    Unique identifier of the network pool instance.
    NetworkPoolsDetails List<GetNetworkpoolNetworkPoolsDetail>
    List of Network Pools.
    Filter GetNetworkpoolFilter
    Id string
    Unique identifier of the network pool instance.
    NetworkPoolsDetails []GetNetworkpoolNetworkPoolsDetail
    List of Network Pools.
    Filter GetNetworkpoolFilter
    id String
    Unique identifier of the network pool instance.
    networkPoolsDetails List<GetNetworkpoolNetworkPoolsDetail>
    List of Network Pools.
    filter GetNetworkpoolFilter
    id string
    Unique identifier of the network pool instance.
    networkPoolsDetails GetNetworkpoolNetworkPoolsDetail[]
    List of Network Pools.
    filter GetNetworkpoolFilter
    id str
    Unique identifier of the network pool instance.
    network_pools_details Sequence[GetNetworkpoolNetworkPoolsDetail]
    List of Network Pools.
    filter GetNetworkpoolFilter
    id String
    Unique identifier of the network pool instance.
    networkPoolsDetails List<Property Map>
    List of Network Pools.
    filter Property Map

    Supporting Types

    GetNetworkpoolFilter

    AccessZone string
    If specified, only pools with this zone name will be returned.
    AllocMethod string
    If specified, only pools with this allocation type will be returned.
    Groupnet string
    If specified, only pools for this groupnet will be returned.
    Names List<string>
    Filter network pools by names.
    Subnet string
    If specified, only pools for this subnet will be returned.
    AccessZone string
    If specified, only pools with this zone name will be returned.
    AllocMethod string
    If specified, only pools with this allocation type will be returned.
    Groupnet string
    If specified, only pools for this groupnet will be returned.
    Names []string
    Filter network pools by names.
    Subnet string
    If specified, only pools for this subnet will be returned.
    accessZone String
    If specified, only pools with this zone name will be returned.
    allocMethod String
    If specified, only pools with this allocation type will be returned.
    groupnet String
    If specified, only pools for this groupnet will be returned.
    names List<String>
    Filter network pools by names.
    subnet String
    If specified, only pools for this subnet will be returned.
    accessZone string
    If specified, only pools with this zone name will be returned.
    allocMethod string
    If specified, only pools with this allocation type will be returned.
    groupnet string
    If specified, only pools for this groupnet will be returned.
    names string[]
    Filter network pools by names.
    subnet string
    If specified, only pools for this subnet will be returned.
    access_zone str
    If specified, only pools with this zone name will be returned.
    alloc_method str
    If specified, only pools with this allocation type will be returned.
    groupnet str
    If specified, only pools for this groupnet will be returned.
    names Sequence[str]
    Filter network pools by names.
    subnet str
    If specified, only pools for this subnet will be returned.
    accessZone String
    If specified, only pools with this zone name will be returned.
    allocMethod String
    If specified, only pools with this allocation type will be returned.
    groupnet String
    If specified, only pools for this groupnet will be returned.
    names List<String>
    Filter network pools by names.
    subnet String
    If specified, only pools for this subnet will be returned.

    GetNetworkpoolNetworkPoolsDetail

    AccessZone string
    Name of a valid access zone to map IP address pool to the zone.
    AddrFamily string
    IP address format.
    AggregationMode string
    OneFS supports the following NIC aggregation modes.
    AllocMethod string
    Specifies how IP address allocation is done among pool members.
    Description string
    A description of the pool.
    Groupnet string
    Name of the groupnet this pool belongs to.
    Id string
    Unique Pool ID.
    Ifaces List<GetNetworkpoolNetworkPoolsDetailIface>
    List of interface members in this pool.
    Name string
    The name of the pool. It must be unique throughout the given subnet.It's a required field with POST method.
    Nfsv3RroceOnly bool
    Indicates that pool contains only RDMA RRoCE capable interfaces.
    Ranges List<GetNetworkpoolNetworkPoolsDetailRange>
    List of IP address ranges in this pool.
    RebalancePolicy string
    Rebalance policy..
    Rules List<string>
    Names of the rules in this pool.
    ScAutoUnsuspendDelay double
    Time delay in seconds before a node which has been automatically unsuspended becomes usable in SmartConnect responses for pool zones.
    ScConnectPolicy string
    SmartConnect client connection balancing policy.
    ScDnsZone string
    SmartConnect zone name for the pool.
    ScDnsZoneAliases List<string>
    List of SmartConnect zone aliases (DNS names) to the pool.
    ScFailoverPolicy string
    SmartConnect IP failover policy.
    ScSubnet string
    Name of SmartConnect service subnet for this pool.
    ScSuspendedNodes List<double>
    List of LNNs showing currently suspended nodes in SmartConnect.
    ScTtl double
    Time to live value for SmartConnect DNS query responses in seconds.
    StaticRoutes List<GetNetworkpoolNetworkPoolsDetailStaticRoute>
    List of interface members in this pool.
    Subnet string
    The name of the subnet.
    AccessZone string
    Name of a valid access zone to map IP address pool to the zone.
    AddrFamily string
    IP address format.
    AggregationMode string
    OneFS supports the following NIC aggregation modes.
    AllocMethod string
    Specifies how IP address allocation is done among pool members.
    Description string
    A description of the pool.
    Groupnet string
    Name of the groupnet this pool belongs to.
    Id string
    Unique Pool ID.
    Ifaces []GetNetworkpoolNetworkPoolsDetailIface
    List of interface members in this pool.
    Name string
    The name of the pool. It must be unique throughout the given subnet.It's a required field with POST method.
    Nfsv3RroceOnly bool
    Indicates that pool contains only RDMA RRoCE capable interfaces.
    Ranges []GetNetworkpoolNetworkPoolsDetailRange
    List of IP address ranges in this pool.
    RebalancePolicy string
    Rebalance policy..
    Rules []string
    Names of the rules in this pool.
    ScAutoUnsuspendDelay float64
    Time delay in seconds before a node which has been automatically unsuspended becomes usable in SmartConnect responses for pool zones.
    ScConnectPolicy string
    SmartConnect client connection balancing policy.
    ScDnsZone string
    SmartConnect zone name for the pool.
    ScDnsZoneAliases []string
    List of SmartConnect zone aliases (DNS names) to the pool.
    ScFailoverPolicy string
    SmartConnect IP failover policy.
    ScSubnet string
    Name of SmartConnect service subnet for this pool.
    ScSuspendedNodes []float64
    List of LNNs showing currently suspended nodes in SmartConnect.
    ScTtl float64
    Time to live value for SmartConnect DNS query responses in seconds.
    StaticRoutes []GetNetworkpoolNetworkPoolsDetailStaticRoute
    List of interface members in this pool.
    Subnet string
    The name of the subnet.
    accessZone String
    Name of a valid access zone to map IP address pool to the zone.
    addrFamily String
    IP address format.
    aggregationMode String
    OneFS supports the following NIC aggregation modes.
    allocMethod String
    Specifies how IP address allocation is done among pool members.
    description String
    A description of the pool.
    groupnet String
    Name of the groupnet this pool belongs to.
    id String
    Unique Pool ID.
    ifaces List<GetNetworkpoolNetworkPoolsDetailIface>
    List of interface members in this pool.
    name String
    The name of the pool. It must be unique throughout the given subnet.It's a required field with POST method.
    nfsv3RroceOnly Boolean
    Indicates that pool contains only RDMA RRoCE capable interfaces.
    ranges List<GetNetworkpoolNetworkPoolsDetailRange>
    List of IP address ranges in this pool.
    rebalancePolicy String
    Rebalance policy..
    rules List<String>
    Names of the rules in this pool.
    scAutoUnsuspendDelay Double
    Time delay in seconds before a node which has been automatically unsuspended becomes usable in SmartConnect responses for pool zones.
    scConnectPolicy String
    SmartConnect client connection balancing policy.
    scDnsZone String
    SmartConnect zone name for the pool.
    scDnsZoneAliases List<String>
    List of SmartConnect zone aliases (DNS names) to the pool.
    scFailoverPolicy String
    SmartConnect IP failover policy.
    scSubnet String
    Name of SmartConnect service subnet for this pool.
    scSuspendedNodes List<Double>
    List of LNNs showing currently suspended nodes in SmartConnect.
    scTtl Double
    Time to live value for SmartConnect DNS query responses in seconds.
    staticRoutes List<GetNetworkpoolNetworkPoolsDetailStaticRoute>
    List of interface members in this pool.
    subnet String
    The name of the subnet.
    accessZone string
    Name of a valid access zone to map IP address pool to the zone.
    addrFamily string
    IP address format.
    aggregationMode string
    OneFS supports the following NIC aggregation modes.
    allocMethod string
    Specifies how IP address allocation is done among pool members.
    description string
    A description of the pool.
    groupnet string
    Name of the groupnet this pool belongs to.
    id string
    Unique Pool ID.
    ifaces GetNetworkpoolNetworkPoolsDetailIface[]
    List of interface members in this pool.
    name string
    The name of the pool. It must be unique throughout the given subnet.It's a required field with POST method.
    nfsv3RroceOnly boolean
    Indicates that pool contains only RDMA RRoCE capable interfaces.
    ranges GetNetworkpoolNetworkPoolsDetailRange[]
    List of IP address ranges in this pool.
    rebalancePolicy string
    Rebalance policy..
    rules string[]
    Names of the rules in this pool.
    scAutoUnsuspendDelay number
    Time delay in seconds before a node which has been automatically unsuspended becomes usable in SmartConnect responses for pool zones.
    scConnectPolicy string
    SmartConnect client connection balancing policy.
    scDnsZone string
    SmartConnect zone name for the pool.
    scDnsZoneAliases string[]
    List of SmartConnect zone aliases (DNS names) to the pool.
    scFailoverPolicy string
    SmartConnect IP failover policy.
    scSubnet string
    Name of SmartConnect service subnet for this pool.
    scSuspendedNodes number[]
    List of LNNs showing currently suspended nodes in SmartConnect.
    scTtl number
    Time to live value for SmartConnect DNS query responses in seconds.
    staticRoutes GetNetworkpoolNetworkPoolsDetailStaticRoute[]
    List of interface members in this pool.
    subnet string
    The name of the subnet.
    access_zone str
    Name of a valid access zone to map IP address pool to the zone.
    addr_family str
    IP address format.
    aggregation_mode str
    OneFS supports the following NIC aggregation modes.
    alloc_method str
    Specifies how IP address allocation is done among pool members.
    description str
    A description of the pool.
    groupnet str
    Name of the groupnet this pool belongs to.
    id str
    Unique Pool ID.
    ifaces Sequence[GetNetworkpoolNetworkPoolsDetailIface]
    List of interface members in this pool.
    name str
    The name of the pool. It must be unique throughout the given subnet.It's a required field with POST method.
    nfsv3_rroce_only bool
    Indicates that pool contains only RDMA RRoCE capable interfaces.
    ranges Sequence[GetNetworkpoolNetworkPoolsDetailRange]
    List of IP address ranges in this pool.
    rebalance_policy str
    Rebalance policy..
    rules Sequence[str]
    Names of the rules in this pool.
    sc_auto_unsuspend_delay float
    Time delay in seconds before a node which has been automatically unsuspended becomes usable in SmartConnect responses for pool zones.
    sc_connect_policy str
    SmartConnect client connection balancing policy.
    sc_dns_zone str
    SmartConnect zone name for the pool.
    sc_dns_zone_aliases Sequence[str]
    List of SmartConnect zone aliases (DNS names) to the pool.
    sc_failover_policy str
    SmartConnect IP failover policy.
    sc_subnet str
    Name of SmartConnect service subnet for this pool.
    sc_suspended_nodes Sequence[float]
    List of LNNs showing currently suspended nodes in SmartConnect.
    sc_ttl float
    Time to live value for SmartConnect DNS query responses in seconds.
    static_routes Sequence[GetNetworkpoolNetworkPoolsDetailStaticRoute]
    List of interface members in this pool.
    subnet str
    The name of the subnet.
    accessZone String
    Name of a valid access zone to map IP address pool to the zone.
    addrFamily String
    IP address format.
    aggregationMode String
    OneFS supports the following NIC aggregation modes.
    allocMethod String
    Specifies how IP address allocation is done among pool members.
    description String
    A description of the pool.
    groupnet String
    Name of the groupnet this pool belongs to.
    id String
    Unique Pool ID.
    ifaces List<Property Map>
    List of interface members in this pool.
    name String
    The name of the pool. It must be unique throughout the given subnet.It's a required field with POST method.
    nfsv3RroceOnly Boolean
    Indicates that pool contains only RDMA RRoCE capable interfaces.
    ranges List<Property Map>
    List of IP address ranges in this pool.
    rebalancePolicy String
    Rebalance policy..
    rules List<String>
    Names of the rules in this pool.
    scAutoUnsuspendDelay Number
    Time delay in seconds before a node which has been automatically unsuspended becomes usable in SmartConnect responses for pool zones.
    scConnectPolicy String
    SmartConnect client connection balancing policy.
    scDnsZone String
    SmartConnect zone name for the pool.
    scDnsZoneAliases List<String>
    List of SmartConnect zone aliases (DNS names) to the pool.
    scFailoverPolicy String
    SmartConnect IP failover policy.
    scSubnet String
    Name of SmartConnect service subnet for this pool.
    scSuspendedNodes List<Number>
    List of LNNs showing currently suspended nodes in SmartConnect.
    scTtl Number
    Time to live value for SmartConnect DNS query responses in seconds.
    staticRoutes List<Property Map>
    List of interface members in this pool.
    subnet String
    The name of the subnet.

    GetNetworkpoolNetworkPoolsDetailIface

    Iface string
    A string that defines an interface name.
    Lnn double
    Logical Node Number (LNN) of a node.
    Iface string
    A string that defines an interface name.
    Lnn float64
    Logical Node Number (LNN) of a node.
    iface String
    A string that defines an interface name.
    lnn Double
    Logical Node Number (LNN) of a node.
    iface string
    A string that defines an interface name.
    lnn number
    Logical Node Number (LNN) of a node.
    iface str
    A string that defines an interface name.
    lnn float
    Logical Node Number (LNN) of a node.
    iface String
    A string that defines an interface name.
    lnn Number
    Logical Node Number (LNN) of a node.

    GetNetworkpoolNetworkPoolsDetailRange

    High string
    High IP
    Low string
    Low IP
    High string
    High IP
    Low string
    Low IP
    high String
    High IP
    low String
    Low IP
    high string
    High IP
    low string
    Low IP
    high str
    High IP
    low str
    Low IP
    high String
    High IP
    low String
    Low IP

    GetNetworkpoolNetworkPoolsDetailStaticRoute

    Gateway string
    Address of the gateway in the format: yyy.yyy.yyy.yyy
    Prefixlen double
    Prefix length in the format: nn.
    Subnet string
    Network address in the format: xxx.xxx.xxx.xxx
    Gateway string
    Address of the gateway in the format: yyy.yyy.yyy.yyy
    Prefixlen float64
    Prefix length in the format: nn.
    Subnet string
    Network address in the format: xxx.xxx.xxx.xxx
    gateway String
    Address of the gateway in the format: yyy.yyy.yyy.yyy
    prefixlen Double
    Prefix length in the format: nn.
    subnet String
    Network address in the format: xxx.xxx.xxx.xxx
    gateway string
    Address of the gateway in the format: yyy.yyy.yyy.yyy
    prefixlen number
    Prefix length in the format: nn.
    subnet string
    Network address in the format: xxx.xxx.xxx.xxx
    gateway str
    Address of the gateway in the format: yyy.yyy.yyy.yyy
    prefixlen float
    Prefix length in the format: nn.
    subnet str
    Network address in the format: xxx.xxx.xxx.xxx
    gateway String
    Address of the gateway in the format: yyy.yyy.yyy.yyy
    prefixlen Number
    Prefix length in the format: nn.
    subnet String
    Network address in the format: xxx.xxx.xxx.xxx

    Package Details

    Repository
    powerscale dell/terraform-provider-powerscale
    License
    Notes
    This Pulumi package is based on the powerscale Terraform Provider.
    powerscale logo
    powerscale 1.7.1 published on Wednesday, Apr 30, 2025 by dell