pulumi-scm 1.0.1__py3-none-any.whl → 1.0.3__py3-none-any.whl

pulumi_scm/local_user_group.py

@@ -235,6 +235,32 @@ class LocalUserGroup(pulumi.CustomResource):
         """
         LocalUserGroup resource
 
+        ## Import
+
+        The following command can be used to import a resource not managed by Terraform:
+
+        bash
+
+        ```sh
+        $ pulumi import scm:index/localUserGroup:LocalUserGroup example folder:::id
+        ```
+
+        or
+
+        bash
+
+        ```sh
+        $ pulumi import scm:index/localUserGroup:LocalUserGroup example :snippet::id
+        ```
+
+        or
+
+        bash
+
+        ```sh
+        $ pulumi import scm:index/localUserGroup:LocalUserGroup example ::device:id
+        ```
+
         :param str resource_name: The name of the resource.
         :param pulumi.ResourceOptions opts: Options for the resource.
         :param pulumi.Input[_builtins.str] device: The device in which the resource is defined
@@ -256,6 +282,32 @@ class LocalUserGroup(pulumi.CustomResource):
         """
         LocalUserGroup resource
 
+        ## Import
+
+        The following command can be used to import a resource not managed by Terraform:
+
+        bash
+
+        ```sh
+        $ pulumi import scm:index/localUserGroup:LocalUserGroup example folder:::id
+        ```
+
+        or
+
+        bash
+
+        ```sh
+        $ pulumi import scm:index/localUserGroup:LocalUserGroup example :snippet::id
+        ```
+
+        or
+
+        bash
+
+        ```sh
+        $ pulumi import scm:index/localUserGroup:LocalUserGroup example ::device:id
+        ```
+
         :param str resource_name: The name of the resource.
         :param LocalUserGroupArgs args: The arguments to use to populate this resource's properties.
         :param pulumi.ResourceOptions opts: Options for the resource.

pulumi_scm/log_forwarding_profile.py

@@ -21,38 +21,49 @@ __all__ = ['LogForwardingProfileArgs', 'LogForwardingProfile']
 @pulumi.input_type
 class LogForwardingProfileArgs:
     def __init__(__self__, *,
+                 match_lists: pulumi.Input[Sequence[pulumi.Input['LogForwardingProfileMatchListArgs']]],
                  description: Optional[pulumi.Input[_builtins.str]] = None,
                  device: Optional[pulumi.Input[_builtins.str]] = None,
                  folder: Optional[pulumi.Input[_builtins.str]] = None,
-                 match_lists: Optional[pulumi.Input[Sequence[pulumi.Input['LogForwardingProfileMatchListArgs']]]] = None,
                  name: Optional[pulumi.Input[_builtins.str]] = None,
                  snippet: Optional[pulumi.Input[_builtins.str]] = None):
         """
         The set of arguments for constructing a LogForwardingProfile resource.
+        :param pulumi.Input[Sequence[pulumi.Input['LogForwardingProfileMatchListArgs']]] match_lists: Match list
         :param pulumi.Input[_builtins.str] description: Log forwarding profile description
         :param pulumi.Input[_builtins.str] device: The device in which the resource is defined
         :param pulumi.Input[_builtins.str] folder: The folder in which the resource is defined
                
                > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
-        :param pulumi.Input[Sequence[pulumi.Input['LogForwardingProfileMatchListArgs']]] match_lists: Match list
         :param pulumi.Input[_builtins.str] name: The name of the log forwarding profile
         :param pulumi.Input[_builtins.str] snippet: The snippet in which the resource is defined
                
                > ℹ️ **Note:** You must specify exactly one of `device`, `folder`, and `snippet`.
         """
+        pulumi.set(__self__, "match_lists", match_lists)
         if description is not None:
             pulumi.set(__self__, "description", description)
         if device is not None:
             pulumi.set(__self__, "device", device)
         if folder is not None:
             pulumi.set(__self__, "folder", folder)
-        if match_lists is not None:
-            pulumi.set(__self__, "match_lists", match_lists)
         if name is not None:
             pulumi.set(__self__, "name", name)
         if snippet is not None:
             pulumi.set(__self__, "snippet", snippet)
 
+    @_builtins.property
+    @pulumi.getter(name="matchLists")
+    def match_lists(self) -> pulumi.Input[Sequence[pulumi.Input['LogForwardingProfileMatchListArgs']]]:
+        """
+        Match list
+        """
+        return pulumi.get(self, "match_lists")
+
+    @match_lists.setter
+    def match_lists(self, value: pulumi.Input[Sequence[pulumi.Input['LogForwardingProfileMatchListArgs']]]):
+        pulumi.set(self, "match_lists", value)
+
     @_builtins.property
     @pulumi.getter
     def description(self) -> Optional[pulumi.Input[_builtins.str]]:
@@ -91,18 +102,6 @@ class LogForwardingProfileArgs:
     def folder(self, value: Optional[pulumi.Input[_builtins.str]]):
         pulumi.set(self, "folder", value)
 
-    @_builtins.property
-    @pulumi.getter(name="matchLists")
-    def match_lists(self) -> Optional[pulumi.Input[Sequence[pulumi.Input['LogForwardingProfileMatchListArgs']]]]:
-        """
-        Match list
-        """
-        return pulumi.get(self, "match_lists")
-
-    @match_lists.setter
-    def match_lists(self, value: Optional[pulumi.Input[Sequence[pulumi.Input['LogForwardingProfileMatchListArgs']]]]):
-        pulumi.set(self, "match_lists", value)
-
     @_builtins.property
     @pulumi.getter
     def name(self) -> Optional[pulumi.Input[_builtins.str]]:
@@ -270,6 +269,134 @@ class LogForwardingProfile(pulumi.CustomResource):
         """
         LogForwardingProfile resource
 
+        ## Example Usage
+
+        ```python
+        import pulumi
+        import pulumi_scm as scm
+
+        scm_log_forwarding_profile1 = scm.LogForwardingProfile("scm_log_forwarding_profile_1",
+            folder="All",
+            name="scm-log-fowarding-profile-1",
+            match_lists=[{
+                "name": "profile_match",
+                "log_type": "threat",
+                "filter": "(addr in 192.50.10.10) and (addr.dst notin 192.40.50.10)",
+            }])
+        scm_log_forwarding_profile2 = scm.LogForwardingProfile("scm_log_forwarding_profile_2",
+            folder="All",
+            name="scm-log-fowarding-profile-2",
+            description="Log Forwarding w/ HTTP Server Profile and Syslog Server Profile",
+            match_lists=[{
+                "name": "profile_match",
+                "log_type": "traffic",
+                "filter": "(device_name eq test_device)",
+                "send_http": ["test_http"],
+                "send_syslog": [
+                    "syslog-server-prof-mixed",
+                    "syslog-server-prof-complete",
+                ],
+            }])
+        scm_log_forwarding_profile3 = scm.LogForwardingProfile("scm_log_forwarding_profile_3",
+            folder="All",
+            name="scm-log-fowarding-profile-3",
+            description="Log Forwarding w/ All Server Profiles",
+            match_lists=[{
+                "name": "profile_match",
+                "action_desc": "all server profiles",
+                "log_type": "dns-security",
+                "filter": "All Logs",
+                "send_http": [
+                    "test_http",
+                    "t10",
+                ],
+                "send_syslog": [
+                    "syslog-server-prof-base",
+                    "syslog-server-prof-mixed",
+                    "syslog-server-prof-complete",
+                ],
+                "send_snmptrap": ["snmp_test"],
+                "send_email": [
+                    "email_test",
+                    "email_test_2",
+                ],
+            }])
+        scm_log_forwarding_profile4 = scm.LogForwardingProfile("scm_log_forwarding_profile_4",
+            folder="All",
+            name="scm-log-fowarding-profile-4",
+            description="Log Forwarding w/ Multiple Match Lists",
+            match_lists=[
+                {
+                    "name": "profile_match_1",
+                    "action_desc": "match list for url",
+                    "log_type": "url",
+                    "filter": "(sdwan_cluster contains 123)",
+                    "send_http": ["t10"],
+                    "send_syslog": ["syslog-server-prof-base"],
+                    "send_snmptrap": ["snmp_test"],
+                },
+                {
+                    "name": "profile_match_2",
+                    "log_type": "data",
+                    "filter": "(link_switch_2 neq lnk_2) or (pkts_received geq 100)",
+                    "send_http": [
+                        "t5",
+                        "t10",
+                        "t20",
+                    ],
+                    "send_syslog": ["syslog-server-prof-mixed"],
+                    "send_email": [
+                        "email_test",
+                        "email_test_2",
+                    ],
+                },
+                {
+                    "name": "profile_match_3",
+                    "action_desc": "match list for wildfire",
+                    "log_type": "wildfire",
+                    "filter": "(imei contains test_server)",
+                    "send_http": [
+                        "t5",
+                        "t10",
+                        "t20",
+                        "t22",
+                        "t24",
+                    ],
+                    "send_syslog": ["syslog-server-prof-complete"],
+                    "send_email": [
+                        "email_test",
+                        "email_test_2",
+                    ],
+                },
+            ])
+        ```
+
+        ## Import
+
+        The following command can be used to import a resource not managed by Terraform:
+
+        bash
+
+        ```sh
+        $ pulumi import scm:index/logForwardingProfile:LogForwardingProfile example folder:::id
+        ```
+
+        or
+
+        bash
+
+        ```sh
+        $ pulumi import scm:index/logForwardingProfile:LogForwardingProfile example :snippet::id
+        ```
+
+        or
+
+        bash
+
+        ```sh
+        $ pulumi import scm:index/logForwardingProfile:LogForwardingProfile example ::device:id
+        ```
+
         :param str resource_name: The name of the resource.
         :param pulumi.ResourceOptions opts: Options for the resource.
         :param pulumi.Input[_builtins.str] description: Log forwarding profile description
@@ -287,11 +414,139 @@ class LogForwardingProfile(pulumi.CustomResource):
     @overload
     def __init__(__self__,
                  resource_name: str,
-                 args: Optional[LogForwardingProfileArgs] = None,
+                 args: LogForwardingProfileArgs,
                  opts: Optional[pulumi.ResourceOptions] = None):
         """
         LogForwardingProfile resource
 
+        ## Example Usage
+
+        ```python
+        import pulumi
+        import pulumi_scm as scm
+
+        scm_log_forwarding_profile1 = scm.LogForwardingProfile("scm_log_forwarding_profile_1",
+            folder="All",
+            name="scm-log-fowarding-profile-1",
+            match_lists=[{
+                "name": "profile_match",
+                "log_type": "threat",
+                "filter": "(addr in 192.50.10.10) and (addr.dst notin 192.40.50.10)",
+            }])
+        scm_log_forwarding_profile2 = scm.LogForwardingProfile("scm_log_forwarding_profile_2",
+            folder="All",
+            name="scm-log-fowarding-profile-2",
+            description="Log Forwarding w/ HTTP Server Profile and Syslog Server Profile",
+            match_lists=[{
+                "name": "profile_match",
+                "log_type": "traffic",
+                "filter": "(device_name eq test_device)",
+                "send_http": ["test_http"],
+                "send_syslog": [
+                    "syslog-server-prof-mixed",
+                    "syslog-server-prof-complete",
+                ],
+            }])
+        scm_log_forwarding_profile3 = scm.LogForwardingProfile("scm_log_forwarding_profile_3",
+            folder="All",
+            name="scm-log-fowarding-profile-3",
+            description="Log Forwarding w/ All Server Profiles",
+            match_lists=[{
+                "name": "profile_match",
+                "action_desc": "all server profiles",
+                "log_type": "dns-security",
+                "filter": "All Logs",
+                "send_http": [
+                    "test_http",
+                    "t10",
+                ],
+                "send_syslog": [
+                    "syslog-server-prof-base",
+                    "syslog-server-prof-mixed",
+                    "syslog-server-prof-complete",
+                ],
+                "send_snmptrap": ["snmp_test"],
+                "send_email": [
+                    "email_test",
+                    "email_test_2",
+                ],
+            }])
+        scm_log_forwarding_profile4 = scm.LogForwardingProfile("scm_log_forwarding_profile_4",
+            folder="All",
+            name="scm-log-fowarding-profile-4",
+            description="Log Forwarding w/ Multiple Match Lists",
+            match_lists=[
+                {
+                    "name": "profile_match_1",
+                    "action_desc": "match list for url",
+                    "log_type": "url",
+                    "filter": "(sdwan_cluster contains 123)",
+                    "send_http": ["t10"],
+                    "send_syslog": ["syslog-server-prof-base"],
+                    "send_snmptrap": ["snmp_test"],
+                },
+                {
+                    "name": "profile_match_2",
+                    "log_type": "data",
+                    "filter": "(link_switch_2 neq lnk_2) or (pkts_received geq 100)",
+                    "send_http": [
+                        "t5",
+                        "t10",
+                        "t20",
+                    ],
+                    "send_syslog": ["syslog-server-prof-mixed"],
+                    "send_email": [
+                        "email_test",
+                        "email_test_2",
+                    ],
+                },
+                {
+                    "name": "profile_match_3",
+                    "action_desc": "match list for wildfire",
+                    "log_type": "wildfire",
+                    "filter": "(imei contains test_server)",
+                    "send_http": [
+                        "t5",
+                        "t10",
+                        "t20",
+                        "t22",
+                        "t24",
+                    ],
+                    "send_syslog": ["syslog-server-prof-complete"],
+                    "send_email": [
+                        "email_test",
+                        "email_test_2",
+                    ],
+                },
+            ])
+        ```
+
+        ## Import
+
+        The following command can be used to import a resource not managed by Terraform:
+
+        bash
+
+        ```sh
+        $ pulumi import scm:index/logForwardingProfile:LogForwardingProfile example folder:::id
+        ```
+
+        or
+
+        bash
+
+        ```sh
+        $ pulumi import scm:index/logForwardingProfile:LogForwardingProfile example :snippet::id
+        ```
+
+        or
+
+        bash
+
+        ```sh
+        $ pulumi import scm:index/logForwardingProfile:LogForwardingProfile example ::device:id
+        ```
+
         :param str resource_name: The name of the resource.
         :param LogForwardingProfileArgs args: The arguments to use to populate this resource's properties.
         :param pulumi.ResourceOptions opts: Options for the resource.
@@ -325,6 +580,8 @@ class LogForwardingProfile(pulumi.CustomResource):
             __props__.__dict__["description"] = description
             __props__.__dict__["device"] = device
             __props__.__dict__["folder"] = folder
+            if match_lists is None and not opts.urn:
+                raise TypeError("Missing required property 'match_lists'")
             __props__.__dict__["match_lists"] = match_lists
             __props__.__dict__["name"] = name
             __props__.__dict__["snippet"] = snippet
@@ -405,7 +662,7 @@ class LogForwardingProfile(pulumi.CustomResource):
 
     @_builtins.property
     @pulumi.getter(name="matchLists")
-    def match_lists(self) -> pulumi.Output[Optional[Sequence['outputs.LogForwardingProfileMatchList']]]:
+    def match_lists(self) -> pulumi.Output[Sequence['outputs.LogForwardingProfileMatchList']]:
         """
         Match list
         """

pulumi_scm/logical_router.py

@@ -411,6 +411,32 @@ class LogicalRouter(pulumi.CustomResource):
                 ]))
         ```
 
+        ## Import
+
+        The following command can be used to import a resource not managed by Terraform:
+
+        bash
+
+        ```sh
+        $ pulumi import scm:index/logicalRouter:LogicalRouter example folder:::id
+        ```
+
+        or
+
+        bash
+
+        ```sh
+        $ pulumi import scm:index/logicalRouter:LogicalRouter example :snippet::id
+        ```
+
+        or
+
+        bash
+
+        ```sh
+        $ pulumi import scm:index/logicalRouter:LogicalRouter example ::device:id
+        ```
+
         :param str resource_name: The name of the resource.
         :param pulumi.ResourceOptions opts: Options for the resource.
         :param pulumi.Input[_builtins.str] device: The device in which the resource is defined
@@ -574,6 +600,32 @@ class LogicalRouter(pulumi.CustomResource):
                 ]))
         ```
 
+        ## Import
+
+        The following command can be used to import a resource not managed by Terraform:
+
+        bash
+
+        ```sh
+        $ pulumi import scm:index/logicalRouter:LogicalRouter example folder:::id
+        ```
+
+        or
+
+        bash
+
+        ```sh
+        $ pulumi import scm:index/logicalRouter:LogicalRouter example :snippet::id
+        ```
+
+        or
+
+        bash
+
+        ```sh
+        $ pulumi import scm:index/logicalRouter:LogicalRouter example ::device:id
+        ```
+
         :param str resource_name: The name of the resource.
         :param LogicalRouterArgs args: The arguments to use to populate this resource's properties.
         :param pulumi.ResourceOptions opts: Options for the resource.

pulumi_scm/loopback_interface.py

@@ -429,6 +429,58 @@ class LoopbackInterface(pulumi.CustomResource):
             ips=[{
                 "name": "198.18.1.2/32",
             }])
+        #
+        # Creates an ip subnet variable used in the subsequent example
+        #
+        scm_ipv6_prefix = scm.Variable("scm_ipv6_prefix",
+            folder="ngfw-shared",
+            name="$scm_ipv6_prefix",
+            description="Managed by Pulumi",
+            type="ip-netmask",
+            value="2001:0db8:abcd:0001::/64")
+        #
+        # Creates a loopback interface with ipv6 address, with default value loopback.321
+        #
+        scm_loopback_intf3 = scm.LoopbackInterface("scm_loopback_intf_3",
+            name="$scm_loopback_intf3",
+            comment="Managed by Pulumi",
+            folder="ngfw-shared",
+            default_value="loopback.321",
+            ipv6={
+                "enabled": True,
+                "interface_id": "EUI-64",
+                "addresses": [{
+                    "name": "$scm_ipv6_prefix",
+                    "prefix": {},
+                }],
+            },
+            opts = pulumi.ResourceOptions(depends_on=[scm_ipv6_prefix]))
+        ```
+
+        ## Import
+
+        The following command can be used to import a resource not managed by Terraform:
+
+        bash
+
+        ```sh
+        $ pulumi import scm:index/loopbackInterface:LoopbackInterface example folder:::id
+        ```
+
+        or
+
+        bash
+
+        ```sh
+        $ pulumi import scm:index/loopbackInterface:LoopbackInterface example :snippet::id
+        ```
+
+        or
+
+        bash
+
+        ```sh
+        $ pulumi import scm:index/loopbackInterface:LoopbackInterface example ::device:id
         ```
 
         :param str resource_name: The name of the resource.
@@ -484,6 +536,58 @@ class LoopbackInterface(pulumi.CustomResource):
             ips=[{
                 "name": "198.18.1.2/32",
             }])
+        #
+        # Creates an ip subnet variable used in the subsequent example
+        #
+        scm_ipv6_prefix = scm.Variable("scm_ipv6_prefix",
+            folder="ngfw-shared",
+            name="$scm_ipv6_prefix",
+            description="Managed by Pulumi",
+            type="ip-netmask",
+            value="2001:0db8:abcd:0001::/64")
+        #
+        # Creates a loopback interface with ipv6 address, with default value loopback.321
+        #
+        scm_loopback_intf3 = scm.LoopbackInterface("scm_loopback_intf_3",
+            name="$scm_loopback_intf3",
+            comment="Managed by Pulumi",
+            folder="ngfw-shared",
+            default_value="loopback.321",
+            ipv6={
+                "enabled": True,
+                "interface_id": "EUI-64",
+                "addresses": [{
+                    "name": "$scm_ipv6_prefix",
+                    "prefix": {},
+                }],
+            },
+            opts = pulumi.ResourceOptions(depends_on=[scm_ipv6_prefix]))
+        ```
+
+        ## Import
+
+        The following command can be used to import a resource not managed by Terraform:
+
+        bash
+
+        ```sh
+        $ pulumi import scm:index/loopbackInterface:LoopbackInterface example folder:::id
+        ```
+
+        or
+
+        bash
+
+        ```sh
+        $ pulumi import scm:index/loopbackInterface:LoopbackInterface example :snippet::id
+        ```
+
+        or
+
+        bash
+
+        ```sh
+        $ pulumi import scm:index/loopbackInterface:LoopbackInterface example ::device:id
         ```
 
         :param str resource_name: The name of the resource.
@@ -643,7 +747,7 @@ class LoopbackInterface(pulumi.CustomResource):
 
     @_builtins.property
     @pulumi.getter
-    def ipv6(self) -> pulumi.Output['outputs.LoopbackInterfaceIpv6']:
+    def ipv6(self) -> pulumi.Output[Optional['outputs.LoopbackInterfaceIpv6']]:
         """
         Loopback IPv6 Configuration
         """