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

pulumi_scm/get_syslog_server_profile_list.py

@@ -165,6 +165,20 @@ def get_syslog_server_profile_list(device: Optional[_builtins.str] = None,
     """
     Retrieves a listing of config items.
 
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_scm as scm
+
+    #
+    # Data source to retrieve a list of SCM Syslog Server Profile objects.
+    #
+    # Example 1: Fetch a list of all SCM Syslog Server Profile in the "Shared" folder.
+    all_shared = scm.get_syslog_server_profile_list(folder="All")
+    pulumi.export("scmSyslogServerProfileListAllShared", all_shared.datas)
+    ```
+
 
     :param _builtins.str device: The device of the item.
     :param _builtins.str folder: The folder of the item. Default: Shared.
@@ -204,6 +218,20 @@ def get_syslog_server_profile_list_output(device: Optional[pulumi.Input[Optional
     """
     Retrieves a listing of config items.
 
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_scm as scm
+
+    #
+    # Data source to retrieve a list of SCM Syslog Server Profile objects.
+    #
+    # Example 1: Fetch a list of all SCM Syslog Server Profile in the "Shared" folder.
+    all_shared = scm.get_syslog_server_profile_list(folder="All")
+    pulumi.export("scmSyslogServerProfileListAllShared", all_shared.datas)
+    ```
+
 
     :param _builtins.str device: The device of the item.
     :param _builtins.str folder: The folder of the item. Default: Shared.

pulumi_scm/get_tacacs_server_profile.py

@@ -27,10 +27,13 @@ class GetTacacsServerProfileResult:
     """
     A collection of values returned by getTacacsServerProfile.
     """
-    def __init__(__self__, device=None, folder=None, id=None, name=None, protocol=None, servers=None, snippet=None, tfid=None, timeout=None, use_single_connection=None):
+    def __init__(__self__, device=None, encrypted_values=None, folder=None, id=None, name=None, protocol=None, servers=None, snippet=None, tfid=None, timeout=None, use_single_connection=None):
         if device and not isinstance(device, str):
             raise TypeError("Expected argument 'device' to be a str")
         pulumi.set(__self__, "device", device)
+        if encrypted_values and not isinstance(encrypted_values, dict):
+            raise TypeError("Expected argument 'encrypted_values' to be a dict")
+        pulumi.set(__self__, "encrypted_values", encrypted_values)
         if folder and not isinstance(folder, str):
             raise TypeError("Expected argument 'folder' to be a str")
         pulumi.set(__self__, "folder", folder)
@@ -67,6 +70,11 @@ class GetTacacsServerProfileResult:
         """
         return pulumi.get(self, "device")
 
+    @_builtins.property
+    @pulumi.getter(name="encryptedValues")
+    def encrypted_values(self) -> Mapping[str, _builtins.str]:
+        return pulumi.get(self, "encrypted_values")
+
     @_builtins.property
     @pulumi.getter
     def folder(self) -> _builtins.str:
@@ -83,9 +91,6 @@ class GetTacacsServerProfileResult:
     @_builtins.property
     @pulumi.getter
     def name(self) -> _builtins.str:
-        """
-        The name of the TACACS+ server profile
-        """
         return pulumi.get(self, "name")
 
     @_builtins.property
@@ -126,6 +131,7 @@ class AwaitableGetTacacsServerProfileResult(GetTacacsServerProfileResult):
             yield self
         return GetTacacsServerProfileResult(
             device=self.device,
+            encrypted_values=self.encrypted_values,
             folder=self.folder,
             id=self.id,
             name=self.name,
@@ -137,24 +143,48 @@ class AwaitableGetTacacsServerProfileResult(GetTacacsServerProfileResult):
             use_single_connection=self.use_single_connection)
 
 
-def get_tacacs_server_profile(id: Optional[_builtins.str] = None,
+def get_tacacs_server_profile(device: Optional[_builtins.str] = None,
+                              folder: Optional[_builtins.str] = None,
+                              id: Optional[_builtins.str] = None,
                               name: Optional[_builtins.str] = None,
+                              snippet: Optional[_builtins.str] = None,
                               opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetTacacsServerProfileResult:
     """
     TacacsServerProfile data source
 
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_scm as scm
 
+    # Look up the multi-tag address object by its ID.
+    scm_tacacs_server_profile5_ds = scm.get_tacacs_server_profile(id="1967a784-402b-4c20-aa48-aab64d73cc06")
+    pulumi.export("profileDataSourceResults", {
+        "name": scm_tacacs_server_profile5_ds.name,
+        "protocol": scm_tacacs_server_profile5_ds.protocol,
+        "timeout": scm_tacacs_server_profile5_ds.timeout,
+        "folder": scm_tacacs_server_profile5_ds.folder,
+        "useSingleConnection": scm_tacacs_server_profile5_ds.use_single_connection,
+    })
+    ```
+
+
+    :param _builtins.str device: The device in which the resource is defined
     :param _builtins.str id: The UUID of the TACACS+ server profile
-    :param _builtins.str name: The name of the TACACS+ server profile
     """
     __args__ = dict()
+    __args__['device'] = device
+    __args__['folder'] = folder
     __args__['id'] = id
     __args__['name'] = name
+    __args__['snippet'] = snippet
     opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
     __ret__ = pulumi.runtime.invoke('scm:index/getTacacsServerProfile:getTacacsServerProfile', __args__, opts=opts, typ=GetTacacsServerProfileResult).value
 
     return AwaitableGetTacacsServerProfileResult(
         device=pulumi.get(__ret__, 'device'),
+        encrypted_values=pulumi.get(__ret__, 'encrypted_values'),
         folder=pulumi.get(__ret__, 'folder'),
         id=pulumi.get(__ret__, 'id'),
         name=pulumi.get(__ret__, 'name'),
@@ -164,23 +194,47 @@ def get_tacacs_server_profile(id: Optional[_builtins.str] = None,
         tfid=pulumi.get(__ret__, 'tfid'),
         timeout=pulumi.get(__ret__, 'timeout'),
         use_single_connection=pulumi.get(__ret__, 'use_single_connection'))
-def get_tacacs_server_profile_output(id: Optional[pulumi.Input[_builtins.str]] = None,
+def get_tacacs_server_profile_output(device: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
+                                     folder: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
+                                     id: Optional[pulumi.Input[_builtins.str]] = None,
                                      name: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
+                                     snippet: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
                                      opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetTacacsServerProfileResult]:
     """
     TacacsServerProfile data source
 
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_scm as scm
+
+    # Look up the multi-tag address object by its ID.
+    scm_tacacs_server_profile5_ds = scm.get_tacacs_server_profile(id="1967a784-402b-4c20-aa48-aab64d73cc06")
+    pulumi.export("profileDataSourceResults", {
+        "name": scm_tacacs_server_profile5_ds.name,
+        "protocol": scm_tacacs_server_profile5_ds.protocol,
+        "timeout": scm_tacacs_server_profile5_ds.timeout,
+        "folder": scm_tacacs_server_profile5_ds.folder,
+        "useSingleConnection": scm_tacacs_server_profile5_ds.use_single_connection,
+    })
+    ```
+
 
+    :param _builtins.str device: The device in which the resource is defined
     :param _builtins.str id: The UUID of the TACACS+ server profile
-    :param _builtins.str name: The name of the TACACS+ server profile
     """
     __args__ = dict()
+    __args__['device'] = device
+    __args__['folder'] = folder
     __args__['id'] = id
     __args__['name'] = name
+    __args__['snippet'] = snippet
     opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
     __ret__ = pulumi.runtime.invoke_output('scm:index/getTacacsServerProfile:getTacacsServerProfile', __args__, opts=opts, typ=GetTacacsServerProfileResult)
     return __ret__.apply(lambda __response__: GetTacacsServerProfileResult(
         device=pulumi.get(__response__, 'device'),
+        encrypted_values=pulumi.get(__response__, 'encrypted_values'),
         folder=pulumi.get(__response__, 'folder'),
         id=pulumi.get(__response__, 'id'),
         name=pulumi.get(__response__, 'name'),

pulumi_scm/get_tacacs_server_profile_list.py

@@ -165,6 +165,18 @@ def get_tacacs_server_profile_list(device: Optional[_builtins.str] = None,
     """
     Retrieves a listing of config items.
 
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_scm as scm
+
+    # Look up the multi-tag address object by its ID.
+    scm_tacacs_server_profiles = scm.get_tacacs_server_profile_list(folder="All")
+    pulumi.export("profileDataSourceResults", scm_tacacs_server_profiles.datas)
+    pulumi.export("profileNames", [profile.name for profile in scm_tacacs_server_profiles.datas])
+    ```
+
 
     :param _builtins.str device: The device of the item.
     :param _builtins.str folder: The folder of the item. Default: Shared.
@@ -204,6 +216,18 @@ def get_tacacs_server_profile_list_output(device: Optional[pulumi.Input[Optional
     """
     Retrieves a listing of config items.
 
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_scm as scm
+
+    # Look up the multi-tag address object by its ID.
+    scm_tacacs_server_profiles = scm.get_tacacs_server_profile_list(folder="All")
+    pulumi.export("profileDataSourceResults", scm_tacacs_server_profiles.datas)
+    pulumi.export("profileNames", [profile.name for profile in scm_tacacs_server_profiles.datas])
+    ```
+
 
     :param _builtins.str device: The device of the item.
     :param _builtins.str folder: The folder of the item. Default: Shared.

pulumi_scm/get_tag.py

@@ -55,17 +55,11 @@ class GetTagResult:
     @_builtins.property
     @pulumi.getter
     def color(self) -> _builtins.str:
-        """
-        The color of the tag
-        """
         return pulumi.get(self, "color")
 
     @_builtins.property
     @pulumi.getter
     def comments(self) -> _builtins.str:
-        """
-        The description of the tag
-        """
         return pulumi.get(self, "comments")
 
     @_builtins.property
@@ -92,9 +86,6 @@ class GetTagResult:
     @_builtins.property
     @pulumi.getter
     def name(self) -> _builtins.str:
-        """
-        The name of the tag
-        """
         return pulumi.get(self, "name")
 
     @_builtins.property
@@ -124,8 +115,11 @@ class AwaitableGetTagResult(GetTagResult):
             tfid=self.tfid)
 
 
-def get_tag(id: Optional[_builtins.str] = None,
+def get_tag(device: Optional[_builtins.str] = None,
+            folder: Optional[_builtins.str] = None,
+            id: Optional[_builtins.str] = None,
             name: Optional[_builtins.str] = None,
+            snippet: Optional[_builtins.str] = None,
             opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetTagResult:
     """
     Tag data source
@@ -148,12 +142,15 @@ def get_tag(id: Optional[_builtins.str] = None,
     ```
 
 
+    :param _builtins.str device: The device in which the resource is defined
     :param _builtins.str id: The UUID of the tag
-    :param _builtins.str name: The name of the tag
     """
     __args__ = dict()
+    __args__['device'] = device
+    __args__['folder'] = folder
     __args__['id'] = id
     __args__['name'] = name
+    __args__['snippet'] = snippet
     opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
     __ret__ = pulumi.runtime.invoke('scm:index/getTag:getTag', __args__, opts=opts, typ=GetTagResult).value
 
@@ -166,8 +163,11 @@ def get_tag(id: Optional[_builtins.str] = None,
         name=pulumi.get(__ret__, 'name'),
         snippet=pulumi.get(__ret__, 'snippet'),
         tfid=pulumi.get(__ret__, 'tfid'))
-def get_tag_output(id: Optional[pulumi.Input[_builtins.str]] = None,
+def get_tag_output(device: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
+                   folder: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
+                   id: Optional[pulumi.Input[_builtins.str]] = None,
                    name: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
+                   snippet: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
                    opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetTagResult]:
     """
     Tag data source
@@ -190,12 +190,15 @@ def get_tag_output(id: Optional[pulumi.Input[_builtins.str]] = None,
     ```
 
 
+    :param _builtins.str device: The device in which the resource is defined
     :param _builtins.str id: The UUID of the tag
-    :param _builtins.str name: The name of the tag
     """
     __args__ = dict()
+    __args__['device'] = device
+    __args__['folder'] = folder
     __args__['id'] = id
     __args__['name'] = name
+    __args__['snippet'] = snippet
     opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
     __ret__ = pulumi.runtime.invoke_output('scm:index/getTag:getTag', __args__, opts=opts, typ=GetTagResult)
     return __ret__.apply(lambda __response__: GetTagResult(

pulumi_scm/get_tcp_setting.py

@@ -0,0 +1,173 @@
+# coding=utf-8
+# *** WARNING: this file was generated by pulumi-language-python. ***
+# *** Do not edit by hand unless you're certain you know what you are doing! ***
+
+import builtins as _builtins
+import warnings
+import sys
+import pulumi
+import pulumi.runtime
+from typing import Any, Mapping, Optional, Sequence, Union, overload
+if sys.version_info >= (3, 11):
+    from typing import NotRequired, TypedDict, TypeAlias
+else:
+    from typing_extensions import NotRequired, TypedDict, TypeAlias
+from . import _utilities
+from . import outputs
+
+__all__ = [
+    'GetTcpSettingResult',
+    'AwaitableGetTcpSettingResult',
+    'get_tcp_setting',
+    'get_tcp_setting_output',
+]
+
+@pulumi.output_type
+class GetTcpSettingResult:
+    """
+    A collection of values returned by getTcpSetting.
+    """
+    def __init__(__self__, device=None, folder=None, id=None, snippet=None, tcp=None, tfid=None):
+        if device and not isinstance(device, str):
+            raise TypeError("Expected argument 'device' to be a str")
+        pulumi.set(__self__, "device", device)
+        if folder and not isinstance(folder, str):
+            raise TypeError("Expected argument 'folder' to be a str")
+        pulumi.set(__self__, "folder", folder)
+        if id and not isinstance(id, str):
+            raise TypeError("Expected argument 'id' to be a str")
+        pulumi.set(__self__, "id", id)
+        if snippet and not isinstance(snippet, str):
+            raise TypeError("Expected argument 'snippet' to be a str")
+        pulumi.set(__self__, "snippet", snippet)
+        if tcp and not isinstance(tcp, dict):
+            raise TypeError("Expected argument 'tcp' to be a dict")
+        pulumi.set(__self__, "tcp", tcp)
+        if tfid and not isinstance(tfid, str):
+            raise TypeError("Expected argument 'tfid' to be a str")
+        pulumi.set(__self__, "tfid", tfid)
+
+    @_builtins.property
+    @pulumi.getter
+    def device(self) -> _builtins.str:
+        """
+        The device in which the resource is defined
+        """
+        return pulumi.get(self, "device")
+
+    @_builtins.property
+    @pulumi.getter
+    def folder(self) -> _builtins.str:
+        return pulumi.get(self, "folder")
+
+    @_builtins.property
+    @pulumi.getter
+    def id(self) -> _builtins.str:
+        """
+        UUID of the resource
+        """
+        return pulumi.get(self, "id")
+
+    @_builtins.property
+    @pulumi.getter
+    def snippet(self) -> _builtins.str:
+        return pulumi.get(self, "snippet")
+
+    @_builtins.property
+    @pulumi.getter
+    def tcp(self) -> 'outputs.GetTcpSettingTcpResult':
+        return pulumi.get(self, "tcp")
+
+    @_builtins.property
+    @pulumi.getter
+    def tfid(self) -> _builtins.str:
+        return pulumi.get(self, "tfid")
+
+
+class AwaitableGetTcpSettingResult(GetTcpSettingResult):
+    # pylint: disable=using-constant-test
+    def __await__(self):
+        if False:
+            yield self
+        return GetTcpSettingResult(
+            device=self.device,
+            folder=self.folder,
+            id=self.id,
+            snippet=self.snippet,
+            tcp=self.tcp,
+            tfid=self.tfid)
+
+
+def get_tcp_setting(device: Optional[_builtins.str] = None,
+                    folder: Optional[_builtins.str] = None,
+                    id: Optional[_builtins.str] = None,
+                    snippet: Optional[_builtins.str] = None,
+                    opts: Optional[pulumi.InvokeOptions] = None) -> AwaitableGetTcpSettingResult:
+    """
+    TcpSetting data source
+
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_scm as scm
+
+    settings_data = scm.get_tcp_setting(id="e7e9b9e1-e8db-4eed-b355-099a36a380c9")
+    pulumi.export("fetchedSettings", settings_data)
+    ```
+
+
+    :param _builtins.str device: The device in which the resource is defined
+    :param _builtins.str id: UUID of the resource
+    """
+    __args__ = dict()
+    __args__['device'] = device
+    __args__['folder'] = folder
+    __args__['id'] = id
+    __args__['snippet'] = snippet
+    opts = pulumi.InvokeOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke('scm:index/getTcpSetting:getTcpSetting', __args__, opts=opts, typ=GetTcpSettingResult).value
+
+    return AwaitableGetTcpSettingResult(
+        device=pulumi.get(__ret__, 'device'),
+        folder=pulumi.get(__ret__, 'folder'),
+        id=pulumi.get(__ret__, 'id'),
+        snippet=pulumi.get(__ret__, 'snippet'),
+        tcp=pulumi.get(__ret__, 'tcp'),
+        tfid=pulumi.get(__ret__, 'tfid'))
+def get_tcp_setting_output(device: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
+                           folder: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
+                           id: Optional[pulumi.Input[_builtins.str]] = None,
+                           snippet: Optional[pulumi.Input[Optional[_builtins.str]]] = None,
+                           opts: Optional[Union[pulumi.InvokeOptions, pulumi.InvokeOutputOptions]] = None) -> pulumi.Output[GetTcpSettingResult]:
+    """
+    TcpSetting data source
+
+    ## Example Usage
+
+    ```python
+    import pulumi
+    import pulumi_scm as scm
+
+    settings_data = scm.get_tcp_setting(id="e7e9b9e1-e8db-4eed-b355-099a36a380c9")
+    pulumi.export("fetchedSettings", settings_data)
+    ```
+
+
+    :param _builtins.str device: The device in which the resource is defined
+    :param _builtins.str id: UUID of the resource
+    """
+    __args__ = dict()
+    __args__['device'] = device
+    __args__['folder'] = folder
+    __args__['id'] = id
+    __args__['snippet'] = snippet
+    opts = pulumi.InvokeOutputOptions.merge(_utilities.get_invoke_opts_defaults(), opts)
+    __ret__ = pulumi.runtime.invoke_output('scm:index/getTcpSetting:getTcpSetting', __args__, opts=opts, typ=GetTcpSettingResult)
+    return __ret__.apply(lambda __response__: GetTcpSettingResult(
+        device=pulumi.get(__response__, 'device'),
+        folder=pulumi.get(__response__, 'folder'),
+        id=pulumi.get(__response__, 'id'),
+        snippet=pulumi.get(__response__, 'snippet'),
+        tcp=pulumi.get(__response__, 'tcp'),
+        tfid=pulumi.get(__response__, 'tfid')))