Python·SSH로 운영 작업 자동화하기

01대상·연결·작업·결과 저장을 별도 함수로 나누기

• 여러 장비의 반복 작업SSH 자동화는 Linux의 주소·경로 조회와 네트워크 장비의 설정 조회·변경을 여러 대상에 반복하는 구조다.
• 대상·연결이를 대상 목록 읽기, 연결, 명령 선택, 결과 수집, 파일 저장, 종료 단계로 나누면 입력 오류와 원격 실행 오류를 구분할 수 있다.
• 인증장치마다 hostname·종류·인증 방법을 자료로 두고 그 값을 명령 문자열 안에 무조건 이어 붙이지 않는다.
• 대상·명령조회 작업의 결과는 대상 식별자·명령·시각·종료 코드·표준 출력·오류와 연결되어야 한다.
• 출력의 대상 식별화면에 문자열이 보였다는 이유만으로 저장이 완료되었다고 판정하지 않는다.

  • 같은 경로에 모두 덮어쓰면 어느 장비의 자료인지 사라지므로 파일명과 기록 구조를 미리 정한다.
• 대상·작업·비밀 분리재사용할 자동화에서는 대상 정보·작업 정의·자격증명을 분리하여 관리한다.

02Paramiko의 SSHClient·Transport·Channel

• SSHClientSSHClient는 서버 키 검증과 인증·채널 생성을 다루는 고수준 객체다.
• 명령 채널·세 스트림내부 SSH 전송 연결 위에서 exec_command가 새 채널을 열어 명령을 요청하고 stdin·stdout·stderr를 파일과 비슷한 객체로 반환한다.
• 프롬프트invoke_shell은 대화형 터미널 채널을 만들어 프롬프트·모드 전환을 주고받는 방식이라 단일 명령 요청과 제어 흐름이 다르다.
• known_hostsload_system_host_keys 또는 지정 known_hosts 파일로 이미 검증한 서버 키를 불러오고 기본 RejectPolicy로 모르는 서버를 거부하는 구성은 접속 대상 확인을 유지한다.
• AutoAddPolicyAutoAddPolicy는 새로운 키를 자동 신뢰하는 정책이지 키 교환 알고리즘 오류를 해결하는 기능이 아니다.
• 인증사용자의 개인키 또는 agent 인증과 서버 host key의 신뢰는 별도로 준비한다.

import paramiko

with paramiko.SSHClient() as client:
    client.load_system_host_keys()
    client.connect("server.example", username="observer",
                   timeout=5, banner_timeout=5, auth_timeout=5)
    stdin, stdout, stderr = client.exec_command("uname -s", timeout=5)
    stdin.close()
    out = stdout.read().decode("utf-8", errors="replace")
    err = stderr.read().decode("utf-8", errors="replace")
    status = stdout.channel.recv_exit_status()
    print({"rc": status, "stdout": out.strip(), "stderr": err.strip()})

교육용 예시. 실제 원격 접속·설정 변경·배포는 실행하지 않았다.

03출력 스트림·종료 상태·timeout의 실제 의미

• 작은 출력 예제의 전제위 코드는 uname -s처럼 출력이 작고 종료하는 고정 조회 명령을 가정한다.
• stdout·stderr일반 대용량 작업에서 stdout을 다 읽은 뒤 stderr를 읽거나 출력이 남은 채 종료 상태부터 기다리면 SSH 채널의 흐름 제어와 버퍼 때문에 막힐 수 있다.
• 출력 크기의 전제그런 작업은 두 스트림을 함께 비우고 전체 기한과 최대 출력량을 정하는 수집 구조가 필요하다.

  • 예제 하나를 임의 명령 실행기로 확장하면 이 전제가 사라진다.
• rc=0rc=0은 그 프로그램의 성공 관례이며 출력이 비었다고 실패도 성공도 자동 판정할 수 없다.

  • 반대로 stderr에 경고가 있어도 rc는 성공일 수 있다.
• timeout접속 timeout, SSH banner timeout, 인증 timeout, 명령 채널 timeout은 기다리는 단계가 다르다.
• bytesbytes를 디코딩할 때 replace는 깨진 바이트가 있었다는 표시를 남기는 선택이며 정확한 바이너리 자료의 보존은 원본 bytes를 따로 유지해야 한다.

07Netmiko가 네트워크 장비 CLI에 더하는 처리

• 장비 CLI의 모드네트워크 OS CLI는 Linux 명령 실행과 달리 사용자·특권·설정 모드, 프롬프트, 화면 페이지 분할이 있다.
• NetmikoNetmiko는 장비 종류별로 이런 터미널 동작을 처리하는 연결 기능을 제공한다.
• send_command·명령send_command는 조회 명령의 출력과 종료 프롬프트를 기다리고 send_config_set은 설정 모드에서 여러 명령을 적용하는 용도다.
• 조회와 설정 호출두 호출을 같은 단순 문자열 전송으로 취급하면 모드와 실패 검출을 놓칠 수 있다.
• 대상·인증device_type은 장비 드라이버 선택, host는 접속 대상, 인증값은 로그인에 사용된다.
• 호스트 키 검증 정책운영 구조에서는 ssh_strict와 호스트키 자료 등 연결 신뢰 정책을 명시한다.
• 반환과 장비 오류명령이 반환됐어도 출력에 Invalid input 같은 장비 오류가 있을 수 있어 결과를 파싱하고 실제 running 상태를 다시 조회한다.

  • running-config 변경과 startup-config 저장도 별도 작업이며 장비·플랫폼에 맞는 저장 절차가 필요하다.

08subprocess의 인자 목록과 셸 문자열

• subprocess로컬 프로그램을 실행할 때 subprocess.run에 인자 목록을 주면 각 요소를 별도 인자로 전달한다.
• shell=Trueshell=True로 문자열을 전달하면 셸이 파이프·리다이렉션·명령 치환 등을 해석한다.
• 사용자 입력사용자 입력이 셸 문법이 되는 위험을 줄이려면 가능한 한 목록과 고정 실행 파일을 사용한다.
• Paramiko하지만 Paramiko exec_command의 원격 문자열은 원격 셸에서 해석될 수 있으므로 로컬 목록 방식의 보장을 그대로 적용할 수 없다.
• timeoutcapture_output은 출력·오류를 모으고 text는 텍스트 디코딩, timeout은 대기 기한, check=True는 0이 아닌 종료 상태에서 CalledProcessError를 발생시키는 선택이다.

  • 잘못된 실행 파일 경로, 시간 초과, 프로그램의 실패 종료는 서로 다른 예외다.
• 고정 작업·반환 구조아래처럼 조회 명령을 고정하고 반환 구조를 읽는 부분을 먼저 만들면 이후 변경 자동화에서 실패 의미를 보존하기 쉽다.

import subprocess
result = subprocess.run(
    ["ip", "-brief", "address"],
    capture_output=True, text=True, timeout=5, check=True,
)
print(result.stdout)

교육용 예시. 실제 원격 접속·설정 변경·배포는 실행하지 않았다.

09반복 실행과 부분 성공을 상태로 관리하기

• 부분 적용과 원복여러 서버 중 세 번째에서 실패했다고 첫 두 서버의 변경까지 자동으로 되돌아가지는 않는다.
• 대상별 부분 성공대상별 성공·실패와 이전 상태를 기록하고 다시 실행할 때 필요한 작업만 적용할 수 있어야 한다.
• 중복 변경의 누적파일 끝에 설정 줄을 계속 붙이는 스크립트는 반복할수록 중복되지만 현재 설정과 원하는 값을 비교해 바꾸는 작업은 수렴할 수 있다.

  • 자동화의 속도보다 상태 전환의 정의가 먼저다.
• 검증·작은 배치입력 형식 검증, 읽기 전용 사전 조회, 작은 대상 배치, 결과 비교를 함수 경계로 나누고 비밀값은 코드·예외·출력 파일에 남기지 않는다.
• 응답 유실 후 상태 조회원격 응답을 잃은 경우 실제 명령이 실행됐는지 모를 수 있으므로 무조건 재시도하지 않고 상태를 조회한다.
• 상태 관리 도구이런 반복 가능한 상태 관리가 커질 때 Ansible 모듈과 선언적 관리 방식으로 넘어갈 이유가 생긴다.

10동시 실행과 재시도

• 연결·대상동시 연결 수와 요청 속도를 제한해 대상 장비에 부하가 몰리지 않게 한다.

  • 재시도는 일시 실패에 한정하고 최대 횟수와 간격을 정한다.
  • 멱등하지 않은 변경은 중복 수행을 막을 식별자나 확인 절차가 필요하다.

import subprocess
import sys

result = subprocess.run(
    [sys.executable, "--version"],
    capture_output=True, text=True, timeout=5, check=True,
)
print(result.stdout.strip())

현재 Python 실행 파일의 버전만 별도 프로세스로 조회한다. 원격 접속이나 환경 변경은 하지 않는다.

11원격 조회 한 건의 생애

• 대상인벤토리에서 승인된 대상 한 대와 읽기 전용 작업을 선택했다고 가정한다.
• 연결·대상먼저 연결 대상의 이름·주소·포트와 자격 증명 공급 경로를 분리해 준비하고 신뢰한 호스트 키로 서버를 검증한다.
• 인증·명령사용자 인증 뒤 명령 채널을 열어 조회 요청을 보내고 표준 출력·표준 오류·종료 상태를 수집한다.
• 연결·명령·자료 유효성연결 성공은 이 과정의 중간 결과이며 실제 명령 성공과 출력 자료의 유효성은 뒤에서 판단해야 한다.
• stdout출력에 성공이라는 문자가 있거나 stdout이 비어 있지 않다는 이유만으로 성공 처리하면 안 된다.

  • 반대로 stderr에 경고가 있다고 항상 실패인 것도 아니므로 종료 상태와 프로그램의 계약을 함께 해석한다.
• 명령·프롬프트네트워크 장비는 일반적인 Unix 프로세스와 같은 종료 코드를 제공하지 않을 수 있어 명령 오류 문구·프롬프트·구조화된 응답 규칙이 필요하다.
• Paramiko·명령Paramiko의 명령 채널과 Netmiko의 장비 CLI 처리 역할을 구분하고, 양쪽에서 발생하는 부분 출력과 시간 초과도 별도 상태로 기록한다.

1. 대상 검증·인증호스트 키와 사용자 인증을 확인한다.
2. 명령 채널 요청검증한 조회 작업을 요청한다.
3. 원격 실행대상 환경과 계정 권한으로 명령이 실행된다.
4. 출력과 종료 상태stdout·stderr·종료 상태 또는 연결 실패를 수집한다.
5. 구조화 기록대상·시각·판정·필요한 출력만 저장한다.

12부분 성공과 결과 불명을 처리하기

• 변경 결과 불명설정 변경을 요청한 뒤 응답 전에 연결이 끊기면 변경이 적용되지 않았는지, 적용됐지만 응답만 유실됐는지 알 수 없을 수 있다.

  • 이 상태를 실패로 뭉뚱그려 같은 변경을 즉시 반복하면 사용자나 규칙이 중복 생성될 수 있다.
• 결과 불명의 재확인가능한 경우 현재 상태를 다시 조회해 원하는 상태와 비교하고, 작업 식별자나 멱등한 연산으로 반복의 영향을 제한한다.
• 부분 실패와 전체 판정조회 자동화에서도 일부 장비 실패와 전체 작업 실패를 구분해야 성공한 결과를 보존할 수 있다.
• 연결·출력·시간 제한연결 수와 출력량을 제한하고 네트워크 연결·인증·명령 실행 시간 제한의 범위를 나눈다.
• 출력 버퍼출력 버퍼를 비우지 않은 채 종료만 기다리면 큰 출력에서 멈출 수 있는 도구도 있으므로 해당 라이브러리의 수집 방식을 따른다.
• subprocess·shell=Falsesubprocess의 shell=False는 로컬 셸 해석을 피하는 데 도움이 되지만 원격 exec 명령 문자열의 해석까지 바꾸지 않는다.
• 입력 경계·자원 종료신뢰할 수 없는 입력을 명령에 끼워 넣지 말고 고정 작업과 검증된 인수를 사용하며 모든 종료 경로에서 연결 자원을 닫는다.