airflow.providers.microsoft.psrp.operators.psrp¶

类¶

PsrpOperator

PowerShell 远程处理协议 operator。

模块内容¶

class airflow.providers.microsoft.psrp.operators.psrp.PsrpOperator(*, psrp_conn_id, command=None, powershell=None, cmdlet=None, arguments=None, parameters=None, logging_level=DEBUG, runspace_options=None, wsman_options=None, psrp_session_init=None, **kwargs)[source]¶

基类： airflow.models.BaseOperator

PowerShell 远程处理协议 operator。

使用 ‘command’、‘cmdlet’ 或 ‘powershell’ 参数中的一个。

‘securestring’ 模板过滤器可用于标记值，以便将其序列化为 System.Security.SecureString （仅适用于设置了 render_template_as_native_obj=True 的 DAG）。

当使用 cmdlet 或 powershell 参数且启用了 do_xcom_push 时，命令输出会由 PowerShell 使用 ConvertTo-Json cmdlet 转换为 JSON，以便 operator 的返回值可以序列化为 XCom 值。

参数：

psrp_conn_id (str) – 连接 ID
command (str | None) – 要在远程主机上执行的命令。（可模板化）
powershell (str | None) – 要在远程主机上执行的 powershell 代码。（可模板化）
cmdlet (str | None) – 要在远程主机上执行的 cmdlet（可模板化）。也用作 task_id 的默认值。
arguments (list[str] | None) – 当使用 cmdlet 或 powershell 选项时，使用 arguments 来提供参数（可模板化）。
parameters (dict[str, str] | None) – 当使用 cmdlet 或 powershell 选项时，使用 parameters 来提供参数（可模板化）。请注意，值为 None 的参数会变成一个 argument (即，开关参数)。
logging_level (int) – 远程执行期间接收到的消息流的日志级别。默认是将所有消息包含在任务日志中。
runspace_options (dict[str, Any] | None) – 创建 runspace pool 时传递的可选字典。有关可用选项的说明，请参阅 RunspacePool。
wsman_options (dict[str, Any] | None) – 创建 WSMan 客户端时传递的可选字典。有关可用选项的说明，请参阅 WSMan。
psrp_session_init (pypsrp.powershell.Command | None) – 建立新的 PowerShell 会话时将添加到 pipeline 的可选命令，在调用使用 cmdlet、command 或 powershell 参数指定的动作之前。

template_fields: collections.abc.Sequence[str] = ('cmdlet', 'command', 'arguments', 'parameters', 'powershell')[source]¶

template_fields_renderers[source]¶

ui_color = '#c2e2ff'[source]¶

conn_id[source]¶

command = None[source]¶

powershell = None[source]¶

cmdlet = None[source]¶

arguments = None[source]¶

parameters = None[source]¶

logging_level = 10[source]¶

runspace_options = None[source]¶

wsman_options = None[source]¶

psrp_session_init = None[source]¶

execute(context)[source]¶

在创建 operator 时派生。

context 与渲染 jinja 模板时使用的字典相同。

有关更多 context，请参阅 get_template_context。

get_template_env()[source]¶: 获取用于渲染模板的模板环境。