ibm.PiNetworkPeer
Create, update, and delete network peers with this resource for on-prem locations.
Example Usage
The following example creates a network peer for your Power Systems Virtual Server.
import * as pulumi from "@pulumi/pulumi";
import * as ibm from "@pulumi/ibm";
const networkPeerInstance = new ibm.PiNetworkPeer("networkPeerInstance", {
piCloudInstanceId: "49fba6c9-23f8-40bc-9899-aca322ee7d5b",
piCustomerAsn: 64512,
piCustomerCidr: "192.168.91.2/30",
piDefaultExportRouteFilter: "allow",
piDefaultImportRouteFilter: "allow",
piIbmAsn: 64512,
piIbmCidr: "192.168.91.1/30",
piName: "newPeerNetwork",
piPeerInterfaceId: "031ab7da-bca6-493f-ac55-1a2a26f19160",
piType: "dcnetwork_bgp",
piVlan: 2000,
});
import pulumi
import pulumi_ibm as ibm
network_peer_instance = ibm.PiNetworkPeer("networkPeerInstance",
pi_cloud_instance_id="49fba6c9-23f8-40bc-9899-aca322ee7d5b",
pi_customer_asn=64512,
pi_customer_cidr="192.168.91.2/30",
pi_default_export_route_filter="allow",
pi_default_import_route_filter="allow",
pi_ibm_asn=64512,
pi_ibm_cidr="192.168.91.1/30",
pi_name="newPeerNetwork",
pi_peer_interface_id="031ab7da-bca6-493f-ac55-1a2a26f19160",
pi_type="dcnetwork_bgp",
pi_vlan=2000)
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := ibm.NewPiNetworkPeer(ctx, "networkPeerInstance", &ibm.PiNetworkPeerArgs{
PiCloudInstanceId: pulumi.String("49fba6c9-23f8-40bc-9899-aca322ee7d5b"),
PiCustomerAsn: pulumi.Float64(64512),
PiCustomerCidr: pulumi.String("192.168.91.2/30"),
PiDefaultExportRouteFilter: pulumi.String("allow"),
PiDefaultImportRouteFilter: pulumi.String("allow"),
PiIbmAsn: pulumi.Float64(64512),
PiIbmCidr: pulumi.String("192.168.91.1/30"),
PiName: pulumi.String("newPeerNetwork"),
PiPeerInterfaceId: pulumi.String("031ab7da-bca6-493f-ac55-1a2a26f19160"),
PiType: pulumi.String("dcnetwork_bgp"),
PiVlan: pulumi.Float64(2000),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ibm = Pulumi.Ibm;
return await Deployment.RunAsync(() =>
{
var networkPeerInstance = new Ibm.PiNetworkPeer("networkPeerInstance", new()
{
PiCloudInstanceId = "49fba6c9-23f8-40bc-9899-aca322ee7d5b",
PiCustomerAsn = 64512,
PiCustomerCidr = "192.168.91.2/30",
PiDefaultExportRouteFilter = "allow",
PiDefaultImportRouteFilter = "allow",
PiIbmAsn = 64512,
PiIbmCidr = "192.168.91.1/30",
PiName = "newPeerNetwork",
PiPeerInterfaceId = "031ab7da-bca6-493f-ac55-1a2a26f19160",
PiType = "dcnetwork_bgp",
PiVlan = 2000,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ibm.PiNetworkPeer;
import com.pulumi.ibm.PiNetworkPeerArgs;
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 networkPeerInstance = new PiNetworkPeer("networkPeerInstance", PiNetworkPeerArgs.builder()
.piCloudInstanceId("49fba6c9-23f8-40bc-9899-aca322ee7d5b")
.piCustomerAsn(64512)
.piCustomerCidr("192.168.91.2/30")
.piDefaultExportRouteFilter("allow")
.piDefaultImportRouteFilter("allow")
.piIbmAsn(64512)
.piIbmCidr("192.168.91.1/30")
.piName("newPeerNetwork")
.piPeerInterfaceId("031ab7da-bca6-493f-ac55-1a2a26f19160")
.piType("dcnetwork_bgp")
.piVlan(2000)
.build());
}
}
resources:
networkPeerInstance:
type: ibm:PiNetworkPeer
properties:
piCloudInstanceId: 49fba6c9-23f8-40bc-9899-aca322ee7d5b
piCustomerAsn: 64512
piCustomerCidr: 192.168.91.2/30
piDefaultExportRouteFilter: allow
piDefaultImportRouteFilter: allow
piIbmAsn: 64512
piIbmCidr: 192.168.91.1/30
piName: newPeerNetwork
piPeerInterfaceId: 031ab7da-bca6-493f-ac55-1a2a26f19160
piType: dcnetwork_bgp
piVlan: 2000
Notes
- Please find supported Regions for endpoints.
- If a Power cloud instance is provisioned at
lon04
, The provider level attributes should be as follows:region
-lon
zone
-lon04
Example usage:
import * as pulumi from "@pulumi/pulumi";
import pulumi
package main
import (
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
return await Deployment.RunAsync(() =>
{
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
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) {
}
}
{}
Create PiNetworkPeer Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new PiNetworkPeer(name: string, args: PiNetworkPeerArgs, opts?: CustomResourceOptions);
@overload
def PiNetworkPeer(resource_name: str,
args: PiNetworkPeerArgs,
opts: Optional[ResourceOptions] = None)
@overload
def PiNetworkPeer(resource_name: str,
opts: Optional[ResourceOptions] = None,
pi_peer_interface_id: Optional[str] = None,
pi_customer_asn: Optional[float] = None,
pi_customer_cidr: Optional[str] = None,
pi_ibm_asn: Optional[float] = None,
pi_ibm_cidr: Optional[str] = None,
pi_name: Optional[str] = None,
pi_cloud_instance_id: Optional[str] = None,
pi_vlan: Optional[float] = None,
pi_default_export_route_filter: Optional[str] = None,
pi_default_import_route_filter: Optional[str] = None,
pi_network_peer_id: Optional[str] = None,
pi_type: Optional[str] = None,
timeouts: Optional[PiNetworkPeerTimeoutsArgs] = None)
func NewPiNetworkPeer(ctx *Context, name string, args PiNetworkPeerArgs, opts ...ResourceOption) (*PiNetworkPeer, error)
public PiNetworkPeer(string name, PiNetworkPeerArgs args, CustomResourceOptions? opts = null)
public PiNetworkPeer(String name, PiNetworkPeerArgs args)
public PiNetworkPeer(String name, PiNetworkPeerArgs args, CustomResourceOptions options)
type: ibm:PiNetworkPeer
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 PiNetworkPeerArgs
- 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 PiNetworkPeerArgs
- 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 PiNetworkPeerArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args PiNetworkPeerArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args PiNetworkPeerArgs
- 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 piNetworkPeerResource = new Ibm.PiNetworkPeer("piNetworkPeerResource", new()
{
PiPeerInterfaceId = "string",
PiCustomerAsn = 0,
PiCustomerCidr = "string",
PiIbmAsn = 0,
PiIbmCidr = "string",
PiName = "string",
PiCloudInstanceId = "string",
PiVlan = 0,
PiDefaultExportRouteFilter = "string",
PiDefaultImportRouteFilter = "string",
PiNetworkPeerId = "string",
PiType = "string",
Timeouts = new Ibm.Inputs.PiNetworkPeerTimeoutsArgs
{
Create = "string",
Delete = "string",
Update = "string",
},
});
example, err := ibm.NewPiNetworkPeer(ctx, "piNetworkPeerResource", &ibm.PiNetworkPeerArgs{
PiPeerInterfaceId: pulumi.String("string"),
PiCustomerAsn: pulumi.Float64(0),
PiCustomerCidr: pulumi.String("string"),
PiIbmAsn: pulumi.Float64(0),
PiIbmCidr: pulumi.String("string"),
PiName: pulumi.String("string"),
PiCloudInstanceId: pulumi.String("string"),
PiVlan: pulumi.Float64(0),
PiDefaultExportRouteFilter: pulumi.String("string"),
PiDefaultImportRouteFilter: pulumi.String("string"),
PiNetworkPeerId: pulumi.String("string"),
PiType: pulumi.String("string"),
Timeouts: &ibm.PiNetworkPeerTimeoutsArgs{
Create: pulumi.String("string"),
Delete: pulumi.String("string"),
Update: pulumi.String("string"),
},
})
var piNetworkPeerResource = new PiNetworkPeer("piNetworkPeerResource", PiNetworkPeerArgs.builder()
.piPeerInterfaceId("string")
.piCustomerAsn(0.0)
.piCustomerCidr("string")
.piIbmAsn(0.0)
.piIbmCidr("string")
.piName("string")
.piCloudInstanceId("string")
.piVlan(0.0)
.piDefaultExportRouteFilter("string")
.piDefaultImportRouteFilter("string")
.piNetworkPeerId("string")
.piType("string")
.timeouts(PiNetworkPeerTimeoutsArgs.builder()
.create("string")
.delete("string")
.update("string")
.build())
.build());
pi_network_peer_resource = ibm.PiNetworkPeer("piNetworkPeerResource",
pi_peer_interface_id="string",
pi_customer_asn=0,
pi_customer_cidr="string",
pi_ibm_asn=0,
pi_ibm_cidr="string",
pi_name="string",
pi_cloud_instance_id="string",
pi_vlan=0,
pi_default_export_route_filter="string",
pi_default_import_route_filter="string",
pi_network_peer_id="string",
pi_type="string",
timeouts={
"create": "string",
"delete": "string",
"update": "string",
})
const piNetworkPeerResource = new ibm.PiNetworkPeer("piNetworkPeerResource", {
piPeerInterfaceId: "string",
piCustomerAsn: 0,
piCustomerCidr: "string",
piIbmAsn: 0,
piIbmCidr: "string",
piName: "string",
piCloudInstanceId: "string",
piVlan: 0,
piDefaultExportRouteFilter: "string",
piDefaultImportRouteFilter: "string",
piNetworkPeerId: "string",
piType: "string",
timeouts: {
create: "string",
"delete": "string",
update: "string",
},
});
type: ibm:PiNetworkPeer
properties:
piCloudInstanceId: string
piCustomerAsn: 0
piCustomerCidr: string
piDefaultExportRouteFilter: string
piDefaultImportRouteFilter: string
piIbmAsn: 0
piIbmCidr: string
piName: string
piNetworkPeerId: string
piPeerInterfaceId: string
piType: string
piVlan: 0
timeouts:
create: string
delete: string
update: string
PiNetworkPeer 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 PiNetworkPeer resource accepts the following input properties:
- Pi
Cloud stringInstance Id - The GUID of the service instance associated with an account.
- Pi
Customer doubleAsn - ASN number at customer network side.
- Pi
Customer stringCidr - IP address used for configuring customer network interface with network subnet mask. customerCidr and ibmCidr must have matching network and subnet mask values.
- Pi
Ibm doubleAsn - ASN number at IBM PowerVS side.
- Pi
Ibm stringCidr - IP address used for configuring IBM network interface with network subnet mask. customerCidr and ibmCidr must have matching network and subnet mask values.
- Pi
Name string - User defined name.
- Pi
Peer stringInterface Id - Peer interface id. Use datasource
ibm.getPiNetworkPeerInterfaces
to get a list of valid peer interface id. - Pi
Vlan double - A vlan configured at the customer network.
- Pi
Default stringExport Route Filter - Default action for export route filter,the default value is
allow
. Allowable values are:allow
,deny
. - Pi
Default stringImport Route Filter - Default action for import route filter, the default value is
allow
. Allowable values are:allow
,deny
. - Pi
Network stringPeer Id - (String) The unique identifier of the network peer resource. Composed of
<pi_cloud_instance_id>/<peer_id>
- Pi
Type string - Type of the peer network - dcnetwork_bgp: broader gateway protocol is used to share routes between two autonomous network. The default value is
dcnetwork_bgp
. Allowable values are:dcnetwork_bgp
. - Timeouts
Pi
Network Peer Timeouts
- Pi
Cloud stringInstance Id - The GUID of the service instance associated with an account.
- Pi
Customer float64Asn - ASN number at customer network side.
- Pi
Customer stringCidr - IP address used for configuring customer network interface with network subnet mask. customerCidr and ibmCidr must have matching network and subnet mask values.
- Pi
Ibm float64Asn - ASN number at IBM PowerVS side.
- Pi
Ibm stringCidr - IP address used for configuring IBM network interface with network subnet mask. customerCidr and ibmCidr must have matching network and subnet mask values.
- Pi
Name string - User defined name.
- Pi
Peer stringInterface Id - Peer interface id. Use datasource
ibm.getPiNetworkPeerInterfaces
to get a list of valid peer interface id. - Pi
Vlan float64 - A vlan configured at the customer network.
- Pi
Default stringExport Route Filter - Default action for export route filter,the default value is
allow
. Allowable values are:allow
,deny
. - Pi
Default stringImport Route Filter - Default action for import route filter, the default value is
allow
. Allowable values are:allow
,deny
. - Pi
Network stringPeer Id - (String) The unique identifier of the network peer resource. Composed of
<pi_cloud_instance_id>/<peer_id>
- Pi
Type string - Type of the peer network - dcnetwork_bgp: broader gateway protocol is used to share routes between two autonomous network. The default value is
dcnetwork_bgp
. Allowable values are:dcnetwork_bgp
. - Timeouts
Pi
Network Peer Timeouts Args
- pi
Cloud StringInstance Id - The GUID of the service instance associated with an account.
- pi
Customer DoubleAsn - ASN number at customer network side.
- pi
Customer StringCidr - IP address used for configuring customer network interface with network subnet mask. customerCidr and ibmCidr must have matching network and subnet mask values.
- pi
Ibm DoubleAsn - ASN number at IBM PowerVS side.
- pi
Ibm StringCidr - IP address used for configuring IBM network interface with network subnet mask. customerCidr and ibmCidr must have matching network and subnet mask values.
- pi
Name String - User defined name.
- pi
Peer StringInterface Id - Peer interface id. Use datasource
ibm.getPiNetworkPeerInterfaces
to get a list of valid peer interface id. - pi
Vlan Double - A vlan configured at the customer network.
- pi
Default StringExport Route Filter - Default action for export route filter,the default value is
allow
. Allowable values are:allow
,deny
. - pi
Default StringImport Route Filter - Default action for import route filter, the default value is
allow
. Allowable values are:allow
,deny
. - pi
Network StringPeer Id - (String) The unique identifier of the network peer resource. Composed of
<pi_cloud_instance_id>/<peer_id>
- pi
Type String - Type of the peer network - dcnetwork_bgp: broader gateway protocol is used to share routes between two autonomous network. The default value is
dcnetwork_bgp
. Allowable values are:dcnetwork_bgp
. - timeouts
Pi
Network Peer Timeouts
- pi
Cloud stringInstance Id - The GUID of the service instance associated with an account.
- pi
Customer numberAsn - ASN number at customer network side.
- pi
Customer stringCidr - IP address used for configuring customer network interface with network subnet mask. customerCidr and ibmCidr must have matching network and subnet mask values.
- pi
Ibm numberAsn - ASN number at IBM PowerVS side.
- pi
Ibm stringCidr - IP address used for configuring IBM network interface with network subnet mask. customerCidr and ibmCidr must have matching network and subnet mask values.
- pi
Name string - User defined name.
- pi
Peer stringInterface Id - Peer interface id. Use datasource
ibm.getPiNetworkPeerInterfaces
to get a list of valid peer interface id. - pi
Vlan number - A vlan configured at the customer network.
- pi
Default stringExport Route Filter - Default action for export route filter,the default value is
allow
. Allowable values are:allow
,deny
. - pi
Default stringImport Route Filter - Default action for import route filter, the default value is
allow
. Allowable values are:allow
,deny
. - pi
Network stringPeer Id - (String) The unique identifier of the network peer resource. Composed of
<pi_cloud_instance_id>/<peer_id>
- pi
Type string - Type of the peer network - dcnetwork_bgp: broader gateway protocol is used to share routes between two autonomous network. The default value is
dcnetwork_bgp
. Allowable values are:dcnetwork_bgp
. - timeouts
Pi
Network Peer Timeouts
- pi_
cloud_ strinstance_ id - The GUID of the service instance associated with an account.
- pi_
customer_ floatasn - ASN number at customer network side.
- pi_
customer_ strcidr - IP address used for configuring customer network interface with network subnet mask. customerCidr and ibmCidr must have matching network and subnet mask values.
- pi_
ibm_ floatasn - ASN number at IBM PowerVS side.
- pi_
ibm_ strcidr - IP address used for configuring IBM network interface with network subnet mask. customerCidr and ibmCidr must have matching network and subnet mask values.
- pi_
name str - User defined name.
- pi_
peer_ strinterface_ id - Peer interface id. Use datasource
ibm.getPiNetworkPeerInterfaces
to get a list of valid peer interface id. - pi_
vlan float - A vlan configured at the customer network.
- pi_
default_ strexport_ route_ filter - Default action for export route filter,the default value is
allow
. Allowable values are:allow
,deny
. - pi_
default_ strimport_ route_ filter - Default action for import route filter, the default value is
allow
. Allowable values are:allow
,deny
. - pi_
network_ strpeer_ id - (String) The unique identifier of the network peer resource. Composed of
<pi_cloud_instance_id>/<peer_id>
- pi_
type str - Type of the peer network - dcnetwork_bgp: broader gateway protocol is used to share routes between two autonomous network. The default value is
dcnetwork_bgp
. Allowable values are:dcnetwork_bgp
. - timeouts
Pi
Network Peer Timeouts Args
- pi
Cloud StringInstance Id - The GUID of the service instance associated with an account.
- pi
Customer NumberAsn - ASN number at customer network side.
- pi
Customer StringCidr - IP address used for configuring customer network interface with network subnet mask. customerCidr and ibmCidr must have matching network and subnet mask values.
- pi
Ibm NumberAsn - ASN number at IBM PowerVS side.
- pi
Ibm StringCidr - IP address used for configuring IBM network interface with network subnet mask. customerCidr and ibmCidr must have matching network and subnet mask values.
- pi
Name String - User defined name.
- pi
Peer StringInterface Id - Peer interface id. Use datasource
ibm.getPiNetworkPeerInterfaces
to get a list of valid peer interface id. - pi
Vlan Number - A vlan configured at the customer network.
- pi
Default StringExport Route Filter - Default action for export route filter,the default value is
allow
. Allowable values are:allow
,deny
. - pi
Default StringImport Route Filter - Default action for import route filter, the default value is
allow
. Allowable values are:allow
,deny
. - pi
Network StringPeer Id - (String) The unique identifier of the network peer resource. Composed of
<pi_cloud_instance_id>/<peer_id>
- pi
Type String - Type of the peer network - dcnetwork_bgp: broader gateway protocol is used to share routes between two autonomous network. The default value is
dcnetwork_bgp
. Allowable values are:dcnetwork_bgp
. - timeouts Property Map
Outputs
All input properties are implicitly available as output properties. Additionally, the PiNetworkPeer resource produces the following output properties:
- Creation
Date string - (String) Time stamp for create route filter.
- Error string
- (String) Error description.
- Export
Route List<PiFilters Network Peer Export Route Filter> - (List) List of export route filters.
- Id string
- The provider-assigned unique ID for this managed resource.
- Import
Route List<PiFilters Network Peer Import Route Filter> - (List) List of import route filters.
- Peer
Id string - (String) The unique identifier of the pi_network_peer.
- State string
- (String) Status of the network peer.
- Updated
Date string - (String) Time stamp for update network peer.
- Creation
Date string - (String) Time stamp for create route filter.
- Error string
- (String) Error description.
- Export
Route []PiFilters Network Peer Export Route Filter - (List) List of export route filters.
- Id string
- The provider-assigned unique ID for this managed resource.
- Import
Route []PiFilters Network Peer Import Route Filter - (List) List of import route filters.
- Peer
Id string - (String) The unique identifier of the pi_network_peer.
- State string
- (String) Status of the network peer.
- Updated
Date string - (String) Time stamp for update network peer.
- creation
Date String - (String) Time stamp for create route filter.
- error String
- (String) Error description.
- export
Route List<PiFilters Network Peer Export Route Filter> - (List) List of export route filters.
- id String
- The provider-assigned unique ID for this managed resource.
- import
Route List<PiFilters Network Peer Import Route Filter> - (List) List of import route filters.
- peer
Id String - (String) The unique identifier of the pi_network_peer.
- state String
- (String) Status of the network peer.
- updated
Date String - (String) Time stamp for update network peer.
- creation
Date string - (String) Time stamp for create route filter.
- error string
- (String) Error description.
- export
Route PiFilters Network Peer Export Route Filter[] - (List) List of export route filters.
- id string
- The provider-assigned unique ID for this managed resource.
- import
Route PiFilters Network Peer Import Route Filter[] - (List) List of import route filters.
- peer
Id string - (String) The unique identifier of the pi_network_peer.
- state string
- (String) Status of the network peer.
- updated
Date string - (String) Time stamp for update network peer.
- creation_
date str - (String) Time stamp for create route filter.
- error str
- (String) Error description.
- export_
route_ Sequence[Pifilters Network Peer Export Route Filter] - (List) List of export route filters.
- id str
- The provider-assigned unique ID for this managed resource.
- import_
route_ Sequence[Pifilters Network Peer Import Route Filter] - (List) List of import route filters.
- peer_
id str - (String) The unique identifier of the pi_network_peer.
- state str
- (String) Status of the network peer.
- updated_
date str - (String) Time stamp for update network peer.
- creation
Date String - (String) Time stamp for create route filter.
- error String
- (String) Error description.
- export
Route List<Property Map>Filters - (List) List of export route filters.
- id String
- The provider-assigned unique ID for this managed resource.
- import
Route List<Property Map>Filters - (List) List of import route filters.
- peer
Id String - (String) The unique identifier of the pi_network_peer.
- state String
- (String) Status of the network peer.
- updated
Date String - (String) Time stamp for update network peer.
Look up Existing PiNetworkPeer Resource
Get an existing PiNetworkPeer 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?: PiNetworkPeerState, opts?: CustomResourceOptions): PiNetworkPeer
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
creation_date: Optional[str] = None,
error: Optional[str] = None,
export_route_filters: Optional[Sequence[PiNetworkPeerExportRouteFilterArgs]] = None,
import_route_filters: Optional[Sequence[PiNetworkPeerImportRouteFilterArgs]] = None,
peer_id: Optional[str] = None,
pi_cloud_instance_id: Optional[str] = None,
pi_customer_asn: Optional[float] = None,
pi_customer_cidr: Optional[str] = None,
pi_default_export_route_filter: Optional[str] = None,
pi_default_import_route_filter: Optional[str] = None,
pi_ibm_asn: Optional[float] = None,
pi_ibm_cidr: Optional[str] = None,
pi_name: Optional[str] = None,
pi_network_peer_id: Optional[str] = None,
pi_peer_interface_id: Optional[str] = None,
pi_type: Optional[str] = None,
pi_vlan: Optional[float] = None,
state: Optional[str] = None,
timeouts: Optional[PiNetworkPeerTimeoutsArgs] = None,
updated_date: Optional[str] = None) -> PiNetworkPeer
func GetPiNetworkPeer(ctx *Context, name string, id IDInput, state *PiNetworkPeerState, opts ...ResourceOption) (*PiNetworkPeer, error)
public static PiNetworkPeer Get(string name, Input<string> id, PiNetworkPeerState? state, CustomResourceOptions? opts = null)
public static PiNetworkPeer get(String name, Output<String> id, PiNetworkPeerState state, CustomResourceOptions options)
resources: _: type: ibm:PiNetworkPeer 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.
- Creation
Date string - (String) Time stamp for create route filter.
- Error string
- (String) Error description.
- Export
Route List<PiFilters Network Peer Export Route Filter> - (List) List of export route filters.
- Import
Route List<PiFilters Network Peer Import Route Filter> - (List) List of import route filters.
- Peer
Id string - (String) The unique identifier of the pi_network_peer.
- Pi
Cloud stringInstance Id - The GUID of the service instance associated with an account.
- Pi
Customer doubleAsn - ASN number at customer network side.
- Pi
Customer stringCidr - IP address used for configuring customer network interface with network subnet mask. customerCidr and ibmCidr must have matching network and subnet mask values.
- Pi
Default stringExport Route Filter - Default action for export route filter,the default value is
allow
. Allowable values are:allow
,deny
. - Pi
Default stringImport Route Filter - Default action for import route filter, the default value is
allow
. Allowable values are:allow
,deny
. - Pi
Ibm doubleAsn - ASN number at IBM PowerVS side.
- Pi
Ibm stringCidr - IP address used for configuring IBM network interface with network subnet mask. customerCidr and ibmCidr must have matching network and subnet mask values.
- Pi
Name string - User defined name.
- Pi
Network stringPeer Id - (String) The unique identifier of the network peer resource. Composed of
<pi_cloud_instance_id>/<peer_id>
- Pi
Peer stringInterface Id - Peer interface id. Use datasource
ibm.getPiNetworkPeerInterfaces
to get a list of valid peer interface id. - Pi
Type string - Type of the peer network - dcnetwork_bgp: broader gateway protocol is used to share routes between two autonomous network. The default value is
dcnetwork_bgp
. Allowable values are:dcnetwork_bgp
. - Pi
Vlan double - A vlan configured at the customer network.
- State string
- (String) Status of the network peer.
- Timeouts
Pi
Network Peer Timeouts - Updated
Date string - (String) Time stamp for update network peer.
- Creation
Date string - (String) Time stamp for create route filter.
- Error string
- (String) Error description.
- Export
Route []PiFilters Network Peer Export Route Filter Args - (List) List of export route filters.
- Import
Route []PiFilters Network Peer Import Route Filter Args - (List) List of import route filters.
- Peer
Id string - (String) The unique identifier of the pi_network_peer.
- Pi
Cloud stringInstance Id - The GUID of the service instance associated with an account.
- Pi
Customer float64Asn - ASN number at customer network side.
- Pi
Customer stringCidr - IP address used for configuring customer network interface with network subnet mask. customerCidr and ibmCidr must have matching network and subnet mask values.
- Pi
Default stringExport Route Filter - Default action for export route filter,the default value is
allow
. Allowable values are:allow
,deny
. - Pi
Default stringImport Route Filter - Default action for import route filter, the default value is
allow
. Allowable values are:allow
,deny
. - Pi
Ibm float64Asn - ASN number at IBM PowerVS side.
- Pi
Ibm stringCidr - IP address used for configuring IBM network interface with network subnet mask. customerCidr and ibmCidr must have matching network and subnet mask values.
- Pi
Name string - User defined name.
- Pi
Network stringPeer Id - (String) The unique identifier of the network peer resource. Composed of
<pi_cloud_instance_id>/<peer_id>
- Pi
Peer stringInterface Id - Peer interface id. Use datasource
ibm.getPiNetworkPeerInterfaces
to get a list of valid peer interface id. - Pi
Type string - Type of the peer network - dcnetwork_bgp: broader gateway protocol is used to share routes between two autonomous network. The default value is
dcnetwork_bgp
. Allowable values are:dcnetwork_bgp
. - Pi
Vlan float64 - A vlan configured at the customer network.
- State string
- (String) Status of the network peer.
- Timeouts
Pi
Network Peer Timeouts Args - Updated
Date string - (String) Time stamp for update network peer.
- creation
Date String - (String) Time stamp for create route filter.
- error String
- (String) Error description.
- export
Route List<PiFilters Network Peer Export Route Filter> - (List) List of export route filters.
- import
Route List<PiFilters Network Peer Import Route Filter> - (List) List of import route filters.
- peer
Id String - (String) The unique identifier of the pi_network_peer.
- pi
Cloud StringInstance Id - The GUID of the service instance associated with an account.
- pi
Customer DoubleAsn - ASN number at customer network side.
- pi
Customer StringCidr - IP address used for configuring customer network interface with network subnet mask. customerCidr and ibmCidr must have matching network and subnet mask values.
- pi
Default StringExport Route Filter - Default action for export route filter,the default value is
allow
. Allowable values are:allow
,deny
. - pi
Default StringImport Route Filter - Default action for import route filter, the default value is
allow
. Allowable values are:allow
,deny
. - pi
Ibm DoubleAsn - ASN number at IBM PowerVS side.
- pi
Ibm StringCidr - IP address used for configuring IBM network interface with network subnet mask. customerCidr and ibmCidr must have matching network and subnet mask values.
- pi
Name String - User defined name.
- pi
Network StringPeer Id - (String) The unique identifier of the network peer resource. Composed of
<pi_cloud_instance_id>/<peer_id>
- pi
Peer StringInterface Id - Peer interface id. Use datasource
ibm.getPiNetworkPeerInterfaces
to get a list of valid peer interface id. - pi
Type String - Type of the peer network - dcnetwork_bgp: broader gateway protocol is used to share routes between two autonomous network. The default value is
dcnetwork_bgp
. Allowable values are:dcnetwork_bgp
. - pi
Vlan Double - A vlan configured at the customer network.
- state String
- (String) Status of the network peer.
- timeouts
Pi
Network Peer Timeouts - updated
Date String - (String) Time stamp for update network peer.
- creation
Date string - (String) Time stamp for create route filter.
- error string
- (String) Error description.
- export
Route PiFilters Network Peer Export Route Filter[] - (List) List of export route filters.
- import
Route PiFilters Network Peer Import Route Filter[] - (List) List of import route filters.
- peer
Id string - (String) The unique identifier of the pi_network_peer.
- pi
Cloud stringInstance Id - The GUID of the service instance associated with an account.
- pi
Customer numberAsn - ASN number at customer network side.
- pi
Customer stringCidr - IP address used for configuring customer network interface with network subnet mask. customerCidr and ibmCidr must have matching network and subnet mask values.
- pi
Default stringExport Route Filter - Default action for export route filter,the default value is
allow
. Allowable values are:allow
,deny
. - pi
Default stringImport Route Filter - Default action for import route filter, the default value is
allow
. Allowable values are:allow
,deny
. - pi
Ibm numberAsn - ASN number at IBM PowerVS side.
- pi
Ibm stringCidr - IP address used for configuring IBM network interface with network subnet mask. customerCidr and ibmCidr must have matching network and subnet mask values.
- pi
Name string - User defined name.
- pi
Network stringPeer Id - (String) The unique identifier of the network peer resource. Composed of
<pi_cloud_instance_id>/<peer_id>
- pi
Peer stringInterface Id - Peer interface id. Use datasource
ibm.getPiNetworkPeerInterfaces
to get a list of valid peer interface id. - pi
Type string - Type of the peer network - dcnetwork_bgp: broader gateway protocol is used to share routes between two autonomous network. The default value is
dcnetwork_bgp
. Allowable values are:dcnetwork_bgp
. - pi
Vlan number - A vlan configured at the customer network.
- state string
- (String) Status of the network peer.
- timeouts
Pi
Network Peer Timeouts - updated
Date string - (String) Time stamp for update network peer.
- creation_
date str - (String) Time stamp for create route filter.
- error str
- (String) Error description.
- export_
route_ Sequence[Pifilters Network Peer Export Route Filter Args] - (List) List of export route filters.
- import_
route_ Sequence[Pifilters Network Peer Import Route Filter Args] - (List) List of import route filters.
- peer_
id str - (String) The unique identifier of the pi_network_peer.
- pi_
cloud_ strinstance_ id - The GUID of the service instance associated with an account.
- pi_
customer_ floatasn - ASN number at customer network side.
- pi_
customer_ strcidr - IP address used for configuring customer network interface with network subnet mask. customerCidr and ibmCidr must have matching network and subnet mask values.
- pi_
default_ strexport_ route_ filter - Default action for export route filter,the default value is
allow
. Allowable values are:allow
,deny
. - pi_
default_ strimport_ route_ filter - Default action for import route filter, the default value is
allow
. Allowable values are:allow
,deny
. - pi_
ibm_ floatasn - ASN number at IBM PowerVS side.
- pi_
ibm_ strcidr - IP address used for configuring IBM network interface with network subnet mask. customerCidr and ibmCidr must have matching network and subnet mask values.
- pi_
name str - User defined name.
- pi_
network_ strpeer_ id - (String) The unique identifier of the network peer resource. Composed of
<pi_cloud_instance_id>/<peer_id>
- pi_
peer_ strinterface_ id - Peer interface id. Use datasource
ibm.getPiNetworkPeerInterfaces
to get a list of valid peer interface id. - pi_
type str - Type of the peer network - dcnetwork_bgp: broader gateway protocol is used to share routes between two autonomous network. The default value is
dcnetwork_bgp
. Allowable values are:dcnetwork_bgp
. - pi_
vlan float - A vlan configured at the customer network.
- state str
- (String) Status of the network peer.
- timeouts
Pi
Network Peer Timeouts Args - updated_
date str - (String) Time stamp for update network peer.
- creation
Date String - (String) Time stamp for create route filter.
- error String
- (String) Error description.
- export
Route List<Property Map>Filters - (List) List of export route filters.
- import
Route List<Property Map>Filters - (List) List of import route filters.
- peer
Id String - (String) The unique identifier of the pi_network_peer.
- pi
Cloud StringInstance Id - The GUID of the service instance associated with an account.
- pi
Customer NumberAsn - ASN number at customer network side.
- pi
Customer StringCidr - IP address used for configuring customer network interface with network subnet mask. customerCidr and ibmCidr must have matching network and subnet mask values.
- pi
Default StringExport Route Filter - Default action for export route filter,the default value is
allow
. Allowable values are:allow
,deny
. - pi
Default StringImport Route Filter - Default action for import route filter, the default value is
allow
. Allowable values are:allow
,deny
. - pi
Ibm NumberAsn - ASN number at IBM PowerVS side.
- pi
Ibm StringCidr - IP address used for configuring IBM network interface with network subnet mask. customerCidr and ibmCidr must have matching network and subnet mask values.
- pi
Name String - User defined name.
- pi
Network StringPeer Id - (String) The unique identifier of the network peer resource. Composed of
<pi_cloud_instance_id>/<peer_id>
- pi
Peer StringInterface Id - Peer interface id. Use datasource
ibm.getPiNetworkPeerInterfaces
to get a list of valid peer interface id. - pi
Type String - Type of the peer network - dcnetwork_bgp: broader gateway protocol is used to share routes between two autonomous network. The default value is
dcnetwork_bgp
. Allowable values are:dcnetwork_bgp
. - pi
Vlan Number - A vlan configured at the customer network.
- state String
- (String) Status of the network peer.
- timeouts Property Map
- updated
Date String - (String) Time stamp for update network peer.
Supporting Types
PiNetworkPeerExportRouteFilter, PiNetworkPeerExportRouteFilterArgs
- Action string
- (String) Action of the filter.
- Creation
Date string - (String) Time stamp for create route filter.
- Direction string
- (String) Direction of the filter.
- Error string
- (String) Error description.
- Ge double
- (Integer) The minimum matching length of the prefix-set.
- Index double
- (Integer) Priority or order of the filter.
- Le double
- (Integer) The maximum matching length of the prefix-set.
- Prefix string
- (String) IP prefix representing an address and mask length of the prefix-set.
- Route
Filter stringId - (String) Route filter ID.
- State string
- (String) Status of the network peer.
- Action string
- (String) Action of the filter.
- Creation
Date string - (String) Time stamp for create route filter.
- Direction string
- (String) Direction of the filter.
- Error string
- (String) Error description.
- Ge float64
- (Integer) The minimum matching length of the prefix-set.
- Index float64
- (Integer) Priority or order of the filter.
- Le float64
- (Integer) The maximum matching length of the prefix-set.
- Prefix string
- (String) IP prefix representing an address and mask length of the prefix-set.
- Route
Filter stringId - (String) Route filter ID.
- State string
- (String) Status of the network peer.
- action String
- (String) Action of the filter.
- creation
Date String - (String) Time stamp for create route filter.
- direction String
- (String) Direction of the filter.
- error String
- (String) Error description.
- ge Double
- (Integer) The minimum matching length of the prefix-set.
- index Double
- (Integer) Priority or order of the filter.
- le Double
- (Integer) The maximum matching length of the prefix-set.
- prefix String
- (String) IP prefix representing an address and mask length of the prefix-set.
- route
Filter StringId - (String) Route filter ID.
- state String
- (String) Status of the network peer.
- action string
- (String) Action of the filter.
- creation
Date string - (String) Time stamp for create route filter.
- direction string
- (String) Direction of the filter.
- error string
- (String) Error description.
- ge number
- (Integer) The minimum matching length of the prefix-set.
- index number
- (Integer) Priority or order of the filter.
- le number
- (Integer) The maximum matching length of the prefix-set.
- prefix string
- (String) IP prefix representing an address and mask length of the prefix-set.
- route
Filter stringId - (String) Route filter ID.
- state string
- (String) Status of the network peer.
- action str
- (String) Action of the filter.
- creation_
date str - (String) Time stamp for create route filter.
- direction str
- (String) Direction of the filter.
- error str
- (String) Error description.
- ge float
- (Integer) The minimum matching length of the prefix-set.
- index float
- (Integer) Priority or order of the filter.
- le float
- (Integer) The maximum matching length of the prefix-set.
- prefix str
- (String) IP prefix representing an address and mask length of the prefix-set.
- route_
filter_ strid - (String) Route filter ID.
- state str
- (String) Status of the network peer.
- action String
- (String) Action of the filter.
- creation
Date String - (String) Time stamp for create route filter.
- direction String
- (String) Direction of the filter.
- error String
- (String) Error description.
- ge Number
- (Integer) The minimum matching length of the prefix-set.
- index Number
- (Integer) Priority or order of the filter.
- le Number
- (Integer) The maximum matching length of the prefix-set.
- prefix String
- (String) IP prefix representing an address and mask length of the prefix-set.
- route
Filter StringId - (String) Route filter ID.
- state String
- (String) Status of the network peer.
PiNetworkPeerImportRouteFilter, PiNetworkPeerImportRouteFilterArgs
- Action string
- (String) Action of the filter.
- Creation
Date string - (String) Time stamp for create route filter.
- Direction string
- (String) Direction of the filter.
- Error string
- (String) Error description.
- Ge double
- (Integer) The minimum matching length of the prefix-set.
- Index double
- (Integer) Priority or order of the filter.
- Le double
- (Integer) The maximum matching length of the prefix-set.
- Prefix string
- (String) IP prefix representing an address and mask length of the prefix-set.
- Route
Filter stringId - (String) Route filter ID.
- State string
- (String) Status of the network peer.
- Action string
- (String) Action of the filter.
- Creation
Date string - (String) Time stamp for create route filter.
- Direction string
- (String) Direction of the filter.
- Error string
- (String) Error description.
- Ge float64
- (Integer) The minimum matching length of the prefix-set.
- Index float64
- (Integer) Priority or order of the filter.
- Le float64
- (Integer) The maximum matching length of the prefix-set.
- Prefix string
- (String) IP prefix representing an address and mask length of the prefix-set.
- Route
Filter stringId - (String) Route filter ID.
- State string
- (String) Status of the network peer.
- action String
- (String) Action of the filter.
- creation
Date String - (String) Time stamp for create route filter.
- direction String
- (String) Direction of the filter.
- error String
- (String) Error description.
- ge Double
- (Integer) The minimum matching length of the prefix-set.
- index Double
- (Integer) Priority or order of the filter.
- le Double
- (Integer) The maximum matching length of the prefix-set.
- prefix String
- (String) IP prefix representing an address and mask length of the prefix-set.
- route
Filter StringId - (String) Route filter ID.
- state String
- (String) Status of the network peer.
- action string
- (String) Action of the filter.
- creation
Date string - (String) Time stamp for create route filter.
- direction string
- (String) Direction of the filter.
- error string
- (String) Error description.
- ge number
- (Integer) The minimum matching length of the prefix-set.
- index number
- (Integer) Priority or order of the filter.
- le number
- (Integer) The maximum matching length of the prefix-set.
- prefix string
- (String) IP prefix representing an address and mask length of the prefix-set.
- route
Filter stringId - (String) Route filter ID.
- state string
- (String) Status of the network peer.
- action str
- (String) Action of the filter.
- creation_
date str - (String) Time stamp for create route filter.
- direction str
- (String) Direction of the filter.
- error str
- (String) Error description.
- ge float
- (Integer) The minimum matching length of the prefix-set.
- index float
- (Integer) Priority or order of the filter.
- le float
- (Integer) The maximum matching length of the prefix-set.
- prefix str
- (String) IP prefix representing an address and mask length of the prefix-set.
- route_
filter_ strid - (String) Route filter ID.
- state str
- (String) Status of the network peer.
- action String
- (String) Action of the filter.
- creation
Date String - (String) Time stamp for create route filter.
- direction String
- (String) Direction of the filter.
- error String
- (String) Error description.
- ge Number
- (Integer) The minimum matching length of the prefix-set.
- index Number
- (Integer) Priority or order of the filter.
- le Number
- (Integer) The maximum matching length of the prefix-set.
- prefix String
- (String) IP prefix representing an address and mask length of the prefix-set.
- route
Filter StringId - (String) Route filter ID.
- state String
- (String) Status of the network peer.
PiNetworkPeerTimeouts, PiNetworkPeerTimeoutsArgs
Import
Example
bash
$ pulumi import ibm:index/piNetworkPeer:PiNetworkPeer pi_network_peer 49fba6c9-23f8-40bc-9899-aca322ee7d5b/8a9b1c2d-3e4f-5g6h-7i8j-9k0l1m2n3o4p
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- ibm ibm-cloud/terraform-provider-ibm
- License
- Notes
- This Pulumi package is based on the
ibm
Terraform Provider.